@hathora/cloud-sdk-typescript
TypeScript icon, indicating that this package has built-in type declarations

2.2.8 • Public • Published

Typescript SDK

Serverless cloud hosting for multiplayer games

SDK Installation

NPM

npm add @hathora/cloud-sdk-typescript

Yarn

yarn add @hathora/cloud-sdk-typescript

SDK Example Usage

Example

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

const hathoraCloud = new HathoraCloud({
    hathoraDevToken: "<YOUR_BEARER_TOKEN_HERE>",
    appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2",
});

async function run() {
    const result = await hathoraCloud.appV1.getApps();

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

run();

Available Resources and Operations

  • loginAnonymous - Returns a unique player token for an anonymous user.
  • loginNickname - Returns a unique player token with a specified nickname for a user.
  • loginGoogle - Returns a unique player token using a Google-signed OIDC idToken.
  • getPingServiceEndpointsDeprecated - Returns an array of V1 regions with a host and port that a client can directly ping. Open a websocket connection to wss://<host>:<port>/ws and send a packet. To calculate ping, measure the time it takes to get an echo packet back. ⚠️ Deprecated
  • getPingServiceEndpoints - Returns an array of all regions with a host and port that a client can directly ping. Open a websocket connection to wss://<host>:<port>/ws and send a packet. To calculate ping, measure the time it takes to get an echo packet back.
  • createPrivateLobby - ⚠️ Deprecated
  • createPublicLobby - ⚠️ Deprecated
  • createLocalLobby - ⚠️ Deprecated
  • createLobbyDeprecated - Create a new lobby for an application. A lobby object is a wrapper around a room object. With a lobby, you get additional functionality like configuring the visibility of the room, managing the state of a match, and retrieving a list of public lobbies to display to players. ⚠️ Deprecated
  • listActivePublicLobbiesDeprecatedV2 - Get all active lobbies for a an application. Filter by optionally passing in a region. Use this endpoint to display all public lobbies that a player can join in the game client. ⚠️ Deprecated
  • getLobbyInfo - Get details for a lobby. ⚠️ Deprecated
  • setLobbyState - Set the state of a lobby. State is intended to be set by the server and must be smaller than 1MB. Use this endpoint to store match data like live player count to enforce max number of clients or persist end-game data (i.e. winner or final scores). ⚠️ Deprecated
  • createLobby - Create a new lobby for an application. A lobby object is a wrapper around a room object. With a lobby, you get additional functionality like configuring the visibility of the room, managing the state of a match, and retrieving a list of public lobbies to display to players.
  • listActivePublicLobbies - Get all active lobbies for a given application. Filter the array by optionally passing in a region. Use this endpoint to display all public lobbies that a player can join in the game client.
  • getLobbyInfoByRoomId - Get details for a lobby.
  • getLobbyInfoByShortCode - Get details for a lobby. If 2 or more lobbies have the same shortCode, then the most recently created lobby will be returned.

Error Handling

All SDK methods return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.

Error Object Status Code Content Type
errors.ApiError 401,422,429,500 application/json
errors.SDKError 4xx-5xx /

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 string since validation errors can list many issues and the plain error string may be difficult read when debugging.

import { HathoraCloud } from "@hathora/cloud-sdk-typescript";
import * as errors from "@hathora/cloud-sdk-typescript/models/errors";

const hathoraCloud = new HathoraCloud({
    hathoraDevToken: "<YOUR_BEARER_TOKEN_HERE>",
    appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2",
});

async function run() {
    let result;
    try {
        result = await hathoraCloud.appV1.createApp({
            authConfiguration: {},
            appName: "minecraft",
        });
    } catch (err) {
        switch (true) {
            case err instanceof errors.SDKValidationError: {
                // Validation errors can be pretty-printed
                console.error(err.pretty());
                // Raw value may also be inspected
                console.error(err.rawValue);
                return;
            }
            case err instanceof errors.ApiError: {
                console.error(err); // handle exception
                return;
            }
            default: {
                throw err;
            }
        }
    }

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

run();

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the serverIdx 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 Variables
0 https://api.hathora.dev None
1 https:/// None
import { HathoraCloud } from "@hathora/cloud-sdk-typescript";

const hathoraCloud = new HathoraCloud({
    serverIdx: 1,
    hathoraDevToken: "<YOUR_BEARER_TOKEN_HERE>",
    appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2",
});

async function run() {
    const result = await hathoraCloud.appV1.getApps();

    // 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 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>",
    appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2",
});

async function run() {
    const result = await hathoraCloud.appV1.getApps();

    // 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>",
    appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2",
});

async function run() {
    const result = await hathoraCloud.appV1.getApps();

    // 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";
import { Region } from "@hathora/cloud-sdk-typescript/models/components";

const hathoraCloud = new HathoraCloud({
    appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2",
});

async function run() {
    const result = await hathoraCloud.lobbyV1.createPrivateLobbyDeprecated(
        "<YOUR_BEARER_TOKEN_HERE>",
        "app-af469a92-5b45-4565-b3c4-b79878de67d2",
        Region.London,
        false
    );

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

run();

Global Parameters

A parameter is configured globally. This parameter may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.

For example, you can set appId to "app-af469a92-5b45-4565-b3c4-b79878de67d2" at SDK initialization and then you do not have to pass the same value on calls to operations like updateApp. 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 parameter is available.

Name Type Required Description
appId string The appId parameter.

Example

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

const hathoraCloud = new HathoraCloud({
    hathoraDevToken: "<YOUR_BEARER_TOKEN_HERE>",
    appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2",
});

async function run() {
    const result = await hathoraCloud.appV1.updateApp(
        {
            authConfiguration: {},
            appName: "minecraft",
        },
        "app-af469a92-5b45-4565-b3c4-b79878de67d2"
    );

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

run();

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

File uploads

Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.

[!TIP]

Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:

  • Node.js v20+: Since v20, Node.js comes with a native openAsBlob function in node:fs.
  • Bun: The native Bun.file function produces a file handle that can be used for streaming file uploads.
  • Browsers: All supported browsers return an instance to a File when reading the value from an <input type="file"> element.
  • Node.js v18: A file stream can be created using the fileFrom helper from fetch-blob/from.js.
import { HathoraCloud } from "@hathora/cloud-sdk-typescript";
import { openAsBlob } from "node:fs";

const hathoraCloud = new HathoraCloud({
    hathoraDevToken: "<YOUR_BEARER_TOKEN_HERE>",
    appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2",
});

async function run() {
    const result = await hathoraCloud.buildV1.runBuildDeprecated(
        1,
        {
            file: await openAsBlob("./sample-file"),
        },
        "app-af469a92-5b45-4565-b3c4-b79878de67d2"
    );

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

run();

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

Readme

Keywords

none

Package Sidebar

Install

npm i @hathora/cloud-sdk-typescript

Weekly Downloads

23

Version

2.2.8

License

none

Unpacked Size

2.88 MB

Total Files

980

Last publish

Collaborators

  • natgabb
  • hathora_justin
  • dsiddharth
  • gwprice115
  • hpx7