@rivetkit/engine-api-full 25.5.3

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@rivetkit/engine-api-full",
+  "version": "25.5.3",
+  "repository": "https://github.com/rivet-gg/rivet/tree/main/sdks/typescript",
+  "files": [
+    "dist",
+    "types",
+    "core.d.ts",
+    "serialization.d.ts"
+  ],
+  "exports": {
+    ".": {
+      "node": "./dist/node/index.js",
+      "import": "./dist/browser/esm/index.js",
+      "require": "./dist/browser/cjs/index.js",
+      "default": "./dist/browser/cjs/index.js",
+      "types": "./types/index.d.ts"
+    },
+    "./core": {
+      "node": "./dist/node/core.js",
+      "import": "./dist/browser/esm/core.js",
+      "require": "./dist/browser/cjs/core.js",
+      "default": "./dist/browser/cjs/core.js",
+      "types": "./types/core/index.d.ts"
+    },
+    "./serialization": {
+      "node": "./dist/node/serialization.js",
+      "import": "./dist/browser/esm/serialization.js",
+      "require": "./dist/browser/cjs/serialization.js",
+      "default": "./dist/browser/cjs/serialization.js",
+      "types": "./types/serialization/index.d.ts"
+    }
+  },
+  "types": "./types/index.d.ts",
+  "scripts": {
+    "compile": "tsc",
+    "bundle": "node build.js",
+    "build": "pnpm compile && pnpm bundle",
+    "prepack": "pnpm run build"
+  },
+  "dependencies": {
+    "form-data": "^4.0.0",
+    "js-base64": "^3.7.5",
+    "node-fetch": "2",
+    "qs": "^6.11.2",
+    "readable-stream": "^4.5.2",
+    "url-join": "^5.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "17.0.33",
+    "@types/node-fetch": "2.6.11",
+    "@types/qs": "6.9.8",
+    "@types/readable-stream": "^4.0.18",
+    "@types/url-join": "4.0.1",
+    "esbuild": "^0.19.11",
+    "prettier": "2.7.1",
+    "typescript": "5.8.2"
+  }
+}

package/types/Client.d.ts

@@ -0,0 +1,241 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as core from "./core";
+import * as Rivet from "./api/index";
+import { Datacenters } from "./api/resources/datacenters/client/Client";
+import { Namespaces } from "./api/resources/namespaces/client/Client";
+import { Runners } from "./api/resources/runners/client/Client";
+export declare namespace RivetClient {
+    interface Options {
+        environment: core.Supplier<string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        fetcher?: core.FetchFunction;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
+    }
+}
+export declare class RivetClient {
+    protected readonly _options: RivetClient.Options;
+    protected _datacenters: Datacenters | undefined;
+    protected _namespaces: Namespaces | undefined;
+    protected _runners: Runners | undefined;
+    constructor(_options: RivetClient.Options);
+    get datacenters(): Datacenters;
+    get namespaces(): Namespaces;
+    get runners(): Runners;
+    /**
+     * **If key is some & `include_destroyed` is false**
+     *
+     * 2 round trips:
+     *
+     * - namespace::ops::resolve_for_name_global
+     * - GET /actors/{} (multiple DCs based on actor IDs)
+     *
+     *   This path is optimized because we can read the actor IDs fro the key directly from Epoxy with
+     *   stale consistency to determine which datacenter the actor lives in. Under most circumstances,
+     *   this means we don't need to fan out to all datacenters (like normal list does).
+     *
+     *   The reason `include_destroyed` has to be false is Epoxy only stores currently active actors. If
+     *   `include_destroyed` is true, we show all previous iterations of actors with the same key.
+     *
+     * **Otherwise**
+     *
+     * 2 round trips:
+     *
+     * - namespace::ops::resolve_for_name_global
+     * - GET /actors (fanout)
+     *
+     * ## Optimized Alternative Routes
+     *
+     * For minimal round trips to check if an actor exists for a key, use `GET /actors/by-id`. This
+     * does not require fetching the actor's state, so it returns immediately.
+     *
+     * @param {Rivet.ActorsListRequest} request
+     * @param {RivetClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.actorsList({
+     *         namespace: "namespace"
+     *     })
+     */
+    actorsList(request: Rivet.ActorsListRequest, requestOptions?: RivetClient.RequestOptions): Promise<Rivet.ActorsListResponse>;
+    /**
+     * **If actor is created in the current datacenter:**
+     *
+     * 2 round trips:
+     *
+     * - namespace::ops::resolve_for_name_global
+     * - [pegboard::workflows::actor] Create actor workflow (includes Epoxy key allocation)
+     *
+     * **If actor is created in a different datacenter:**
+     *
+     * 3 round trips:
+     *
+     * - namespace::ops::resolve_for_name_global
+     * - POST /actors to remote datacenter
+     * - [pegboard::workflows::actor] Create actor workflow (includes Epoxy key allocation)
+     *
+     * actor::get will always be in the same datacenter.
+     *
+     * @param {Rivet.ActorsCreateRequest} request
+     * @param {RivetClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.actorsCreate({
+     *         namespace: "namespace",
+     *         crashPolicy: "restart",
+     *         name: "name",
+     *         runnerNameSelector: "runner_name_selector"
+     *     })
+     */
+    actorsCreate(request: Rivet.ActorsCreateRequest, requestOptions?: RivetClient.RequestOptions): Promise<Rivet.ActorsCreateResponse>;
+    /**
+     * **If actor exists**
+     *
+     * 2 round trips:
+     *
+     * - namespace::ops::resolve_for_name_global
+     * - GET /actors/{}
+     *
+     * **If actor does not exist and is created in the current datacenter:**
+     *
+     * 2 round trips:
+     *
+     * - namespace::ops::resolve_for_name_global
+     * - [pegboard::workflows::actor] Create actor workflow (includes Epoxy key allocation)
+     *
+     * **If actor does not exist and is created in a different datacenter:**
+     *
+     * 3 round trips:
+     *
+     * - namespace::ops::resolve_for_name_global
+     * - POST /actors to remote datacenter
+     * - [pegboard::workflows::actor] Create actor workflow (includes Epoxy key allocation)
+     *
+     * actor::get will always be in the same datacenter.
+     *
+     * ## Optimized Alternative Routes
+     *
+     * For minimal round trips to get or create an actor, use `PUT /actors/by-id`. This doesn't
+     * require fetching the actor's state from the other datacenter.
+     *
+     * @param {Rivet.ActorsGetOrCreateRequest} request
+     * @param {RivetClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.actorsGetOrCreate({
+     *         namespace: "namespace",
+     *         crashPolicy: "restart",
+     *         key: "key",
+     *         name: "name",
+     *         runnerNameSelector: "runner_name_selector"
+     *     })
+     */
+    actorsGetOrCreate(request: Rivet.ActorsGetOrCreateRequest, requestOptions?: RivetClient.RequestOptions): Promise<Rivet.ActorsGetOrCreateResponse>;
+    /**
+     * 1 round trip:
+     *
+     * - namespace::ops::resolve_for_name_global
+     *
+     * This does not require another round trip since we use stale consistency for the get_id_for_key.
+     *
+     * @param {Rivet.ActorsGetByIdRequest} request
+     * @param {RivetClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.actorsGetById({
+     *         namespace: "namespace",
+     *         name: "name",
+     *         key: "key"
+     *     })
+     */
+    actorsGetById(request: Rivet.ActorsGetByIdRequest, requestOptions?: RivetClient.RequestOptions): Promise<Rivet.ActorsGetByIdResponse>;
+    /**
+     * **If actor exists**
+     *
+     * 1 round trip:
+     *
+     * - namespace::ops::resolve_for_name_global
+     *
+     * **If actor does not exist and is created in the current datacenter:**
+     *
+     * 2 round trips:
+     *
+     * - namespace::ops::resolve_for_name_global
+     * - [pegboard::workflows::actors::keys::allocate_key] Reserve Epoxy key
+     *
+     * **If actor does not exist and is created in a different datacenter:**
+     *
+     * 3 round trips:
+     *
+     * - namespace::ops::resolve_for_name_global
+     * - namespace::ops::get (to get namespace name for remote call)
+     * - POST /actors to remote datacenter
+     *
+     * @param {Rivet.ActorsGetOrCreateByIdRequest} request
+     * @param {RivetClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.actorsGetOrCreateById({
+     *         namespace: "namespace",
+     *         crashPolicy: "restart",
+     *         key: "key",
+     *         name: "name",
+     *         runnerNameSelector: "runner_name_selector"
+     *     })
+     */
+    actorsGetOrCreateById(request: Rivet.ActorsGetOrCreateByIdRequest, requestOptions?: RivetClient.RequestOptions): Promise<Rivet.ActorsGetOrCreateByIdResponse>;
+    /**
+     * 2 round trips:
+     *
+     * - GET /actors/names (fanout)
+     * - [api-peer] namespace::ops::resolve_for_name_global
+     *
+     * @param {Rivet.ActorsListNamesRequest} request
+     * @param {RivetClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.actorsListNames({
+     *         namespace: "namespace"
+     *     })
+     */
+    actorsListNames(request: Rivet.ActorsListNamesRequest, requestOptions?: RivetClient.RequestOptions): Promise<Rivet.ActorsListNamesResponse>;
+    /**
+     * 2 round trip:
+     *
+     * - GET /actors/{}
+     * - [api-peer] namespace::ops::resolve_for_name_global
+     *
+     * @param {Rivet.RivetId} actorId
+     * @param {Rivet.ActorsGetRequest} request
+     * @param {RivetClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.actorsGet("actor_id")
+     */
+    actorsGet(actorId: Rivet.RivetId, request?: Rivet.ActorsGetRequest, requestOptions?: RivetClient.RequestOptions): Promise<Rivet.ActorsGetResponse>;
+    /**
+     * 2 round trip:
+     *
+     * - DELETE /actors/{}
+     * - [api-peer] namespace::ops::resolve_for_name_global
+     *
+     * @param {Rivet.RivetId} actorId
+     * @param {Rivet.ActorsDeleteRequest} request
+     * @param {RivetClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.actorsDelete("actor_id")
+     */
+    actorsDelete(actorId: Rivet.RivetId, request?: Rivet.ActorsDeleteRequest, requestOptions?: RivetClient.RequestOptions): Promise<Rivet.ActorsDeleteResponse>;
+}

package/types/api/client/index.d.ts

@@ -0,0 +1 @@
+export * from "./requests";

package/types/api/client/requests/ActorsCreateRequest.d.ts

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Rivet from "../../index";
+/**
+ * @example
+ *     {
+ *         namespace: "namespace",
+ *         crashPolicy: "restart",
+ *         name: "name",
+ *         runnerNameSelector: "runner_name_selector"
+ *     }
+ */
+export interface ActorsCreateRequest {
+    namespace: string;
+    datacenter?: string;
+    crashPolicy: Rivet.CrashPolicy;
+    input?: string;
+    key?: string;
+    name: string;
+    runnerNameSelector: string;
+}

package/types/api/client/requests/ActorsDeleteRequest.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {}
+ */
+export interface ActorsDeleteRequest {
+    namespace?: string;
+}

package/types/api/client/requests/ActorsGetByIdRequest.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         namespace: "namespace",
+ *         name: "name",
+ *         key: "key"
+ *     }
+ */
+export interface ActorsGetByIdRequest {
+    namespace: string;
+    name: string;
+    key: string;
+}

package/types/api/client/requests/ActorsGetOrCreateByIdRequest.d.ts

@@ -0,0 +1,23 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Rivet from "../../index";
+/**
+ * @example
+ *     {
+ *         namespace: "namespace",
+ *         crashPolicy: "restart",
+ *         key: "key",
+ *         name: "name",
+ *         runnerNameSelector: "runner_name_selector"
+ *     }
+ */
+export interface ActorsGetOrCreateByIdRequest {
+    namespace: string;
+    datacenter?: string;
+    crashPolicy: Rivet.CrashPolicy;
+    input?: string;
+    key: string;
+    name: string;
+    runnerNameSelector: string;
+}

package/types/api/client/requests/ActorsGetOrCreateRequest.d.ts

@@ -0,0 +1,23 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Rivet from "../../index";
+/**
+ * @example
+ *     {
+ *         namespace: "namespace",
+ *         crashPolicy: "restart",
+ *         key: "key",
+ *         name: "name",
+ *         runnerNameSelector: "runner_name_selector"
+ *     }
+ */
+export interface ActorsGetOrCreateRequest {
+    namespace: string;
+    datacenter?: string;
+    crashPolicy: Rivet.CrashPolicy;
+    input?: string;
+    key: string;
+    name: string;
+    runnerNameSelector: string;
+}

package/types/api/client/requests/ActorsGetRequest.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {}
+ */
+export interface ActorsGetRequest {
+    namespace?: string;
+}

package/types/api/client/requests/ActorsListNamesRequest.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         namespace: "namespace"
+ *     }
+ */
+export interface ActorsListNamesRequest {
+    namespace: string;
+    limit?: number;
+    cursor?: string;
+}

package/types/api/client/requests/ActorsListRequest.d.ts

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         namespace: "namespace"
+ *     }
+ */
+export interface ActorsListRequest {
+    namespace: string;
+    name?: string;
+    key?: string;
+    actorIds?: string;
+    includeDestroyed?: boolean;
+    limit?: number;
+    cursor?: string;
+}

package/types/api/client/requests/index.d.ts

@@ -0,0 +1,8 @@
+export { type ActorsListRequest } from "./ActorsListRequest";
+export { type ActorsCreateRequest } from "./ActorsCreateRequest";
+export { type ActorsGetOrCreateRequest } from "./ActorsGetOrCreateRequest";
+export { type ActorsGetByIdRequest } from "./ActorsGetByIdRequest";
+export { type ActorsGetOrCreateByIdRequest } from "./ActorsGetOrCreateByIdRequest";
+export { type ActorsListNamesRequest } from "./ActorsListNamesRequest";
+export { type ActorsGetRequest } from "./ActorsGetRequest";
+export { type ActorsDeleteRequest } from "./ActorsDeleteRequest";

package/types/api/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./types";
+export * from "./resources";
+export * from "./client";

package/types/api/resources/datacenters/client/Client.d.ts

@@ -0,0 +1,34 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as core from "../../../../core";
+import * as Rivet from "../../../index";
+export declare namespace Datacenters {
+    interface Options {
+        environment: core.Supplier<string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        fetcher?: core.FetchFunction;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
+    }
+}
+export declare class Datacenters {
+    protected readonly _options: Datacenters.Options;
+    constructor(_options: Datacenters.Options);
+    /**
+     * @param {Datacenters.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.datacenters.list()
+     */
+    list(requestOptions?: Datacenters.RequestOptions): Promise<Rivet.DatacentersListResponse>;
+}

package/types/api/resources/datacenters/client/index.d.ts

@@ -0,0 +1 @@
+export {};

package/types/api/resources/datacenters/index.d.ts

@@ -0,0 +1 @@
+export * from "./client";

package/types/api/resources/index.d.ts

@@ -0,0 +1,5 @@
+export * as datacenters from "./datacenters";
+export * as namespaces from "./namespaces";
+export * as runners from "./runners";
+export * from "./namespaces/client/requests";
+export * from "./runners/client/requests";

package/types/api/resources/namespaces/client/Client.d.ts

@@ -0,0 +1,54 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as core from "../../../../core";
+import * as Rivet from "../../../index";
+export declare namespace Namespaces {
+    interface Options {
+        environment: core.Supplier<string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        fetcher?: core.FetchFunction;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
+    }
+}
+export declare class Namespaces {
+    protected readonly _options: Namespaces.Options;
+    constructor(_options: Namespaces.Options);
+    /**
+     * @param {Rivet.NamespacesListRequest} request
+     * @param {Namespaces.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.namespaces.list()
+     */
+    list(request?: Rivet.NamespacesListRequest, requestOptions?: Namespaces.RequestOptions): Promise<Rivet.NamespacesListResponse>;
+    /**
+     * @param {Rivet.NamespacesCreateRequest} request
+     * @param {Namespaces.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.namespaces.create({
+     *         displayName: "display_name",
+     *         name: "name"
+     *     })
+     */
+    create(request: Rivet.NamespacesCreateRequest, requestOptions?: Namespaces.RequestOptions): Promise<Rivet.NamespacesCreateResponse>;
+    /**
+     * @param {Rivet.RivetId} namespaceId
+     * @param {Namespaces.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.namespaces.get("namespace_id")
+     */
+    get(namespaceId: Rivet.RivetId, requestOptions?: Namespaces.RequestOptions): Promise<Rivet.NamespacesGetResponse>;
+}

package/types/api/resources/namespaces/client/index.d.ts

@@ -0,0 +1 @@
+export * from "./requests";

package/types/api/resources/namespaces/client/requests/NamespacesCreateRequest.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         displayName: "display_name",
+ *         name: "name"
+ *     }
+ */
+export interface NamespacesCreateRequest {
+    displayName: string;
+    name: string;
+}

package/types/api/resources/namespaces/client/requests/NamespacesListRequest.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {}
+ */
+export interface NamespacesListRequest {
+    limit?: number;
+    cursor?: string;
+    name?: string;
+}

package/types/api/resources/namespaces/client/requests/index.d.ts

@@ -0,0 +1,2 @@
+export { type NamespacesListRequest } from "./NamespacesListRequest";
+export { type NamespacesCreateRequest } from "./NamespacesCreateRequest";

package/types/api/resources/namespaces/index.d.ts

@@ -0,0 +1 @@
+export * from "./client";

package/types/api/resources/runners/client/Client.d.ts

@@ -0,0 +1,61 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as core from "../../../../core";
+import * as Rivet from "../../../index";
+export declare namespace Runners {
+    interface Options {
+        environment: core.Supplier<string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        fetcher?: core.FetchFunction;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
+    }
+}
+export declare class Runners {
+    protected readonly _options: Runners.Options;
+    constructor(_options: Runners.Options);
+    /**
+     * @param {Rivet.RunnersListRequest} request
+     * @param {Runners.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.runners.list({
+     *         namespace: "namespace"
+     *     })
+     */
+    list(request: Rivet.RunnersListRequest, requestOptions?: Runners.RequestOptions): Promise<Rivet.RunnersListResponse>;
+    /**
+     * 2 round trips:
+     *
+     * - GET /runners/names (fanout)
+     * - [api-peer] namespace::ops::resolve_for_name_global
+     *
+     * @param {Rivet.RunnersListNamesRequest} request
+     * @param {Runners.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.runners.listNames({
+     *         namespace: "namespace"
+     *     })
+     */
+    listNames(request: Rivet.RunnersListNamesRequest, requestOptions?: Runners.RequestOptions): Promise<Rivet.RunnersListNamesResponse>;
+    /**
+     * @param {Rivet.RivetId} runnerId
+     * @param {Rivet.RunnersGetRequest} request
+     * @param {Runners.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.runners.get("runner_id")
+     */
+    get(runnerId: Rivet.RivetId, request?: Rivet.RunnersGetRequest, requestOptions?: Runners.RequestOptions): Promise<Rivet.RunnersGetResponse>;
+}

package/types/api/resources/runners/client/index.d.ts

@@ -0,0 +1 @@
+export * from "./requests";