@hathora/cloud-sdk-typescript
v2.11.5
Published
<div align="center"> <img src="https://user-images.githubusercontent.com/6267663/235110661-00e586cc-7489-4daf-82e8-7ae3c2c7143e.svg" width="350px"> <h1> Typescript SDK</h1> <p>Serverless cloud hosting for multiplayer games</p> <a href="https
Downloads
836
Keywords
Readme
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
- SDK Example Usage
- Available Resources and Operations
- Error Handling
- Server Selection
- Custom HTTP Client
- Authentication
- Standalone functions
- Global Parameters
- Requirements
- Retries
- Debugging
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
~~appsV1~~
- ~~getAppsV1Deprecated~~ - GetAppsV1Deprecated :warning: Deprecated
- ~~createAppV1Deprecated~~ - CreateAppV1Deprecated :warning: Deprecated
- ~~updateAppV1Deprecated~~ - UpdateAppV1Deprecated :warning: Deprecated
- ~~getAppInfoV1Deprecated~~ - GetAppInfoV1Deprecated :warning: Deprecated
- ~~deleteAppV1Deprecated~~ - DeleteAppV1Deprecated :warning: Deprecated
appsV2
authV1
- loginAnonymous - LoginAnonymous
- loginNickname - LoginNickname
- loginGoogle - LoginGoogle
billingV1
- getBalance - GetBalance
- getUpcomingInvoiceItems - GetUpcomingInvoiceItems
- getUpcomingInvoiceTotal - GetUpcomingInvoiceTotal
- getPaymentMethod - GetPaymentMethod
- initStripeCustomerPortalUrl - InitStripeCustomerPortalUrl
- getInvoices - GetInvoices
~~buildsV1~~
- ~~getBuildsDeprecated~~ - GetBuildsDeprecated :warning: Deprecated
- ~~getBuildInfoDeprecated~~ - GetBuildInfoDeprecated :warning: Deprecated
- ~~createBuildDeprecated~~ - CreateBuildDeprecated :warning: Deprecated
- ~~deleteBuildDeprecated~~ - DeleteBuildDeprecated :warning: Deprecated
- ~~runBuildDeprecated~~ - RunBuildDeprecated :warning: Deprecated
~~buildsV2~~
- ~~getBuildsV2Deprecated~~ - GetBuildsV2Deprecated :warning: Deprecated
- ~~getBuildInfoV2Deprecated~~ - GetBuildInfoV2Deprecated :warning: Deprecated
- ~~createBuildV2Deprecated~~ - CreateBuildV2Deprecated :warning: Deprecated
- ~~createBuildWithUploadUrlV2Deprecated~~ - CreateBuildWithUploadUrlV2Deprecated :warning: Deprecated
- ~~createWithMultipartUploadsV2Deprecated~~ - CreateWithMultipartUploadsV2Deprecated :warning: Deprecated
- ~~deleteBuildV2Deprecated~~ - DeleteBuildV2Deprecated :warning: Deprecated
- ~~runBuildV2Deprecated~~ - RunBuildV2Deprecated :warning: Deprecated
buildsV3
- getBuilds - GetBuilds
- createBuild - CreateBuild
- getBuild - GetBuild
- deleteBuild - DeleteBuild
- runBuild - RunBuild
~~deploymentsV1~~
- ~~getDeploymentsV1Deprecated~~ - GetDeploymentsV1Deprecated :warning: Deprecated
- ~~getLatestDeploymentV1Deprecated~~ - GetLatestDeploymentV1Deprecated :warning: Deprecated
- ~~getDeploymentInfoV1Deprecated~~ - GetDeploymentInfoV1Deprecated :warning: Deprecated
- ~~createDeploymentV1Deprecated~~ - CreateDeploymentV1Deprecated :warning: Deprecated
~~deploymentsV2~~
- ~~getDeploymentsV2Deprecated~~ - GetDeploymentsV2Deprecated :warning: Deprecated
- ~~getLatestDeploymentV2Deprecated~~ - GetLatestDeploymentV2Deprecated :warning: Deprecated
- ~~getDeploymentInfoV2Deprecated~~ - GetDeploymentInfoV2Deprecated :warning: Deprecated
- ~~createDeploymentV2Deprecated~~ - CreateDeploymentV2Deprecated :warning: Deprecated
deploymentsV3
- getDeployments - GetDeployments
- createDeployment - CreateDeployment
- getLatestDeployment - GetLatestDeployment
- getDeployment - GetDeployment
~~discoveryV1~~
- ~~getPingServiceEndpointsDeprecated~~ - GetPingServiceEndpointsDeprecated :warning: Deprecated
discoveryV2
- getPingServiceEndpoints - GetPingServiceEndpoints
fleetsV1
- getFleets - GetFleets
- getFleetRegion - GetFleetRegion
- updateFleetRegion - UpdateFleetRegion
- getFleetMetrics - GetFleetMetrics
~~lobbiesV1~~
- ~~createPrivateLobbyDeprecated~~ - CreatePrivateLobbyDeprecated :warning: Deprecated
- ~~createPublicLobbyDeprecated~~ - CreatePublicLobbyDeprecated :warning: Deprecated
- ~~listActivePublicLobbiesDeprecatedV1~~ - ListActivePublicLobbiesDeprecatedV1 :warning: Deprecated
~~lobbiesV2~~
- ~~createPrivateLobby~~ - CreatePrivateLobby :warning: Deprecated
- ~~createPublicLobby~~ - CreatePublicLobby :warning: Deprecated
- ~~createLocalLobby~~ - CreateLocalLobby :warning: Deprecated
- ~~createLobbyDeprecated~~ - CreateLobbyDeprecated :warning: Deprecated
- ~~listActivePublicLobbiesDeprecatedV2~~ - ListActivePublicLobbiesDeprecatedV2 :warning: Deprecated
- ~~getLobbyInfo~~ - GetLobbyInfo :warning: Deprecated
- ~~setLobbyState~~ - SetLobbyState :warning: Deprecated
lobbiesV3
- createLobby - CreateLobby
- listActivePublicLobbies - ListActivePublicLobbies
- getLobbyInfoByRoomId - GetLobbyInfoByRoomId
- getLobbyInfoByShortCode - GetLobbyInfoByShortCode
logsV1
- getLogsForProcess - GetLogsForProcess
- downloadLogForProcess - DownloadLogForProcess
managementV1
- sendVerificationEmail - SendVerificationEmail
~~metricsV1~~
- ~~getMetricsDeprecated~~ - GetMetricsDeprecated :warning: Deprecated
organizationsV1
- getOrgs - GetOrgs
- getUserPendingInvites - GetUserPendingInvites
- getOrgMembers - GetOrgMembers
- inviteUser - InviteUser
- updateUserInvite - UpdateUserInvite
- rescindInvite - RescindInvite
- getOrgPendingInvites - GetOrgPendingInvites
- acceptInvite - AcceptInvite
- rejectInvite - RejectInvite
- getUsageLimits - GetUsageLimits
~~processesV1~~
- ~~getRunningProcesses~~ - GetRunningProcesses :warning: Deprecated
- ~~getStoppedProcesses~~ - GetStoppedProcesses :warning: Deprecated
- ~~getProcessInfoDeprecated~~ - GetProcessInfoDeprecated :warning: Deprecated
~~processesV2~~
- ~~getProcessInfoV2Deprecated~~ - GetProcessInfoV2Deprecated :warning: Deprecated
- ~~getLatestProcessesV2Deprecated~~ - GetLatestProcessesV2Deprecated :warning: Deprecated
- ~~getProcessesCountExperimentalV2Deprecated~~ - GetProcessesCountExperimentalV2Deprecated :warning: Deprecated
- ~~stopProcessV2Deprecated~~ - StopProcessV2Deprecated :warning: Deprecated
- ~~createProcessV2Deprecated~~ - CreateProcessV2Deprecated :warning: Deprecated
processesV3
- getLatestProcesses - GetLatestProcesses
- getProcessesCountExperimental - GetProcessesCountExperimental
- createProcess - CreateProcess
- getProcess - GetProcess
- stopProcess - StopProcess
- getProcessMetrics - GetProcessMetrics
~~roomsV1~~
- ~~createRoomDeprecated~~ - CreateRoomDeprecated :warning: Deprecated
- ~~getRoomInfoDeprecated~~ - GetRoomInfoDeprecated :warning: Deprecated
- ~~getActiveRoomsForProcessDeprecated~~ - GetActiveRoomsForProcessDeprecated :warning: Deprecated
- ~~getInactiveRoomsForProcessDeprecated~~ - GetInactiveRoomsForProcessDeprecated :warning: Deprecated
- ~~destroyRoomDeprecated~~ - DestroyRoomDeprecated :warning: Deprecated
- ~~suspendRoomDeprecated~~ - SuspendRoomDeprecated :warning: Deprecated
- ~~getConnectionInfoDeprecated~~ - GetConnectionInfoDeprecated :warning: Deprecated
roomsV2
- createRoom - CreateRoom
- getRoomInfo - GetRoomInfo
- getActiveRoomsForProcess - GetActiveRoomsForProcess
- getInactiveRoomsForProcess - GetInactiveRoomsForProcess
- destroyRoom - DestroyRoom
- ~~suspendRoomV2Deprecated~~ - SuspendRoomV2Deprecated :warning: Deprecated
- getConnectionInfo - GetConnectionInfo
- updateRoomConfig - UpdateRoomConfig
tokensV1
- getOrgTokens - GetOrgTokens
- createOrgToken - CreateOrgToken
- revokeOrgToken - RevokeOrgToken
Error Handling
All SDK methods return a response object or throw an error. By default, an API error will throw a errors.SDKError
.
If a HTTP request fails, an operation my also throw an error from 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 |
In addition, when custom error responses are specified for an operation, the SDK may throw their associated Error type. You can refer to respective Errors tables in SDK docs for more details on possible error types for each operation. 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 | */* |
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) {
case (err instanceof 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 ApiError): {
// Handle err.data$: ApiErrorData
console.error(err);
return;
}
default: {
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 string since validation errors can list many issues and the plain error string may be difficult read when debugging.
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.
appsV2CreateApp
- CreateAppappsV2DeleteApp
- DeleteAppappsV2GetApp
- GetAppappsV2GetApps
- GetAppsappsV2UpdateApp
- UpdateAppauthV1LoginAnonymous
- LoginAnonymousauthV1LoginGoogle
- LoginGoogleauthV1LoginNickname
- LoginNicknamebillingV1GetBalance
- GetBalancebillingV1GetInvoices
- GetInvoicesbillingV1GetPaymentMethod
- GetPaymentMethodbillingV1GetUpcomingInvoiceItems
- GetUpcomingInvoiceItemsbillingV1GetUpcomingInvoiceTotal
- GetUpcomingInvoiceTotalbillingV1InitStripeCustomerPortalUrl
- InitStripeCustomerPortalUrlbuildsV3CreateBuild
- CreateBuildbuildsV3DeleteBuild
- DeleteBuildbuildsV3GetBuild
- GetBuildbuildsV3GetBuilds
- GetBuildsbuildsV3RunBuild
- RunBuilddeploymentsV3CreateDeployment
- CreateDeploymentdeploymentsV3GetDeployment
- GetDeploymentdeploymentsV3GetDeployments
- GetDeploymentsdeploymentsV3GetLatestDeployment
- GetLatestDeploymentdiscoveryV2GetPingServiceEndpoints
- GetPingServiceEndpointsfleetsV1GetFleetMetrics
- GetFleetMetricsfleetsV1GetFleetRegion
- GetFleetRegionfleetsV1GetFleets
- GetFleetsfleetsV1UpdateFleetRegion
- UpdateFleetRegionlobbiesV3CreateLobby
- CreateLobbylobbiesV3GetLobbyInfoByRoomId
- GetLobbyInfoByRoomIdlobbiesV3GetLobbyInfoByShortCode
- GetLobbyInfoByShortCodelobbiesV3ListActivePublicLobbies
- ListActivePublicLobbieslogsV1DownloadLogForProcess
- DownloadLogForProcesslogsV1GetLogsForProcess
- GetLogsForProcessmanagementV1SendVerificationEmail
- SendVerificationEmailorganizationsV1AcceptInvite
- AcceptInviteorganizationsV1GetOrgMembers
- GetOrgMembersorganizationsV1GetOrgPendingInvites
- GetOrgPendingInvitesorganizationsV1GetOrgs
- GetOrgsorganizationsV1GetUsageLimits
- GetUsageLimitsorganizationsV1GetUserPendingInvites
- GetUserPendingInvitesorganizationsV1InviteUser
- InviteUserorganizationsV1RejectInvite
- RejectInviteorganizationsV1RescindInvite
- RescindInviteorganizationsV1UpdateUserInvite
- UpdateUserInviteprocessesV3CreateProcess
- CreateProcessprocessesV3GetLatestProcesses
- GetLatestProcessesprocessesV3GetProcess
- GetProcessprocessesV3GetProcessesCountExperimental
- GetProcessesCountExperimentalprocessesV3GetProcessMetrics
- GetProcessMetricsprocessesV3StopProcess
- StopProcessroomsV2CreateRoom
- CreateRoomroomsV2DestroyRoom
- DestroyRoomroomsV2GetActiveRoomsForProcess
- GetActiveRoomsForProcessroomsV2GetConnectionInfo
- GetConnectionInforoomsV2GetInactiveRoomsForProcess
- GetInactiveRoomsForProcessroomsV2GetRoomInfo
- GetRoomInforoomsV2UpdateRoomConfig
- UpdateRoomConfigtokensV1CreateOrgToken
- CreateOrgTokentokensV1GetOrgTokens
- GetOrgTokenstokensV1RevokeOrgToken
- RevokeOrgToken- ~~
appsV1CreateAppV1Deprecated
~~ - CreateAppV1Deprecated :warning: Deprecated - ~~
appsV1DeleteAppV1Deprecated
~~ - DeleteAppV1Deprecated :warning: Deprecated - ~~
appsV1GetAppInfoV1Deprecated
~~ - GetAppInfoV1Deprecated :warning: Deprecated - ~~
appsV1GetAppsV1Deprecated
~~ - GetAppsV1Deprecated :warning: Deprecated - ~~
appsV1UpdateAppV1Deprecated
~~ - UpdateAppV1Deprecated :warning: Deprecated - ~~
buildsV1CreateBuildDeprecated
~~ - CreateBuildDeprecated :warning: Deprecated - ~~
buildsV1DeleteBuildDeprecated
~~ - DeleteBuildDeprecated :warning: Deprecated - ~~
buildsV1GetBuildInfoDeprecated
~~ - GetBuildInfoDeprecated :warning: Deprecated - ~~
buildsV1GetBuildsDeprecated
~~ - GetBuildsDeprecated :warning: Deprecated - ~~
buildsV1RunBuildDeprecated
~~ - RunBuildDeprecated :warning: Deprecated - ~~
buildsV2CreateBuildV2Deprecated
~~ - CreateBuildV2Deprecated :warning: Deprecated - ~~
buildsV2CreateBuildWithUploadUrlV2Deprecated
~~ - CreateBuildWithUploadUrlV2Deprecated :warning: Deprecated - ~~
buildsV2CreateWithMultipartUploadsV2Deprecated
~~ - CreateWithMultipartUploadsV2Deprecated :warning: Deprecated - ~~
buildsV2DeleteBuildV2Deprecated
~~ - DeleteBuildV2Deprecated :warning: Deprecated - ~~
buildsV2GetBuildInfoV2Deprecated
~~ - GetBuildInfoV2Deprecated :warning: Deprecated - ~~
buildsV2GetBuildsV2Deprecated
~~ - GetBuildsV2Deprecated :warning: Deprecated - ~~
buildsV2RunBuildV2Deprecated
~~ - RunBuildV2Deprecated :warning: Deprecated - ~~
deploymentsV1CreateDeploymentV1Deprecated
~~ - CreateDeploymentV1Deprecated :warning: Deprecated - ~~
deploymentsV1GetDeploymentInfoV1Deprecated
~~ - GetDeploymentInfoV1Deprecated :warning: Deprecated - ~~
deploymentsV1GetDeploymentsV1Deprecated
~~ - GetDeploymentsV1Deprecated :warning: Deprecated - ~~
deploymentsV1GetLatestDeploymentV1Deprecated
~~ - GetLatestDeploymentV1Deprecated :warning: Deprecated - ~~
deploymentsV2CreateDeploymentV2Deprecated
~~ - CreateDeploymentV2Deprecated :warning: Deprecated - ~~
deploymentsV2GetDeploymentInfoV2Deprecated
~~ - GetDeploymentInfoV2Deprecated :warning: Deprecated - ~~
deploymentsV2GetDeploymentsV2Deprecated
~~ - GetDeploymentsV2Deprecated :warning: Deprecated - ~~
deploymentsV2GetLatestDeploymentV2Deprecated
~~ - GetLatestDeploymentV2Deprecated :warning: Deprecated - ~~
discoveryV1GetPingServiceEndpointsDeprecated
~~ - GetPingServiceEndpointsDeprecated :warning: Deprecated - ~~
lobbiesV1CreatePrivateLobbyDeprecated
~~ - CreatePrivateLobbyDeprecated :warning: Deprecated - ~~
lobbiesV1CreatePublicLobbyDeprecated
~~ - CreatePublicLobbyDeprecated :warning: Deprecated - ~~
lobbiesV1ListActivePublicLobbiesDeprecatedV1
~~ - ListActivePublicLobbiesDeprecatedV1 :warning: Deprecated - ~~
lobbiesV2CreateLobbyDeprecated
~~ - CreateLobbyDeprecated :warning: Deprecated - ~~
lobbiesV2CreateLocalLobby
~~ - CreateLocalLobby :warning: Deprecated - ~~
lobbiesV2CreatePrivateLobby
~~ - CreatePrivateLobby :warning: Deprecated - ~~
lobbiesV2CreatePublicLobby
~~ - CreatePublicLobby :warning: Deprecated - ~~
lobbiesV2GetLobbyInfo
~~ - GetLobbyInfo :warning: Deprecated - ~~
lobbiesV2ListActivePublicLobbiesDeprecatedV2
~~ - ListActivePublicLobbiesDeprecatedV2 :warning: Deprecated - ~~
lobbiesV2SetLobbyState
~~ - SetLobbyState :warning: Deprecated - ~~
metricsV1GetMetricsDeprecated
~~ - GetMetricsDeprecated :warning: Deprecated - ~~
processesV1GetProcessInfoDeprecated
~~ - GetProcessInfoDeprecated :warning: Deprecated - ~~
processesV1GetRunningProcesses
~~ - GetRunningProcesses :warning: Deprecated - ~~
processesV1GetStoppedProcesses
~~ - GetStoppedProcesses :warning: Deprecated - ~~
processesV2CreateProcessV2Deprecated
~~ - CreateProcessV2Deprecated :warning: Deprecated - ~~
processesV2GetLatestProcessesV2Deprecated
~~ - GetLatestProcessesV2Deprecated :warning: Deprecated - ~~
processesV2GetProcessesCountExperimentalV2Deprecated
~~ - GetProcessesCountExperimentalV2Deprecated :warning: Deprecated - ~~
processesV2GetProcessInfoV2Deprecated
~~ - GetProcessInfoV2Deprecated :warning: Deprecated - ~~
processesV2StopProcessV2Deprecated
~~ - StopProcessV2Deprecated :warning: Deprecated - ~~
roomsV1CreateRoomDeprecated
~~ - CreateRoomDeprecated :warning: Deprecated - ~~
roomsV1DestroyRoomDeprecated
~~ - DestroyRoomDeprecated :warning: Deprecated - ~~
roomsV1GetActiveRoomsForProcessDeprecated
~~ - GetActiveRoomsForProcessDeprecated :warning: Deprecated - ~~
roomsV1GetConnectionInfoDeprecated
~~ - GetConnectionInfoDeprecated :warning: Deprecated - ~~
roomsV1GetInactiveRoomsForProcessDeprecated
~~ - GetInactiveRoomsForProcessDeprecated :warning: Deprecated - ~~
roomsV1GetRoomInfoDeprecated
~~ - GetRoomInfoDeprecated :warning: Deprecated - ~~
roomsV1SuspendRoomDeprecated
~~ - SuspendRoomDeprecated :warning: Deprecated - ~~
roomsV2SuspendRoomV2Deprecated
~~ - SuspendRoomV2Deprecated :warning: Deprecated
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 !