rivetkit 2.0.1 → 2.0.3

package/package.json

@@ -1,8 +1,211 @@
 {
   "name": "rivetkit",
-  "version": "2.0.1",
-  "description": "",
-  "keywords": [],
-  "author": "",
-  "license": "Apache-2.0"
+  "version": "2.0.3",
+  "license": "Apache-2.0",
+  "keywords": [
+    "rivetkit",
+    "stateful",
+    "serverless",
+    "actors",
+    "agents",
+    "realtime",
+    "websocket",
+    "actors",
+    "framework"
+  ],
+  "files": [
+    "dist",
+    "src",
+    "deno.json",
+    "bun.json",
+    "package.json"
+  ],
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/tsup/mod.d.ts",
+        "default": "./dist/tsup/mod.js"
+      },
+      "require": {
+        "types": "./dist/tsup/mod.d.cts",
+        "default": "./dist/tsup/mod.cjs"
+      }
+    },
+    "./client": {
+      "import": {
+        "types": "./dist/tsup/client/mod.d.ts",
+        "default": "./dist/tsup/client/mod.js"
+      },
+      "require": {
+        "types": "./dist/tsup/client/mod.d.cts",
+        "default": "./dist/tsup/client/mod.cjs"
+      }
+    },
+    "./log": {
+      "import": {
+        "types": "./dist/tsup/common/log.d.ts",
+        "default": "./dist/tsup/common/log.js"
+      },
+      "require": {
+        "types": "./dist/tsup/common/log.d.cts",
+        "default": "./dist/tsup/common/log.cjs"
+      }
+    },
+    "./errors": {
+      "import": {
+        "types": "./dist/tsup/actor/errors.d.ts",
+        "default": "./dist/tsup/actor/errors.js"
+      },
+      "require": {
+        "types": "./dist/tsup/actor/errors.d.cts",
+        "default": "./dist/tsup/actor/errors.cjs"
+      }
+    },
+    "./utils": {
+      "import": {
+        "types": "./dist/tsup/utils.d.ts",
+        "default": "./dist/tsup/utils.js"
+      },
+      "require": {
+        "types": "./dist/tsup/utils.d.cts",
+        "default": "./dist/tsup/utils.cjs"
+      }
+    },
+    "./driver-helpers": {
+      "import": {
+        "types": "./dist/tsup/driver-helpers/mod.d.ts",
+        "default": "./dist/tsup/driver-helpers/mod.js"
+      },
+      "require": {
+        "types": "./dist/tsup/driver-helpers/mod.d.cts",
+        "default": "./dist/tsup/driver-helpers/mod.cjs"
+      }
+    },
+    "./driver-helpers/websocket": {
+      "import": {
+        "types": "./dist/tsup/common/websocket.d.ts",
+        "default": "./dist/tsup/common/websocket.js"
+      },
+      "require": {
+        "types": "./dist/tsup/common/websocket.d.cts",
+        "default": "./dist/tsup/common/websocket.cjs"
+      }
+    },
+    "./driver-test-suite": {
+      "import": {
+        "types": "./dist/tsup/driver-test-suite/mod.d.ts",
+        "default": "./dist/tsup/driver-test-suite/mod.js"
+      },
+      "require": {
+        "types": "./dist/tsup/driver-test-suite/mod.d.cts",
+        "default": "./dist/tsup/driver-test-suite/mod.cjs"
+      }
+    },
+    "./topologies/coordinate": {
+      "import": {
+        "types": "./dist/tsup/topologies/coordinate/mod.d.ts",
+        "default": "./dist/tsup/topologies/coordinate/mod.js"
+      },
+      "require": {
+        "types": "./dist/tsup/topologies/coordinate/mod.d.cts",
+        "default": "./dist/tsup/topologies/coordinate/mod.cjs"
+      }
+    },
+    "./topologies/partition": {
+      "import": {
+        "types": "./dist/tsup/topologies/partition/mod.d.ts",
+        "default": "./dist/tsup/topologies/partition/mod.js"
+      },
+      "require": {
+        "types": "./dist/tsup/topologies/partition/mod.d.cts",
+        "default": "./dist/tsup/topologies/partition/mod.cjs"
+      }
+    },
+    "./test": {
+      "import": {
+        "types": "./dist/tsup/test/mod.d.ts",
+        "default": "./dist/tsup/test/mod.js"
+      },
+      "require": {
+        "types": "./dist/tsup/test/mod.d.cts",
+        "default": "./dist/tsup/test/mod.cjs"
+      }
+    },
+    "./inspector": {
+      "import": {
+        "types": "./dist/tsup/inspector/mod.d.ts",
+        "default": "./dist/tsup/inspector/mod.js"
+      },
+      "require": {
+        "types": "./dist/tsup/inspector/mod.d.cts",
+        "default": "./dist/tsup/inspector/mod.cjs"
+      }
+    }
+  },
+  "engines": {
+    "node": ">=22.0.0"
+  },
+  "sideEffects": false,
+  "dependencies": {
+    "@bare-ts/lib": "~0.3.0",
+    "@hono/standard-validator": "^0.1.3",
+    "@hono/zod-openapi": "^0.19.10",
+    "@rivetkit/engine-runner": "https://pkg.pr.new/rivet-gg/engine/@rivetkit/engine-runner@664a377",
+    "@rivetkit/fast-json-patch": "^3.1.2",
+    "cbor-x": "^1.6.0",
+    "hono": "^4.7.0",
+    "invariant": "^2.2.4",
+    "nanoevents": "^9.1.0",
+    "on-change": "^5.0.1",
+    "p-retry": "^6.2.1",
+    "zod": "^3.25.76"
+  },
+  "devDependencies": {
+    "@bare-ts/tools": "^0.13.0",
+    "@hono/node-server": "^1.18.2",
+    "@hono/node-ws": "^1.1.1",
+    "@rivet-gg/actor-core": "^25.1.0",
+    "@types/invariant": "^2",
+    "@types/node": "^22.13.1",
+    "@types/ws": "^8",
+    "@vitest/ui": "3.1.1",
+    "bundle-require": "^5.1.0",
+    "eventsource": "^3.0.5",
+    "tsup": "^8.4.0",
+    "tsx": "^4.19.4",
+    "typescript": "^5.7.3",
+    "vitest": "^3.1.1",
+    "ws": "^8.18.1"
+  },
+  "peerDependencies": {
+    "@hono/node-server": "^1.14.0",
+    "@hono/node-ws": "^1.1.1",
+    "eventsource": "^3.0.5",
+    "ws": "^8.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@hono/node-server": {
+      "optional": true
+    },
+    "@hono/node-ws": {
+      "optional": true
+    },
+    "eventsource": {
+      "optional": true
+    },
+    "ws": {
+      "optional": true
+    }
+  },
+  "stableVersion": "0.8.0",
+  "scripts": {
+    "dev": "pnpm build --watch",
+    "build": "tsup src/mod.ts src/client/mod.ts src/common/log.ts src/common/websocket.ts src/actor/errors.ts src/topologies/coordinate/mod.ts src/topologies/partition/mod.ts src/utils.ts src/driver-helpers/mod.ts src/driver-test-suite/mod.ts src/test/mod.ts src/inspector/mod.ts",
+    "build:schema": "./scripts/compile-bare.ts compile schemas/client-protocol/v1.bare -o dist/schemas/client-protocol/v1.ts && ./scripts/compile-bare.ts compile schemas/file-system-driver/v1.bare -o dist/schemas/file-system-driver/v1.ts && ./scripts/compile-bare.ts compile schemas/actor-persist/v1.bare -o dist/schemas/actor-persist/v1.ts",
+    "check-types": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "dump-openapi": "tsx scripts/dump-openapi.ts"
+  }
 }

package/src/actor/action.ts

@@ -0,0 +1,182 @@
+import type { ActorKey } from "@/actor/mod";
+import type { Client } from "@/client/client";
+import type { Logger } from "@/common/log";
+import type { Registry } from "@/registry/mod";
+import type { Conn, ConnId } from "./connection";
+import type { ActorContext } from "./context";
+import type { AnyDatabaseProvider, InferDatabaseClient } from "./database";
+import type { SaveStateOptions } from "./instance";
+import type { Schedule } from "./schedule";
+
+/**
+ * Context for a remote procedure call.
+ *
+ * @typeParam A Actor this action belongs to
+ */
+export class ActionContext<
+	TState,
+	TConnParams,
+	TConnState,
+	TVars,
+	TInput,
+	TAuthData,
+	TDatabase extends AnyDatabaseProvider,
+> {
+	#actorContext: ActorContext<
+		TState,
+		TConnParams,
+		TConnState,
+		TVars,
+		TInput,
+		TAuthData,
+		TDatabase
+	>;
+
+	/**
+	 * Should not be called directly.
+	 *
+	 * @param actorContext - The actor context
+	 * @param conn - The connection associated with the action
+	 */
+	constructor(
+		actorContext: ActorContext<
+			TState,
+			TConnParams,
+			TConnState,
+			TVars,
+			TInput,
+			TAuthData,
+			TDatabase
+		>,
+		public readonly conn: Conn<
+			TState,
+			TConnParams,
+			TConnState,
+			TVars,
+			TInput,
+			TAuthData,
+			TDatabase
+		>,
+	) {
+		this.#actorContext = actorContext;
+	}
+
+	/**
+	 * Get the actor state
+	 */
+	get state(): TState {
+		return this.#actorContext.state;
+	}
+
+	/**
+	 * Get the actor variables
+	 */
+	get vars(): TVars {
+		return this.#actorContext.vars;
+	}
+
+	/**
+	 * Broadcasts an event to all connected clients.
+	 */
+	broadcast(name: string, ...args: any[]): void {
+		this.#actorContext.broadcast(name, ...args);
+	}
+
+	/**
+	 * Gets the logger instance.
+	 */
+	get log(): Logger {
+		return this.#actorContext.log;
+	}
+
+	/**
+	 * Gets actor ID.
+	 */
+	get actorId(): string {
+		return this.#actorContext.actorId;
+	}
+
+	/**
+	 * Gets the actor name.
+	 */
+	get name(): string {
+		return this.#actorContext.name;
+	}
+
+	/**
+	 * Gets the actor key.
+	 */
+	get key(): ActorKey {
+		return this.#actorContext.key;
+	}
+
+	/**
+	 * Gets the region.
+	 */
+	get region(): string {
+		return this.#actorContext.region;
+	}
+
+	/**
+	 * Gets the scheduler.
+	 */
+	get schedule(): Schedule {
+		return this.#actorContext.schedule;
+	}
+
+	/**
+	 * Gets the map of connections.
+	 */
+	get conns(): Map<
+		ConnId,
+		Conn<TState, TConnParams, TConnState, TVars, TInput, TAuthData, TDatabase>
+	> {
+		return this.#actorContext.conns;
+	}
+
+	/**
+	 * Returns the client for the given registry.
+	 */
+	client<R extends Registry<any>>(): Client<R> {
+		return this.#actorContext.client<R>();
+	}
+
+	/**
+	 * @experimental
+	 */
+	get db(): InferDatabaseClient<TDatabase> {
+		return this.#actorContext.db;
+	}
+
+	/**
+	 * Forces the state to get saved.
+	 */
+	async saveState(opts: SaveStateOptions): Promise<void> {
+		return this.#actorContext.saveState(opts);
+	}
+
+	/**
+	 * Prevents the actor from sleeping until promise is complete.
+	 */
+	waitUntil(promise: Promise<void>): void {
+		this.#actorContext.waitUntil(promise);
+	}
+
+	/**
+	 * AbortSignal that fires when the actor is stopping.
+	 */
+	get abortSignal(): AbortSignal {
+		return this.#actorContext.abortSignal;
+	}
+
+	/**
+	 * Forces the actor to sleep.
+	 *
+	 * Not supported on all drivers.
+	 *
+	 * @experimental
+	 */
+	sleep() {
+		this.#actorContext.sleep();
+	}
+}