rivetkit 2.3.0-rc.12 → 2.3.0-rc.13

package/dist/tsup/agent-os/index.d.cts

@@ -179,6 +179,8 @@ declare const RegistryConfigSchema: z.ZodPipe<z.ZodObject<{
     httpPort: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
     httpHost: z.ZodOptional<z.ZodString>;
     startEngine: z.ZodDefault<z.ZodBoolean>;
+    engineHost: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    enginePort: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
     engineVersion: z.ZodDefault<z.ZodOptional<z.ZodString>>;
     configurePool: z.ZodOptional<z.ZodOptional<z.ZodObject<{
         name: z.ZodOptional<z.ZodString>;
@@ -244,6 +246,8 @@ declare const RegistryConfigSchema: z.ZodPipe<z.ZodObject<{
     httpBasePath: string;
     httpPort: number;
     startEngine: boolean;
+    engineHost: string;
+    enginePort: number;
     engineVersion: string;
     envoy: {
         poolName: string;
@@ -295,6 +299,8 @@ declare const RegistryConfigSchema: z.ZodPipe<z.ZodObject<{
     httpBasePath: string;
     httpPort: number;
     startEngine: boolean;
+    engineHost: string;
+    enginePort: number;
     engineVersion: string;
     serverless: {
         basePath: string;
@@ -714,6 +720,21 @@ interface RuntimeActorConfig {
     actions?: Array<{
         name: string;
     }>;
+    inspectorTabs?: Array<RuntimeInspectorTabEntry>;
+}
+interface RuntimeInspectorTabEntry {
+    id: string;
+    /** Required for custom entries; omitted for built-in hides. */
+    label?: string;
+    /**
+     * Required for custom entries — absolute path to the source directory.
+     * Resolved on the TS side before being handed to the runtime.
+     */
+    source?: string;
+    /** Optional icon id for custom entries. */
+    icon?: string;
+    /** Set to true for built-in hide entries. */
+    hidden?: boolean;
 }
 interface RuntimeServeConfig {
     version: number;
@@ -722,6 +743,8 @@ interface RuntimeServeConfig {
     namespace: string;
     poolName: string;
     engineBinaryPath?: string;
+    engineHost?: string;
+    enginePort?: number;
     handleInspectorHttpInRuntime?: boolean;
     inspectorTestToken?: string;
     serverlessBasePath?: string;
@@ -1499,6 +1522,10 @@ type ActorKvListOptions<T extends ActorKvValueType = "text", K extends ActorKvKe
     limit?: number;
 };
 type ActorClientFor<T> = T extends Registry<any> ? Client<T> : T;
+/**
+ * @deprecated Actor KV is deprecated. Use embedded SQLite (`c.db` / `c.sql`)
+ * or actor state instead.
+ */
 interface ActorKv {
     get<T extends ActorKvValueType = "text">(key: Uint8Array | string, options?: ActorKvValueOptions<T>): Promise<ActorKvValueTypeMap[T] | null>;
     put<T extends ActorKvValueType = "text">(key: Uint8Array | string, value: Uint8Array | string | ArrayBuffer, options?: ActorKvValueOptions<T>): Promise<void>;
@@ -1590,6 +1617,10 @@ interface ActorContext<TState, TConnParams, TConnState, TVars, TInput, TDatabase
     [RAW_STATE_SYMBOL](): TState;
     state: TState;
     vars: TVars;
+    /**
+     * @deprecated Actor KV is deprecated. Use embedded SQLite (`db` / `sql`)
+     * or actor state instead.
+     */
     readonly kv: ActorKv;
     readonly db: InferDatabaseClient<TDatabase>;
     readonly schedule: ActorSchedule;
@@ -1714,6 +1745,25 @@ declare const ActorConfigSchema: z$1.ZodObject<{
         preloadMaxWorkflowBytes: z$1.ZodOptional<z$1.ZodNumber>;
         preloadMaxConnectionsBytes: z$1.ZodOptional<z$1.ZodNumber>;
     }, z$1.core.$strict>>;
+    inspector: z$1.ZodOptional<z$1.ZodObject<{
+        tabs: z$1.ZodDefault<z$1.ZodArray<z$1.ZodUnion<readonly [z$1.ZodObject<{
+            id: z$1.ZodString;
+            label: z$1.ZodString;
+            source: z$1.ZodString;
+            icon: z$1.ZodOptional<z$1.ZodString>;
+            hidden: z$1.ZodOptional<z$1.ZodLiteral<false>>;
+        }, z$1.core.$strict>, z$1.ZodObject<{
+            id: z$1.ZodEnum<{
+                state: "state";
+                queue: "queue";
+                workflow: "workflow";
+                database: "database";
+                connections: "connections";
+                console: "console";
+            }>;
+            hidden: z$1.ZodLiteral<true>;
+        }, z$1.core.$strict>]>>>;
+    }, z$1.core.$strict>>;
 }, z$1.core.$strict>;
 type CreateState<TState, _TConnParams, _TConnState, _TVars, TInput, TDatabase extends AnyDatabaseProvider, TEvents extends EventSchemaConfig, TQueues extends QueueSchemaConfig> = {
     state: TState;

package/dist/tsup/agent-os/index.d.ts

@@ -179,6 +179,8 @@ declare const RegistryConfigSchema: z.ZodPipe<z.ZodObject<{
     httpPort: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
     httpHost: z.ZodOptional<z.ZodString>;
     startEngine: z.ZodDefault<z.ZodBoolean>;
+    engineHost: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    enginePort: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
     engineVersion: z.ZodDefault<z.ZodOptional<z.ZodString>>;
     configurePool: z.ZodOptional<z.ZodOptional<z.ZodObject<{
         name: z.ZodOptional<z.ZodString>;
@@ -244,6 +246,8 @@ declare const RegistryConfigSchema: z.ZodPipe<z.ZodObject<{
     httpBasePath: string;
     httpPort: number;
     startEngine: boolean;
+    engineHost: string;
+    enginePort: number;
     engineVersion: string;
     envoy: {
         poolName: string;
@@ -295,6 +299,8 @@ declare const RegistryConfigSchema: z.ZodPipe<z.ZodObject<{
     httpBasePath: string;
     httpPort: number;
     startEngine: boolean;
+    engineHost: string;
+    enginePort: number;
     engineVersion: string;
     serverless: {
         basePath: string;
@@ -714,6 +720,21 @@ interface RuntimeActorConfig {
     actions?: Array<{
         name: string;
     }>;
+    inspectorTabs?: Array<RuntimeInspectorTabEntry>;
+}
+interface RuntimeInspectorTabEntry {
+    id: string;
+    /** Required for custom entries; omitted for built-in hides. */
+    label?: string;
+    /**
+     * Required for custom entries — absolute path to the source directory.
+     * Resolved on the TS side before being handed to the runtime.
+     */
+    source?: string;
+    /** Optional icon id for custom entries. */
+    icon?: string;
+    /** Set to true for built-in hide entries. */
+    hidden?: boolean;
 }
 interface RuntimeServeConfig {
     version: number;
@@ -722,6 +743,8 @@ interface RuntimeServeConfig {
     namespace: string;
     poolName: string;
     engineBinaryPath?: string;
+    engineHost?: string;
+    enginePort?: number;
     handleInspectorHttpInRuntime?: boolean;
     inspectorTestToken?: string;
     serverlessBasePath?: string;
@@ -1499,6 +1522,10 @@ type ActorKvListOptions<T extends ActorKvValueType = "text", K extends ActorKvKe
     limit?: number;
 };
 type ActorClientFor<T> = T extends Registry<any> ? Client<T> : T;
+/**
+ * @deprecated Actor KV is deprecated. Use embedded SQLite (`c.db` / `c.sql`)
+ * or actor state instead.
+ */
 interface ActorKv {
     get<T extends ActorKvValueType = "text">(key: Uint8Array | string, options?: ActorKvValueOptions<T>): Promise<ActorKvValueTypeMap[T] | null>;
     put<T extends ActorKvValueType = "text">(key: Uint8Array | string, value: Uint8Array | string | ArrayBuffer, options?: ActorKvValueOptions<T>): Promise<void>;
@@ -1590,6 +1617,10 @@ interface ActorContext<TState, TConnParams, TConnState, TVars, TInput, TDatabase
     [RAW_STATE_SYMBOL](): TState;
     state: TState;
     vars: TVars;
+    /**
+     * @deprecated Actor KV is deprecated. Use embedded SQLite (`db` / `sql`)
+     * or actor state instead.
+     */
     readonly kv: ActorKv;
     readonly db: InferDatabaseClient<TDatabase>;
     readonly schedule: ActorSchedule;
@@ -1714,6 +1745,25 @@ declare const ActorConfigSchema: z$1.ZodObject<{
         preloadMaxWorkflowBytes: z$1.ZodOptional<z$1.ZodNumber>;
         preloadMaxConnectionsBytes: z$1.ZodOptional<z$1.ZodNumber>;
     }, z$1.core.$strict>>;
+    inspector: z$1.ZodOptional<z$1.ZodObject<{
+        tabs: z$1.ZodDefault<z$1.ZodArray<z$1.ZodUnion<readonly [z$1.ZodObject<{
+            id: z$1.ZodString;
+            label: z$1.ZodString;
+            source: z$1.ZodString;
+            icon: z$1.ZodOptional<z$1.ZodString>;
+            hidden: z$1.ZodOptional<z$1.ZodLiteral<false>>;
+        }, z$1.core.$strict>, z$1.ZodObject<{
+            id: z$1.ZodEnum<{
+                state: "state";
+                queue: "queue";
+                workflow: "workflow";
+                database: "database";
+                connections: "connections";
+                console: "console";
+            }>;
+            hidden: z$1.ZodLiteral<true>;
+        }, z$1.core.$strict>]>>>;
+    }, z$1.core.$strict>>;
 }, z$1.core.$strict>;
 type CreateState<TState, _TConnParams, _TConnState, _TVars, TInput, TDatabase extends AnyDatabaseProvider, TEvents extends EventSchemaConfig, TQueues extends QueueSchemaConfig> = {
     state: TState;

package/dist/tsup/agent-os/index.js

@@ -13,6 +13,58 @@ var WorkflowInspectorConfigSchema = z.object({
 var RunInspectorConfigSchema = z.object({
   workflow: WorkflowInspectorConfigSchema.optional()
 }).optional();
+var BUILTIN_INSPECTOR_TAB_IDS = [
+  "workflow",
+  "database",
+  "state",
+  "queue",
+  "connections",
+  "console"
+];
+var BuiltinInspectorTabIdSchema = z.enum(BUILTIN_INSPECTOR_TAB_IDS);
+var CUSTOM_INSPECTOR_TAB_ID_RE = /^[A-Za-z0-9_-]+$/;
+var CustomInspectorTabEntrySchema = z.object({
+  id: z.string().regex(
+    CUSTOM_INSPECTOR_TAB_ID_RE,
+    "inspector.tabs[].id must contain only letters, digits, underscore, or dash"
+  ),
+  label: z.string().min(1),
+  source: z.string().min(1),
+  /**
+   * Optional icon id. The dashboard maps strings to glyphs (see its
+   * icon registry); unknown ids fall back to a generic icon.
+   */
+  icon: z.string().min(1).optional(),
+  hidden: z.literal(false).optional()
+}).strict();
+var HideInspectorTabEntrySchema = z.object({
+  id: BuiltinInspectorTabIdSchema,
+  hidden: z.literal(true)
+}).strict();
+var InspectorTabEntrySchema = z.union([
+  CustomInspectorTabEntrySchema,
+  HideInspectorTabEntrySchema
+]);
+var ActorInspectorConfigSchema = z.object({
+  tabs: z.array(InspectorTabEntrySchema).default(() => [])
+}).strict().refine(
+  (data) => {
+    const ids = data.tabs.map((t) => t.id);
+    return new Set(ids).size === ids.length;
+  },
+  { message: "Duplicate id in inspector.tabs", path: ["tabs"] }
+).refine(
+  (data) => {
+    const builtinSet = new Set(BUILTIN_INSPECTOR_TAB_IDS);
+    return data.tabs.every(
+      (t) => t.hidden === true || !builtinSet.has(t.id)
+    );
+  },
+  {
+    message: "Custom inspector tab id collides with a built-in (use hidden: true to hide a built-in)",
+    path: ["tabs"]
+  }
+);
 var RunConfigSchema = z.object({
   /** Display name for the actor in the Inspector UI. */
   name: z.string().optional(),
@@ -96,7 +148,8 @@ var ActorConfigSchema = z.object({
   vars: z.any().optional(),
   db: z.any().optional(),
   createVars: zFunction().optional(),
-  options: ActorOptionsSchema
+  options: ActorOptionsSchema,
+  inspector: ActorInspectorConfigSchema.optional()
 }).strict().refine(
   (data) => !(data.state !== void 0 && data.createState !== void 0),
   {
@@ -261,7 +314,7 @@ function isRivetErrorCode(error, group, code) {
 // package.json
 var package_default = {
   name: "rivetkit",
-  version: "2.3.0-rc.12",
+  version: "2.3.0-rc.13",
   description: "Lightweight libraries for building stateful actors on edge platforms",
   license: "Apache-2.0",
   keywords: [
@@ -387,6 +440,16 @@ var package_default = {
         default: "./dist/tsup/inspector/mod.cjs"
       }
     },
+    "./inspector-tab": {
+      import: {
+        types: "./dist/tsup/inspector-tab/mod.d.ts",
+        default: "./dist/tsup/inspector-tab/mod.js"
+      },
+      require: {
+        types: "./dist/tsup/inspector-tab/mod.d.cts",
+        default: "./dist/tsup/inspector-tab/mod.cjs"
+      }
+    },
     "./inspector/client": {
       import: {
         types: "./dist/browser/inspector/client.d.ts",
@@ -422,7 +485,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/db/mod.ts src/db/drizzle.ts src/dynamic/mod.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-tab/mod.ts src/db/mod.ts src/db/drizzle.ts src/dynamic/mod.ts && tsup src/agent-os/index.ts --no-clean --out-dir dist/tsup/agent-os",
     "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",