@rivetkit/engine-api-full 25.5.3

package/types/api/resources/runners/client/requests/RunnersGetRequest.d.ts

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

package/types/api/resources/runners/client/requests/RunnersListNamesRequest.d.ts

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

package/types/api/resources/runners/client/requests/RunnersListRequest.d.ts

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

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

@@ -0,0 +1,3 @@
+export { type RunnersListRequest } from "./RunnersListRequest";
+export { type RunnersListNamesRequest } from "./RunnersListNamesRequest";
+export { type RunnersGetRequest } from "./RunnersGetRequest";

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

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

package/types/api/types/Actor.d.ts

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Rivet from "../index";
+export interface Actor {
+    actorId: Rivet.RivetId;
+    connectableTs?: number;
+    crashPolicy: Rivet.CrashPolicy;
+    createTs: number;
+    datacenter: string;
+    destroyTs?: number;
+    key?: string;
+    name: string;
+    namespaceId: Rivet.RivetId;
+    pendingAllocationTs?: number;
+    runnerNameSelector: string;
+    sleepTs?: number;
+    startTs?: number;
+}

package/types/api/types/ActorName.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ActorName {
+    metadata: Record<string, unknown>;
+}

package/types/api/types/ActorsCreateResponse.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Rivet from "../index";
+export interface ActorsCreateResponse {
+    actor: Rivet.Actor;
+}

package/types/api/types/ActorsDeleteResponse.d.ts

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type ActorsDeleteResponse = Record<string, unknown>;

package/types/api/types/ActorsGetByIdResponse.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Rivet from "../index";
+export interface ActorsGetByIdResponse {
+    actorId?: Rivet.RivetId;
+}

package/types/api/types/ActorsGetOrCreateByIdResponse.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Rivet from "../index";
+export interface ActorsGetOrCreateByIdResponse {
+    actorId: Rivet.RivetId;
+    created: boolean;
+}

package/types/api/types/ActorsGetOrCreateResponse.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Rivet from "../index";
+export interface ActorsGetOrCreateResponse {
+    actor: Rivet.Actor;
+    created: boolean;
+}

package/types/api/types/ActorsGetResponse.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Rivet from "../index";
+export interface ActorsGetResponse {
+    actor: Rivet.Actor;
+}

package/types/api/types/ActorsListNamesResponse.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Rivet from "../index";
+export interface ActorsListNamesResponse {
+    names: Record<string, Rivet.ActorName>;
+    pagination: Rivet.Pagination;
+}

package/types/api/types/ActorsListResponse.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Rivet from "../index";
+export interface ActorsListResponse {
+    actors: Rivet.Actor[];
+    pagination: Rivet.Pagination;
+}

package/types/api/types/CrashPolicy.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type CrashPolicy = "restart" | "sleep" | "destroy";
+export declare const CrashPolicy: {
+    readonly Restart: "restart";
+    readonly Sleep: "sleep";
+    readonly Destroy: "destroy";
+};

package/types/api/types/Datacenter.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface Datacenter {
+    datacenterLabel: number;
+    name: string;
+    url: string;
+}

package/types/api/types/DatacentersListResponse.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Rivet from "../index";
+export interface DatacentersListResponse {
+    datacenters: Rivet.Datacenter[];
+    pagination: Rivet.Pagination;
+}

package/types/api/types/Namespace.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Rivet from "../index";
+export interface Namespace {
+    createTs: number;
+    displayName: string;
+    name: string;
+    namespaceId: Rivet.RivetId;
+}

package/types/api/types/NamespacesCreateResponse.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Rivet from "../index";
+export interface NamespacesCreateResponse {
+    namespace: Rivet.Namespace;
+}

package/types/api/types/NamespacesGetResponse.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Rivet from "../index";
+export interface NamespacesGetResponse {
+    namespace: Rivet.Namespace;
+}

package/types/api/types/NamespacesListResponse.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Rivet from "../index";
+export interface NamespacesListResponse {
+    namespaces: Rivet.Namespace[];
+    pagination: Rivet.Pagination;
+}

package/types/api/types/Pagination.d.ts

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

package/types/api/types/RivetId.d.ts

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type RivetId = string;

package/types/api/types/Runner.d.ts

@@ -0,0 +1,24 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Rivet from "../index";
+export interface Runner {
+    addressesHttp: Rivet.StringHttpAddressHashableMap;
+    addressesTcp: Rivet.StringTcpAddressHashableMap;
+    addressesUdp: Rivet.StringUdpAddressHashableMap;
+    createTs: number;
+    datacenter: string;
+    drainTs?: number;
+    key: string;
+    lastConnectedTs?: number;
+    lastPingTs: number;
+    lastRtt: number;
+    metadata?: Record<string, unknown>;
+    name: string;
+    namespaceId: Rivet.RivetId;
+    remainingSlots: number;
+    runnerId: Rivet.RivetId;
+    stopTs?: number;
+    totalSlots: number;
+    version: number;
+}

package/types/api/types/RunnersGetResponse.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Rivet from "../index";
+export interface RunnersGetResponse {
+    runner: Rivet.Runner;
+}

package/types/api/types/RunnersListNamesResponse.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Rivet from "../index";
+export interface RunnersListNamesResponse {
+    names: string[];
+    pagination: Rivet.Pagination;
+}

package/types/api/types/RunnersListResponse.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Rivet from "../index";
+export interface RunnersListResponse {
+    pagination: Rivet.Pagination;
+    runners: Rivet.Runner[];
+}

package/types/api/types/StringHttpAddressHashableMap.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Rivet from "../index";
+export type StringHttpAddressHashableMap = Record<string, Rivet.StringHttpAddressHashableMapValue>;

package/types/api/types/StringHttpAddressHashableMapValue.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface StringHttpAddressHashableMapValue {
+    hostname: string;
+    port: number;
+}

package/types/api/types/StringTcpAddressHashableMap.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Rivet from "../index";
+export type StringTcpAddressHashableMap = Record<string, Rivet.StringTcpAddressHashableMapValue>;

package/types/api/types/StringTcpAddressHashableMapValue.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface StringTcpAddressHashableMapValue {
+    hostname: string;
+    port: number;
+}

package/types/api/types/StringUdpAddressHashableMap.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Rivet from "../index";
+export type StringUdpAddressHashableMap = Record<string, Rivet.StringUdpAddressHashableMapValue>;

package/types/api/types/StringUdpAddressHashableMapValue.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface StringUdpAddressHashableMapValue {
+    hostname: string;
+    port: number;
+}

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

@@ -0,0 +1,29 @@
+export * from "./Actor";
+export * from "./ActorName";
+export * from "./ActorsCreateResponse";
+export * from "./ActorsDeleteResponse";
+export * from "./ActorsGetByIdResponse";
+export * from "./ActorsGetOrCreateByIdResponse";
+export * from "./ActorsGetOrCreateResponse";
+export * from "./ActorsGetResponse";
+export * from "./ActorsListNamesResponse";
+export * from "./ActorsListResponse";
+export * from "./CrashPolicy";
+export * from "./Datacenter";
+export * from "./DatacentersListResponse";
+export * from "./Namespace";
+export * from "./NamespacesCreateResponse";
+export * from "./NamespacesGetResponse";
+export * from "./NamespacesListResponse";
+export * from "./Pagination";
+export * from "./RivetId";
+export * from "./Runner";
+export * from "./RunnersGetResponse";
+export * from "./RunnersListNamesResponse";
+export * from "./RunnersListResponse";
+export * from "./StringHttpAddressHashableMapValue";
+export * from "./StringHttpAddressHashableMap";
+export * from "./StringTcpAddressHashableMapValue";
+export * from "./StringTcpAddressHashableMap";
+export * from "./StringUdpAddressHashableMapValue";
+export * from "./StringUdpAddressHashableMap";

package/types/core/fetcher/APIResponse.d.ts

@@ -0,0 +1,10 @@
+export type APIResponse<Success, Failure> = SuccessfulResponse<Success> | FailedResponse<Failure>;
+export interface SuccessfulResponse<T> {
+    ok: true;
+    body: T;
+    headers?: Record<string, any>;
+}
+export interface FailedResponse<T> {
+    ok: false;
+    error: T;
+}

package/types/core/fetcher/Fetcher.d.ts

@@ -0,0 +1,39 @@
+import { APIResponse } from "./APIResponse";
+export type FetchFunction = <R = unknown>(args: Fetcher.Args) => Promise<APIResponse<R, Fetcher.Error>>;
+export declare namespace Fetcher {
+    interface Args {
+        url: string;
+        method: string;
+        contentType?: string;
+        headers?: Record<string, string | undefined>;
+        queryParameters?: Record<string, string | string[] | object | object[] | null>;
+        body?: unknown;
+        timeoutMs?: number;
+        maxRetries?: number;
+        withCredentials?: boolean;
+        abortSignal?: AbortSignal;
+        requestType?: "json" | "file" | "bytes";
+        responseType?: "json" | "blob" | "sse" | "streaming" | "text" | "arrayBuffer";
+        duplex?: "half";
+    }
+    type Error = FailedStatusCodeError | NonJsonError | TimeoutError | UnknownError;
+    interface FailedStatusCodeError {
+        reason: "status-code";
+        statusCode: number;
+        body: unknown;
+    }
+    interface NonJsonError {
+        reason: "non-json";
+        statusCode: number;
+        rawBody: string;
+    }
+    interface TimeoutError {
+        reason: "timeout";
+    }
+    interface UnknownError {
+        reason: "unknown";
+        errorMessage: string;
+    }
+}
+export declare function fetcherImpl<R = unknown>(args: Fetcher.Args): Promise<APIResponse<R, Fetcher.Error>>;
+export declare const fetcher: FetchFunction;

package/types/core/fetcher/Supplier.d.ts

@@ -0,0 +1,4 @@
+export type Supplier<T> = T | Promise<T> | (() => T | Promise<T>);
+export declare const Supplier: {
+    get: <T>(supplier: Supplier<T>) => Promise<T>;
+};

package/types/core/fetcher/createRequestUrl.d.ts

@@ -0,0 +1 @@
+export declare function createRequestUrl(baseUrl: string, queryParameters?: Record<string, string | string[] | object | object[] | null>): string;

package/types/core/fetcher/getFetchFn.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Returns a fetch function based on the runtime
+ */
+export declare function getFetchFn(): Promise<any>;

package/types/core/fetcher/getHeader.d.ts

@@ -0,0 +1 @@
+export declare function getHeader(headers: Record<string, any>, header: string): string | undefined;

package/types/core/fetcher/getRequestBody.d.ts

@@ -0,0 +1,7 @@
+export declare namespace GetRequestBody {
+    interface Args {
+        body: unknown;
+        type: "json" | "file" | "bytes" | "other";
+    }
+}
+export declare function getRequestBody({ body, type }: GetRequestBody.Args): Promise<BodyInit | undefined>;

package/types/core/fetcher/getResponseBody.d.ts

@@ -0,0 +1 @@
+export declare function getResponseBody(response: Response, responseType?: string): Promise<unknown>;

package/types/core/fetcher/index.d.ts

@@ -0,0 +1,5 @@
+export type { APIResponse } from "./APIResponse";
+export { fetcher } from "./Fetcher";
+export type { Fetcher, FetchFunction } from "./Fetcher";
+export { getHeader } from "./getHeader";
+export { Supplier } from "./Supplier";

package/types/core/fetcher/makeRequest.d.ts

@@ -0,0 +1 @@
+export declare const makeRequest: (fetchFn: (url: string, init: RequestInit) => Promise<Response>, url: string, method: string, headers: Record<string, string>, requestBody: BodyInit | undefined, timeoutMs?: number, abortSignal?: AbortSignal, withCredentials?: boolean, duplex?: "half") => Promise<Response>;

package/types/core/fetcher/requestWithRetries.d.ts

@@ -0,0 +1 @@
+export declare function requestWithRetries(requestFn: () => Promise<Response>, maxRetries?: number): Promise<Response>;

package/types/core/fetcher/signals.d.ts

@@ -0,0 +1,11 @@
+export declare function getTimeoutSignal(timeoutMs: number): {
+    signal: AbortSignal;
+    abortId: NodeJS.Timeout;
+};
+/**
+ * Returns an abort signal that is getting aborted when
+ * at least one of the specified abort signals is aborted.
+ *
+ * Requires at least node.js 18.
+ */
+export declare function anySignal(...args: AbortSignal[] | [AbortSignal[]]): AbortSignal;

package/types/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.d.ts

@@ -0,0 +1,30 @@
+import type { Writable } from "readable-stream";
+import { EventCallback, StreamWrapper } from "./chooseStreamWrapper";
+export declare class Node18UniversalStreamWrapper<ReadFormat extends Uint8Array | Uint16Array | Uint32Array> implements StreamWrapper<Node18UniversalStreamWrapper<ReadFormat> | Writable | WritableStream<ReadFormat>, ReadFormat> {
+    private readableStream;
+    private reader;
+    private events;
+    private paused;
+    private resumeCallback;
+    private encoding;
+    constructor(readableStream: ReadableStream<ReadFormat>);
+    on(event: string, callback: EventCallback): void;
+    off(event: string, callback: EventCallback): void;
+    pipe(dest: Node18UniversalStreamWrapper<ReadFormat> | Writable | WritableStream<ReadFormat>): Node18UniversalStreamWrapper<ReadFormat> | Writable | WritableStream<ReadFormat>;
+    pipeTo(dest: Node18UniversalStreamWrapper<ReadFormat> | Writable | WritableStream<ReadFormat>): Node18UniversalStreamWrapper<ReadFormat> | Writable | WritableStream<ReadFormat>;
+    unpipe(dest: Node18UniversalStreamWrapper<ReadFormat> | Writable | WritableStream<ReadFormat>): void;
+    destroy(error?: Error): void;
+    pause(): void;
+    resume(): void;
+    get isPaused(): boolean;
+    read(): Promise<ReadFormat | undefined>;
+    setEncoding(encoding: string): void;
+    text(): Promise<string>;
+    json<T>(): Promise<T>;
+    private _write;
+    private _end;
+    private _error;
+    private _emit;
+    private _startReading;
+    [Symbol.asyncIterator](): AsyncIterableIterator<ReadFormat>;
+}

package/types/core/fetcher/stream-wrappers/NodePre18StreamWrapper.d.ts

@@ -0,0 +1,21 @@
+import type { Readable, Writable } from "readable-stream";
+import { EventCallback, StreamWrapper } from "./chooseStreamWrapper";
+export declare class NodePre18StreamWrapper implements StreamWrapper<Writable, Buffer> {
+    private readableStream;
+    private encoding;
+    constructor(readableStream: Readable);
+    on(event: string, callback: EventCallback): void;
+    off(event: string, callback: EventCallback): void;
+    pipe(dest: Writable): Writable;
+    pipeTo(dest: Writable): Writable;
+    unpipe(dest?: Writable): void;
+    destroy(error?: Error): void;
+    pause(): void;
+    resume(): void;
+    get isPaused(): boolean;
+    read(): Promise<Buffer | undefined>;
+    setEncoding(encoding?: string): void;
+    text(): Promise<string>;
+    json<T>(): Promise<T>;
+    [Symbol.asyncIterator](): AsyncIterableIterator<Buffer>;
+}

package/types/core/fetcher/stream-wrappers/UndiciStreamWrapper.d.ts

@@ -0,0 +1,31 @@
+import { StreamWrapper } from "./chooseStreamWrapper";
+type EventCallback = (data?: any) => void;
+export declare class UndiciStreamWrapper<ReadFormat extends Uint8Array | Uint16Array | Uint32Array> implements StreamWrapper<UndiciStreamWrapper<ReadFormat> | WritableStream<ReadFormat>, ReadFormat> {
+    private readableStream;
+    private reader;
+    private events;
+    private paused;
+    private resumeCallback;
+    private encoding;
+    constructor(readableStream: ReadableStream<ReadFormat>);
+    on(event: string, callback: EventCallback): void;
+    off(event: string, callback: EventCallback): void;
+    pipe(dest: UndiciStreamWrapper<ReadFormat> | WritableStream<ReadFormat>): UndiciStreamWrapper<ReadFormat> | WritableStream<ReadFormat>;
+    pipeTo(dest: UndiciStreamWrapper<ReadFormat> | WritableStream<ReadFormat>): UndiciStreamWrapper<ReadFormat> | WritableStream<ReadFormat>;
+    unpipe(dest: UndiciStreamWrapper<ReadFormat> | WritableStream): void;
+    destroy(error?: Error): void;
+    pause(): void;
+    resume(): void;
+    get isPaused(): boolean;
+    read(): Promise<ReadFormat | undefined>;
+    setEncoding(encoding: string): void;
+    text(): Promise<string>;
+    json<T>(): Promise<T>;
+    private _write;
+    private _end;
+    private _error;
+    private _emit;
+    private _startReading;
+    [Symbol.asyncIterator](): AsyncIterableIterator<ReadFormat>;
+}
+export {};

package/types/core/fetcher/stream-wrappers/chooseStreamWrapper.d.ts

@@ -0,0 +1,18 @@
+export type EventCallback = (data?: any) => void;
+export interface StreamWrapper<WritableStream, ReadFormat> {
+    setEncoding(encoding?: string): void;
+    on(event: string, callback: EventCallback): void;
+    off(event: string, callback: EventCallback): void;
+    pipe(dest: WritableStream): WritableStream;
+    pipeTo(dest: WritableStream): WritableStream;
+    unpipe(dest?: WritableStream): void;
+    destroy(error?: Error): void;
+    pause(): void;
+    resume(): void;
+    get isPaused(): boolean;
+    read(): Promise<ReadFormat | undefined>;
+    text(): Promise<string>;
+    json<T>(): Promise<T>;
+    [Symbol.asyncIterator](): AsyncIterableIterator<ReadFormat>;
+}
+export declare function chooseStreamWrapper(responseBody: any): Promise<Promise<StreamWrapper<any, any>>>;

package/types/core/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./fetcher";
+export * from "./runtime";
+export * as serialization from "./schemas";

package/types/core/json.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Serialize a value to JSON
+ * @param value A JavaScript value, usually an object or array, to be converted.
+ * @param replacer A function that transforms the results.
+ * @param space Adds indentation, white space, and line break characters to the return-value JSON text to make it easier to read.
+ * @returns JSON string
+ */
+export declare const toJson: (value: unknown, replacer?: (this: unknown, key: string, value: unknown) => unknown, space?: string | number) => string;
+/**
+ * Parse JSON string to object, array, or other type
+ * @param text A valid JSON string.
+ * @param reviver A function that transforms the results. This function is called for each member of the object. If a member contains nested objects, the nested objects are transformed before the parent object is.
+ * @returns Parsed object, array, or other type
+ */
+export declare function fromJson<T = unknown>(text: string, reviver?: (this: unknown, key: string, value: unknown) => unknown): T;

package/types/core/runtime/index.d.ts

@@ -0,0 +1 @@
+export { RUNTIME } from "./runtime";

package/types/core/runtime/runtime.d.ts

@@ -0,0 +1,9 @@
+/**
+ * A constant that indicates which environment and version the SDK is running in.
+ */
+export declare const RUNTIME: Runtime;
+export interface Runtime {
+    type: "browser" | "web-worker" | "deno" | "bun" | "node" | "react-native" | "unknown" | "workerd" | "edge-runtime";
+    version?: string;
+    parsedVersion?: number;
+}