rivetkit 2.0.22-rc.1 → 2.0.22

package/dist/tsup/{conn-Clu655RU.d.ts → conn-BYXlxnh0.d.ts}

@@ -3,7 +3,6 @@ import { WSContext } from 'hono/ws';
 import { GetUpgradeWebSocket, promiseWithResolvers } from './utils.js';
 import z$1, { z } from 'zod';
 import { Logger } from 'pino';
-import * as hono from 'hono';
 import { Env, Context, Hono } from 'hono';
 import * as nanoevents from 'nanoevents';
 import z__default from 'zod/v4';
@@ -69,9 +68,19 @@ interface RivetEvent {
     type: string;
     target?: any;
     currentTarget?: any;
+    /**
+     * @experimental
+     * Request ID for hibernatable websockets (provided by engine runner)
+     **/
+    rivetRequestId?: ArrayBuffer;
 }
 interface RivetMessageEvent extends RivetEvent {
     data: any;
+    /**
+     * @experimental
+     * Message index for hibernatable websockets (provided by engine runner)
+     **/
+    rivetMessageIndex?: number;
 }
 interface RivetCloseEvent extends RivetEvent {
     code: number;
@@ -169,21 +178,6 @@ declare const RunnerConfigSchema: z.ZodDefault<z.ZodObject<{
         name: string;
         manager: ManagerDriverBuilder;
     }>>;
-    cors: z.ZodOptional<z.ZodType<{
-        origin: string | string[] | ((origin: string, c: hono.Context) => Promise<string | undefined | null> | string | undefined | null);
-        allowMethods?: string[] | ((origin: string, c: hono.Context) => Promise<string[]> | string[]);
-        allowHeaders?: string[];
-        maxAge?: number;
-        credentials?: boolean;
-        exposeHeaders?: string[];
-    }, z.ZodTypeDef, {
-        origin: string | string[] | ((origin: string, c: hono.Context) => Promise<string | undefined | null> | string | undefined | null);
-        allowMethods?: string[] | ((origin: string, c: hono.Context) => Promise<string[]> | 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.ZodUnion<[z.ZodBoolean, z.ZodObject<{
@@ -196,21 +190,6 @@ declare const RunnerConfigSchema: z.ZodDefault<z.ZodObject<{
             actor?: boolean | undefined;
             manager?: boolean | undefined;
         }>]>>>;
-        cors: z.ZodDefault<z.ZodOptional<z.ZodType<{
-            origin: string | string[] | ((origin: string, c: hono.Context) => Promise<string | undefined | null> | string | undefined | null);
-            allowMethods?: string[] | ((origin: string, c: hono.Context) => Promise<string[]> | string[]);
-            allowHeaders?: string[];
-            maxAge?: number;
-            credentials?: boolean;
-            exposeHeaders?: string[];
-        }, z.ZodTypeDef, {
-            origin: string | string[] | ((origin: string, c: hono.Context) => Promise<string | undefined | null> | string | undefined | null);
-            allowMethods?: string[] | ((origin: string, c: hono.Context) => Promise<string[]> | 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, {
@@ -219,14 +198,6 @@ declare const RunnerConfigSchema: z.ZodDefault<z.ZodObject<{
             manager: boolean;
         };
         token: (...args: unknown[]) => string;
-        cors: {
-            origin: string | string[] | ((origin: string, c: hono.Context) => Promise<string | undefined | null> | string | undefined | null);
-            allowMethods?: string[] | ((origin: string, c: hono.Context) => Promise<string[]> | string[]);
-            allowHeaders?: string[];
-            maxAge?: number;
-            credentials?: boolean;
-            exposeHeaders?: string[];
-        };
         defaultEndpoint?: string | undefined;
     }, {
         enabled?: boolean | {
@@ -234,14 +205,6 @@ declare const RunnerConfigSchema: z.ZodDefault<z.ZodObject<{
             manager?: boolean | undefined;
         } | undefined;
         token?: ((...args: unknown[]) => string) | undefined;
-        cors?: {
-            origin: string | string[] | ((origin: string, c: hono.Context) => Promise<string | undefined | null> | string | undefined | null);
-            allowMethods?: string[] | ((origin: string, c: hono.Context) => Promise<string[]> | string[]);
-            allowHeaders?: string[];
-            maxAge?: number;
-            credentials?: boolean;
-            exposeHeaders?: string[];
-        } | undefined;
         defaultEndpoint?: string | undefined;
     }>>>;
     disableDefaultServer: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
@@ -292,7 +255,7 @@ declare const RunnerConfigSchema: z.ZodDefault<z.ZodObject<{
         slotsPerRunner?: number | undefined;
     }>]>>;
 } & {
-    runnerKey: z.ZodDefault<z.ZodString>;
+    runnerKey: z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, string | undefined>;
     totalSlots: z.ZodDefault<z.ZodNumber>;
     endpoint: z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, string | undefined>;
     token: z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, string | undefined>;
@@ -316,17 +279,8 @@ declare const RunnerConfigSchema: z.ZodDefault<z.ZodObject<{
             manager: boolean;
         };
         token: (...args: unknown[]) => string;
-        cors: {
-            origin: string | string[] | ((origin: string, c: hono.Context) => Promise<string | undefined | null> | string | undefined | null);
-            allowMethods?: string[] | ((origin: string, c: hono.Context) => Promise<string[]> | string[]);
-            allowHeaders?: string[];
-            maxAge?: number;
-            credentials?: boolean;
-            exposeHeaders?: string[];
-        };
         defaultEndpoint?: string | undefined;
     };
-    runnerKey: string;
     totalSlots: number;
     maxIncomingMessageSize: number;
     disableDefaultServer: boolean;
@@ -349,14 +303,7 @@ declare const RunnerConfigSchema: z.ZodDefault<z.ZodObject<{
     endpoint?: string | undefined;
     token?: string | undefined;
     getUpgradeWebSocket?: GetUpgradeWebSocket | undefined;
-    cors?: {
-        origin: string | string[] | ((origin: string, c: hono.Context) => Promise<string | undefined | null> | string | undefined | null);
-        allowMethods?: string[] | ((origin: string, c: hono.Context) => Promise<string[]> | string[]);
-        allowHeaders?: string[];
-        maxAge?: number;
-        credentials?: boolean;
-        exposeHeaders?: string[];
-    } | undefined;
+    runnerKey?: string | undefined;
     overrideServerAddress?: string | undefined;
     autoConfigureServerless?: boolean | {
         metadata?: Record<string, unknown> | undefined;
@@ -389,24 +336,8 @@ declare const RunnerConfigSchema: z.ZodDefault<z.ZodObject<{
             manager?: boolean | undefined;
         } | undefined;
         token?: ((...args: unknown[]) => string) | undefined;
-        cors?: {
-            origin: string | string[] | ((origin: string, c: hono.Context) => Promise<string | undefined | null> | string | undefined | null);
-            allowMethods?: string[] | ((origin: string, c: hono.Context) => Promise<string[]> | string[]);
-            allowHeaders?: string[];
-            maxAge?: number;
-            credentials?: boolean;
-            exposeHeaders?: string[];
-        } | undefined;
         defaultEndpoint?: string | undefined;
     } | undefined;
-    cors?: {
-        origin: string | string[] | ((origin: string, c: hono.Context) => Promise<string | undefined | null> | string | undefined | null);
-        allowMethods?: string[] | ((origin: string, c: hono.Context) => Promise<string[]> | string[]);
-        allowHeaders?: string[];
-        maxAge?: number;
-        credentials?: boolean;
-        exposeHeaders?: string[];
-    } | undefined;
     runnerKey?: string | undefined;
     totalSlots?: number | undefined;
     maxIncomingMessageSize?: number | undefined;
@@ -505,10 +436,20 @@ interface ActorDriver {
      * This is an experimental API that may change in the future.
      */
     getDatabase(actorId: string): Promise<unknown | undefined>;
-    sleep?(actorId: string): Promise<void>;
-    shutdown?(immediate: boolean): Promise<void>;
+    /**
+     * Requests the actor to go to sleep.
+     *
+     * This will call `_stop` independently.
+     */
+    startSleep?(actorId: string): void;
+    /**
+     * Shuts down the actor runner.
+     */
+    shutdownRunner?(immediate: boolean): Promise<void>;
     /** This handles the serverless start request. This should manage the lifecycle of the runner tied to the request lifecycle. */
     serverlessHandleStart?(c: Context): Promise<Response>;
+    /** Extra properties to add to logs for each actor. */
+    getExtraActorLogParams?(): Record<string, string>;
 }
 
 type ServerlessActorDriverBuilder = (updateConfig: (config: RunnerConfig) => void) => ActorDriver;
@@ -1397,6 +1338,8 @@ declare const ActorConfigSchema: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodObj
         connectionLivenessInterval: z.ZodDefault<z.ZodNumber>;
         noSleep: z.ZodDefault<z.ZodBoolean>;
         sleepTimeout: z.ZodDefault<z.ZodNumber>;
+        /** @experimental */
+        canHibernatWebSocket: z.ZodDefault<z.ZodUnion<[z.ZodBoolean, z.ZodFunction<z.ZodTuple<[z.ZodType<Request, z.ZodTypeDef, Request>], z.ZodUnknown>, z.ZodBoolean>]>>;
     }, "strict", z.ZodTypeAny, {
         createVarsTimeout: number;
         createConnStateTimeout: number;
@@ -1409,6 +1352,7 @@ declare const ActorConfigSchema: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodObj
         connectionLivenessInterval: number;
         noSleep: boolean;
         sleepTimeout: number;
+        canHibernatWebSocket: boolean | ((args_0: Request, ...args: unknown[]) => boolean);
     }, {
         createVarsTimeout?: number | undefined;
         createConnStateTimeout?: number | undefined;
@@ -1421,6 +1365,7 @@ declare const ActorConfigSchema: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodObj
         connectionLivenessInterval?: number | undefined;
         noSleep?: boolean | undefined;
         sleepTimeout?: number | undefined;
+        canHibernatWebSocket?: boolean | ((args_0: Request, ...args: unknown[]) => boolean) | undefined;
     }>>;
 }, "strict", z.ZodTypeAny, {
     options: {
@@ -1435,6 +1380,7 @@ declare const ActorConfigSchema: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodObj
         connectionLivenessInterval: number;
         noSleep: boolean;
         sleepTimeout: number;
+        canHibernatWebSocket: boolean | ((args_0: Request, ...args: unknown[]) => boolean);
     };
     actions: Record<string, (...args: unknown[]) => unknown>;
     state?: any;
@@ -1468,6 +1414,7 @@ declare const ActorConfigSchema: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodObj
         connectionLivenessInterval?: number | undefined;
         noSleep?: boolean | undefined;
         sleepTimeout?: number | undefined;
+        canHibernatWebSocket?: boolean | ((args_0: Request, ...args: unknown[]) => boolean) | undefined;
     } | undefined;
     onCreate?: ((...args: unknown[]) => unknown) | undefined;
     onStart?: ((...args: unknown[]) => unknown) | undefined;
@@ -1499,6 +1446,7 @@ declare const ActorConfigSchema: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodObj
         connectionLivenessInterval: number;
         noSleep: boolean;
         sleepTimeout: number;
+        canHibernatWebSocket: boolean | ((args_0: Request, ...args: unknown[]) => boolean);
     };
     actions: Record<string, (...args: unknown[]) => unknown>;
     state?: any;
@@ -1532,6 +1480,7 @@ declare const ActorConfigSchema: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodObj
         connectionLivenessInterval?: number | undefined;
         noSleep?: boolean | undefined;
         sleepTimeout?: number | undefined;
+        canHibernatWebSocket?: boolean | ((args_0: Request, ...args: unknown[]) => boolean) | undefined;
     } | undefined;
     onCreate?: ((...args: unknown[]) => unknown) | undefined;
     onStart?: ((...args: unknown[]) => unknown) | undefined;
@@ -1563,6 +1512,7 @@ declare const ActorConfigSchema: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodObj
         connectionLivenessInterval: number;
         noSleep: boolean;
         sleepTimeout: number;
+        canHibernatWebSocket: boolean | ((args_0: Request, ...args: unknown[]) => boolean);
     };
     actions: Record<string, (...args: unknown[]) => unknown>;
     state?: any;
@@ -1596,6 +1546,7 @@ declare const ActorConfigSchema: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodObj
         connectionLivenessInterval?: number | undefined;
         noSleep?: boolean | undefined;
         sleepTimeout?: number | undefined;
+        canHibernatWebSocket?: boolean | ((args_0: Request, ...args: unknown[]) => boolean) | undefined;
     } | undefined;
     onCreate?: ((...args: unknown[]) => unknown) | undefined;
     onStart?: ((...args: unknown[]) => unknown) | undefined;
@@ -1627,6 +1578,7 @@ declare const ActorConfigSchema: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodObj
         connectionLivenessInterval: number;
         noSleep: boolean;
         sleepTimeout: number;
+        canHibernatWebSocket: boolean | ((args_0: Request, ...args: unknown[]) => boolean);
     };
     actions: Record<string, (...args: unknown[]) => unknown>;
     state?: any;
@@ -1660,6 +1612,7 @@ declare const ActorConfigSchema: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodObj
         connectionLivenessInterval?: number | undefined;
         noSleep?: boolean | undefined;
         sleepTimeout?: number | undefined;
+        canHibernatWebSocket?: boolean | ((args_0: Request, ...args: unknown[]) => boolean) | undefined;
     } | undefined;
     onCreate?: ((...args: unknown[]) => unknown) | undefined;
     onStart?: ((...args: unknown[]) => unknown) | undefined;
@@ -2105,10 +2058,51 @@ declare class ActorInspector {
 }
 
 interface ConnSocket {
-    socketId: string;
+    requestId: string;
     driverState: ConnDriverState;
 }
 
+/** State object that gets automatically persisted to storage. */
+interface PersistedActor<S, CP, CS, I> {
+    input?: I;
+    hasInitiated: boolean;
+    state: S;
+    connections: PersistedConn<CP, CS>[];
+    scheduledEvents: PersistedScheduleEvent[];
+    hibernatableWebSocket: PersistedHibernatableWebSocket[];
+}
+/** Object representing connection that gets persisted to storage. */
+interface PersistedConn<CP, CS> {
+    connId: string;
+    token: string;
+    params: CP;
+    state: CS;
+    subscriptions: PersistedSubscription[];
+    /** Last time the socket was seen. This is set when disconencted so we can determine when we need to clean this up. */
+    lastSeen: number;
+}
+interface PersistedSubscription {
+    eventName: string;
+}
+interface GenericPersistedScheduleEvent {
+    actionName: string;
+    args: ArrayBuffer | null;
+}
+type PersistedScheduleEventKind = {
+    generic: GenericPersistedScheduleEvent;
+};
+interface PersistedScheduleEvent {
+    eventId: string;
+    timestamp: number;
+    kind: PersistedScheduleEventKind;
+}
+interface PersistedHibernatableWebSocket {
+    requestId: ArrayBuffer;
+    lastSeenTimestamp: bigint;
+    msgIndex: bigint;
+}
+
+declare const PERSIST_SYMBOL: unique symbol;
 /**
  * Options for the `_saveState` method.
  */
@@ -2126,6 +2120,7 @@ declare class ActorInstance<S, CP, CS, V, I, DB extends AnyDatabaseProvider> {
     #private;
     actorContext: ActorContext<S, CP, CS, V, I, DB>;
     get isStopping(): boolean;
+    get [PERSIST_SYMBOL](): PersistedActor<S, CP, CS, I>;
     get id(): string;
     get inlineClient(): Client<Registry<any>>;
     get inspector(): ActorInspector;
@@ -2156,7 +2151,7 @@ declare class ActorInstance<S, CP, CS, V, I, DB extends AnyDatabaseProvider> {
      *
      * If not a clean disconnect, will keep the connection alive for a given interval to wait for reconnect.
      */
-    __connDisconnected(conn: Conn<S, CP, CS, V, I, DB>, wasClean: boolean, socketId: string): void;
+    __connDisconnected(conn: Conn<S, CP, CS, V, I, DB>, wasClean: boolean, requestId: string): void;
     /**
      * Called to create a new connection or reconnect an existing one.
      */
@@ -2245,9 +2240,31 @@ declare class ActorInstance<S, CP, CS, V, I, DB extends AnyDatabaseProvider> {
      * @param opts - Options for saving the state.
      */
     saveState(opts: SaveStateOptions): Promise<void>;
-    /** Puts an actor to sleep. This should just start the sleep sequence, most shutdown logic should be in _stop (which is called by the ActorDriver when sleeping). */
-    _sleep(): Promise<void>;
-    _stop(): Promise<void>;
+    /**
+     * Called by router middleware when an HTTP request begins.
+     */
+    __beginHonoHttpRequest(): void;
+    /**
+     * Called by router middleware when an HTTP request ends.
+     */
+    __endHonoHttpRequest(): void;
+    /**
+     * Puts an actor to sleep. This should just start the sleep sequence, most shutdown logic should be in _stop (which is called by the ActorDriver when sleeping).
+     *
+     * For the engine, this will:
+     * 1. Publish EventActorIntent with ActorIntentSleep (via driver.startSleep)
+     * 2. Engine runner will wait for CommandStopActor
+     * 3. Engine runner will call _onStop and wait for it to finish
+     * 4. Engine runner will publish EventActorStateUpdate with ActorStateSTop
+     **/
+    _startSleep(): void;
+    /**
+     * For the engine:
+     * 1. Engine runner receives CommandStopActor
+     * 2. Engine runner calls _onStop and waits for it to finish
+     * 3. Engine runner publishes EventActorStateUpdate with ActorStateSTop
+     */
+    _onStop(): Promise<void>;
     /** Abort signal that fires when the actor is stopping. */
     get abortSignal(): AbortSignal;
 }
@@ -2275,20 +2292,6 @@ type ConnDriverState = {
     [ConnDriverKind.HTTP]: ConnDriverHttpState;
 };
 
-/** Object representing connection that gets persisted to storage. */
-interface PersistedConn<CP, CS> {
-    connId: string;
-    token: string;
-    params: CP;
-    state: CS;
-    subscriptions: PersistedSubscription[];
-    /** Last time the socket was seen. This is set when disconencted so we can determine when we need to clean this up. */
-    lastSeen: number;
-}
-interface PersistedSubscription {
-    eventName: string;
-}
-
 declare function generateConnId(): string;
 declare function generateConnToken(): string;
 type ConnId = string;
@@ -2343,6 +2346,12 @@ declare class Conn<S, CP, CS, V, I, DB extends AnyDatabaseProvider> {
      * Status of the connection.
      */
     get status(): ConnectionStatus;
+    /**
+     * @experimental
+     *
+     * If the underlying connection can hibernate.
+     */
+    get isHibernatable(): boolean;
     /**
      * Timestamp of the last time the connection was seen, i.e. the last time the connection was active and checked for liveness.
      */