@speakeasy-sdks/hathora-sdk-typescript

🏗 Welcome to your new SDK! 🏗

It has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:

• [ ] 🛠 Make your SDK feel handcrafted by customizing it
• [ ] ♻️ Refine your SDK quickly by iterating locally with the Speakeasy CLI
• [ ] 🎁 Publish your SDK to package managers by configuring automatic publishing
• [ ] ✨ When ready to productionize, delete this section from the README

SDK Installation

NPM

npm add https://github.com/hathora/cloud-sdk-typescript

Yarn

yarn add https://github.com/hathora/cloud-sdk-typescript

SDK Example Usage

Example

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

async function run() {
  const sdk = new HathoraCloud({
      security: {
        hathoraDevToken: "",
      },
      appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2",
    });

  
  const res = await sdk.appV1.createApp({
      appName: "minecraft",
      authConfiguration: {
        anonymous: {},
        google: {
          clientId: "string",
        },
        nickname: {},
      },
    });

  if (res?.statusCode !== 200) {
    throw new Error("Unexpected status code: " + res?.statusCode || "-");
  }
  
  // handle response
}

run();

Available Resources and Operations

appV1

• createApp - Create a new application.
• deleteApp - Delete an application using appId. Your organization will lose access to this application.
• getAppInfo - Get details for an application using appId.
• getApps - Returns an unsorted list of your organization’s applications. An application is uniquely identified by an appId.
• updateApp - Update data for an existing application using appId.

authV1

• loginAnonymous - Returns a unique player token for an anonymous user.
• loginGoogle - Returns a unique player token using a Google-signed OIDC idToken.
• loginNickname - Returns a unique player token with a specified nickname for a user.

billingV1

• getBalance
• getInvoices
• getPaymentMethod
• initStripeCustomerPortalUrl

buildV1

• createBuild - Creates a new build. Responds with a buildId that you must pass to RunBuild() to build the game server artifact. You can optionally pass in a buildTag to associate an external version with a build.
• deleteBuild - Delete a build. All associated metadata is deleted.
• getBuildInfo - Get details for a build.
• getBuilds - Returns an array of builds for an application.
• runBuild - Builds a game server artifact from a tarball you provide. Pass in the buildId generated from CreateBuild().

deploymentV1

• createDeployment - Create a new deployment. Creating a new deployment means all new rooms created will use the latest deployment configuration, but existing games in progress will not be affected.
• getDeploymentInfo - Get details for a deployment.
• getDeployments - Returns an array of deployments for an application.

discoveryV1

• 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.

lobbyV1

• ~~createPrivateLobbyDeprecated~~ - :warning: Deprecated
• ~~createPublicLobbyDeprecated~~ - :warning: Deprecated
• ~~listActivePublicLobbiesDeprecatedV1~~ - :warning: Deprecated

lobbyV2

• ~~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. :warning: Deprecated
• ~~createLocalLobby~~ - :warning: Deprecated
• ~~createPrivateLobby~~ - :warning: Deprecated
• ~~createPublicLobby~~ - :warning: Deprecated
• ~~getLobbyInfo~~ - Get details for a lobby. :warning: 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. :warning: 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). :warning: Deprecated

lobbyV3

• 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.
• 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.
• 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.

logV1

• ~~getLogsForApp~~ - Returns a stream of logs for an application using appId. :warning: Deprecated
• ~~getLogsForDeployment~~ - Returns a stream of logs for a deployment using appId and deploymentId. :warning: Deprecated
• getLogsForProcess - Returns a stream of logs for a process using appId and processId.

managementV1

• sendVerificationEmail

metricsV1

• getMetrics - Get metrics for a process using appId and processId.

processesV1

• getProcessInfo - Get details for a process.
• getRunningProcesses - Retrieve 10 most recently started process objects for an application. Filter the array by optionally passing in a region.
• getStoppedProcesses - Retrieve 10 most recently stopped process objects for an application. Filter the array by optionally passing in a region.

roomV1

• ~~createRoomDeprecated~~ - :warning: Deprecated
• ~~destroyRoomDeprecated~~ - :warning: Deprecated
• ~~getActiveRoomsForProcessDeprecated~~ - :warning: Deprecated
• ~~getConnectionInfoDeprecated~~ - :warning: Deprecated
• ~~getInactiveRoomsForProcessDeprecated~~ - :warning: Deprecated
• ~~getRoomInfoDeprecated~~ - :warning: Deprecated
• ~~suspendRoomDeprecated~~ - :warning: Deprecated

roomV2

• createRoom - Create a new room for an existing application. Poll the GetConnectionInfo() endpoint to get connection details for an active room.
• destroyRoom - Destroy a room. All associated metadata is deleted.
• getActiveRoomsForProcess - Get all active rooms for a given process.
• getConnectionInfo - Poll this endpoint to get connection details to a room. Clients can call this endpoint without authentication.
• getInactiveRoomsForProcess - Get all inactive rooms for a given process.
• getRoomInfo - Retreive current and historical allocation data for a room.
• suspendRoom - Suspend a room. The room is unallocated from the process but can be rescheduled later using the same roomId.
• updateRoomConfig

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 deleteApp. 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 "@speakeasy-sdks/hathora-sdk-typescript";

async function run() {
  const sdk = new HathoraCloud({
      security: {
        hathoraDevToken: "",
      },
      appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2",
    });

  const appId = "app-af469a92-5b45-4565-b3c4-b79878de67d2";
  const res = await sdk.appV1.deleteApp(appId);

  if (res?.statusCode !== 200) {
    throw new Error("Unexpected status code: " + res?.statusCode || "-");
  }
  
  // handle response
}

run();

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 | | --------------- | --------------- | --------------- | | models.SDKError | 400-600 | / |

Example

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

async function run() {
  const sdk = new HathoraCloud({
      security: {
        hathoraDevToken: "",
      },
      appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2",
    });

  
  
  const res = await sdk.appV1.createApp({
      appName: "minecraft",
      authConfiguration: {
        anonymous: {},
        google: {
          clientId: "string",
        },
        nickname: {},
      },
    })
    .catch((err) => {
      throw err;
    });

  if (res?.statusCode !== 200) {
    throw new Error("Unexpected status code: " + res?.statusCode || "-");
  }
  
  // handle response
}

run();

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

Example

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

async function run() {
  const sdk = new HathoraCloud({
      serverIdx: 1,
      security: {
        hathoraDevToken: "",
      },
      appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2",
    });

  
  const res = await sdk.appV1.createApp({
      appName: "minecraft",
      authConfiguration: {
        anonymous: {},
        google: {
          clientId: "string",
        },
        nickname: {},
      },
    });

  if (res?.statusCode !== 200) {
    throw new Error("Unexpected status code: " + res?.statusCode || "-");
  }
  
  // handle response
}

run();

Override Server URL Per-Client

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

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

async function run() {
  const sdk = new HathoraCloud({
      serverURL: "https://api.hathora.dev",
      security: {
        hathoraDevToken: "",
      },
      appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2",
    });

  
  const res = await sdk.appV1.createApp({
      appName: "minecraft",
      authConfiguration: {
        anonymous: {},
        google: {
          clientId: "string",
        },
        nickname: {},
      },
    });

  if (res?.statusCode !== 200) {
    throw new Error("Unexpected status code: " + res?.statusCode || "-");
  }
  
  // handle response
}

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 "@speakeasy-sdks/hathora-sdk-typescript";
import { HTTPClient } from "@speakeasy-sdks/hathora-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 |

You can set the security parameters through the security optional parameter when initializing the SDK client instance. For example:

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

async function run() {
  const sdk = new HathoraCloud({
      security: {
        hathoraDevToken: "",
      },
      appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2",
    });

  
  const res = await sdk.appV1.createApp({
      appName: "minecraft",
      authConfiguration: {
        anonymous: {},
        google: {
          clientId: "string",
        },
        nickname: {},
      },
    });

  if (res?.statusCode !== 200) {
    throw new Error("Unexpected status code: " + res?.statusCode || "-");
  }
  
  // handle response
}

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 "@speakeasy-sdks/hathora-sdk-typescript";
import { CreatePrivateLobbyDeprecatedSecurity, Region } from "@speakeasy-sdks/hathora-sdk-typescript/models";

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

  const appId = "app-af469a92-5b45-4565-b3c4-b79878de67d2";
  const local = false;
  const region = Region.London;
  const operationSecurity: CreatePrivateLobbyDeprecatedSecurity = {
    playerAuth: "",
  };
  const res = await sdk.lobbyV1.createPrivateLobbyDeprecated(operationSecurity, appId, local, region);

  if (res?.statusCode !== 200) {
    throw new Error("Unexpected status code: " + res?.statusCode || "-");
  }
  
  // handle response
}

run();

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. 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