Skip to content

hathora/cloud-sdk-typescript

BranchesTags

Repository files navigation

Typescript SDK

Serverless cloud hosting for multiplayer games

Summary

Hathora Cloud API: Welcome to the Hathora Cloud API documentation! Learn how to use the Hathora Cloud APIs to build and scale your game servers globally.

Table of Contents

SDK Installation

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

NPM

npm add @hathora/cloud-sdk-typescript

PNPM

pnpm add @hathora/cloud-sdk-typescript

Bun

bun add @hathora/cloud-sdk-typescript

Yarn

yarn add @hathora/cloud-sdk-typescript zod

# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.

SDK Example Usage

Example

import { HathoraCloud } from "@hathora/cloud-sdk-typescript";

const hathoraCloud = new HathoraCloud({
  hathoraDevToken: "<YOUR_BEARER_TOKEN_HERE>",
  orgId: "org-6f706e83-0ec1-437a-9a46-7d4281eb2f39",
  appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2",
});

async function run() {
  const result = await hathoraCloud.tokensV1.getOrgTokens(
    "org-6f706e83-0ec1-437a-9a46-7d4281eb2f39",
  );

  // Handle the result
  console.log(result);
}

run();

Available Resources and Operations

Available methods

appsV1

appsV2

authV1

billingV1

buildsV1

buildsV2

buildsV3

deploymentsV1

deploymentsV2

deploymentsV3

discoveryV1

discoveryV2

fleetsV1

lobbiesV1

lobbiesV2

lobbiesV3

logsV1

managementV1

metricsV1

organizationsV1

processesV1

processesV2

processesV3

roomsV1

roomsV2

tokensV1

Error Handling

Some methods specify known errors which can be thrown. All the known errors are enumerated in the models/errors/errors.ts module. The known errors for a method are documented under the Errors tables in SDK docs. For example, the getOrgTokens method may throw the following errors:

Error Type Status Code Content Type
errors.ApiError 401, 404, 429 application/json
errors.SDKError 4XX, 5XX */*

If the method throws an error and it is not captured by the known errors, it will default to throwing a SDKError.

import { HathoraCloud } from "@hathora/cloud-sdk-typescript";
import {
  ApiError,
  SDKValidationError,
} from "@hathora/cloud-sdk-typescript/models/errors";

const hathoraCloud = new HathoraCloud({
  hathoraDevToken: "<YOUR_BEARER_TOKEN_HERE>",
  orgId: "org-6f706e83-0ec1-437a-9a46-7d4281eb2f39",
  appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2",
});

async function run() {
  let result;
  try {
    result = await hathoraCloud.tokensV1.getOrgTokens(
      "org-6f706e83-0ec1-437a-9a46-7d4281eb2f39",
    );

    // Handle the result
    console.log(result);
  } catch (err) {
    switch (true) {
      // The server response does not match the expected SDK schema
      case (err instanceof SDKValidationError): {
        // Pretty-print will provide a human-readable multi-line error message
        console.error(err.pretty());
        // Raw value may also be inspected
        console.error(err.rawValue);
        return;
      }
      case (err instanceof ApiError): {
        // Handle err.data$: ApiErrorData
        console.error(err);
        return;
      }
      default: {
        // Other errors such as network errors, see HTTPClientErrors for more details
        throw err;
      }
    }
  }
}

run();

Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The SDKValidationError that is thrown as a result will capture the raw value that failed validation in an attribute called rawValue. Additionally, a pretty() method is available on this error that can be used to log a nicely formatted multi-line string since validation errors can list many issues and the plain error string may be difficult read when debugging.

In some rare cases, the SDK can fail to get a response from the server or even make the request due to unexpected circumstances such as network conditions. These types of errors are captured in the models/errors/httpclienterrors.ts module:

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

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
0 https://api.hathora.dev
1 https:///

Example

import { HathoraCloud } from "@hathora/cloud-sdk-typescript";

const hathoraCloud = new HathoraCloud({
  serverIdx: 1,
  hathoraDevToken: "<YOUR_BEARER_TOKEN_HERE>",
  orgId: "org-6f706e83-0ec1-437a-9a46-7d4281eb2f39",
  appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2",
});

async function run() {
  const result = await hathoraCloud.tokensV1.getOrgTokens(
    "org-6f706e83-0ec1-437a-9a46-7d4281eb2f39",
  );

  // Handle the result
  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 { HathoraCloud } from "@hathora/cloud-sdk-typescript";

const hathoraCloud = new HathoraCloud({
  serverURL: "https://api.hathora.dev",
  hathoraDevToken: "<YOUR_BEARER_TOKEN_HERE>",
  orgId: "org-6f706e83-0ec1-437a-9a46-7d4281eb2f39",
  appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2",
});

async function run() {
  const result = await hathoraCloud.tokensV1.getOrgTokens(
    "org-6f706e83-0ec1-437a-9a46-7d4281eb2f39",
  );

  // Handle the result
  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 use the "beforeRequest" hook to to add a custom header and a timeout to requests and how to use the "requestError" hook to log errors:

import { HathoraCloud } from "@hathora/cloud-sdk-typescript";
import { HTTPClient } from "@hathora/cloud-sdk-typescript/lib/http";

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

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 HathoraCloud({ httpClient });

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name Type Scheme
hathoraDevToken http HTTP Bearer

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

import { HathoraCloud } from "@hathora/cloud-sdk-typescript";

const hathoraCloud = new HathoraCloud({
  hathoraDevToken: "<YOUR_BEARER_TOKEN_HERE>",
  orgId: "org-6f706e83-0ec1-437a-9a46-7d4281eb2f39",
  appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2",
});

async function run() {
  const result = await hathoraCloud.tokensV1.getOrgTokens(
    "org-6f706e83-0ec1-437a-9a46-7d4281eb2f39",
  );

  // Handle the result
  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 { HathoraCloud } from "@hathora/cloud-sdk-typescript";

const hathoraCloud = new HathoraCloud({
  orgId: "org-6f706e83-0ec1-437a-9a46-7d4281eb2f39",
  appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2",
});

async function run() {
  const result = await hathoraCloud.lobbiesV3.createLobby(
    {
      playerAuth: "<YOUR_BEARER_TOKEN_HERE>",
    },
    {
      visibility: "private",
      roomConfig: "{\"name\":\"my-room\"}",
      region: "Seattle",
    },
    "app-af469a92-5b45-4565-b3c4-b79878de67d2",
    "LFG4",
    "2swovpy1fnunu",
  );

  // Handle the result
  console.log(result);
}

run();

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.

Available standalone functions

Global Parameters

Certain parameters are configured globally. These parameters may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, These global values will be used as defaults on the operations that use them. When such operations are called, there is a place in each to override the global value, if needed.

For example, you can set orgId to "org-6f706e83-0ec1-437a-9a46-7d4281eb2f39" at SDK initialization and then you do not have to pass the same value on calls to operations like getOrgTokens. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.

Available Globals

The following global parameters are available.

Name Type Description
orgId string The orgId parameter.
appId string The appId parameter.

Example

import { HathoraCloud } from "@hathora/cloud-sdk-typescript";

const hathoraCloud = new HathoraCloud({
  hathoraDevToken: "<YOUR_BEARER_TOKEN_HERE>",
  orgId: "org-6f706e83-0ec1-437a-9a46-7d4281eb2f39",
  appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2",
});

async function run() {
  const result = await hathoraCloud.tokensV1.getOrgTokens(
    "org-6f706e83-0ec1-437a-9a46-7d4281eb2f39",
  );

  // Handle the result
  console.log(result);
}

run();

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

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 { HathoraCloud } from "@hathora/cloud-sdk-typescript";

const hathoraCloud = new HathoraCloud({
  hathoraDevToken: "<YOUR_BEARER_TOKEN_HERE>",
  orgId: "org-6f706e83-0ec1-437a-9a46-7d4281eb2f39",
  appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2",
});

async function run() {
  const result = await hathoraCloud.tokensV1.getOrgTokens(
    "org-6f706e83-0ec1-437a-9a46-7d4281eb2f39",
    {
      retries: {
        strategy: "backoff",
        backoff: {
          initialInterval: 1,
          maxInterval: 50,
          exponent: 1.1,
          maxElapsedTime: 100,
        },
        retryConnectionErrors: false,
      },
    },
  );

  // Handle the result
  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 { HathoraCloud } from "@hathora/cloud-sdk-typescript";

const hathoraCloud = new HathoraCloud({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  hathoraDevToken: "<YOUR_BEARER_TOKEN_HERE>",
  orgId: "org-6f706e83-0ec1-437a-9a46-7d4281eb2f39",
  appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2",
});

async function run() {
  const result = await hathoraCloud.tokensV1.getOrgTokens(
    "org-6f706e83-0ec1-437a-9a46-7d4281eb2f39",
  );

  // Handle the result
  console.log(result);
}

run();

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 { HathoraCloud } from "@hathora/cloud-sdk-typescript";

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

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. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release !

SDK Created by Speakeasy

About

Hathora Cloud TypeScript SDK

hathora.dev/docs

Topics

api typescript sdk multiplayer game-server-hosting hathora

Resources

Readme

License

MIT license
Activity
Custom properties

Stars

3 stars

Watchers

6 watching

Forks

5 forks
Report repository

Releases 39

typescript - v2.11.6 - 2025-01-08 00:15:21 Latest
Jan 8, 2025
+ 38 releases

Packages

No packages published

Contributors 9

Languages