Caseblocks JavaScript API Reference (Modern Functions)

The Caseblocks scripting environment provides various functions for interacting with Caseblocks data and external services. This document lists non-deprecated methods and utilities, which are recommended for new script development.

Core Environment
Utility Functions
- utils.deflate()
- utils.inflate()

Core Environment

Caseblocks

Type: Reference to the Caseblocks node object.

This is a reference to the Caseblocks node npm package

You can use this to interact with objects in your Caseblocks environment.

requestContext()

const context = requestContext();

Retrieves any current request context metadata, such as authorization tokens or user/session information. Some internal calls may leverage this context automatically.

generateGuid()

const myGuid = generateGuid();

Generates a new GUID (Universally Unique Identifier) as a string.

graphql(query, variables, url)

graphql(`
  query GetCase($id: ID!) {
    case(id: $id) {
      title
      status
    }
  }
`, { id: "1234" })
  .then(response => {
    // handle GraphQL response data
  })
  .catch(error => {
    // handle error
  });

Executes a GraphQL query or mutation against the default or specified GraphQL endpoint.

query: A string containing your GraphQL operation.
variables: An object mapping variable names to values for the query.
url (optional): Specify a custom GraphQL endpoint; defaults to the system’s standard endpoint.
Returns: A Promise resolving with the JSON response.

Use Case: Reading or modifying Caseblocks data (e.g., creating, updating, or fetching cases) in a structured, robust manner.

fetch

This is the standard fetch() function, similar to what you’d use in modern browsers.

fetch("https://example.com/api/data")
  .then(res => res.json())
  .then(data => {
    // handle the data object
  })
  .catch(err => {
    // handle errors
  });

Use fetch() for RESTful or other HTTP/HTTPS requests to external APIs, or to perform custom calls within Caseblocks, when GraphQL is not suitable.

Utility Functions

The utils object provides convenience methods for compressing and decompressing data.

utils.deflate()

utils.deflate(
  "some UTF-8 text",
  (base64Zipped) => {
    // base64Zipped is the compressed data in Base64 format
  },
  (error) => {
    // handle error
  }
);

Purpose: Compress a UTF-8 string and return a Base64-encoded representation.

Parameters

str: The UTF-8 string to compress.
callback: Function invoked on success, receiving the Base64-encoded data.
errorHandler: Function invoked on failure, receiving an error object.

utils.inflate()

utils.inflate(
  base64ZippedString,
  (unzipped) => {
    // unzipped is the original UTF-8 string
  },
  (error) => {
    // handle error
  }
);

Purpose: Decompress a Base64-encoded, zipped string back to its original UTF-8 form.