Gbox TypeScript SDK

This library provides convenient access to the Gbox API from TypeScript or JavaScript.

Documentation

Table of Contents

• Installation
• Usage
• Quick Start
• Handling errors
  • Retries
  • Timeouts
• Advanced Usage
  • Logging
    • Log levels
    • Custom logger
  • Customizing the fetch client
  • Fetch options
    • Configuring proxies
• Frequently Asked Questions
• Semantic versioning
• Requirements
• Contributing

Installation

npm install gbox-sdk
Copy

Usage

import GboxSDK from 'gbox-sdk';

const gboxSDK = new GboxSDK({
  apiKey: process.env['GBOX_API_KEY'], // This is the default and can be omitted
  environment: 'selfHosting', // or 'production' | 'internal'; defaults to 'production'
});

async function main() {
  const box = await gboxSDK.create({type: 'android'})
}

main();
Copy

Quick Start

import GboxClient from 'gbox-sdk';

const client = new GboxClient({
  apiKey: process.env['GBOX_API_KEY'], // This is the default and can be omitted
  environment: 'selfHosting', // or 'production' | 'internal'; defaults to 'production'
});

const box = await gboxSDK.create({ type: 'android' });

// box.config is the config of the box (e.g. OS version, screen size, etc.)
console.log(box.config);
Copy

Handling errors

When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of APIError will be thrown:

async function main() {
  const box = await gboxSDK.create({ type: 'android' }).catch(async (err) => {
    if (err instanceof GboxSDK.APIError) {
      console.log(err.status); // 400
      console.log(err.name); // BadRequestError
      console.log(err.headers); // {server: 'nginx', ...}
    } else {
      throw err;
    }
  });
}

main();
Copy

Error codes are as follows:

Status Code	Error Type
400	BadRequestError
401	AuthenticationError
403	PermissionDeniedError
404	NotFoundError
422	UnprocessableEntityError
429	RateLimitError
>=500	InternalServerError
N/A	APIConnectionError

Retries

Certain errors will be automatically retried 0 times by default, with a short exponential backoff. Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict, 429 Rate Limit, and >=500 Internal errors will all be retried by default.

You can use the maxRetries option to configure or disable this:

// Configure the default for all requests:
const gboxSDK = new GboxSDK({
  maxRetries: 0, // default is 2
});

// Or, configure per-request:
await gboxSDK.create({ type: 'android' }, {
  maxRetries: 5,
});
Copy

Timeouts

Requests time out after 1 minute by default. You can configure this with a timeout option:

// Configure the default for all requests:
const gboxSDK = new GboxSDK({
  timeout: 20 * 1000, // 20 seconds (default is 1 minute)
});

// Override per-request:
await gboxSDK.create({ type: 'linux' }, {
  timeout: 5 * 1000,
});
Copy

On timeout, an APIConnectionTimeoutError is thrown.

Note that requests which time out will be retried twice by default.

Advanced Usage

Logging

Log levels

The log level can be configured in two ways:

1. Via the GBOX_CLIENT_LOG environment variable
2. Using the logLevel client option (overrides the environment variable if set)

import GboxSDK from 'gbox-sdk';

const gboxSDK = new GboxSDK({
  logLevel: 'debug', // Show all log messages
});
Copy

Available log levels, from most to least verbose:

• 'debug' - Show debug messages, info, warnings, and errors
• 'info' - Show info messages, warnings, and errors
• 'warn' - Show warnings and errors (default)
• 'error' - Show only errors
• 'off' - Disable all logging

At the 'debug' level, all HTTP requests and responses are logged, including headers and bodies. Some authentication-related headers are redacted, but sensitive data in request and response bodies may still be visible.

Custom logger

By default, this library logs to globalThis.console. You can also provide a custom logger. Most logging libraries are supported, including pino, winston, bunyan, consola, signale, and @std/log. If your logger doesn't work, please open an issue.

When providing a custom logger, the logLevel option still controls which messages are emitted, messages below the configured level will not be sent to your logger.

import GboxSDK from 'gbox-sdk';
import pino from 'pino';

const logger = pino();

const gboxSDK = new GboxSDK({
  logger: logger.child({ name: 'GboxClient' }),
  logLevel: 'debug', // Send all messages to pino, allowing it to filter
});
Copy

Customizing the fetch client

By default, this library expects a global fetch function is defined.

If you want to use a different fetch function, you can either polyfill the global:

import fetch from 'my-fetch';

globalThis.fetch = fetch;
Copy

Or pass it to the client:

import GboxSDK from 'gbox-sdk';
import fetch from 'my-fetch';

const gboxSDK = new GboxSDK({ fetch });
Copy

Fetch options

If you want to set custom fetch options without overriding the fetch function, you can provide a fetchOptions object when instantiating the client or making a request. (Request-specific options override client options.)

import GboxSDK from 'gbox-sdk';

const gboxSDK = new GboxSDK({
  fetchOptions: {
    // `RequestInit` options
  },
});
Copy

Configuring proxies

To modify proxy behavior, you can provide custom fetchOptions that add runtime-specific proxy options to requests:

Node ^[docs]

import GboxSDK from 'gbox-sdk';
import * as undici from 'undici';

const proxyAgent = new undici.ProxyAgent('http://localhost:8888');
const gboxSDK = new GboxSDK({
  fetchOptions: {
    dispatcher: proxyAgent,
  },
});
Copy

Bun ^[docs]

import GboxSDK from 'gbox-sdk';

const gboxSDK = new GboxSDK({
  fetchOptions: {
    proxy: 'http://localhost:8888',
  },
});
Copy

Deno ^[docs]

import GboxSDK from 'npm:gbox-sdk';

const httpClient = Deno.createHttpClient({ proxy: { url: 'http://localhost:8888' } });
const gboxSDK = new GboxSDK({
  fetchOptions: {
    client: httpClient,
  },
});
Copy

Frequently Asked Questions

Semantic versioning

This package generally follows SemVer conventions, though certain backwards-incompatible changes may be released as minor versions:

1. Changes that only affect static types, without breaking runtime behavior.
2. Changes to library internals which are technically public but not intended or documented for external use. (Please open a GitHub issue to let us know if you are relying on such internals.)
3. Changes that we do not expect to impact the vast majority of users in practice.

We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.

We are keen for your feedback; please open an issue with questions, bugs, or suggestions.

Requirements

TypeScript >= 4.9 is supported.

The following runtimes are supported:

• Web browsers (Up-to-date Chrome, Firefox, Safari, Edge, and more)
• Node.js 20 LTS or later (non-EOL) versions.
• Deno v1.28.0 or higher.
• Bun 1.0 or later.
• Cloudflare Workers.
• Vercel Edge Runtime.
• Jest 28 or greater with the "node" environment ("jsdom" is not supported at this time).
• Nitro v2.6 or greater.

Note that React Native is not supported at this time.

If you are interested in other runtime environments, please open or upvote an issue on GitHub.

Contributing

See the contributing documentation.