@speakeasy-sdks/hathora-sdk-typescript
Advanced tools
It has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:
npm add https://github.com/hathora/cloud-sdk-typescript
yarn add https://github.com/hathora/cloud-sdk-typescript
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();
appId. Your organization will lose access to this application.appId.appId.appId.idToken.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.buildId generated from CreateBuild().wss://<host>:<port>/ws and send a packet. To calculate ping, measure the time it takes to get an echo packet back.region. Use this endpoint to display all public lobbies that a player can join in the game client. :warning: DeprecatedshortCode, then the most recently created lobby will be returned.region. Use this endpoint to display all public lobbies that a player can join in the game client.appId. :warning: DeprecatedappId and deploymentId. :warning: DeprecatedappId and processId.appId and processId.region.region.GetConnectionInfo() endpoint to get connection details for an active room.roomId.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.
The following global parameter is available.
| Name | Type | Required | Description |
|---|---|---|---|
| appId | string | The appId parameter. |
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();
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();
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 |
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();
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();
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 });
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();
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();
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.
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!
FAQs
<a href="https://github.com/
The npm package @speakeasy-sdks/hathora-sdk-typescript receives a total of 0 weekly downloads. As such, @speakeasy-sdks/hathora-sdk-typescript popularity was classified as not popular.
We found that @speakeasy-sdks/hathora-sdk-typescript demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 6 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
/Research
Malicious Nx npm versions stole secrets and wallet info using AI CLI tools; Socket’s AI scanner detected the supply chain attack and flagged the malware.
Security News
CISA’s 2025 draft SBOM guidance adds new fields like hashes, licenses, and tool metadata to make software inventories more actionable.
Security News
A clarification on our recent research investigating 60 malicious Ruby gems.