Previous versions of the JavaScript/TypeScript SDK

JavaScript v1 SDK

• GitHub repository
• Getting Started
• Reference docs

Features

Middlewares

The JavaScript SDK has a middleware architecture. Allowing plugins or middlewares to be connected to the request. Middlewares allow for easy extensibility of the SDK. Find more information about the architecture here.

The following middlewares are supported:

• sdk-middleware-auth
• sdk-middleware-http
• sdk-middleware-queue
• sdk-middleware-logger
• sdk-middleware-user-agent

Authentication

The JavaScript SDK supports all authentication flows listed here.

If the SDK is used to generate the token, it stores a refresh token which is used to fetch a valid token if the old token expires.

Helper Libraries

These are libraries that help in building the final request.

api-request-builder

Helps to construct the URI for the HTTP API endpoints in a declarative approach. You can find more information here.

sync-actions

Helps in generating update actions required to update an entity from an old state to a new state. You can find more information here.

get-credentials

Helps to retrieve Project credentials from the environment or file system. You can find more information here.

http-user-agent

Creates a HTTP user-agent that can be added to the request. You can find more information here.

Node SDK

The Node SDK is no longer maintained. It should not be confused with the JavaScript SDK. If you are still using the Node SDK, a migration guide is available here.