@rivetkit/cloudflare-workers 2.0.3 → 2.0.4-rc.1

package/dist/mod.d.ts

@@ -1,179 +1,88 @@
-import * as hono_types from 'hono/types';
-import * as hono from 'hono';
-import { Hono } from 'hono';
-import * as rivetkit_utils from 'rivetkit/utils';
-import * as rivetkit_driver_helpers from 'rivetkit/driver-helpers';
-import * as rivetkit from 'rivetkit';
-import { ActorKey, Registry } from 'rivetkit';
-import { z } from 'zod';
-import { Client } from 'rivetkit/client';
+import { Client, Registry, ActorKey } from 'rivetkit';
+export { Client } from 'rivetkit';
 import { DurableObject } from 'cloudflare:workers';
+import { GetUpgradeWebSocket } from 'rivetkit/utils';
+import { z } from 'zod/v4';
 
 interface DriverContext {
     state: DurableObjectState;
 }
 
-declare const ConfigSchema: z.ZodDefault<z.ZodObject<Omit<{
-    driver: z.ZodOptional<z.ZodObject<{
-        name: z.ZodString;
-        manager: z.ZodType<(registryConfig: rivetkit.RegistryConfig, runConfig: rivetkit.RunConfig) => rivetkit_driver_helpers.ManagerDriver, z.ZodTypeDef, (registryConfig: rivetkit.RegistryConfig, runConfig: rivetkit.RunConfig) => rivetkit_driver_helpers.ManagerDriver>;
-        actor: z.ZodType<(registryConfig: rivetkit.RegistryConfig, runConfig: rivetkit.RunConfig, managerDriver: rivetkit_driver_helpers.ManagerDriver, inlineClient: rivetkit.AnyClient) => rivetkit_driver_helpers.ActorDriver, z.ZodTypeDef, (registryConfig: rivetkit.RegistryConfig, runConfig: rivetkit.RunConfig, managerDriver: rivetkit_driver_helpers.ManagerDriver, inlineClient: rivetkit.AnyClient) => rivetkit_driver_helpers.ActorDriver>;
-    }, "strip", z.ZodTypeAny, {
-        actor: (registryConfig: rivetkit.RegistryConfig, runConfig: rivetkit.RunConfig, managerDriver: rivetkit_driver_helpers.ManagerDriver, inlineClient: rivetkit.AnyClient) => rivetkit_driver_helpers.ActorDriver;
-        name: string;
-        manager: (registryConfig: rivetkit.RegistryConfig, runConfig: rivetkit.RunConfig) => rivetkit_driver_helpers.ManagerDriver;
-    }, {
-        actor: (registryConfig: rivetkit.RegistryConfig, runConfig: rivetkit.RunConfig, managerDriver: rivetkit_driver_helpers.ManagerDriver, inlineClient: rivetkit.AnyClient) => rivetkit_driver_helpers.ActorDriver;
-        name: string;
-        manager: (registryConfig: rivetkit.RegistryConfig, runConfig: rivetkit.RunConfig) => rivetkit_driver_helpers.ManagerDriver;
-    }>>;
-    engine: z.ZodOptional<z.ZodString>;
-    getUpgradeWebSocket: z.ZodOptional<z.ZodType<() => rivetkit_utils.UpgradeWebSocket, z.ZodTypeDef, () => rivetkit_utils.UpgradeWebSocket>>;
-    role: z.ZodDefault<z.ZodOptional<z.ZodEnum<["all", "server", "runner"]>>>;
-    cors: z.ZodOptional<z.ZodType<{
-        origin: string | string[] | ((origin: string, c: hono.Context) => string | undefined | null);
-        allowMethods?: string[] | ((origin: string, c: hono.Context) => string[]);
-        allowHeaders?: string[];
-        maxAge?: number;
-        credentials?: boolean;
-        exposeHeaders?: string[];
-    }, z.ZodTypeDef, {
-        origin: string | string[] | ((origin: string, c: hono.Context) => string | undefined | null);
-        allowMethods?: string[] | ((origin: string, c: hono.Context) => string[]);
-        allowHeaders?: string[];
-        maxAge?: number;
-        credentials?: boolean;
-        exposeHeaders?: string[];
-    }>>;
-    maxIncomingMessageSize: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
-    inspector: z.ZodDefault<z.ZodOptional<z.ZodObject<{
-        enabled: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
-        cors: z.ZodDefault<z.ZodOptional<z.ZodType<{
-            origin: string | string[] | ((origin: string, c: hono.Context) => string | undefined | null);
-            allowMethods?: string[] | ((origin: string, c: hono.Context) => string[]);
-            allowHeaders?: string[];
-            maxAge?: number;
-            credentials?: boolean;
-            exposeHeaders?: string[];
-        }, z.ZodTypeDef, {
-            origin: string | string[] | ((origin: string, c: hono.Context) => string | undefined | null);
-            allowMethods?: string[] | ((origin: string, c: hono.Context) => string[]);
-            allowHeaders?: string[];
-            maxAge?: number;
-            credentials?: boolean;
-            exposeHeaders?: string[];
-        }>>>;
-        token: z.ZodDefault<z.ZodOptional<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodString>>>;
-        defaultEndpoint: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        enabled: boolean;
-        cors: {
-            origin: string | string[] | ((origin: string, c: hono.Context) => string | undefined | null);
-            allowMethods?: string[] | ((origin: string, c: hono.Context) => string[]);
-            allowHeaders?: string[];
-            maxAge?: number;
-            credentials?: boolean;
-            exposeHeaders?: string[];
-        };
-        token: (...args: unknown[]) => string;
-        defaultEndpoint?: string | undefined;
-    }, {
-        enabled?: boolean | undefined;
-        cors?: {
-            origin: string | string[] | ((origin: string, c: hono.Context) => string | undefined | null);
-            allowMethods?: string[] | ((origin: string, c: hono.Context) => string[]);
-            allowHeaders?: string[];
-            maxAge?: number;
-            credentials?: boolean;
-            exposeHeaders?: string[];
-        } | undefined;
-        token?: ((...args: unknown[]) => string) | undefined;
-        defaultEndpoint?: string | undefined;
-    }>>>;
-    basePath: z.ZodDefault<z.ZodOptional<z.ZodString>>;
-}, "driver" | "getUpgradeWebSocket"> & {
-    app: z.ZodOptional<z.ZodType<Hono<hono_types.BlankEnv, hono_types.BlankSchema, "/">, z.ZodTypeDef, Hono<hono_types.BlankEnv, hono_types.BlankSchema, "/">>>;
-}, "strip", z.ZodTypeAny, {
-    role: "all" | "server" | "runner";
-    maxIncomingMessageSize: number;
-    inspector: {
-        enabled: boolean;
-        cors: {
-            origin: string | string[] | ((origin: string, c: hono.Context) => string | undefined | null);
-            allowMethods?: string[] | ((origin: string, c: hono.Context) => string[]);
-            allowHeaders?: string[];
-            maxAge?: number;
-            credentials?: boolean;
-            exposeHeaders?: string[];
-        };
-        token: (...args: unknown[]) => string;
-        defaultEndpoint?: string | undefined;
-    };
-    basePath: string;
-    engine?: string | undefined;
-    cors?: {
-        origin: string | string[] | ((origin: string, c: hono.Context) => string | undefined | null);
-        allowMethods?: string[] | ((origin: string, c: hono.Context) => string[]);
-        allowHeaders?: string[];
-        maxAge?: number;
-        credentials?: boolean;
-        exposeHeaders?: string[];
-    } | undefined;
-    app?: Hono<hono_types.BlankEnv, hono_types.BlankSchema, "/"> | undefined;
-}, {
-    engine?: string | undefined;
-    role?: "all" | "server" | "runner" | undefined;
-    cors?: {
-        origin: string | string[] | ((origin: string, c: hono.Context) => string | undefined | null);
-        allowMethods?: string[] | ((origin: string, c: hono.Context) => string[]);
-        allowHeaders?: string[];
-        maxAge?: number;
-        credentials?: boolean;
-        exposeHeaders?: string[];
-    } | undefined;
-    maxIncomingMessageSize?: number | undefined;
-    inspector?: {
-        enabled?: boolean | undefined;
-        cors?: {
-            origin: string | string[] | ((origin: string, c: hono.Context) => string | undefined | null);
-            allowMethods?: string[] | ((origin: string, c: hono.Context) => string[]);
-            allowHeaders?: string[];
-            maxAge?: number;
-            credentials?: boolean;
-            exposeHeaders?: string[];
-        } | undefined;
-        token?: ((...args: unknown[]) => string) | undefined;
-        defaultEndpoint?: string | undefined;
-    } | undefined;
-    basePath?: string | undefined;
-    app?: Hono<hono_types.BlankEnv, hono_types.BlankSchema, "/"> | undefined;
-}>>;
+declare const ConfigSchema: z.ZodDefault<z.ZodObject<{
+    managerPath: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    runnerKey: z.ZodOptional<z.ZodString>;
+    noWelcome: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    fetch: z.ZodOptional<z.ZodCustom<ExportedHandlerFetchHandler<{
+        RIVET: Client<any>;
+    }, unknown>, ExportedHandlerFetchHandler<{
+        RIVET: Client<any>;
+    }, unknown>>>;
+}, z.core.$strip>>;
 type InputConfig = z.input<typeof ConfigSchema>;
-
-interface ActorHandlerInterface extends DurableObject {
-    initialize(req: ActorInitRequest): Promise<void>;
-}
-interface ActorInitRequest {
-    name: string;
-    key: ActorKey;
-    input?: unknown;
-}
-type DurableObjectConstructor = new (...args: ConstructorParameters<typeof DurableObject<Bindings>>) => DurableObject<Bindings>;
+type Config = z.infer<typeof ConfigSchema>;
 
 /** Cloudflare Workers env */
 interface Bindings {
     ACTOR_KV: KVNamespace;
     ACTOR_DO: DurableObjectNamespace<ActorHandlerInterface>;
 }
-interface Handler {
+interface InlineOutput<A extends Registry<any>> {
+    /** Client to communicate with the actors. */
+    client: Client<A>;
+    /** Fetch handler to manually route requests to the Rivet manager API. */
+    fetch: (request: Request, ...args: any) => Response | Promise<Response>;
+    config: Config;
+    ActorHandler: DurableObjectConstructor;
+}
+interface HandlerOutput {
     handler: ExportedHandler<Bindings>;
     ActorHandler: DurableObjectConstructor;
 }
-interface SetupOutput<A extends Registry<any>> {
-    client: Client<A>;
-    createHandler: (hono?: Hono) => Handler;
+/**
+ * Creates an inline client for accessing Rivet Actors privately without a public manager API.
+ *
+ * If you want to expose a public manager API, either:
+ *
+ * - Use `createHandler` to expose the Rivet API on `/api/rivet`
+ * - Forward Rivet API requests to `InlineOutput::fetch`
+ */
+declare function createInlineClient<R extends Registry<any>>(registry: R, inputConfig?: InputConfig): InlineOutput<R>;
+/**
+ * Creates a handler to be exported from a Cloudflare Worker.
+ *
+ * This will automatically expose the Rivet manager API on `/api/rivet`.
+ *
+ * This includes a `fetch` handler and `ActorHandler` Durable Object.
+ */
+declare function createHandler<R extends Registry<any>>(registry: R, inputConfig?: InputConfig): HandlerOutput;
+
+interface ActorHandlerInterface extends DurableObject {
+    create(req: ActorInitRequest): Promise<ActorInitResponse>;
+    getMetadata(): Promise<{
+        actorId: string;
+        name: string;
+        key: ActorKey;
+        destroying: boolean;
+    } | undefined>;
+    managerKvGet(key: Uint8Array): Promise<Uint8Array | null>;
 }
-declare function createServerHandler<R extends Registry<any>>(registry: R, inputConfig?: InputConfig): Handler;
-declare function createServer<R extends Registry<any>>(registry: R, inputConfig?: InputConfig): SetupOutput<R>;
+interface ActorInitRequest {
+    name: string;
+    key: ActorKey;
+    input?: unknown;
+    allowExisting: boolean;
+}
+type ActorInitResponse = {
+    success: {
+        actorId: string;
+        created: boolean;
+    };
+} | {
+    error: {
+        actorAlreadyExists: true;
+    };
+};
+type DurableObjectConstructor = new (...args: ConstructorParameters<typeof DurableObject<Bindings>>) => DurableObject<Bindings>;
+declare function createActorDurableObject(registry: Registry<any>, getUpgradeWebSocket: GetUpgradeWebSocket): DurableObjectConstructor;
 
-export { type Bindings, type InputConfig as Config, type DriverContext, createServer, createServerHandler };
+export { type Bindings, type InputConfig as Config, type DriverContext, type HandlerOutput, type InlineOutput, createActorDurableObject, createHandler, createInlineClient };