@gbg/go-core

Developer-friendly & type-safe Typescript SDK specifically catered to leverage @gbg/go-core API.

Summary

GBG GO Next Gen Flow Captain API: API for Customers and End Users to interact with the GBG GO Next Gen Flow Captain

Table of Contents

• @gbg/go-core
  • SDK Installation
  • Requirements
  • SDK Example Usage
  • Authentication
  • Available Resources and Operations
  • Standalone functions
  • Retries
  • Error Handling
  • Server Selection
  • Custom HTTP Client
  • Analytics
  • Debugging
• Development
  • Maturity
  • Contributions

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add @gbg/go-core

PNPM

pnpm add @gbg/go-core

Bun

bun add @gbg/go-core

Yarn

yarn add @gbg/go-core

[!NOTE] This package is published with CommonJS and ES Modules (ESM) support.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { Go } from "@gbg/go-core";

const go = new Go();

async function run() {
  const result = await go.tokens.generate();

  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name | Type | Scheme | Environment Variable | | ---------------- | ---- | ----------- | -------------------- | | customerAccess | http | HTTP Bearer | GO_CUSTOMER_ACCESS |

To authenticate with the API the customerAccess parameter must be set when initializing the SDK client instance. For example:

import { Go } from "@gbg/go-core";

const go = new Go({
  customerAccess: process.env["GO_CUSTOMER_ACCESS"] ?? "",
});

async function run() {
  const result = await go.tokens.generate();

  console.log(result);
}

run();

Per-Operation Security Schemes

Some operations in this SDK require the security scheme to be specified at the request level. For example:

import { Go } from "@gbg/go-core";

const go = new Go();

async function run() {
  const result = await go.devices.connect({
    deviceConnect: process.env["GO_DEVICE_CONNECT"] ?? "",
  }, {
    connectToken: "s4FUx8Ny8ijXRtFigz3x1_8rb9bd_5ZD",
    deviceInfo: {
      deviceId: "exampleDeviceId123",
      deviceName: "deviceName",
      deviceType: "deviceType",
    },
  });

  console.log(result);
}

run();

Available Resources and Operations

Devices

• connect - Connect or Refresh End User Device
• add - Create Connect Secret

Health

• get - Obtain the flow-captain health status

Instances

• delete - Delete instance

Interactions

• submit - Submit Interaction
• fetch - Fetch Interaction

Journeys

• start - Start Journey
• getState - Get State Data

Tasks

• list - Get End User Tasks
• update - Put End User Data
• getSchema - Get Task Schema
• listSchema - Get Tasks Schema

Tokens

• generate - Generate access token

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

• devicesAdd - Create Connect Secret
• devicesConnect - Connect or Refresh End User Device
• healthGet - Obtain the flow-captain health status
• instancesDelete - Delete instance
• interactionsFetch - Fetch Interaction
• interactionsSubmit - Submit Interaction
• journeysGetState - Get State Data
• journeysStart - Start Journey
• tasksGetSchema - Get Task Schema
• tasksList - Get End User Tasks
• tasksListSchema - Get Tasks Schema
• tasksUpdate - Put End User Data
• tokensGenerate - Generate access token

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { Go } from "@gbg/go-core";

const go = new Go();

async function run() {
  const result = await go.tokens.generate(undefined, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { Go } from "@gbg/go-core";

const go = new Go({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
});

async function run() {
  const result = await go.tokens.generate();

  console.log(result);
}

run();

Error Handling

GoError is the base class for all HTTP error responses. It has the following properties:

| Property | Type | Description | | ------------------- | ---------- | ------------------------------------------------------ | | error.message | string | Error message | | error.statusCode | number | HTTP response status code eg 404 | | error.headers | Headers | HTTP response headers | | error.body | string | HTTP body. Can be empty string if no body is returned. | | error.rawResponse | Response | Raw HTTP response |

Example

import { Go } from "@gbg/go-core";
import * as errors from "@gbg/go-core/models/errors";

const go = new Go();

async function run() {
  try {
    const result = await go.tokens.generate();

    console.log(result);
  } catch (error) {
    if (error instanceof errors.GoError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);
    }
  }
}

run();

Error Classes

Primary error:

• GoError: The base class for HTTP error responses.

Network errors:

• ConnectionError: HTTP client was unable to make a request to a server.
• RequestTimeoutError: HTTP request timed out due to an AbortSignal signal.
• RequestAbortedError: HTTP request was aborted by the client.
• InvalidRequestError: Any input used to create a request is invalid.
• UnexpectedClientError: Unrecognised or unexpected error.

Inherit from GoError:

• ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the serverIdx: number optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

| # | Server | Description | | --- | ---------------------------------------------- | ----------- | | 0 | https://eu.platform.go.gbgplc.com/v2/captain | | | 1 | https://us.platform.go.gbgplc.com/v2/captain | | | 2 | https://au.platform.go.gbgplc.com/v2/captain | |

Example

import { Go } from "@gbg/go-core";

const go = new Go({
  serverIdx: 0,
  customerAccess: process.env["GO_CUSTOMER_ACCESS"] ?? "",
});

async function run() {
  const result = await go.health.get();

  console.log(result);
}

run();

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:

import { Go } from "@gbg/go-core";

const go = new Go({
  serverURL: "https://au.platform.go.gbgplc.com/v2/captain",
  customerAccess: process.env["GO_CUSTOMER_ACCESS"] ?? "",
});

async function run() {
  const result = await go.health.get();

  console.log(result);
}

run();

Override Server URL Per-Operation

The server URL can also be overridden on a per-operation basis, provided a server list was specified for the operation. For example:

import { Go } from "@gbg/go-core";

const go = new Go();

async function run() {
  const result = await go.tokens.generate(undefined, {
    serverURL: "https://api.auth.gbgplc.com",
  });

  console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to:

• route requests through a proxy server using undici's ProxyAgent
• use the "beforeRequest" hook to add a custom header and a timeout to requests
• use the "requestError" hook to log errors

import { Go } from "@gbg/go-core";
import { ProxyAgent } from "undici";
import { HTTPClient } from "@gbg/go-core/lib/http";

const dispatcher = new ProxyAgent("http://proxy.example.com:8080");

const httpClient = new HTTPClient({
  // 'fetcher' takes a function that has the same signature as native 'fetch'.
  fetcher: (input, init) =>
    // 'dispatcher' is specific to undici and not part of the standard Fetch API.
    fetch(input, { ...init, dispatcher } as RequestInit),
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new Go({ httpClient: httpClient });

Analytics

The SDK sends an X-GBG-Source request header identifying the SDK and its version (the same value as the user agent). GBG uses it for anonymous usage analytics. It carries no personal or request data.

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { Go } from "@gbg/go-core";

const sdk = new Go({ debugLogger: console });

You can also enable a default debug logger by setting an environment variable GO_DEBUG to true.

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy