rivetkit 2.3.11-rc.9 → 2.3.11

package/dist/browser/client.d.ts

@@ -13,7 +13,7 @@ interface ActorMetricsLike {
     totalKvWrites: number;
     trackSql(query: string, durationMs: number): void;
 }
-type InferDatabaseClient<DBProvider extends AnyDatabaseProvider> = DBProvider extends DatabaseProvider<any> ? Awaited<ReturnType<DBProvider["createClient"]>> : never;
+type InferDatabaseClient<DBProvider extends AnyDatabaseProvider> = DBProvider extends DatabaseProvider<any> ? Awaited<ReturnType<DBProvider["createClient"]>> : RawAccess;
 type SqliteBindings = unknown[] | Record<string, unknown>;
 interface SqliteQueryResult {
     columns: string[];
@@ -27,6 +27,41 @@ interface SqliteBatchStatement {
     sql: string;
     params?: SqliteBindings;
 }
+interface SqliteTransactionOptions {
+    /** Static operation name used to aggregate transaction performance. */
+    name?: string;
+    /** Deadlock-safety timeout in milliseconds. */
+    timeout?: number;
+    /** @experimental */
+    experimental?: {
+        /**
+         * Atomically includes actor and hibernatable connection state.
+         * Only single-statement `execute` calls are supported in the transaction.
+         * Concurrent actions that try to mutate state while the transaction is
+         * active fail with `actor.state_transaction_conflict`.
+         */
+        includeState?: boolean;
+    };
+}
+/**
+ * SQLite profiling configuration.
+ *
+ * @experimental This entire configuration surface is experimental and subject
+ * to change without notice.
+ */
+interface SqliteProfilingOptions {
+    enabled?: boolean;
+    maxTrackedStatementFingerprints?: number;
+    maxTrackedTransactionFingerprints?: number;
+    maxPrometheusSeries?: number;
+    maxStatementsPerTransactionTrace?: number;
+    maxGetPagesRequestsPerTrace?: number;
+    maxTransactionNameBytes?: number;
+    slowOperationThresholdMs?: number;
+    baselineSampleRate?: number;
+    maxDiagnosticEventsPerMinute?: number;
+    diagnosticEventQueueCapacity?: number;
+}
 interface SqliteNativeMetrics {
     requestBuildNs: number;
     serializeNs: number;
@@ -44,7 +79,7 @@ interface SqliteDatabase {
     exec(sql: string, callback?: (row: unknown[], columns: string[]) => void): Promise<void>;
     execute(sql: string, params?: SqliteBindings): Promise<SqliteExecuteResult>;
     executeBatch(statements: SqliteBatchStatement[]): Promise<SqliteExecuteResult[]>;
-    beginTransaction(timeoutMs?: number): Promise<SqliteTransactionDatabase>;
+    beginTransaction(timeoutMs?: number, name?: string): Promise<SqliteTransactionDatabase>;
     run(sql: string, params?: SqliteBindings): Promise<void>;
     query(sql: string, params?: SqliteBindings): Promise<SqliteQueryResult>;
     nativeMetrics?(): SqliteNativeMetrics | Promise<SqliteNativeMetrics | null> | null;
@@ -99,6 +134,13 @@ interface DatabaseProviderContext {
     nativeDatabaseProvider?: NativeDatabaseProvider;
 }
 type DatabaseProvider<DB extends RawAccess> = {
+    /**
+     * Local SQLite profiling controls consumed by the actor runtime.
+     *
+     * @experimental This entire configuration surface is experimental and
+     * subject to change without notice.
+     */
+    sqliteProfiling?: SqliteProfilingOptions;
     /**
      * Creates a new database client for the actor.
      * The result is passed to the actor context as `c.db`.
@@ -123,9 +165,7 @@ type RawAccess = {
      */
     execute: ExecuteFunction;
     /** Runs a callback in an isolated SQLite transaction. */
-    transaction: <T>(callback: (tx: RawAccess) => Promise<T> | T, options?: {
-        timeout?: number;
-    }) => Promise<T>;
+    transaction: <T>(callback: (tx: RawAccess) => Promise<T> | T, options?: SqliteTransactionOptions) => Promise<T>;
     /**
      * Returns native SQLite metrics when the active runtime supports them.
      */
@@ -406,7 +446,9 @@ type LooseEventSubscribe = (eventName: string, callback: (...args: any[]) => voi
 type ActorActionMap<R> = {
     [K in keyof NonNullable<R>]: NonNullable<R>[K] extends (...args: infer Args) => infer Return ? ActorActionFunction<Args, Awaited<Return>> : NonNullable<R>[K] extends Record<string, unknown> ? ActorActionMap<NonNullable<R>[K]> : never;
 };
-type ActionsOf<AD extends AnyActorDefinition> = AD extends BaseActorDefinition<any, any, any, any, any, any, any, any, infer R> ? R : never;
+type ActionsOf<AD extends AnyActorDefinition> = AD["config"] extends {
+    actions?: infer R;
+} ? R : never;
 interface ActorGatewayOptions {
     skipReadyWait?: boolean;
 }
@@ -977,6 +1019,9 @@ type Client<A extends Registry<any>> = ClientRaw & {
     [K in keyof ExtractActorsFromRegistry<A>]: ActorAccessor<ExtractActorsFromRegistry<A>[K]>;
 };
 
+/** @experimental State exposed by a durable workflow run handler to the Inspector. */
+type WorkflowState = "pending" | "running" | "sleeping" | "failed" | "completed" | "cancelled" | "rolling_back";
+
 declare const ACTOR_CONTEXT_INTERNAL_SYMBOL: unique symbol;
 declare const RAW_STATE_SYMBOL: unique symbol;
 interface ActorLogger {
@@ -1012,7 +1057,7 @@ type ActorKvListOptions<T extends ActorKvValueType = "text", K extends ActorKvKe
 };
 type ActorClientFor<T> = T extends Registry<any> ? Client<T> : T;
 /**
- * @deprecated Actor KV is deprecated. Use embedded SQLite (`c.db` / `c.sql`)
+ * @deprecated Actor KV is deprecated. Use embedded SQLite (`c.db`)
  * or actor state instead.
  */
 interface ActorKv {
@@ -1109,6 +1154,8 @@ type QueueMessageOf<Name extends string, Body> = {
 type QueueName<TQueues extends QueueSchemaConfig> = keyof TQueues & string;
 type QueueFilterName<TQueues extends QueueSchemaConfig> = keyof TQueues extends never ? string : QueueName<TQueues>;
 type QueueMessageForName<TQueues extends QueueSchemaConfig, TName extends QueueFilterName<TQueues>> = keyof TQueues extends never ? QueueMessageOf<string, unknown> : TName extends QueueName<TQueues> ? QueueMessageOf<TName, InferSchemaMap<TQueues>[TName]> : never;
+type QueueCompleteArgs<T> = undefined extends T ? [response?: T] : [response: T];
+type QueueCompleteArgsForName<TQueues extends QueueSchemaConfig, TName extends QueueFilterName<TQueues>> = keyof TQueues extends never ? [response?: unknown] : TName extends QueueName<TQueues> ? [InferQueueCompleteMap<TQueues>[TName]] extends [never] ? [response?: unknown] : QueueCompleteArgs<InferQueueCompleteMap<TQueues>[TName]> : [response?: unknown];
 type QueueCompletionResultForName<TQueues extends QueueSchemaConfig, TName extends QueueFilterName<TQueues>> = keyof TQueues extends never ? unknown | undefined : TName extends QueueName<TQueues> ? InferQueueCompleteMap<TQueues>[TName] | undefined : unknown | undefined;
 interface QueueNextOptions<TName extends string = string, TCompletable extends boolean = boolean> {
     names?: readonly TName[];
@@ -1151,6 +1198,13 @@ interface ActorQueue<TQueues extends QueueSchemaConfig = Record<never, never>> {
     next<const TName extends QueueFilterName<TQueues>, const TCompletable extends boolean = false>(opts?: QueueNextOptions<TName, TCompletable>): Promise<any>;
     nextBatch<const TName extends QueueFilterName<TQueues>, const TCompletable extends boolean = false>(opts?: QueueNextBatchOptions<TName, TCompletable>): Promise<any[]>;
     waitForNames<const TName extends QueueFilterName<TQueues>, const TCompletable extends boolean = false>(names: readonly TName[], opts?: QueueWaitOptions<TCompletable>): Promise<any>;
+    /** @experimental */
+    waitForAvailable<const TName extends QueueFilterName<TQueues>>(names?: readonly TName[], opts?: Omit<QueueWaitOptions<false>, "completable">): Promise<void>;
+    /** @experimental */
+    complete<const TName extends QueueFilterName<TQueues>>(message: {
+        id: number | bigint;
+        name: TName;
+    }, ...args: QueueCompleteArgsForName<TQueues, TName>): Promise<void>;
     enqueueAndWait<const TName extends QueueFilterName<TQueues>>(name: TName, body: QueueMessageForName<TQueues, TName>["body"], opts?: QueueEnqueueAndWaitOptions): Promise<QueueCompletionResultForName<TQueues, TName>>;
     tryNext<const TName extends QueueFilterName<TQueues>, const TCompletable extends boolean = false>(opts?: QueueTryNextOptions<TName, TCompletable>): Promise<any>;
     tryNextBatch<const TName extends QueueFilterName<TQueues>, const TCompletable extends boolean = false>(opts?: QueueTryNextBatchOptions<TName, TCompletable>): Promise<any[]>;
@@ -1173,7 +1227,7 @@ interface ActorContext<TState, TConnParams, TConnState, TVars, TInput, TDatabase
     state: TState;
     vars: TVars;
     /**
-     * @deprecated Actor KV is deprecated. Use embedded SQLite (`db` / `sql`)
+     * @deprecated Actor KV is deprecated. Use embedded SQLite (`c.db`)
      * or actor state instead.
      */
     readonly kv: ActorKv;
@@ -1181,6 +1235,8 @@ interface ActorContext<TState, TConnParams, TConnState, TVars, TInput, TDatabase
     readonly schedule: ActorSchedule;
     readonly cron: ActorCron;
     readonly queue: ActorQueue<TQueues>;
+    /** @experimental */
+    readonly run: ActorRun;
     readonly actorId: string;
     readonly name: string;
     readonly key: string[];
@@ -1210,6 +1266,14 @@ interface ActorContext<TState, TConnParams, TConnState, TVars, TInput, TDatabase
     client<T = any>(): ActorClientFor<T>;
     [key: string]: any;
 }
+/** @experimental */
+interface ActorRun {
+    /**
+     * @experimental Sets or clears the durable Unix-millisecond deadline that
+     * ensures this actor's run handler is active, starting it if inactive.
+     */
+    setWakeAt(timestamp: number | null): Promise<void>;
+}
 type ActionContext<TState, TConnParams, TConnState, TVars, TInput, TDatabase extends AnyDatabaseProvider, TEvents extends EventSchemaConfig = Record<never, never>, TQueues extends QueueSchemaConfig = Record<never, never>> = ActorContext<TState, TConnParams, TConnState, TVars, TInput, TDatabase, TEvents, TQueues> & {
     conn: Conn<TState, TConnParams, TConnState, TVars, TInput, TDatabase, TEvents, TQueues>;
 };
@@ -1236,6 +1300,7 @@ declare const RunConfigSchema: z.ZodObject<{
     inspector: z.ZodOptional<z.ZodOptional<z.ZodObject<{
         workflow: z.ZodOptional<z.ZodObject<{
             getHistory: z.ZodCustom<() => unknown, () => unknown>;
+            getState: z.ZodOptional<z.ZodCustom<() => Promise<WorkflowState | null>, () => Promise<WorkflowState | null>>>;
             onHistoryUpdated: z.ZodOptional<z.ZodCustom<(listener: (history: unknown) => void) => InspectorUnsubscribe, (listener: (history: unknown) => void) => InspectorUnsubscribe>>;
             replayFromStep: z.ZodOptional<z.ZodCustom<(entryId?: string) => Promise<unknown>, (entryId?: string) => Promise<unknown>>>;
         }, z.core.$strip>>;
@@ -1258,6 +1323,7 @@ declare const ActorConfigSchema: z.ZodObject<{
         inspector: z.ZodOptional<z.ZodOptional<z.ZodObject<{
             workflow: z.ZodOptional<z.ZodObject<{
                 getHistory: z.ZodCustom<() => unknown, () => unknown>;
+                getState: z.ZodOptional<z.ZodCustom<() => Promise<WorkflowState | null>, () => Promise<WorkflowState | null>>>;
                 onHistoryUpdated: z.ZodOptional<z.ZodCustom<(listener: (history: unknown) => void) => InspectorUnsubscribe, (listener: (history: unknown) => void) => InspectorUnsubscribe>>;
                 replayFromStep: z.ZodOptional<z.ZodCustom<(entryId?: string) => Promise<unknown>, (entryId?: string) => Promise<unknown>>>;
             }, z.core.$strip>>;
@@ -1317,12 +1383,12 @@ declare const ActorConfigSchema: z.ZodObject<{
         }, z.core.$strict>, z.ZodObject<{
             id: z.ZodEnum<{
                 state: "state";
-                workflow: "workflow";
                 database: "database";
+                console: "console";
+                workflow: "workflow";
                 queue: "queue";
                 schedules: "schedules";
                 connections: "connections";
-                console: "console";
             }>;
             hidden: z.ZodLiteral<true>;
         }, z.core.$strict>]>>>;
@@ -1565,7 +1631,11 @@ declare const RegistryConfigSchema: z$2.ZodPipe<z$2.ZodObject<{
     }>>, z$2.ZodTransform<"auto" | "native" | "wasm", "auto" | "native" | "wasm" | undefined>>;
     wasm: z$2.ZodDefault<z$2.ZodOptional<z$2.ZodObject<{
         bindings: z$2.ZodOptional<z$2.ZodCustom<typeof _rivetkit_rivetkit_wasm, typeof _rivetkit_rivetkit_wasm>>;
-        initInput: z$2.ZodOptional<z$2.ZodCustom<_rivetkit_rivetkit_wasm.InitInput | Promise<_rivetkit_rivetkit_wasm.InitInput> | undefined, _rivetkit_rivetkit_wasm.InitInput | Promise<_rivetkit_rivetkit_wasm.InitInput> | undefined>>;
+        initInput: z$2.ZodOptional<z$2.ZodCustom<{
+            module_or_path: _rivetkit_rivetkit_wasm.InitInput | Promise<_rivetkit_rivetkit_wasm.InitInput>;
+        } | _rivetkit_rivetkit_wasm.InitInput | Promise<_rivetkit_rivetkit_wasm.InitInput> | undefined, {
+            module_or_path: _rivetkit_rivetkit_wasm.InitInput | Promise<_rivetkit_rivetkit_wasm.InitInput>;
+        } | _rivetkit_rivetkit_wasm.InitInput | Promise<_rivetkit_rivetkit_wasm.InitInput> | undefined>>;
     }, z$2.core.$strip>>>;
     sqlite: z$2.ZodPipe<z$2.ZodOptional<z$2.ZodUnion<readonly [z$2.ZodEnum<{
         local: "local";
@@ -1658,7 +1728,9 @@ declare const RegistryConfigSchema: z$2.ZodPipe<z$2.ZodObject<{
     runtime: "auto" | "native" | "wasm";
     wasm: {
         bindings?: typeof _rivetkit_rivetkit_wasm | undefined;
-        initInput?: _rivetkit_rivetkit_wasm.InitInput | Promise<_rivetkit_rivetkit_wasm.InitInput> | undefined;
+        initInput?: {
+            module_or_path: _rivetkit_rivetkit_wasm.InitInput | Promise<_rivetkit_rivetkit_wasm.InitInput>;
+        } | _rivetkit_rivetkit_wasm.InitInput | Promise<_rivetkit_rivetkit_wasm.InitInput> | undefined;
     };
     noWelcome: boolean;
     logging: {
@@ -1705,7 +1777,9 @@ declare const RegistryConfigSchema: z$2.ZodPipe<z$2.ZodObject<{
     runtime: "auto" | "native" | "wasm";
     wasm: {
         bindings?: typeof _rivetkit_rivetkit_wasm | undefined;
-        initInput?: _rivetkit_rivetkit_wasm.InitInput | Promise<_rivetkit_rivetkit_wasm.InitInput> | undefined;
+        initInput?: {
+            module_or_path: _rivetkit_rivetkit_wasm.InitInput | Promise<_rivetkit_rivetkit_wasm.InitInput>;
+        } | _rivetkit_rivetkit_wasm.InitInput | Promise<_rivetkit_rivetkit_wasm.InitInput> | undefined;
     };
     sqlite: {
         backend: "local" | "remote";
@@ -1769,6 +1843,7 @@ type ActorContextHandle = OpaqueHandle<"actorContext">;
 type ConnHandle = OpaqueHandle<"conn">;
 type WebSocketHandle = OpaqueHandle<"webSocket">;
 type CancellationTokenHandle = OpaqueHandle<"cancellationToken">;
+type ActorStateTransactionHandle = OpaqueHandle<"actorStateTransaction">;
 type SqliteTransactionHandle = OpaqueHandle<"sqliteTransaction">;
 type RuntimeBytes = Uint8Array;
 interface RuntimeActorKeySegment {
@@ -1935,6 +2010,7 @@ interface RuntimeActorConfig {
     icon?: string;
     hasDatabase?: boolean;
     remoteSqlite?: boolean;
+    sqliteProfiling?: SqliteProfilingOptions;
     enableActorRuntimeSocket?: boolean;
     hasState?: boolean;
     canHibernateWebsocket?: boolean;
@@ -2076,6 +2152,7 @@ interface CoreRuntime {
     actorBeginOnStateChange(ctx: ActorContextHandle): void;
     actorEndOnStateChange(ctx: ActorContextHandle): void;
     actorSetAlarm(ctx: ActorContextHandle, timestampMs?: number | undefined | null): void;
+    actorSetRunWakeAt(ctx: ActorContextHandle, timestampMs?: number | undefined | null): Promise<void>;
     actorRequestSave(ctx: ActorContextHandle, opts?: RuntimeRequestSaveOpts | undefined | null): void;
     actorRequestSaveAndWait(ctx: ActorContextHandle, opts?: RuntimeRequestSaveOpts | undefined | null): Promise<void>;
     actorInspectorSnapshot(ctx: ActorContextHandle): RuntimeInspectorSnapshot;
@@ -2121,11 +2198,15 @@ interface CoreRuntime {
     actorSqlExec(ctx: ActorContextHandle, sql: string): Promise<RuntimeSqlExecResult>;
     actorSqlExecute(ctx: ActorContextHandle, sql: string, params?: RuntimeSqlBindParams): Promise<RuntimeSqlExecuteResult>;
     actorSqlExecuteBatch(ctx: ActorContextHandle, statements: RuntimeSqlBatchStatement[]): Promise<RuntimeSqlExecuteResult[]>;
-    actorSqlBeginTransaction(ctx: ActorContextHandle, timeoutMs?: number): Promise<SqliteTransactionHandle>;
+    actorSqlBeginTransaction(ctx: ActorContextHandle, timeoutMs?: number, name?: string): Promise<SqliteTransactionHandle>;
     actorSqlTransactionExec(transaction: SqliteTransactionHandle, sql: string): Promise<RuntimeSqlExecResult>;
     actorSqlTransactionExecute(transaction: SqliteTransactionHandle, sql: string, params?: RuntimeSqlBindParams): Promise<RuntimeSqlExecuteResult>;
     actorSqlTransactionCommit(transaction: SqliteTransactionHandle): Promise<void>;
     actorSqlTransactionRollback(transaction: SqliteTransactionHandle): Promise<void>;
+    actorBeginStateTransaction(ctx: ActorContextHandle, timeoutMs?: number): Promise<ActorStateTransactionHandle>;
+    actorStateTransactionExecute(transaction: ActorStateTransactionHandle, sql: string, params?: RuntimeSqlBindParams): Promise<RuntimeSqlExecuteResult>;
+    actorStateTransactionCommit(transaction: ActorStateTransactionHandle, payload: RuntimeStateDeltaPayload): Promise<void>;
+    actorStateTransactionRollback(transaction: ActorStateTransactionHandle): Promise<void>;
     actorSqlQuery(ctx: ActorContextHandle, sql: string, params?: RuntimeSqlBindParams): Promise<RuntimeSqlQueryResult>;
     actorSqlRun(ctx: ActorContextHandle, sql: string, params?: RuntimeSqlBindParams): Promise<RuntimeSqlRunResult>;
     actorSqlMetrics(ctx: ActorContextHandle): SqliteNativeMetrics | null;
@@ -2136,6 +2217,7 @@ interface CoreRuntime {
     actorQueueNextBatch(ctx: ActorContextHandle, options?: RuntimeQueueNextBatchOptions | undefined | null, signal?: CancellationTokenHandle | undefined | null): Promise<RuntimeQueueMessage[]>;
     actorQueueWaitForNames(ctx: ActorContextHandle, names: string[], options?: RuntimeQueueWaitOptions | undefined | null, signal?: CancellationTokenHandle | undefined | null): Promise<RuntimeQueueMessage>;
     actorQueueWaitForNamesAvailable(ctx: ActorContextHandle, names: string[], options?: RuntimeQueueWaitOptions | undefined | null, signal?: CancellationTokenHandle | undefined | null): Promise<void>;
+    actorQueueCompletePersisted(ctx: ActorContextHandle, messageId: bigint, expectedName: string, response?: RuntimeBytes | undefined | null): Promise<boolean>;
     actorQueueEnqueueAndWait(ctx: ActorContextHandle, name: string, body: RuntimeBytes, options?: RuntimeQueueEnqueueAndWaitOptions | undefined | null, signal?: CancellationTokenHandle | undefined | null): Promise<RuntimeBytes | null>;
     actorQueueTryNextBatch(ctx: ActorContextHandle, options?: RuntimeQueueTryNextBatchOptions | undefined | null): RuntimeQueueMessage[];
     actorQueueMaxSize(ctx: ActorContextHandle): number;

package/dist/browser/client.js

@@ -194,7 +194,7 @@ function noopNext() {
 // package.json
 var package_default = {
   name: "rivetkit",
-  version: "2.3.11-rc.9",
+  version: "2.3.11",
   description: "Lightweight libraries for building stateful actors on edge platforms",
   license: "Apache-2.0",
   keywords: [
@@ -330,6 +330,16 @@ var package_default = {
         default: "./dist/tsup/inspector/mod.cjs"
       }
     },
+    "./experimental/inspector/workflow": {
+      import: {
+        types: "./dist/tsup/inspector/workflow.d.ts",
+        default: "./dist/tsup/inspector/workflow.js"
+      },
+      require: {
+        types: "./dist/tsup/inspector/workflow.d.cts",
+        default: "./dist/tsup/inspector/workflow.cjs"
+      }
+    },
     "./inspector-tab": {
       import: {
         types: "./dist/tsup/inspector-tab/mod.d.ts",
@@ -375,7 +385,7 @@ var package_default = {
     "./dist/tsup/chunk-*.cjs"
   ],
   scripts: {
-    build: "tsup src/mod.ts src/client/mod.ts src/common/log.ts src/common/websocket.ts src/actor/errors.ts src/utils.ts src/workflow/mod.ts src/test/mod.ts src/inspector/mod.ts src/inspector-tab/mod.ts src/db/mod.ts src/db/drizzle.ts src/dynamic/mod.ts src/unstable/migrations.ts && tsup src/agent-os/index.ts --no-clean --out-dir dist/tsup/agent-os",
+    build: "tsup src/mod.ts src/client/mod.ts src/common/log.ts src/common/websocket.ts src/actor/errors.ts src/utils.ts src/workflow/mod.ts src/test/mod.ts src/inspector/mod.ts src/inspector/workflow.ts src/inspector-tab/mod.ts src/db/mod.ts src/db/drizzle.ts src/dynamic/mod.ts src/unstable/migrations.ts && tsup src/agent-os/index.ts --no-clean --out-dir dist/tsup/agent-os && node scripts/check-built-commonjs.mjs",
     "build:browser": "tsup --config tsup.browser.config.ts",
     "check-types": "tsc --noEmit",
     lint: "biome check . && pnpm run check:test-skips && pnpm run check:wait-for-comments",