Count: {count}
@@ -150,7 +150,7 @@ The React integration leverages React's hooks system to provide an idiomatic way The main function that creates React hooks for interacting with RivetKit. It takes a client instance and returns hook functions. ```tsx -const { useActor, useActorEvent } = createReactRivetKit(client); +const { useWorker, useWorkerEvent } = createReactRivetKit(client); ``` #### Parameters @@ -160,46 +160,46 @@ const { useActor, useActorEvent } = createReactRivetKit(client); #### Returns An object containing React hooks: -- `useActor`: Hook for connecting to actors -- `useActorEvent`: Hook for subscribing to actor events +- `useWorker`: Hook for connecting to workers +- `useWorkerEvent`: Hook for subscribing to worker events -### `useActor` +### `useWorker` -Hook that connects to an actor, creating it if necessary. It manages the actor connection and returns the actor handle. +Hook that connects to a worker, creating it if necessary. It manages the worker connection and returns the worker handle. ```tsx -const [{ actor, error, isLoading, state }] = useActor(actorName, options); +const [{ worker, error, isLoading, state }] = useWorker(workerName, options); ``` #### Parameters -- `actorName`: The name of the actor to connect to (string). -- `options`: Optional connection options (same options as `client.actorName.get()`). - - `id`: String identifier for the actor instance. - - `tags`: Key-value pairs for actor identification. +- `workerName`: The name of the worker to connect to (string). +- `options`: Optional connection options (same options as `client.workerName.get()`). + - `id`: String identifier for the worker instance. + - `tags`: Key-value pairs for worker identification. - `params`: Parameters to pass during connection. - - `noCreate`: Boolean to prevent actor creation if it doesn't exist. + - `noCreate`: Boolean to prevent worker creation if it doesn't exist. #### Returns Returns an array with a single object containing: -- `actor`: The actor handle if connected, or `undefined` if still connecting. +- `worker`: The worker handle if connected, or `undefined` if still connecting. - `error`: Any error that occurred during connection. - `isLoading`: Boolean indicating if the connection is in progress. - `state`: String representing the internal connection state ("init", "creating", "created", or "error"). -### `useActorEvent` +### `useWorkerEvent` -Hook that subscribes to events from an actor. +Hook that subscribes to events from a worker. ```tsx -useActorEvent({ actor, event }, cb); +useWorkerEvent({ worker, event }, cb); ``` #### Parameters - `opts`: Object containing: - - `actor`: The actor handle from `useActor`, or undefined. + - `worker`: The worker handle from `useWorker`, or undefined. - `event`: The name of the event to subscribe to. - `cb`: Function called when the event is fired. The arguments passed to this function depend on the event type. @@ -212,27 +212,27 @@ This hook doesn't return a value. The subscription is automatically managed by t ### Simple Counter ```tsx -import { createClient } from "@rivetkit/actor/client"; +import { createClient } from "rivetkit/client"; import { createReactRivetKit } from "@rivetkit/react"; -import type { App } from "../actors/app"; +import type { App } from "../workers/app"; import { useState } from "react"; // Connect to RivetKit const client = createClientCount: {count}
-
-
+
{/*Supports
-
- {/* Platforms (all-in-one) */}
-
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
-
-
- Rivet
-
-
-
- Cloudflare Workers
-
-
- {/* Compute */}
-
-
- Node.js
-
-
-
- Bun
-
-
- {/* Databases */}
-
-
- Redis
-
-
-
- File System
-
-
-
- Memory
-
-
- {/* Languages & Frameworks */}
-
-
- TypeScript
-
-
-
- Python (Client)
-
-
-
- Rust (Client)
-
-
-
- React
-
-
- {/* Integrations */}
-
-
- Hono
-
-
-
- Vitest
-
- window.copyCommand && window.copyCommand(e.currentTarget)}>
*/}
- {/*
- npx create-actor@latest
+ npx create-worker@latest
-
+
{/*
+
*/}
+ */}
+
-
Workflows
+Workers
-
Distributed workflow engine for durable business processes.
-Replaces Temporal, AWS Step Functions, or LangGraph
+Stateful worker model for building reliable, scalable, and maintainable backend services.
+Replaces Durable Objects, Orelans, or Akka
-
Agents
+Workflows
-
Framework for building, deploying, and orchestrating AI agents in production.
-Replaces LangChain, LlamaIndex, or AutoGen
+Distributed workflow engine for durable business processes.
+Replaces Cloudflare Workflows, Temporal, or AWS Step Functions
-
Actors
+Agents
-
Stateful actor model for building reliable, scalable, and maintainable backend services.
-Replaces Durable Objects, AWS EventBridge, or Orleans
+Framework for building, deploying, and orchestrating AI agents in production.
+Replaces LangChain, LlamaIndex, or AutoGen
@@ -227,6 +159,75 @@ import FAQ from "/snippets/landing-faq.mdx";
Have more questions? Jump to our FAQ
*/}
+
+
+
+
+
Supports
+
+ {/* Platforms (all-in-one) */}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Rivet
+
+
+
+ Cloudflare Workers
+
+
+ {/* Compute */}
+
+
+ Node.js
+
+
+
+ Bun
+
+
+ {/* Databases */}
+
+
+ Redis
+
+
+
+ File System
+
+
+
+ Memory
+
+
+ {/* Languages & Frameworks */}
+
+
+ TypeScript
+
+
+
+ Python (Client)
+
+
+
+ Rust (Client)
+
+
+
+ React
+
+
+ {/* Integrations */}
+
+
+ Hono
+
+
+
+ Vitest
+
+
@@ -336,10 +337,10 @@ import FAQ from "/snippets/landing-faq.mdx";
diff --git a/docs/snippets/landing-faq.mdx b/docs/snippets/landing-faq.mdx
index 4d4131b33..e23b7314d 100644
--- a/docs/snippets/landing-faq.mdx
+++ b/docs/snippets/landing-faq.mdx
@@ -9,7 +9,7 @@ import { Icon } from "@/components/Icon";
-
Performance in every act - thanks to Rivet Actors.
+Performance in every act - thanks to Rivet Workers.
-
+
Get Started
diff --git a/docs/llm/claude.mdx b/docs/llm/claude.mdx
index 7e56941d6..05896be0c 100644
--- a/docs/llm/claude.mdx
+++ b/docs/llm/claude.mdx
@@ -22,7 +22,7 @@ To set up an effective `CLAUDE.md` file for RivetKit:
Paste the template into `CLAUDE.md`
- Run Claude Code and ask a simple question like `What lifecycle hook is used when an actor is first created?` to confirm it's reading your CLAUDE.md file correctly
+ Run Claude Code and ask a simple question like `What lifecycle hook is used when a worker is first created?` to confirm it's reading your CLAUDE.md file correctly
@@ -36,11 +36,11 @@ Here are some useful ways to leverage Claude Code with RivetKit:
# Get an overview of RivetKit's architecture
claude "explain the architecture of RivetKit and how the different topologies work"
-# Understand how actors communicate
-claude "explain how actors communicate with each other in the coordinate topology"
+# Understand how workers communicate
+claude "explain how workers communicate with each other in the coordinate topology"
# Learn about specific concepts
-claude "explain the lifecycle hooks for actors and when each one is called"
+claude "explain the lifecycle hooks for workers and when each one is called"
```
### Find Relevant Code
@@ -52,34 +52,34 @@ claude "find the files that implement the Redis driver"
# Locate examples of specific patterns
claude "show me examples of RPC methods in the codebase"
-# Understand actor state management
-claude "explain how actor state is persisted between restarts"
+# Understand worker state management
+claude "explain how worker state is persisted between restarts"
```
### Add New Features
```bash
-# Create a new actor implementation
-claude "help me create a new actor for managing user sessions"
+# Create a new worker implementation
+claude "help me create a new worker for managing user sessions"
-# Add authentication to an actor
-claude "show me how to add authentication to my actor's _onBeforeConnect method"
+# Add authentication to a worker
+claude "show me how to add authentication to my worker's _onBeforeConnect method"
# Implement error handling
-claude "help me implement proper error handling for my actor's RPC methods"
+claude "help me implement proper error handling for my worker's RPC methods"
```
### Debug Issues
```bash
# Diagnose connection problems
-claude "my actor connections are dropping, help me debug why"
+claude "my worker connections are dropping, help me debug why"
# Fix state persistence issues
-claude "my actor state isn't persisting between restarts, what could be wrong?"
+claude "my worker state isn't persisting between restarts, what could be wrong?"
# Address scaling problems
-claude "my actors are using too much memory, how can I optimize them?"
+claude "my workers are using too much memory, how can I optimize them?"
```
## Additional Resources
diff --git a/docs/llm/cursor.mdx b/docs/llm/cursor.mdx
index 2deb2cacc..e6ca440e9 100644
--- a/docs/llm/cursor.mdx
+++ b/docs/llm/cursor.mdx
@@ -52,11 +52,11 @@ Here are some useful prompts to try with Cursor when working with RivetKit:
# Get an overview of RivetKit's architecture
Explain the architecture of RivetKit and how the different topologies work
-# Understand how actors communicate
-Explain how actors communicate with each other in the coordinate topology
+# Understand how workers communicate
+Explain how workers communicate with each other in the coordinate topology
# Learn about specific concepts
-Explain the lifecycle hooks for actors and when each one is called
+Explain the lifecycle hooks for workers and when each one is called
```
### Find Relevant Code
@@ -68,34 +68,34 @@ Find the files that implement the Redis driver
# Locate examples of specific patterns
Show me examples of RPC methods in the codebase
-# Understand actor state management
-Explain how actor state is persisted between restarts
+# Understand worker state management
+Explain how worker state is persisted between restarts
```
### Add New Features
```
-# Create a new actor implementation
-Help me create a new actor for managing user sessions
+# Create a new worker implementation
+Help me create a new worker for managing user sessions
-# Add authentication to an actor
-Show me how to add authentication to my actor's _onBeforeConnect method
+# Add authentication to a worker
+Show me how to add authentication to my worker's _onBeforeConnect method
# Implement error handling
-Help me implement proper error handling for my actor's RPC methods
+Help me implement proper error handling for my worker's RPC methods
```
### Debug Issues
```
# Diagnose connection problems
-My actor connections are dropping, help me debug why
+My worker connections are dropping, help me debug why
# Fix state persistence issues
-My actor state isn't persisting between restarts, what could be wrong?
+My worker state isn't persisting between restarts, what could be wrong?
# Address scaling problems
-My actors are using too much memory, how can I optimize them?
+My workers are using too much memory, how can I optimize them?
```
## Additional Resources
diff --git a/docs/llm/prompt.mdx b/docs/llm/prompt.mdx
index 4f6d8c653..ddb9e31c6 100644
--- a/docs/llm/prompt.mdx
+++ b/docs/llm/prompt.mdx
@@ -36,10 +36,10 @@ This guide contains essential information for working with the RivetKit project.
### Core Concepts
-- **Actor**: A stateful, long-lived entity that processes messages and maintains state
-- **Manager**: Component responsible for creating, routing, and managing actor instances
-- **Action**: Method for an actor to expose callable functions to clients
-- **Event**: Asynchronous message sent from an actor to connected clients
+- **Worker**: A stateful, long-lived entity that processes messages and maintains state
+- **Manager**: Component responsible for creating, routing, and managing worker instances
+- **Action**: Method for a worker to expose callable functions to clients
+- **Event**: Asynchronous message sent from a worker to connected clients
- **Alarm**: Scheduled callback that triggers at a specific time
## Build Commands
@@ -56,7 +56,7 @@ Available driver implementations:
- **Memory**: In-memory implementation for development and testing
- **Redis**: Production-ready implementation using Redis for persistence and pub/sub
-- **Cloudflare Workers**: Uses Durable Objects for actor state persistence
+- **Cloudflare Workers**: Uses Durable Objects for worker state persistence
- **Rivet**: Fully-managed cloud platform with built-in scaling and monitoring
## Platform Support
@@ -98,7 +98,7 @@ When importing from workspace packages, always check the package's `package.json
## State Management
-- Each actor owns and manages its own isolated state via `c.state`
+- Each worker owns and manages its own isolated state via `c.state`
- State is automatically persisted between action calls
- State is initialized via `createState` function or `state` constant
- Only JSON-serializable types can be stored in state
@@ -115,43 +115,43 @@ When importing from workspace packages, always check the package's `package.json
## Actions and Events
-- **Actions**: Used for clients to call actor functions
-- **Events**: For actors to publish updates to clients
-- Actions are defined in the `actions` object of the actor configuration
+- **Actions**: Used for clients to call worker functions
+- **Events**: For workers to publish updates to clients
+- Actions are defined in the `actions` object of the worker configuration
- Helper functions outside the `actions` object are not callable by clients
- Broadcasting is done via `c.broadcast(name, data)`
- Specific client messaging uses `conn.send(name, data)`
-- Clients subscribe to events with `actor.on(eventName, callback)`
+- Clients subscribe to events with `worker.on(eventName, callback)`
## Lifecycle Hooks
-- `createState()`: Function that returns initial actor state
-- `onStart(c)`: Called any time actor is started (after restart/upgrade)
-- `onStateChange(c, newState)`: Called when actor state changes
+- `createState()`: Function that returns initial worker state
+- `onStart(c)`: Called any time worker is started (after restart/upgrade)
+- `onStateChange(c, newState)`: Called when worker state changes
- `onBeforeConnect(c)`: Called when new client connects
- `onConnect(c)`: Executed after client connection succeeds
- `onDisconnect(c)`: Called when client disconnects
-## Actor Management
+## Worker Management
-- App is configured with actors using `setup({ actors: { actorName }})` followed by `serve(app)`
-- Actors are accessed by client using `client.actorName.get()`
-- Actors can pass an ID parameter or object with `client.actorName.get(id)` or `client.actorName.get({key: value})`
-- Actors can be shut down with `c.shutdown()` from within the actor
+- App is configured with workers using `setup({ workers: { workerName }})` followed by `serve(app)`
+- Workers are accessed by client using `client.workerName.get()`
+- Workers can pass an ID parameter or object with `client.workerName.get(id)` or `client.workerName.get({key: value})`
+- Workers can be shut down with `c.shutdown()` from within the worker
## Scaling and Architecture Guidelines
-- Each actor should have a single responsibility
-- Keep state minimal and relevant to the actor's core function
-- Use separate actors for different entity types (users, rooms, documents)
-- Avoid too many cross-actor communications
+- Each worker should have a single responsibility
+- Keep state minimal and relevant to the worker's core function
+- Use separate workers for different entity types (users, rooms, documents)
+- Avoid too many cross-worker communications
- Use appropriate topology based on your scaling needs
## Scheduling
- Schedule future events with `c.after(duration, fn, ...args)`
- Schedule events for specific time with `c.at(timestamp, fn, ...args)`
-- Scheduled events persist across actor restarts
+- Scheduled events persist across worker restarts
## CORS Configuration
@@ -161,7 +161,7 @@ When importing from workspace packages, always check the package's `package.json
## Development Best Practices
-- Prefer functional actor pattern with `actor({ ... })` syntax
+- Prefer functional worker pattern with `worker({ ... })` syntax
- Use zod for runtime type validation
- Use `assertUnreachable(x: never)` for exhaustive type checking
- Add proper JSDoc comments for public APIs
diff --git a/docs/llm/windsurf.mdx b/docs/llm/windsurf.mdx
index 05f61bd76..48c65613d 100644
--- a/docs/llm/windsurf.mdx
+++ b/docs/llm/windsurf.mdx
@@ -50,11 +50,11 @@ Here are some useful prompts to try with Windsurf when working with RivetKit:
# Get an overview of RivetKit's architecture
Explain the architecture of RivetKit and how the different topologies work
-# Understand how actors communicate
-Explain how actors communicate with each other in the coordinate topology
+# Understand how workers communicate
+Explain how workers communicate with each other in the coordinate topology
# Learn about specific concepts
-Explain the lifecycle hooks for actors and when each one is called
+Explain the lifecycle hooks for workers and when each one is called
```
### Find Relevant Code
@@ -66,34 +66,34 @@ Find the files that implement the Redis driver
# Locate examples of specific patterns
Show me examples of RPC methods in the codebase
-# Understand actor state management
-Explain how actor state is persisted between restarts
+# Understand worker state management
+Explain how worker state is persisted between restarts
```
### Add New Features
```
-# Create a new actor implementation
-Help me create a new actor for managing user sessions
+# Create a new worker implementation
+Help me create a new worker for managing user sessions
-# Add authentication to an actor
-Show me how to add authentication to my actor's _onBeforeConnect method
+# Add authentication to a worker
+Show me how to add authentication to my worker's _onBeforeConnect method
# Implement error handling
-Help me implement proper error handling for my actor's RPC methods
+Help me implement proper error handling for my worker's RPC methods
```
### Debug Issues
```
# Diagnose connection problems
-My actor connections are dropping, help me debug why
+My worker connections are dropping, help me debug why
# Fix state persistence issues
-My actor state isn't persisting between restarts, what could be wrong?
+My worker state isn't persisting between restarts, what could be wrong?
# Address scaling problems
-My actors are using too much memory, how can I optimize them?
+My workers are using too much memory, how can I optimize them?
```
## Additional Resources
diff --git a/docs/openapi.json b/docs/openapi.json
index 9d87e67b8..76276f42b 100644
--- a/docs/openapi.json
+++ b/docs/openapi.json
@@ -2,7 +2,7 @@
"openapi": "3.0.0",
"info": {
"version": "0.9.0-rc.1",
- "title": "ActorCore API"
+ "title": "WorkerCore API"
},
"components": {
"schemas": {
@@ -11,7 +11,7 @@
"properties": {
"i": {
"type": "string",
- "example": "actor-123"
+ "example": "worker-123"
}
},
"required": [
@@ -25,7 +25,7 @@
"nullable": true,
"example": {
"getForId": {
- "actorId": "actor-123"
+ "workerId": "worker-123"
}
}
}
@@ -41,7 +41,7 @@
"nullable": true,
"example": {
"getForId": {
- "actorId": "actor-123"
+ "workerId": "worker-123"
}
}
},
@@ -64,7 +64,7 @@
"nullable": true,
"example": {
"type": "message",
- "content": "Hello, actor!"
+ "content": "Hello, worker!"
}
}
}
@@ -73,13 +73,13 @@
"parameters": {}
},
"paths": {
- "/actors/resolve": {
+ "/workers/resolve": {
"post": {
"parameters": [
{
"schema": {
"type": "string",
- "description": "Actor query information"
+ "description": "Worker query information"
},
"required": true,
"name": "X-AC-Query",
@@ -115,7 +115,7 @@
}
}
},
- "/actors/connect/websocket": {
+ "/workers/connect/websocket": {
"get": {
"parameters": [
{
@@ -131,7 +131,7 @@
{
"schema": {
"type": "string",
- "description": "Actor query information"
+ "description": "Worker query information"
},
"required": true,
"name": "query",
@@ -145,7 +145,7 @@
}
}
},
- "/actors/connect/sse": {
+ "/workers/connect/sse": {
"get": {
"parameters": [
{
@@ -161,7 +161,7 @@
{
"schema": {
"type": "string",
- "description": "Actor query information"
+ "description": "Worker query information"
},
"required": true,
"name": "X-AC-Query",
@@ -191,7 +191,7 @@
}
}
},
- "/actors/actions/{action}": {
+ "/workers/actions/{action}": {
"post": {
"parameters": [
{
@@ -252,17 +252,17 @@
}
}
},
- "/actors/message": {
+ "/workers/message": {
"post": {
"parameters": [
{
"schema": {
"type": "string",
- "description": "Actor ID (used in some endpoints)",
- "example": "actor-123456"
+ "description": "Worker ID (used in some endpoints)",
+ "example": "worker-123456"
},
"required": true,
- "name": "X-AC-Actor",
+ "name": "X-AC-Worker",
"in": "header"
},
{
diff --git a/docs/platforms/bun.mdx b/docs/platforms/bun.mdx
index f3f57db41..a6dab0475 100644
--- a/docs/platforms/bun.mdx
+++ b/docs/platforms/bun.mdx
@@ -30,7 +30,7 @@ Bun provides a fast runtime environment for running RivetKit, with excellent per
```typescript src/index.ts
import { serve } from "@rivetkit/bun";
- import { app } from "../actors/app";
+ import { app } from "../workers/app";
// Start the server with file-system driver (default)
serve(app);
diff --git a/docs/platforms/cloudflare-workers.mdx b/docs/platforms/cloudflare-workers.mdx
index 40eee56b8..4077975f6 100644
--- a/docs/platforms/cloudflare-workers.mdx
+++ b/docs/platforms/cloudflare-workers.mdx
@@ -45,21 +45,21 @@ The Cloudflare Workers platform with Durable Objects provides a robust environme
```typescript src/index.ts
import { createHandler } from "@rivetkit/cloudflare-workers";
- import { app } from "../actors/app";
+ import { app } from "../workers/app";
// Create handlers for Cloudflare Workers
- const { handler, ActorHandler } = createHandler(app);
+ const { handler, WorkerHandler } = createHandler(app);
// Export the handlers for Cloudflare
- export { handler as default, ActorHandler };
+ export { handler as default, WorkerHandler };
```
- Create a KV namespace for your actors:
+ Create a KV namespace for your workers:
```sh
- npx wrangler kv:namespace create ACTOR_KV
+ npx wrangler kv:namespace create WORKER_KV
```
Take note of the KV namespace ID from the output, as you'll need it in the next step.
@@ -80,20 +80,20 @@ The Cloudflare Workers platform with Durable Objects provides a robust environme
"migrations": [
{
"tag": "v1",
- "new_classes": ["ActorHandler"]
+ "new_classes": ["WorkerHandler"]
}
],
"durable_objects": {
"bindings": [
{
- "name": "ACTOR_DO",
- "class_name": "ActorHandler"
+ "name": "WORKER_DO",
+ "class_name": "WorkerHandler"
}
]
},
"kv_namespaces": [
{
- "binding": "ACTOR_KV",
+ "binding": "WORKER_KV",
"id": "your-namespace-id-here" // Replace with your actual ID
}
]
@@ -118,12 +118,12 @@ The Cloudflare Workers platform with Durable Objects provides a robust environme
## Accessing Cloudflare Context And Bindings
-You can access Cloudflare-specific features like the [DurableObjectState](https://developers.cloudflare.com/durable-objects/api/state/) and environment bindings from your actor:
+You can access Cloudflare-specific features like the [DurableObjectState](https://developers.cloudflare.com/durable-objects/api/state/) and environment bindings from your worker:
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
-const myActor = actor({
+const myWorker = worker({
// Load Cloudflare-specific variables
createVars: (c, cloudflare) => ({
ctx: cloudflare.ctx,
diff --git a/docs/platforms/nodejs.mdx b/docs/platforms/nodejs.mdx
index a943d8d15..768beca7e 100644
--- a/docs/platforms/nodejs.mdx
+++ b/docs/platforms/nodejs.mdx
@@ -44,7 +44,7 @@ Node.js provides a robust environment for running RivetKit, ideal for developmen
```typescript src/index.ts
import { serve } from "@rivetkit/nodejs";
- import { app } from "../actors/app";
+ import { app } from "../workers/app";
// Start the server with file-system driver (default)
serve(app);
diff --git a/docs/platforms/rivet.mdx b/docs/platforms/rivet.mdx
index 6bdaa70ee..0f1519d52 100644
--- a/docs/platforms/rivet.mdx
+++ b/docs/platforms/rivet.mdx
@@ -44,19 +44,19 @@ Rivet provides a fully managed cloud service for running RivetKit, with automati
```sh npm
- npx rivetkit/cli@latest deploy rivet actors/app.ts
+ npx rivetkit/cli@latest deploy rivet workers/app.ts
```
```sh pnpm
- pnpm exec rivetkit/cli@latest deploy rivet actors/app.ts
+ pnpm exec rivetkit/cli@latest deploy rivet workers/app.ts
```
```sh yarn
- yarn rivetkit/cli@latest deploy rivet actors/app.ts
+ yarn rivetkit/cli@latest deploy rivet workers/app.ts
```
```sh bun
- bunx rivetkit/cli@latest deploy rivet actors/app.ts
+ bunx rivetkit/cli@latest deploy rivet workers/app.ts
```
@@ -76,19 +76,19 @@ Rivet provides a fully managed cloud service for running RivetKit, with automati
## Accessing Rivet Context
-[Rivet's `ActorContext`](https://rivet.gg/docs/javascript-runtime#the-actor-context-object) can be accessed from `createVars`.
+[Rivet's `WorkerContext`](https://rivet.gg/docs/javascript-runtime#the-worker-context-object) can be accessed from `createVars`.
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
-const myActor = actor({
+const myWorker = worker({
// Load Rivet-specific variables
createVars: (c, rivet) => ({
rivet: rivet.ctx,
}),
actions: {
foo: async (c) => {
- // Access ActorContext
+ // Access WorkerContext
c.log.info(`Region: ${c.vars.rivet.metadata.region.name}`);
await c.vars.rivet.kv.get("foo");
},
@@ -98,7 +98,7 @@ const myActor = actor({
## Available Regions
-Rivet supports deploying your actors to multiple regions automatically. You can specify region preferences in your Rivet project settings in the Rivet Hub.
+Rivet supports deploying your workers to multiple regions automatically. You can specify region preferences in your Rivet project settings in the Rivet Hub.
See available regions [here](https://rivet.gg/docs/regions).
diff --git a/docs/snippets/cloudflare-deploy.mdx b/docs/snippets/cloudflare-deploy.mdx
index 6970b4a64..8bcadcf5d 100644
--- a/docs/snippets/cloudflare-deploy.mdx
+++ b/docs/snippets/cloudflare-deploy.mdx
@@ -1,7 +1,7 @@
1. Create a new KV namespace with:
```sh
- npx wrangler kv namespace create ACTOR_KV
+ npx wrangler kv namespace create WORKER_KV
```
2. After creating the KV namespace, you will receive an ID. Update your `wrangler.json` file by replacing the placeholder in the `kv_namespaces` section with this ID. It should look like this:
@@ -10,7 +10,7 @@
{
"kv_namespaces": [
{
- "binding": "ACTOR_KV",
+ "binding": "WORKER_KV",
"id": "your-namespace-id-here" // Replace with your actual ID
}
]
@@ -27,7 +27,7 @@
4. Update `tests/client.ts` (or wherever your client lives) to use the deployed endpoint. Replace the local endpoint in `client.ts` with your Cloudflare Workers URL:
```typescript
- import { createClient } from "@rivetkit/actor/client";
+ import { createClient } from "rivetkit/client";
import type { App } from "../src/index";
const client = createClient("https://your-worker-subdomain.workers.dev");
diff --git a/docs/snippets/create-actor-cli.mdx b/docs/snippets/create-actor-cli.mdx
index 65366ec96..07fac8b22 100644
--- a/docs/snippets/create-actor-cli.mdx
+++ b/docs/snippets/create-actor-cli.mdx
@@ -1,21 +1,21 @@
```sh npx
-npx create-actor@latest
+npx create-worker@latest
```
```sh npm
-npm create actor@latest
+npm create worker@latest
```
```sh pnpm
-pnpm create actor@latest
+pnpm create worker@latest
```
```sh yarn
-yarn create actor@latest
+yarn create worker@latest
```
```sh bun
-bun create actor@latest
+bun create worker@latest
```
diff --git a/docs/snippets/examples/ai-agent-js.mdx b/docs/snippets/examples/ai-agent-js.mdx
index 0df15dec8..a93bafad4 100644
--- a/docs/snippets/examples/ai-agent-js.mdx
+++ b/docs/snippets/examples/ai-agent-js.mdx
@@ -1,12 +1,12 @@
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
import { generateText, tool } from "ai";
import { openai } from "@ai-sdk/openai";
import { getWeather } from "./my-utils";
export type Message = { role: "user" | "assistant"; content: string; timestamp: number; }
-const aiAgent = actor({
+const aiAgent = worker({
// State is automatically persisted
state: {
messages: [] as Message[]
diff --git a/docs/snippets/examples/ai-agent-react.mdx b/docs/snippets/examples/ai-agent-react.mdx
index 27c0bf127..688bc0fe7 100644
--- a/docs/snippets/examples/ai-agent-react.mdx
+++ b/docs/snippets/examples/ai-agent-react.mdx
@@ -1,42 +1,42 @@
```typescript
-import { createClient } from "@rivetkit/actor/client";
+import { createClient } from "rivetkit/client";
import { createReactRivetKit } from "@rivetkit/react";
import { useState, useEffect } from "react";
-import type { App } from "../actors/app";
-import type { Message } from "./actor";
+import type { App } from "../workers/app";
+import type { Message } from "./worker";
const client = createClient("http://localhost:6420");
-const { useActor, useActorEvent } = createReactRivetKit(client);
+const { useWorker, useWorkerEvent } = createReactRivetKit(client);
export function AIAssistant() {
- const [{ actor }] = useActor("aiAgent", { tags: { conversationId: "default" } });
+ const [{ worker }] = useWorker("aiAgent", { tags: { conversationId: "default" } });
const [messages, setMessages] = useState([]);
const [input, setInput] = useState("");
const [isLoading, setIsLoading] = useState(false);
// Load initial messages
useEffect(() => {
- if (actor) {
- actor.getMessages().then(setMessages);
+ if (worker) {
+ worker.getMessages().then(setMessages);
}
- }, [actor]);
+ }, [worker]);
// Listen for real-time messages
- useActorEvent({ actor, event: "messageReceived" }, (message) => {
+ useWorkerEvent({ worker, event: "messageReceived" }, (message) => {
setMessages(prev => [...prev, message as Message]);
setIsLoading(false);
});
const handleSendMessage = async () => {
- if (actor && input.trim()) {
+ if (worker && input.trim()) {
setIsLoading(true);
// Add user message to UI immediately
const userMessage = { role: "user", content: input } as Message;
setMessages(prev => [...prev, userMessage]);
- // Send to actor (AI response will come through the event)
- await actor.sendMessage(input);
+ // Send to worker (AI response will come through the event)
+ await worker.sendMessage(input);
setInput("");
}
};
diff --git a/docs/snippets/examples/ai-agent-sqlite.mdx b/docs/snippets/examples/ai-agent-sqlite.mdx
index 47f40aab4..eda07de22 100644
--- a/docs/snippets/examples/ai-agent-sqlite.mdx
+++ b/docs/snippets/examples/ai-agent-sqlite.mdx
@@ -1,5 +1,5 @@
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
import { drizzle } from "@rivetkit/drizzle";
import { generateText, tool } from "ai";
import { openai } from "@ai-sdk/openai";
@@ -8,7 +8,7 @@ import { messages } from "./schema";
export type Message = { role: "user" | "assistant"; content: string; timestamp: number; }
-const aiAgent = actor({
+const aiAgent = worker({
sql: drizzle(),
actions: {
@@ -28,7 +28,7 @@ const aiAgent = actor({
// Add user message to conversation
const userMsg = {
- conversationId: c.actorId, // Use the actor instance ID
+ conversationId: c.workerId, // Use the worker instance ID
role: "user",
content: userMessage,
};
diff --git a/docs/snippets/examples/chat-room-js.mdx b/docs/snippets/examples/chat-room-js.mdx
index bb5954580..e8db01eb3 100644
--- a/docs/snippets/examples/chat-room-js.mdx
+++ b/docs/snippets/examples/chat-room-js.mdx
@@ -1,9 +1,9 @@
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
export type Message = { sender: string; text: string; timestamp: number; }
-const chatRoom = actor({
+const chatRoom = worker({
// State is automatically persisted
state: {
messages: [] as Message[]
diff --git a/docs/snippets/examples/chat-room-react.mdx b/docs/snippets/examples/chat-room-react.mdx
index 36909e89d..78d516c22 100644
--- a/docs/snippets/examples/chat-room-react.mdx
+++ b/docs/snippets/examples/chat-room-react.mdx
@@ -1,16 +1,16 @@
```typescript
-import { createClient } from "@rivetkit/actor/client";
+import { createClient } from "rivetkit/client";
import { createReactRivetKit } from "@rivetkit/react";
import { useState, useEffect } from "react";
-import type { App } from "../actors/app";
-import type { Message } from "./actor";
+import type { App } from "../workers/app";
+import type { Message } from "./worker";
const client = createClient("http://localhost:6420");
-const { useActor, useActorEvent } = createReactRivetKit(client);
+const { useWorker, useWorkerEvent } = createReactRivetKit(client);
export function ChatRoom({ roomId = "general" }) {
// Connect to specific chat room using tags
- const [{ actor }] = useActor("chatRoom", {
+ const [{ worker }] = useWorker("chatRoom", {
tags: { roomId }
});
@@ -19,20 +19,20 @@ export function ChatRoom({ roomId = "general" }) {
// Load initial state
useEffect(() => {
- if (actor) {
+ if (worker) {
// Load chat history
- actor.getHistory().then(setMessages);
+ worker.getHistory().then(setMessages);
}
- }, [actor]);
+ }, [worker]);
// Listen for real-time updates from the server
- useActorEvent({ actor, event: "newMessage" }, (message) => {
+ useWorkerEvent({ worker, event: "newMessage" }, (message) => {
setMessages(prev => [...prev, message]);
});
const sendMessage = () => {
- if (actor && input.trim()) {
- actor.sendMessage("User", input);
+ if (worker && input.trim()) {
+ worker.sendMessage("User", input);
setInput("");
}
};
diff --git a/docs/snippets/examples/chat-room-sqlite.mdx b/docs/snippets/examples/chat-room-sqlite.mdx
index c44b8e33e..38c9c7c38 100644
--- a/docs/snippets/examples/chat-room-sqlite.mdx
+++ b/docs/snippets/examples/chat-room-sqlite.mdx
@@ -1,11 +1,11 @@
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
import { drizzle } from "@rivetkit/drizzle";
import { messages } from "./schema";
export type Message = { sender: string; text: string; timestamp: number; }
-const chatRoom = actor({
+const chatRoom = worker({
sql: drizzle(),
actions: {
diff --git a/docs/snippets/examples/crdt-js.mdx b/docs/snippets/examples/crdt-js.mdx
index 1a3494a73..6614d2d45 100644
--- a/docs/snippets/examples/crdt-js.mdx
+++ b/docs/snippets/examples/crdt-js.mdx
@@ -1,9 +1,9 @@
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
import * as Y from 'yjs';
import { encodeStateAsUpdate, applyUpdate } from 'yjs';
-const yjsDocument = actor({
+const yjsDocument = worker({
// State: just the serialized Yjs document data
state: {
docData: "", // Base64 encoded Yjs document
@@ -15,7 +15,7 @@ const yjsDocument = actor({
doc: new Y.Doc()
}),
- // Initialize document from state when actor starts
+ // Initialize document from state when worker starts
onStart: (c) => {
if (c.state.docData) {
const binary = atob(c.state.docData);
diff --git a/docs/snippets/examples/crdt-react.mdx b/docs/snippets/examples/crdt-react.mdx
index f682c2302..4ff9677cd 100644
--- a/docs/snippets/examples/crdt-react.mdx
+++ b/docs/snippets/examples/crdt-react.mdx
@@ -1,17 +1,17 @@
```typescript
-import { createClient } from "@rivetkit/actor/client";
+import { createClient } from "rivetkit/client";
import { createReactRivetKit } from "@rivetkit/react";
import { useState, useEffect, useRef } from "react";
import * as Y from 'yjs';
import { applyUpdate, encodeStateAsUpdate } from 'yjs';
-import type { App } from "../actors/app";
+import type { App } from "../workers/app";
const client = createClient("http://localhost:6420");
-const { useActor, useActorEvent } = createReactRivetKit(client);
+const { useWorker, useWorkerEvent } = createReactRivetKit(client);
export function YjsEditor({ documentId = "shared-doc" }) {
// Connect to specific document using tags
- const { actor } = useActor("yjsDocument", {
+ const { worker } = useWorker("yjsDocument", {
tags: { documentId }
});
@@ -38,7 +38,7 @@ export function YjsEditor({ documentId = "shared-doc" }) {
// Clean up Yjs document
yDoc.destroy();
};
- }, [actor]);
+ }, [worker]);
// Set up text observation
useEffect(() => {
@@ -55,14 +55,14 @@ export function YjsEditor({ documentId = "shared-doc" }) {
// Update React state
setText(yText.toString());
- if (actor && !updatingFromLocal.current) {
+ if (worker && !updatingFromLocal.current) {
// Set flag to prevent loops
updatingFromLocal.current = true;
// Convert update to base64 and send to server
const update = encodeStateAsUpdate(yDoc);
const base64 = bufferToBase64(update);
- actor.applyUpdate(base64).finally(() => {
+ worker.applyUpdate(base64).finally(() => {
updatingFromLocal.current = false;
});
}
@@ -70,10 +70,10 @@ export function YjsEditor({ documentId = "shared-doc" }) {
});
observationInitialized.current = true;
- }, [actor]);
+ }, [worker]);
// Handle initial state from server
- useActorEvent({ actor, event: "initialState" }, ({ update }) => {
+ useWorkerEvent({ worker, event: "initialState" }, ({ update }) => {
const yDoc = yDocRef.current;
if (!yDoc) return;
@@ -102,7 +102,7 @@ export function YjsEditor({ documentId = "shared-doc" }) {
});
// Handle updates from other clients
- useActorEvent({ actor, event: "update" }, ({ update }) => {
+ useWorkerEvent({ worker, event: "update" }, ({ update }) => {
const yDoc = yDocRef.current;
if (!yDoc) return;
diff --git a/docs/snippets/examples/crdt-sqlite.mdx b/docs/snippets/examples/crdt-sqlite.mdx
index 293e1f969..0e871bfba 100644
--- a/docs/snippets/examples/crdt-sqlite.mdx
+++ b/docs/snippets/examples/crdt-sqlite.mdx
@@ -1,11 +1,11 @@
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
import { drizzle } from "@rivetkit/drizzle";
import * as Y from 'yjs';
import { encodeStateAsUpdate, applyUpdate } from 'yjs';
import { documents } from "./schema";
-const yjsDocument = actor({
+const yjsDocument = worker({
sql: drizzle(),
// In-memory Yjs objects (not serialized)
@@ -13,7 +13,7 @@ const yjsDocument = actor({
doc: new Y.Doc()
}),
- // Initialize document from state when actor starts
+ // Initialize document from state when worker starts
onStart: async (c) => {
// Get document data from database
const documentData = await c.db
diff --git a/docs/snippets/examples/database-js.mdx b/docs/snippets/examples/database-js.mdx
index 0e9355073..445ee338c 100644
--- a/docs/snippets/examples/database-js.mdx
+++ b/docs/snippets/examples/database-js.mdx
@@ -1,11 +1,11 @@
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
import { authenticate } from "./my-utils";
export type Note = { id: string; content: string; updatedAt: number };
-// User notes actor
-const notes = actor({
+// User notes worker
+const notes = worker({
state: {
notes: [] as Note[]
},
diff --git a/docs/snippets/examples/database-react.mdx b/docs/snippets/examples/database-react.mdx
index 9238bb68a..da06385fc 100644
--- a/docs/snippets/examples/database-react.mdx
+++ b/docs/snippets/examples/database-react.mdx
@@ -1,54 +1,54 @@
```typescript
-import { createClient } from "@rivetkit/actor/client";
+import { createClient } from "rivetkit/client";
import { createReactRivetKit } from "@rivetkit/react";
import { useState, useEffect } from "react";
const client = createClient("http://localhost:6420");
-const { useActor, useActorEvent } = createReactRivetKit(client);
+const { useWorker, useWorkerEvent } = createReactRivetKit(client);
export function NotesApp({ userId }: { userId: string }) {
const [notes, setNotes] = useState>([]);
const [newNote, setNewNote] = useState("");
- // Connect to actor with auth token
- const [{ actor }] = useActor("notes", {
+ // Connect to worker with auth token
+ const [{ worker }] = useWorker("notes", {
params: { userId, token: "demo-token" }
});
// Load initial notes
useEffect(() => {
- if (actor) {
- actor.getNotes().then(setNotes);
+ if (worker) {
+ worker.getNotes().then(setNotes);
}
- }, [actor]);
+ }, [worker]);
// Add a new note
const addNote = async () => {
- if (actor && newNote.trim()) {
- await actor.updateNote({ id: `note-${Date.now()}`, content: newNote });
+ if (worker && newNote.trim()) {
+ await worker.updateNote({ id: `note-${Date.now()}`, content: newNote });
setNewNote("");
}
};
// Delete a note
const deleteNote = (id: string) => {
- if (actor) {
- actor.deleteNote({ id });
+ if (worker) {
+ worker.deleteNote({ id });
}
};
// Listen for realtime updates
- useActorEvent({ actor, event: "noteAdded" }, (note) => {
+ useWorkerEvent({ worker, event: "noteAdded" }, (note) => {
setNotes(notes => [...notes, note]);
});
- useActorEvent({ actor, event: "noteUpdated" }, (updatedNote) => {
+ useWorkerEvent({ worker, event: "noteUpdated" }, (updatedNote) => {
setNotes(notes => notes.map(note =>
note.id === updatedNote.id ? updatedNote : note
));
});
- useActorEvent({ actor, event: "noteDeleted" }, ({ id }) => {
+ useWorkerEvent({ worker, event: "noteDeleted" }, ({ id }) => {
setNotes(notes => notes.filter(note => note.id !== id));
});
diff --git a/docs/snippets/examples/database-sqlite.mdx b/docs/snippets/examples/database-sqlite.mdx
index 5866a9185..84d9ab000 100644
--- a/docs/snippets/examples/database-sqlite.mdx
+++ b/docs/snippets/examples/database-sqlite.mdx
@@ -1,13 +1,13 @@
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
import { drizzle } from "@rivetkit/drizzle";
import { notes } from "./schema";
import { authenticate } from "./my-utils";
export type Note = { id: string; content: string; updatedAt: number };
-// User notes actor
-const userNotes = actor({
+// User notes worker
+const userNotes = worker({
sql: drizzle(),
// Authenticate
diff --git a/docs/snippets/examples/document-js.mdx b/docs/snippets/examples/document-js.mdx
index bb5147394..410601e27 100644
--- a/docs/snippets/examples/document-js.mdx
+++ b/docs/snippets/examples/document-js.mdx
@@ -1,9 +1,9 @@
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
export type Cursor = { x: number, y: number, userId: string };
-const document = actor({
+const document = worker({
state: {
text: "",
cursors: {} as Record,
diff --git a/docs/snippets/examples/document-react.mdx b/docs/snippets/examples/document-react.mdx
index eb908969e..b845b1868 100644
--- a/docs/snippets/examples/document-react.mdx
+++ b/docs/snippets/examples/document-react.mdx
@@ -1,16 +1,16 @@
```typescript
-import { createClient } from "@rivetkit/actor/client";
+import { createClient } from "rivetkit/client";
import { createReactRivetKit } from "@rivetkit/react";
import { useState, useEffect } from "react";
-import type { App } from "../actors/app";
+import type { App } from "../workers/app";
const client = createClient("http://localhost:6420");
-const { useActor, useActorEvent } = createReactRivetKit(client);
+const { useWorker, useWorkerEvent } = createReactRivetKit(client);
export function DocumentEditor() {
- // Connect to actor for this document ID from URL
+ // Connect to worker for this document ID from URL
const documentId = new URLSearchParams(window.location.search).get('id') || 'default-doc';
- const [{ actor, connectionId }] = useActor("document", { tags: { id: documentId } });
+ const [{ worker, connectionId }] = useWorker("document", { tags: { id: documentId } });
// Local state
const [text, setText] = useState("");
@@ -19,18 +19,18 @@ export function DocumentEditor() {
// Load initial document state
useEffect(() => {
- if (actor) {
- actor.getText().then(setText);
- actor.getCursors().then(setOtherCursors);
+ if (worker) {
+ worker.getText().then(setText);
+ worker.getCursors().then(setOtherCursors);
}
- }, [actor]);
+ }, [worker]);
// Listen for updates from other users
- useActorEvent({ actor, event: "textUpdated" }, ({ text: newText, userId: senderId }) => {
+ useWorkerEvent({ worker, event: "textUpdated" }, ({ text: newText, userId: senderId }) => {
if (senderId !== connectionId) setText(newText);
});
- useActorEvent({ actor, event: "cursorUpdated" }, ({ userId: cursorUserId, x, y }) => {
+ useWorkerEvent({ worker, event: "cursorUpdated" }, ({ userId: cursorUserId, x, y }) => {
if (cursorUserId !== connectionId) {
setOtherCursors(prev => ({
...prev,
@@ -41,14 +41,14 @@ export function DocumentEditor() {
// Update cursor position
const updateCursor = (e) => {
- if (!actor) return;
+ if (!worker) return;
const rect = e.currentTarget.getBoundingClientRect();
const x = e.clientX - rect.left;
const y = e.clientY - rect.top;
if (x !== cursorPos.x || y !== cursorPos.y) {
setCursorPos({ x, y });
- actor.updateCursor(x, y);
+ worker.updateCursor(x, y);
}
};
@@ -62,7 +62,7 @@ export function DocumentEditor() {
onChange={(e) => {
const newText = e.target.value;
setText(newText);
- actor?.setText(newText);
+ worker?.setText(newText);
}}
placeholder="Start typing..."
/>
diff --git a/docs/snippets/examples/document-sqlite.mdx b/docs/snippets/examples/document-sqlite.mdx
index 194a5c0fd..3ff14b120 100644
--- a/docs/snippets/examples/document-sqlite.mdx
+++ b/docs/snippets/examples/document-sqlite.mdx
@@ -1,11 +1,11 @@
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
import { drizzle } from "@rivetkit/drizzle";
import { documents, cursors } from "./schema";
export type Cursor = { x: number, y: number, userId: string };
-const document = actor({
+const document = worker({
sql: drizzle(),
actions: {
diff --git a/docs/snippets/examples/game-js.mdx b/docs/snippets/examples/game-js.mdx
index 903224947..73887a79b 100644
--- a/docs/snippets/examples/game-js.mdx
+++ b/docs/snippets/examples/game-js.mdx
@@ -1,11 +1,11 @@
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
export type Position = { x: number; y: number };
export type Input = { x: number; y: number };
export type Player = { id: string; position: Position; input: Input };
-const gameRoom = actor({
+const gameRoom = worker({
state: {
players: {} as Record,
mapSize: 800
diff --git a/docs/snippets/examples/game-react.mdx b/docs/snippets/examples/game-react.mdx
index 8aa3db942..cbbc97329 100644
--- a/docs/snippets/examples/game-react.mdx
+++ b/docs/snippets/examples/game-react.mdx
@@ -1,21 +1,21 @@
```tsx
-import { createClient } from "@rivetkit/actor/client";
+import { createClient } from "rivetkit/client";
import { createReactRivetKit } from "@rivetkit/react";
import { useState, useEffect, useRef } from "react";
-import type { Player } from "./actor";
+import type { Player } from "./worker";
const client = createClient("http://localhost:6420");
-const { useActor, useActorEvent } = createReactRivetKit(client);
+const { useWorker, useWorkerEvent } = createReactRivetKit(client);
export function MultiplayerGame() {
- const [{ actor, connectionId }] = useActor("gameRoom");
+ const [{ worker, connectionId }] = useWorker("gameRoom");
const [players, setPlayers] = useState([]);
const canvasRef = useRef(null);
const keysPressed = useRef>({});
// Set up game
useEffect(() => {
- if (!actor) return;
+ if (!worker) return;
// Set up keyboard handlers
const handleKeyDown = (e: KeyboardEvent) => {
@@ -38,7 +38,7 @@ export function MultiplayerGame() {
if (keysPressed.current["a"] || keysPressed.current["arrowleft"]) input.x = -1;
if (keysPressed.current["d"] || keysPressed.current["arrowright"]) input.x = 1;
- actor.setInput(input);
+ worker.setInput(input);
}, 50);
// Rendering loop
@@ -71,10 +71,10 @@ export function MultiplayerGame() {
clearInterval(inputInterval);
cancelAnimationFrame(animationId);
};
- }, [actor, connectionId, players]);
+ }, [worker, connectionId, players]);
// Listen for world updates
- useActorEvent({ actor, event: "worldUpdate" }, ({ players: updatedPlayers }) => {
+ useWorkerEvent({ worker, event: "worldUpdate" }, ({ players: updatedPlayers }) => {
setPlayers(updatedPlayers);
});
diff --git a/docs/snippets/examples/game-sqlite.mdx b/docs/snippets/examples/game-sqlite.mdx
index 0898cefdf..c1f77b3f8 100644
--- a/docs/snippets/examples/game-sqlite.mdx
+++ b/docs/snippets/examples/game-sqlite.mdx
@@ -1,5 +1,5 @@
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
import { drizzle } from "@rivetkit/drizzle";
import { players, gameSettings } from "./schema";
@@ -7,7 +7,7 @@ export type Position = { x: number; y: number };
export type Input = { x: number; y: number };
export type Player = { id: string; position: Position; input: Input };
-const gameRoom = actor({
+const gameRoom = worker({
sql: drizzle(),
// Store game settings and player inputs in memory for performance
diff --git a/docs/snippets/examples/rate-js.mdx b/docs/snippets/examples/rate-js.mdx
index f190355c3..906cea57f 100644
--- a/docs/snippets/examples/rate-js.mdx
+++ b/docs/snippets/examples/rate-js.mdx
@@ -1,8 +1,8 @@
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
// Simple rate limiter - allows 5 requests per minute
-const rateLimiter = actor({
+const rateLimiter = worker({
state: {
count: 0,
resetAt: 0
diff --git a/docs/snippets/examples/rate-react.mdx b/docs/snippets/examples/rate-react.mdx
index 191667769..3a097c4b6 100644
--- a/docs/snippets/examples/rate-react.mdx
+++ b/docs/snippets/examples/rate-react.mdx
@@ -1,15 +1,15 @@
```typescript
-import { createClient } from "@rivetkit/actor/client";
+import { createClient } from "rivetkit/client";
import { createReactRivetKit } from "@rivetkit/react";
import { useState } from "react";
-import type { App } from "../actors/app";
+import type { App } from "../workers/app";
const client = createClient("http://localhost:6420");
-const { useActor } = createReactRivetKit(client);
+const { useWorker } = createReactRivetKit(client);
export function RateLimiter() {
// Connect to API rate limiter for user-123
- const [{ actor }] = useActor("rateLimiter", { tags: { userId: "user-123" } });
+ const [{ worker }] = useWorker("rateLimiter", { tags: { userId: "user-123" } });
const [result, setResult] = useState<{
allowed: boolean;
remaining: number;
@@ -18,9 +18,9 @@ export function RateLimiter() {
// Make a request
const makeRequest = async () => {
- if (!actor) return;
+ if (!worker) return;
- const response = await actor.checkLimit();
+ const response = await worker.checkLimit();
setResult(response);
};
diff --git a/docs/snippets/examples/rate-sqlite.mdx b/docs/snippets/examples/rate-sqlite.mdx
index a4e73bf09..501a45e74 100644
--- a/docs/snippets/examples/rate-sqlite.mdx
+++ b/docs/snippets/examples/rate-sqlite.mdx
@@ -1,10 +1,10 @@
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
import { drizzle } from "@rivetkit/drizzle";
import { limiters } from "./schema";
// Simple rate limiter - allows 5 requests per minute
-const rateLimiter = actor({
+const rateLimiter = worker({
sql: drizzle(),
actions: {
diff --git a/docs/snippets/examples/stream-js.mdx b/docs/snippets/examples/stream-js.mdx
index 924e3be38..a2ec818ca 100644
--- a/docs/snippets/examples/stream-js.mdx
+++ b/docs/snippets/examples/stream-js.mdx
@@ -1,12 +1,12 @@
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
export type StreamState = {
topValues: number[];
};
// Simple top-K stream processor example
-const streamProcessor = actor({
+const streamProcessor = worker({
state: {
topValues: [] as number[]
},
diff --git a/docs/snippets/examples/stream-react.mdx b/docs/snippets/examples/stream-react.mdx
index c63da07c8..c2a1daedd 100644
--- a/docs/snippets/examples/stream-react.mdx
+++ b/docs/snippets/examples/stream-react.mdx
@@ -1,34 +1,34 @@
```typescript
-import { createClient } from "@rivetkit/actor/client";
+import { createClient } from "rivetkit/client";
import { createReactRivetKit } from "@rivetkit/react";
import { useState, useEffect } from "react";
-import type { App } from "../actors/app";
-import type { StreamState } from "./actor"; // Import shared types from actor
+import type { App } from "../workers/app";
+import type { StreamState } from "./worker"; // Import shared types from worker
const client = createClient("http://localhost:6420");
-const { useActor, useActorEvent } = createReactRivetKit(client);
+const { useWorker, useWorkerEvent } = createReactRivetKit(client);
export function StreamExample() {
- const [{ actor }] = useActor("streamProcessor");
+ const [{ worker }] = useWorker("streamProcessor");
const [topValues, setTopValues] = useState([]);
const [newValue, setNewValue] = useState(0);
// Load initial values
useEffect(() => {
- if (actor) {
- actor.getTopValues().then(setTopValues);
+ if (worker) {
+ worker.getTopValues().then(setTopValues);
}
- }, [actor]);
+ }, [worker]);
// Listen for updates from other clients
- useActorEvent({ actor, event: "updated" }, ({ topValues }) => {
+ useWorkerEvent({ worker, event: "updated" }, ({ topValues }) => {
setTopValues(topValues);
});
// Add a new value to the stream
const handleAddValue = () => {
- if (actor) {
- actor.addValue(newValue).then(setTopValues);
+ if (worker) {
+ worker.addValue(newValue).then(setTopValues);
setNewValue(0);
}
};
diff --git a/docs/snippets/examples/stream-sqlite.mdx b/docs/snippets/examples/stream-sqlite.mdx
index a2b7dc532..699913ad4 100644
--- a/docs/snippets/examples/stream-sqlite.mdx
+++ b/docs/snippets/examples/stream-sqlite.mdx
@@ -1,12 +1,12 @@
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
import { drizzle } from "@rivetkit/drizzle";
import { streams, streamValues } from "./schema";
export type StreamState = { topValues: number[]; };
// Simple top-K stream processor example
-const streamProcessor = actor({
+const streamProcessor = worker({
sql: drizzle(),
actions: {
diff --git a/docs/snippets/examples/sync-js.mdx b/docs/snippets/examples/sync-js.mdx
index 6bd859afd..e785111d5 100644
--- a/docs/snippets/examples/sync-js.mdx
+++ b/docs/snippets/examples/sync-js.mdx
@@ -1,9 +1,9 @@
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
export type Contact = { id: string; name: string; email: string; phone: string; updatedAt: number; }
-const contacts = actor({
+const contacts = worker({
// State is automatically persisted
state: {
contacts: {}
diff --git a/docs/snippets/examples/sync-react.mdx b/docs/snippets/examples/sync-react.mdx
index 93bf276bf..33f521e8b 100644
--- a/docs/snippets/examples/sync-react.mdx
+++ b/docs/snippets/examples/sync-react.mdx
@@ -1,14 +1,14 @@
```tsx
-import { createClient } from "@rivetkit/actor/client";
+import { createClient } from "rivetkit/client";
import { createReactRivetKit } from "@rivetkit/react";
import { useState, useEffect, useRef } from "react";
-import type { Contact } from "./actor";
+import type { Contact } from "./worker";
const client = createClient("http://localhost:6420");
-const { useActor, useActorEvent } = createReactRivetKit(client);
+const { useWorker, useWorkerEvent } = createReactRivetKit(client);
export function ContactsApp() {
- const { actor } = useActor("contacts");
+ const { worker } = useWorker("contacts");
const [contacts, setContacts] = useState([]);
const [name, setName] = useState("");
const [email, setEmail] = useState("");
@@ -19,17 +19,17 @@ export function ContactsApp() {
// Load initial contacts
useEffect(() => {
- if (!actor) return;
+ if (!worker) return;
- actor.getChanges(0).then(data => {
+ worker.getChanges(0).then(data => {
setContacts(data.changes);
lastSyncTime.current = data.timestamp;
setSyncStatus("Synced");
});
- }, [actor]);
+ }, [worker]);
// Handle contact events
- useActorEvent({ actor, event: "contactsChanged" }, ({ contacts: updatedContacts }) => {
+ useWorkerEvent({ worker, event: "contactsChanged" }, ({ contacts: updatedContacts }) => {
setContacts(prev => {
const contactMap = new Map(prev.map(c => [c.id, c]));
@@ -46,14 +46,14 @@ export function ContactsApp() {
// Sync periodically
useEffect(() => {
- if (!actor) return;
+ if (!worker) return;
const sync = async () => {
setSyncStatus("Syncing...");
try {
// Get remote changes
- const changes = await actor.getChanges(lastSyncTime.current);
+ const changes = await worker.getChanges(lastSyncTime.current);
// Apply remote changes
if (changes.changes.length > 0) {
@@ -74,7 +74,7 @@ export function ContactsApp() {
// Push local changes
const localChanges = contacts.filter(c => c.updatedAt > lastSyncTime.current);
if (localChanges.length > 0) {
- await actor.pushChanges(localChanges);
+ await worker.pushChanges(localChanges);
}
lastSyncTime.current = changes.timestamp;
@@ -87,7 +87,7 @@ export function ContactsApp() {
const intervalId = setInterval(sync, 5000);
return () => clearInterval(intervalId);
- }, [actor, contacts]);
+ }, [worker, contacts]);
// Add new contact (local first)
const addContact = () => {
@@ -103,8 +103,8 @@ export function ContactsApp() {
setContacts(prev => [...prev, newContact]);
- if (actor) {
- actor.pushChanges([newContact]);
+ if (worker) {
+ worker.pushChanges([newContact]);
}
setName("");
@@ -121,10 +121,10 @@ export function ContactsApp() {
: c
);
- if (actor) {
+ if (worker) {
const deleted = updatedContacts.find(c => c.id === id);
if (deleted) {
- actor.pushChanges([deleted]);
+ worker.pushChanges([deleted]);
}
}
@@ -134,16 +134,16 @@ export function ContactsApp() {
// Manual sync
const handleSync = async () => {
- if (!actor) return;
+ if (!worker) return;
setSyncStatus("Syncing...");
try {
// Push all contacts
- await actor.pushChanges(contacts);
+ await worker.pushChanges(contacts);
// Get all changes
- const changes = await actor.getChanges(0);
+ const changes = await worker.getChanges(0);
setContacts(changes.changes);
lastSyncTime.current = changes.timestamp;
diff --git a/docs/snippets/examples/sync-sqlite.mdx b/docs/snippets/examples/sync-sqlite.mdx
index 86db417d9..17fd0a5b4 100644
--- a/docs/snippets/examples/sync-sqlite.mdx
+++ b/docs/snippets/examples/sync-sqlite.mdx
@@ -1,11 +1,11 @@
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
import { drizzle } from "@rivetkit/drizzle";
import { contacts } from "./schema";
export type Contact = { id: string; name: string; email: string; phone: string; updatedAt: number; }
-const contactSync = actor({
+const contactSync = worker({
sql: drizzle(),
actions: {
diff --git a/docs/snippets/examples/tenant-js.mdx b/docs/snippets/examples/tenant-js.mdx
index c6e13b69e..15036fcfc 100644
--- a/docs/snippets/examples/tenant-js.mdx
+++ b/docs/snippets/examples/tenant-js.mdx
@@ -1,9 +1,9 @@
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
import { authenticate } from "./my-utils";
-// Simple tenant organization actor
-const tenant = actor({
+// Simple tenant organization worker
+const tenant = worker({
// Example initial state
state: {
members: [
diff --git a/docs/snippets/examples/tenant-react.mdx b/docs/snippets/examples/tenant-react.mdx
index e2854cf69..7446fb67f 100644
--- a/docs/snippets/examples/tenant-react.mdx
+++ b/docs/snippets/examples/tenant-react.mdx
@@ -1,12 +1,12 @@
```typescript
-import { createClient } from "@rivetkit/actor/client";
+import { createClient } from "rivetkit/client";
import { createReactRivetKit } from "@rivetkit/react";
import { useState, useEffect } from "react";
-import type { App } from "../actors/app";
+import type { App } from "../workers/app";
// Create client and hooks
const client = createClient("http://localhost:6420");
-const { useActor } = createReactRivetKit(client);
+const { useWorker } = createReactRivetKit(client);
export function OrgDashboard({ orgId }: { orgId: string }) {
// State for data
@@ -26,25 +26,25 @@ export function OrgDashboard({ orgId }: { orgId: string }) {
// Authentication token
const [token, setToken] = useState("");
- // Connect to tenant actor with authentication token
- const [{ actor }] = useActor("tenant", {
+ // Connect to tenant worker with authentication token
+ const [{ worker }] = useWorker("tenant", {
params: { token },
tags: { orgId }
});
- // Load data when actor is available
+ // Load data when worker is available
useEffect(() => {
- if (!actor || !token) return;
+ if (!worker || !token) return;
const loadData = async () => {
try {
// Get members (available to all users)
- const membersList = await actor.getMembers();
+ const membersList = await worker.getMembers();
setMembers(membersList);
// Try to get invoices (only available to admins)
try {
- const invoicesList = await actor.getInvoices();
+ const invoicesList = await worker.getInvoices();
setInvoices(invoicesList);
setError("");
} catch (err: any) {
@@ -56,7 +56,7 @@ export function OrgDashboard({ orgId }: { orgId: string }) {
};
loadData();
- }, [actor, token]);
+ }, [worker, token]);
// Login screen when not authenticated
if (!token) {
diff --git a/docs/snippets/examples/tenant-sqlite.mdx b/docs/snippets/examples/tenant-sqlite.mdx
index 7028524f7..7bc563ad4 100644
--- a/docs/snippets/examples/tenant-sqlite.mdx
+++ b/docs/snippets/examples/tenant-sqlite.mdx
@@ -1,11 +1,11 @@
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
import { drizzle } from "@rivetkit/drizzle";
import { members, invoices } from "./schema";
import { authenticate } from "./my-utils";
-// Simple tenant organization actor
-const tenant = actor({
+// Simple tenant organization worker
+const tenant = worker({
sql: drizzle(),
// Authentication
diff --git a/docs/snippets/landing-comparison-table.mdx b/docs/snippets/landing-comparison-table.mdx
index 4cac8baf8..686785c6f 100644
--- a/docs/snippets/landing-comparison-table.mdx
+++ b/docs/snippets/landing-comparison-table.mdx
@@ -204,7 +204,7 @@
- Define and call functions that interact with your actors
+ Define and call functions that interact with your workers
@@ -21,11 +21,11 @@ import { Icon } from "@/components/Icon";
@@ -78,7 +78,7 @@ import { Icon } from "@/components/Icon";
diff --git a/docs/snippets/landing-manifesto.mdx b/docs/snippets/landing-manifesto.mdx
index 68ba9d51b..d8f185826 100644
--- a/docs/snippets/landing-manifesto.mdx
+++ b/docs/snippets/landing-manifesto.mdx
@@ -4,7 +4,7 @@
Stateful serverless is the future of how applications will be architected.
-
Stateful serverless is very similar to actors: it's essentially actors with persistence, and usually doesn't have as rigid constraints on message handling. This makes it more flexible while maintaining the core benefits of the actor model.
+Stateful serverless is very similar to workers: it's essentially workers with persistence, and usually doesn't have as rigid constraints on message handling. This makes it more flexible while maintaining the core benefits of the worker model.
-
Yes, but only as much as storing data in a single database row does. We're working on building out read replicas to allow you to perform read-only actions on actors.
+Yes, but only as much as storing data in a single database row does. We're working on building out read replicas to allow you to perform read-only actions on workers.
- Startups increasingly build on stateful serverless to ship faster, achieve better performance, and outscale databases like Postgres. The actor model – closely related to stateful serverless – has an established history in frameworks like Elixir, Orleans, and Akka, though these typically involve steep learning curves and complex infrastructure. Cloudflare demonstrates the power of this approach, having built their entire infrastructure – including R2, Workflows, and Queues – on their stateful serverless engine called Durable Objects. + Startups increasingly build on stateful serverless to ship faster, achieve better performance, and outscale databases like Postgres. The worker model – closely related to stateful serverless – has an established history in frameworks like Elixir, Orleans, and Akka, though these typically involve steep learning curves and complex infrastructure. Cloudflare demonstrates the power of this approach, having built their entire infrastructure – including R2, Workflows, and Queues – on their stateful serverless engine called Durable Objects.
With years of experience in gaming infrastructure, we've seen firsthand how the stateful serverless model excels. After building numerous systems like matchmaking, chat, presence, and social networks using stateful serverless, we're convinced it's hands down the best way to build applications. However, the ecosystem lacks accessibility and resources. diff --git a/docs/snippets/landing-snippets.mdx b/docs/snippets/landing-snippets.mdx index 9caddc25b..6de6fe579 100644 --- a/docs/snippets/landing-snippets.mdx +++ b/docs/snippets/landing-snippets.mdx @@ -102,7 +102,7 @@ import RateReact from "/snippets/examples/rate-react.mdx";
- actor.ts
+ worker.ts
Runs on the server
@@ -126,7 +126,7 @@ import RateReact from "/snippets/examples/rate-react.mdx";
- actor.ts
+ worker.ts
Runs on the server
@@ -151,7 +151,7 @@ import RateReact from "/snippets/examples/rate-react.mdx";
- actor.ts
+ worker.ts
Runs on the server
@@ -175,7 +175,7 @@ import RateReact from "/snippets/examples/rate-react.mdx";
- actor.ts
+ worker.ts
Runs on the server
@@ -200,7 +200,7 @@ import RateReact from "/snippets/examples/rate-react.mdx";
- actor.ts
+ worker.ts
Runs on the server
@@ -224,7 +224,7 @@ import RateReact from "/snippets/examples/rate-react.mdx";
- actor.ts
+ worker.ts
Runs on the server
@@ -249,7 +249,7 @@ import RateReact from "/snippets/examples/rate-react.mdx";
- actor.ts
+ worker.ts
Runs on the server
@@ -273,7 +273,7 @@ import RateReact from "/snippets/examples/rate-react.mdx";
- actor.ts
+ worker.ts
Runs on the server
@@ -298,7 +298,7 @@ import RateReact from "/snippets/examples/rate-react.mdx";
- actor.ts
+ worker.ts
Runs on the server
@@ -322,7 +322,7 @@ import RateReact from "/snippets/examples/rate-react.mdx";
- actor.ts
+ worker.ts
Runs on the server
@@ -347,7 +347,7 @@ import RateReact from "/snippets/examples/rate-react.mdx";
- actor.ts
+ worker.ts
Runs on the server
@@ -371,7 +371,7 @@ import RateReact from "/snippets/examples/rate-react.mdx";
- actor.ts
+ worker.ts
Runs on the server
@@ -396,7 +396,7 @@ import RateReact from "/snippets/examples/rate-react.mdx";
- actor.ts
+ worker.ts
Runs on the server
@@ -420,7 +420,7 @@ import RateReact from "/snippets/examples/rate-react.mdx";
- actor.ts
+ worker.ts
Runs on the server
@@ -445,7 +445,7 @@ import RateReact from "/snippets/examples/rate-react.mdx";
- actor.ts
+ worker.ts
Runs on the server
@@ -469,7 +469,7 @@ import RateReact from "/snippets/examples/rate-react.mdx";
- actor.ts
+ worker.ts
Runs on the server
@@ -494,7 +494,7 @@ import RateReact from "/snippets/examples/rate-react.mdx";
- actor.ts
+ worker.ts
Runs on the server
@@ -518,7 +518,7 @@ import RateReact from "/snippets/examples/rate-react.mdx";
- actor.ts
+ worker.ts
Runs on the server
@@ -543,7 +543,7 @@ import RateReact from "/snippets/examples/rate-react.mdx";
- actor.ts
+ worker.ts
Runs on the server
@@ -567,7 +567,7 @@ import RateReact from "/snippets/examples/rate-react.mdx";
- actor.ts
+ worker.ts
Runs on the server
diff --git a/docs/snippets/landing-tech.mdx b/docs/snippets/landing-tech.mdx
index 38f159fa3..ef94c894c 100644
--- a/docs/snippets/landing-tech.mdx
+++ b/docs/snippets/landing-tech.mdx
@@ -216,7 +216,7 @@
MCP
- Actor-Actor Actions
+ Worker-Worker Actions
Cancellable Schedules
@@ -293,7 +293,7 @@
- create-actor
+ create-worker
diff --git a/docs/snippets/platform-extra-notes.mdx b/docs/snippets/platform-extra-notes.mdx
index b88267b20..7b2938e54 100644
--- a/docs/snippets/platform-extra-notes.mdx
+++ b/docs/snippets/platform-extra-notes.mdx
@@ -2,7 +2,7 @@
For security reasons, you should configure proper CORS settings in production. In the example above, we used `cors: { origin: "*" }` which allows requests from any domain.
-For production deployments, specify the exact domains that should be allowed to connect to your actors. Learn more in the [CORS documentation](/concepts/cors).
+For production deployments, specify the exact domains that should be allowed to connect to your workers. Learn more in the [CORS documentation](/concepts/cors).
## Integration with Existing Projects
diff --git a/docs/snippets/setup-actor.mdx b/docs/snippets/setup-actor.mdx
index f6b22258a..b062f0612 100644
--- a/docs/snippets/setup-actor.mdx
+++ b/docs/snippets/setup-actor.mdx
@@ -1,8 +1,8 @@
```typescript src/app.ts
-import { actor, setup } from "@rivetkit/actor";
+import { worker, setup } from "rivetkit";
-// Create actor
-const counter = actor({
+// Create worker
+const counter = worker({
state: { count: 0 },
actions: {
increment: (c, x: number) => {
@@ -15,7 +15,7 @@ const counter = actor({
// Create the application
export const app = setup({
- actors: { counter },
+ workers: { counter },
cors: { origin: "http://localhost:8080" }
});
diff --git a/docs/snippets/setup-next-steps.mdx b/docs/snippets/setup-next-steps.mdx
index 03229781a..1003f3cb7 100644
--- a/docs/snippets/setup-next-steps.mdx
+++ b/docs/snippets/setup-next-steps.mdx
@@ -2,7 +2,7 @@
diff --git a/docs/snippets/step-define-actor.mdx b/docs/snippets/step-define-actor.mdx
index 07c1503f8..1c5a157fb 100644
--- a/docs/snippets/step-define-actor.mdx
+++ b/docs/snippets/step-define-actor.mdx
@@ -1,11 +1,11 @@
-
- Create a file `actors/app.ts` in your project with your actor definition:
+
+ Create a file `workers/app.ts` in your project with your worker definition:
- ```typescript actors/app.ts
- import { actor, setup } from "@rivetkit/actor";
+ ```typescript workers/app.ts
+ import { worker, setup } from "rivetkit";
- // Create actor
- const counter = actor({
+ // Create worker
+ const counter = worker({
state: { count: 0 },
actions: {
increment: (c, x: number) => {
@@ -18,7 +18,7 @@
// Create the application
export const app = setup({
- actors: { counter },
+ workers: { counter },
cors: { origin: "*" } // Configure CORS for your production domains in production
});
diff --git a/docs/snippets/step-run-studio.mdx b/docs/snippets/step-run-studio.mdx
index 38efd0d78..c06fc690f 100644
--- a/docs/snippets/step-run-studio.mdx
+++ b/docs/snippets/step-run-studio.mdx
@@ -3,19 +3,19 @@
```sh npm
- npx rivetkit/cli@latest dev actors/app.ts
+ npx rivetkit/cli@latest dev workers/app.ts
```
```sh pnpm
- pnpm exec rivetkit/cli@latest dev actors/app.ts
+ pnpm exec rivetkit/cli@latest dev workers/app.ts
```
```sh yarn
- yarn rivetkit/cli@latest dev actors/app.ts
+ yarn rivetkit/cli@latest dev workers/app.ts
```
```sh bun
- bunx rivetkit/cli@latest dev actors/app.ts
+ bunx rivetkit/cli@latest dev workers/app.ts
```
diff --git a/docs/snippets/step-update-client.mdx b/docs/snippets/step-update-client.mdx
index 091c5463b..fb2e09db8 100644
--- a/docs/snippets/step-update-client.mdx
+++ b/docs/snippets/step-update-client.mdx
@@ -12,7 +12,7 @@
```
```python Python
- client = ActorClient(
+ client = WorkerClient(
# FILL ME IN
)
```
diff --git a/docs/styles/cta.js b/docs/styles/cta.js
index b6bf9f7a3..6c4dbcd58 100644
--- a/docs/styles/cta.js
+++ b/docs/styles/cta.js
@@ -1,22 +1,22 @@
// CTA titles array
const CTA_TITLES = [
- "Performance in every act - thanks to Rivet Actors.",
- "Scale without drama - only with Rivet Actors.",
- "It's time your backend took center-stage - with Rivet Actors.",
- "SQLite the spotlight on performance - with Rivet Actors.",
- "Backend scalability: the SQL - starring Rivet Actors.",
- "Take your state to the edge - Rivet Actors makes it easy.",
- "No state fright - just scalability with Rivet Actors.",
- "Act now, deploy at the edge - with Rivet Actors.",
- "Lights, camera, serverless - powered by Rivet Actors.",
- "Your backend deserves a standing ovation - Rivet Actors delivers.",
- "Cue your backend's best performance - enter Rivet Actors.",
- "Backend performance worth applauding - only with Rivet Actors.",
- "Put your backend center-stage - with Rivet Actors.",
- "Make your backend the main actor - with Rivet Actors.",
- "Give your backend its big break - use Rivet Actors.",
- "Serverless, with no intermissions - powered by Rivet Actors.",
- "Set the stage for serverless success - with Rivet Actors."
+ "Performance in every act - thanks to Rivet Workers.",
+ "Scale without drama - only with Rivet Workers.",
+ "It's time your backend took center-stage - with Rivet Workers.",
+ "SQLite the spotlight on performance - with Rivet Workers.",
+ "Backend scalability: the SQL - starring Rivet Workers.",
+ "Take your state to the edge - Rivet Workers makes it easy.",
+ "No state fright - just scalability with Rivet Workers.",
+ "Act now, deploy at the edge - with Rivet Workers.",
+ "Lights, camera, serverless - powered by Rivet Workers.",
+ "Your backend deserves a standing ovation - Rivet Workers delivers.",
+ "Cue your backend's best performance - enter Rivet Workers.",
+ "Backend performance worth applauding - only with Rivet Workers.",
+ "Put your backend center-stage - with Rivet Workers.",
+ "Make your backend the main worker - with Rivet Workers.",
+ "Give your backend its big break - use Rivet Workers.",
+ "Serverless, with no intermissions - powered by Rivet Workers.",
+ "Set the stage for serverless success - with Rivet Workers."
];
function initializeAllCTAs() {
diff --git a/docs/styles/particles.js b/docs/styles/particles.js
index edf9a925b..a0c1a9810 100644
--- a/docs/styles/particles.js
+++ b/docs/styles/particles.js
@@ -190,7 +190,7 @@
// // Size and opacity
// this.size = Particle.PARTICLE_RADIUS * 2;
// this.opacity = 1;
-// this.opacityFactor = Math.random();
+// this.opacityFworker = Math.random();
// this.opacityBase = Math.min(0, Math.random() - 0.5);
// }
//
@@ -220,7 +220,7 @@
// // Fade out between 600px and 1200px from center
// const minDistance = 600;
// const maxDistance = 1200;
-// this.opacity = this.opacityBase + Math.max(0, Math.min(1, 1 - (distance - minDistance) / (maxDistance - minDistance))) * this.opacityFactor;
+// this.opacity = this.opacityBase + Math.max(0, Math.min(1, 1 - (distance - minDistance) / (maxDistance - minDistance))) * this.opacityFworker;
//
// // Calculate velocity magnitude directly - simpler and more accurate
// const velocityMagnitude = Math.sqrt(this.vx * this.vx + this.vy * this.vy);
@@ -454,8 +454,8 @@
// // Normalize mouse velocity to 0-1 range
// const normalizedSpeed = Math.min(mouseSpeed / PARTICLE_CONFIG.MAX_VELOCITY, 1);
//
-// // Calculate base force factor with smoother distance falloff
-// const forceFactor = Math.pow(1 - distance / FORCE_RADIUS, 1.5) *
+// // Calculate base force fworker with smoother distance falloff
+// const forceFworker = Math.pow(1 - distance / FORCE_RADIUS, 1.5) *
// normalizedSpeed *
// PARTICLE_CONFIG.BASE_PUSH_FORCE *
// PARTICLE_CONFIG.MOVEMENT_FORCE_MULTIPLIER *
@@ -477,8 +477,8 @@
// const moveForce = mouseSpeed * PARTICLE_CONFIG.MOVEMENT_FORCE_RATIO;
//
// // More emphasis on movement direction, less on repulsion
-// const fx = (repelDirX * repelForce * 0.5 + mvx * moveForce) * forceFactor * movementInfluence;
-// const fy = (repelDirY * repelForce * 0.5 + mvy * moveForce) * forceFactor * movementInfluence;
+// const fx = (repelDirX * repelForce * 0.5 + mvx * moveForce) * forceFworker * movementInfluence;
+// const fy = (repelDirY * repelForce * 0.5 + mvy * moveForce) * forceFworker * movementInfluence;
//
// particle.applyForce(fx, fy);
// }
diff --git a/docs/styles/style.css b/docs/styles/style.css
index 43170b5a0..b46e7eca7 100644
--- a/docs/styles/style.css
+++ b/docs/styles/style.css
@@ -292,7 +292,6 @@
display: grid;
grid-template-columns: repeat(4, 1fr);
gap: 24px;
- margin-top: 48px;
}
.library-box {
diff --git a/docs/actor/actions.mdx b/docs/workers/actions.mdx
similarity index 81%
rename from docs/actor/actions.mdx
rename to docs/workers/actions.mdx
index e82a1c4c6..d1585b12e 100644
--- a/docs/actor/actions.mdx
+++ b/docs/workers/actions.mdx
@@ -3,23 +3,23 @@ title: Actions
icon: bolt
---
-Actions are how clients & other actors communicate with actors. Actions are defined as functions in the actor configuration and can be called from clients.
+Actions are how clients & other workers communicate with workers. Actions are defined as functions in the worker configuration and can be called from clients.
**Performance**
Actions are very lightweight. They can be called hundreds of times per second to send realtime data to the
-actor.
+worker.
## Writing Actions
-Actions are defined in the `actions` object when creating an actor:
+Actions are defined in the `actions` object when creating a worker:
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
-const mathUtils = actor({
+const mathUtils = worker({
state: {},
actions: {
// This is an action
@@ -37,14 +37,14 @@ Each action receives a context object (commonly named `c`) as its first paramete
You can define helper functions outside the actions object to keep your code organized. These functions cannot be called directly by clients:
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
// Private helper function - not callable by clients
const calculateFee = (amount) => {
return amount * 0.05;
};
-const paymentProcessor = actor({
+const paymentProcessor = worker({
state: {
transactions: []
},
@@ -69,7 +69,7 @@ Actions have a single return value. To stream realtime data in response to an ac
Calling actions from the client is simple:
```typescript
-import { createClient } from "@rivetkit/actor/client";
+import { createClient } from "rivetkit/client";
import type { App } from "./src/index";
const client = createClient("http://localhost:6420");
@@ -84,15 +84,15 @@ Calling actions from the client are async and require an `await`, even if the ac
### Type Safety
-The actor client includes type safety out of the box. When you use `createClient()`, TypeScript automatically infers action parameter and return types:
+The worker client includes type safety out of the box. When you use `createClient()`, TypeScript automatically infers action parameter and return types:
```typescript src/index.ts
-import { setup } from "@rivetkit/actor";
+import { setup } from "rivetkit";
// Create simple counter
-const counter = actor({
+const counter = worker({
state: { count: 0 },
actions: {
increment: (c, count: number) => {
@@ -104,14 +104,14 @@ const counter = actor({
// Create and export the app
const app = setup({
- actors: { counter }
+ workers: { counter }
});
export type App = typeof app;
```
```typescript client.ts
-import { createClient } from "@rivetkit/actor/client";
+import { createClient } from "rivetkit/client";
import type { App } from "./src/index";
const client = createClient("http://localhost:6420");
@@ -127,7 +127,7 @@ await counter.nonexistentMethod(123); // TypeScript error
## Error Handling
-Actors provide robust error handling out of the box for actions.
+Workers provide robust error handling out of the box for actions.
### User Errors
@@ -141,10 +141,10 @@ For example:
-```typescript actor.ts
-import { actor, UserError } from "@rivetkit/actor";
+```typescript worker.ts
+import { worker, UserError } from "rivetkit";
-const user = actor({
+const user = worker({
state: { users: [] },
actions: {
registerUser: (c, username) => {
@@ -167,7 +167,7 @@ const user = actor({
```typescript client.ts
try {
- await userActor.registerUser("extremely_long_username_that_exceeds_limit");
+ await userWorker.registerUser("extremely_long_username_that_exceeds_limit");
} catch (error) {
console.log("Message", error.message); // "Invalid username"
console.log("Code", error.code); // "invalid_username"
@@ -177,7 +177,7 @@ try {
-{/* Read the documentation for `UserError` [here](https://jsr.io/@rivet-gg/actor/doc/~/UserError). */}
+{/* Read the documentation for `UserError` [here](https://jsr.io/@rivet-gg/worker/doc/~/UserError). */}
### Internal Errors
@@ -190,7 +190,7 @@ Data schemas are not validated by default. For production applications, use a li
For example, to validate action parameters:
```typescript
-import { actor, UserError } from "@rivetkit/actor";
+import { worker, UserError } from "rivetkit";
import { z } from "zod";
// Define schema for action parameters
@@ -198,7 +198,7 @@ const IncrementSchema = z.object({
count: z.number().int().positive()
});
-const counter = actor({
+const counter = worker({
state: { count: 0 },
actions: {
increment: (c, params) => {
@@ -224,7 +224,7 @@ const counter = actor({
## Authentication
-By default, clients can call all actions on an actor without restriction. Make sure to implement authentication if needed. Documentation on authentication is available [here](/concepts/authentication).
+By default, clients can call all actions on a worker without restriction. Make sure to implement authentication if needed. Documentation on authentication is available [here](/concepts/authentication).
## Using `ActionContext` Type Externally
@@ -233,9 +233,9 @@ When writing complex logic for actions, you may want to extract parts of your im
RivetKit provides the `ActionContextOf` utility type for exactly this purpose:
```typescript
-import { actor, ActionContextOf } from "@rivetkit/actor";
+import { worker, ActionContextOf } from "rivetkit";
-const counter = actor({
+const counter = worker({
state: { count: 0 },
actions: {
diff --git a/docs/actor/authentication.mdx b/docs/workers/authentication.mdx
similarity index 80%
rename from docs/actor/authentication.mdx
rename to docs/workers/authentication.mdx
index a6ca32a02..5481ddeff 100644
--- a/docs/actor/authentication.mdx
+++ b/docs/workers/authentication.mdx
@@ -3,22 +3,22 @@ title: Authentication
icon: fingerprint
---
-Authentication can be handled through the `onBeforeConnect` or `createConnState` lifecycle hook, which acts as middleware before allowing clients to interact with your actor.
+Authentication can be handled through the `onBeforeConnect` or `createConnState` lifecycle hook, which acts as middleware before allowing clients to interact with your worker.
## Using `onBeforeConnect` or `createConnState`
-The `onBeforeConnect` and `createConnState` hook is called whenever a new client attempts to connect to your actor. It receives a context object that contains the client's connection parameters. `createConnState` should return an object that will become the connection state.
+The `onBeforeConnect` and `createConnState` hook is called whenever a new client attempts to connect to your worker. It receives a context object that contains the client's connection parameters. `createConnState` should return an object that will become the connection state.
Throwing an error in `onBeforeConnect` or `createConnState` will abort the connection.
Here's a basic example:
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
-const exampleActor = actor({
+const exampleWorker = worker({
state: {
- // Actor state...
+ // Worker state...
},
createConnState: async (c, { params }) => {
@@ -36,7 +36,7 @@ const exampleActor = actor({
},
actions: {
- // Actor actions...
+ // Worker actions...
}
});
```
@@ -46,11 +46,11 @@ const exampleActor = actor({
After authentication, you can access the connection state in any action through the context object:
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
-const authenticatedActor = actor({
+const authenticatedWorker = worker({
state: {
- // Actor state...
+ // Worker state...
},
createConnState: (c) => {
@@ -80,11 +80,11 @@ const authenticatedActor = actor({
### With API Server Authentication
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
-const apiAuthenticatedActor = actor({
+const apiAuthenticatedWorker = worker({
state: {
- // Actor state...
+ // Worker state...
},
createConnState: async (c, { params }) => {
@@ -108,7 +108,7 @@ const apiAuthenticatedActor = actor({
},
actions: {
- // Actor actions...
+ // Worker actions...
}
});
```
@@ -118,14 +118,14 @@ When authentication fails, throwing an error in `createConnState` will prevent t
### With JWT Authentication
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
import jwt from "jsonwebtoken";
const JWT_SECRET = process.env.JWT_SECRET;
-const jwtAuthenticatedActor = actor({
+const jwtAuthenticatedWorker = worker({
state: {
- // Actor state...
+ // Worker state...
},
createConnState: (c, { params }) => {
diff --git a/docs/actor/connections.mdx b/docs/workers/connections.mdx
similarity index 79%
rename from docs/actor/connections.mdx
rename to docs/workers/connections.mdx
index 5f1813a0a..17cfc539c 100644
--- a/docs/actor/connections.mdx
+++ b/docs/workers/connections.mdx
@@ -3,20 +3,20 @@ title: Connections
icon: network-wired
---
-Connections represent client connections to your actor. They provide a way to handle client authentication, manage connection-specific data, and control the connection lifecycle.
+Connections represent client connections to your worker. They provide a way to handle client authentication, manage connection-specific data, and control the connection lifecycle.
## Parameters
-When clients connect to an actor, they can pass connection parameters that are handled during the connection process.
+When clients connect to a worker, they can pass connection parameters that are handled during the connection process.
For example:
-```typescript actor.ts
-import { actor } from "@rivetkit/actor";
+```typescript worker.ts
+import { worker } from "rivetkit";
-const gameRoom = actor({
+const gameRoom = worker({
state: {},
// Handle connection setup
@@ -39,7 +39,7 @@ const gameRoom = actor({
```
```typescript client.ts
-import { createClient } from "@rivetkit/actor/client";
+import { createClient } from "rivetkit/client";
import type { App } from "./src/index";
const client = createClient("http://localhost:6420");
@@ -52,14 +52,14 @@ const gameRoom = await client.gameRoom.get({
## Connection State
-There are two ways to define an actor's connection state:
+There are two ways to define a worker's connection state:
### Method 1: `ConnState` constant
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
-const chatRoom = actor({
+const chatRoom = worker({
state: { messages: [] },
// Define default connection state as a constant
@@ -84,9 +84,9 @@ const chatRoom = actor({
The data returned from `createConnState` is used as the initial state of the connection. The connection state can be accessed through `conn.state`.
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
-const chatRoom = actor({
+const chatRoom = worker({
state: { messages: [] },
// Create connection state dynamically
@@ -120,7 +120,7 @@ The connection lifecycle has several hooks:
- `onConnect`: Called when a client successfully connects
- `onDisconnect`: Called when a client disconnects
-See the documentation on [Actor Lifecycle](/concepts/lifecycle) for more details.
+See the documentation on [Worker Lifecycle](/concepts/lifecycle) for more details.
## Connection List
@@ -131,9 +131,9 @@ This is frequently used with `conn.send(name, event)` to send messages directly
For example:
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
-const chatRoom = actor({
+const chatRoom = worker({
state: { users: {} },
actions: {
@@ -158,9 +158,9 @@ const chatRoom = actor({
Connections can be disconnected from within an action:
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
-const secureRoom = actor({
+const secureRoom = worker({
state: {},
actions: {
@@ -189,4 +189,4 @@ This ensures the underlying network connections close cleanly before continuing.
## Offline & Auto-Reconnection
-See [Interacting with Actors](/concepts/interacting-with-actors#offline-and-auto-reconnection) for details on reconnection behavior.
+See [Interacting with Workers](/concepts/interacting-with-workers#offline-and-auto-reconnection) for details on reconnection behavior.
diff --git a/docs/actor/events.mdx b/docs/workers/events.mdx
similarity index 62%
rename from docs/actor/events.mdx
rename to docs/workers/events.mdx
index 982047417..bb1f65339 100644
--- a/docs/actor/events.mdx
+++ b/docs/workers/events.mdx
@@ -3,24 +3,24 @@ title: Events
icon: tower-broadcast
---
-Events are used for clients to receive realtime data from actors.
+Events are used for clients to receive realtime data from workers.
-Events are used for actors to publish updates to clients. Clients call actions to communicate with the actor.
+Events are used for workers to publish updates to clients. Clients call actions to communicate with the worker.
-## Publishing from actors
+## Publishing from workers
-Actors can publish events to clients using `c.broadcast` and `conn.send`.
+Workers can publish events to clients using `c.broadcast` and `conn.send`.
### Broadcasting events
-Actors can publish events to all connected clients with `c.broadcast(name, data)`. For example:
+Workers can publish events to all connected clients with `c.broadcast(name, data)`. For example:
```typescript chat_room.ts
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
-const chatRoom = actor({
+const chatRoom = worker({
state: {},
actions: {
sendMessage: (c, message) => {
@@ -31,7 +31,7 @@ const chatRoom = actor({
```
```typescript client.ts
-import { createClient } from "@rivetkit/actor/client";
+import { createClient } from "rivetkit/client";
import type { App } from "./src/index";
const client = createClient("http://localhost:6420");
@@ -43,14 +43,14 @@ await chatRoom.sendMessage('Hello, world!');
### Sending events to specific connections
-Actors can send messages to specific client connections. All connections are available through the context object. For example:
+Workers can send messages to specific client connections. All connections are available through the context object. For example:
```typescript chat_room.ts
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
-const chatRoom = actor({
+const chatRoom = worker({
state: {},
actions: {
sendPrivateMessage: (c, connId, message) => {
@@ -64,7 +64,7 @@ const chatRoom = actor({
```
```typescript client.ts
-import { createClient } from "@rivetkit/actor/client";
+import { createClient } from "rivetkit/client";
import type { App } from "./src/index";
const client = createClient("http://localhost:6420");
@@ -76,18 +76,18 @@ await chatRoom.sendPrivateMessage(123, 'Hello, world!');
## Subscribing from clients
-Clients can subscribe to events from actors using `on` and `once`.
+Clients can subscribe to events from workers using `on` and `once`.
### `on(eventName, callback)`
-{/* [Documentation](https://jsr.io/@rivet-gg/actor-client/doc/~/ActorHandleRaw.prototype.on.html) */}
+{/* [Documentation](https://jsr.io/@rivet-gg/worker-client/doc/~/WorkerHandleRaw.prototype.on.html) */}
-Clients can subscribe to events that will happen repeatedly using `actor.on(name, callback)`. For example:
+Clients can subscribe to events that will happen repeatedly using `worker.on(name, callback)`. For example:
```typescript client.ts
-import { createClient } from "@rivetkit/actor/client";
+import { createClient } from "rivetkit/client";
import type { App } from "./src/index";
const client = createClient("http://localhost:6420");
@@ -99,9 +99,9 @@ chatRoom.on('newMessage', ({ message }) => {
```
```typescript chat_room.ts
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
-const chatRoom = actor({
+const chatRoom = worker({
state: {},
actions: {
sendMessage: (c, message) => {
@@ -115,14 +115,14 @@ const chatRoom = actor({
### `once(eventName, callback)`
-{/* [Documentation](https://jsr.io/@rivet-gg/actor-client/doc/~/ActorHandleRaw.prototype.once.html) */}
+{/* [Documentation](https://jsr.io/@rivet-gg/worker-client/doc/~/WorkerHandleRaw.prototype.once.html) */}
-Clients can listen for an event only one time with `actor.once(name, callback)`. For example:
+Clients can listen for an event only one time with `worker.once(name, callback)`. For example:
```typescript client.ts
-import { createClient } from "@rivetkit/actor/client";
+import { createClient } from "rivetkit/client";
import type { App } from "./src/index";
const client = createClient("http://localhost:6420");
@@ -137,9 +137,9 @@ await chatRoom.requestJoin();
```
```typescript chat_room.ts
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
-const chatRoom = actor({
+const chatRoom = worker({
state: {
pendingJoinRequests: []
},
@@ -161,6 +161,6 @@ const chatRoom = actor({
## Connections
-Connections are used to communicate with clients from the actor.
+Connections are used to communicate with clients from the worker.
Read more about connections [here](/concepts/connections).
diff --git a/docs/actor/lifecycle.mdx b/docs/workers/lifecycle.mdx
similarity index 70%
rename from docs/actor/lifecycle.mdx
rename to docs/workers/lifecycle.mdx
index 4c7879e08..9b20d9171 100644
--- a/docs/actor/lifecycle.mdx
+++ b/docs/workers/lifecycle.mdx
@@ -5,32 +5,32 @@ icon: rotate
## Lifecycle Hooks
-Actor lifecycle hooks are defined as functions in the actor configuration.
+Worker lifecycle hooks are defined as functions in the worker configuration.
### `createState` and `state`
-{/* [Documentation](https://jsr.io/@rivet-gg/actor/doc/~/Actor.prototype._onInitialize) */}
+{/* [Documentation](https://jsr.io/@rivet-gg/worker/doc/~/Worker.prototype._onInitialize) */}
-The `createState` function or `state` constant defines the initial state of the actor (see [state documentation](/concepts/state)). The `createState` function is called only once when the actor is first created.
+The `createState` function or `state` constant defines the initial state of the worker (see [state documentation](/concepts/state)). The `createState` function is called only once when the worker is first created.
### `createVars` and `vars`
-The `createVars` function or `vars` constant defines ephemeral variables for the actor (see [state documentation](/concepts/state)). These variables are not persisted and are useful for storing runtime-only objects or temporary data.
+The `createVars` function or `vars` constant defines ephemeral variables for the worker (see [state documentation](/concepts/state)). These variables are not persisted and are useful for storing runtime-only objects or temporary data.
The `createVars` function can also receive driver-specific context as its second parameter, allowing access to driver capabilities like Rivet KV or Cloudflare Durable Object storage.
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
// Using vars constant
-const counter1 = actor({
+const counter1 = worker({
state: { count: 0 },
vars: { lastAccessTime: 0 },
actions: { /* ... */ }
});
// Using createVars function
-const counter2 = actor({
+const counter2 = worker({
state: { count: 0 },
createVars: () => {
// Initialize with non-serializable objects
@@ -43,7 +43,7 @@ const counter2 = actor({
});
// Access driver-specific context
-const exampleActor = actor({
+const exampleWorker = worker({
state: { count: 0 },
// Access driver context in createVars
createVars: (c, rivet) => ({
@@ -63,16 +63,16 @@ const exampleActor = actor({
The `onCreate` hook is called at the same time as `createState`, but unlike `createState`, it doesn't return any value. Use this hook for initialization logic that doesn't affect the initial state.
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
// Using state constant
-const counter1 = actor({
+const counter1 = worker({
state: { count: 0 },
actions: { /* ... */ }
});
// Using createState function
-const counter2 = actor({
+const counter2 = worker({
createState: () => {
// Initialize with a count of 0
return { count: 0 };
@@ -81,12 +81,12 @@ const counter2 = actor({
});
// Using onCreate
-const counter3 = actor({
+const counter3 = worker({
state: { count: 0 },
// Run initialization logic (logging, external service setup, etc.)
onCreate: (c) => {
- console.log("Counter actor initialized");
+ console.log("Counter worker initialized");
// Can perform async operations or setup
// No need to return anything
},
@@ -97,22 +97,22 @@ const counter3 = actor({
### `onStart`
-{/* [Documentation](https://jsr.io/@rivet-gg/actor/doc/~/Actor.prototype._onStart) */}
+{/* [Documentation](https://jsr.io/@rivet-gg/worker/doc/~/Worker.prototype._onStart) */}
-This hook is called any time the actor is started (e.g. after restarting, upgrading code, or crashing).
+This hook is called any time the worker is started (e.g. after restarting, upgrading code, or crashing).
-This is called after the actor has been initialized but before any connections are accepted.
+This is called after the worker has been initialized but before any connections are accepted.
Use this hook to set up any resources or start any background tasks, such as `setInterval`.
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
-const counter = actor({
+const counter = worker({
state: { count: 0 },
onStart: (c) => {
- console.log('Actor started with count:', c.state.count);
+ console.log('Worker started with count:', c.state.count);
// Set up interval for automatic counting
const intervalId = setInterval(() => {
@@ -130,14 +130,14 @@ const counter = actor({
### `onStateChange`
-{/* [Documentation](https://jsr.io/@rivet-gg/actor/doc/~/Actor.prototype._onStateChange) */}
+{/* [Documentation](https://jsr.io/@rivet-gg/worker/doc/~/Worker.prototype._onStateChange) */}
-Called whenever the actor's state changes. This is often used to broadcast state updates.
+Called whenever the worker's state changes. This is often used to broadcast state updates.
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
-const counter = actor({
+const counter = worker({
state: { count: 0 },
onStateChange: (c, newState) => {
@@ -158,7 +158,7 @@ const counter = actor({
### `createConnState` and `connState`
-{/* [Documentation](https://jsr.io/@rivet-gg/actor/doc/~/Actor.prototype._createConnState) */}
+{/* [Documentation](https://jsr.io/@rivet-gg/worker/doc/~/Worker.prototype._createConnState) */}
There are two ways to define the initial state for connections:
1. `connState`: Define a constant object that will be used as the initial state for all connections
@@ -166,16 +166,16 @@ There are two ways to define the initial state for connections:
### `onBeforeConnect`
-{/* [Documentation](https://jsr.io/@rivet-gg/actor/doc/~/Actor.prototype._onBeforeConnect) */}
+{/* [Documentation](https://jsr.io/@rivet-gg/worker/doc/~/Worker.prototype._onBeforeConnect) */}
-The `onBeforeConnect` hook is called whenever a new client connects to the actor. Clients can pass parameters when connecting, accessible via `params`. This hook is used for connection validation and can throw errors to reject connections.
+The `onBeforeConnect` hook is called whenever a new client connects to the worker. Clients can pass parameters when connecting, accessible via `params`. This hook is used for connection validation and can throw errors to reject connections.
The `onBeforeConnect` hook does NOT return connection state - it's used solely for validation.
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
-const chatRoom = actor({
+const chatRoom = worker({
state: { messages: [] },
// Method 1: Use a static default connection state
@@ -209,18 +209,18 @@ const chatRoom = actor({
});
```
-Connections cannot interact with the actor until this method completes successfully. Throwing an error will abort the connection. This can be used for authentication - see [Authentication](/concepts/authentication) for details.
+Connections cannot interact with the worker until this method completes successfully. Throwing an error will abort the connection. This can be used for authentication - see [Authentication](/concepts/authentication) for details.
### `onConnect`
-{/* [Documentation](https://jsr.io/@rivet-gg/actor/doc/~/Actor.prototype._onConnect) */}
+{/* [Documentation](https://jsr.io/@rivet-gg/worker/doc/~/Worker.prototype._onConnect) */}
Executed after the client has successfully connected.
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
-const chatRoom = actor({
+const chatRoom = worker({
state: { users: {}, messages: [] },
onConnect: (c) => {
@@ -241,18 +241,18 @@ const chatRoom = actor({
});
```
-Messages will not be processed for this actor until this hook succeeds. Errors thrown from this hook will cause the client to disconnect.
+Messages will not be processed for this worker until this hook succeeds. Errors thrown from this hook will cause the client to disconnect.
### `onDisconnect`
-{/* [Documentation](https://jsr.io/@rivet-gg/actor/doc/~/Actor.prototype._onDisconnect) */}
+{/* [Documentation](https://jsr.io/@rivet-gg/worker/doc/~/Worker.prototype._onDisconnect) */}
-Called when a client disconnects from the actor. Use this to clean up any connection-specific resources.
+Called when a client disconnects from the worker. Use this to clean up any connection-specific resources.
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
-const chatRoom = actor({
+const chatRoom = worker({
state: { users: {}, messages: [] },
onDisconnect: (c) => {
@@ -273,14 +273,14 @@ const chatRoom = actor({
});
```
-## Destroying Actors
+## Destroying Workers
-Actors can be shut down gracefully with `c.shutdown()`. Clients will be gracefully disconnected.
+Workers can be shut down gracefully with `c.shutdown()`. Clients will be gracefully disconnected.
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
-const temporaryRoom = actor({
+const temporaryRoom = worker({
state: {
createdAt: 0,
expiresAfterMs: 3600000 // 1 hour
@@ -314,7 +314,7 @@ const temporaryRoom = actor({
// Notify all clients
c.broadcast("roomClosed", { reason: "Admin closed the room" });
- // Shutdown the actor
+ // Shutdown the worker
c.shutdown();
}
}
@@ -323,42 +323,42 @@ const temporaryRoom = actor({
This action is permanent and cannot be reverted.
-## Using `ActorContext` Type Externally
+## Using `WorkerContext` Type Externally
When extracting logic from lifecycle hooks or actions into external functions, you'll often need to define the type of the context parameter. RivetKit provides helper types that make it easy to extract and pass these context types to external functions.
```typescript
-import { actor, ActorContextOf } from "@rivetkit/actor";
+import { worker, WorkerContextOf } from "rivetkit";
-const myActor = actor({
+const myWorker = worker({
state: { count: 0 },
// Use external function in lifecycle hook
- onStart: (c) => logActorStarted(c)
+ onStart: (c) => logWorkerStarted(c)
});
// Simple external function with typed context
-function logActorStarted(c: ActorContextOf) {
- console.log(`Actor started with count: ${c.state.count}`);
+function logWorkerStarted(c: WorkerContextOf) {
+ console.log(`Worker started with count: ${c.state.count}`);
}
```
-See [Helper Types](/concepts/types) for more details on using `ActorContextOf`.
+See [Helper Types](/concepts/types) for more details on using `WorkerContextOf`.
## Full Example
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
-const counter = actor({
+const counter = worker({
// Initialize state
createState: () => ({
count: 0
}),
- // Initialize actor (run setup that doesn't affect initial state)
+ // Initialize worker (run setup that doesn't affect initial state)
onCreate: (c) => {
- console.log('Counter actor initialized');
+ console.log('Counter worker initialized');
// Set up external resources, etc.
},
diff --git a/docs/actor/metadata.mdx b/docs/workers/metadata.mdx
similarity index 76%
rename from docs/actor/metadata.mdx
rename to docs/workers/metadata.mdx
index 32acd737e..4df0ecfe0 100644
--- a/docs/actor/metadata.mdx
+++ b/docs/workers/metadata.mdx
@@ -3,7 +3,7 @@ title: Metadata
icon: tag
---
-Metadata provides information about the currently running actor.
+Metadata provides information about the currently running worker.
## Region
@@ -20,9 +20,9 @@ For example:
```typescript chat_room.ts
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
-const chatRoom = actor({
+const chatRoom = worker({
state: {
messages: []
},
@@ -53,7 +53,7 @@ export default chatRoom;
```
```typescript client.ts
-import { createClient } from "@rivetkit/actor/client";
+import { createClient } from "rivetkit/client";
import type { App } from "./src/index";
const client = createClient("http://localhost:6420");
@@ -74,12 +74,12 @@ const teamChannel = await client.chatRoom.get({
-## Actor Name
+## Worker Name
-You can access the actor name with:
+You can access the worker name with:
```typescript
-const actorName = c.name;
+const workerName = c.name;
```
-This is useful when you need to know which actor type is running, especially if you have generic utility functions that are shared between different actor implementations.
+This is useful when you need to know which worker type is running, especially if you have generic utility functions that are shared between different worker implementations.
diff --git a/docs/actor/overview.mdx b/docs/workers/overview.mdx
similarity index 54%
rename from docs/actor/overview.mdx
rename to docs/workers/overview.mdx
index a205cefac..0caeb64f6 100644
--- a/docs/actor/overview.mdx
+++ b/docs/workers/overview.mdx
@@ -1,41 +1,41 @@
---
-title: Rivet Actors
+title: Rivet Workers
icon: square-info
sidebarTitle: "Overview"
description: A library for building stateful, scalable, realtime backend applications.
---
-import CreateActorCli from "/snippets/create-actor-cli.mdx";
+import CreateWorkerCli from "/snippets/create-worker-cli.mdx";
-Actors combine compute and storage into unified entities for simplified architecture. Actors seamlessly integrate with your existing infrastructure or can serve as a complete standalone solution.
+Workers combine compute and storage into unified entities for simplified architecture. Workers seamlessly integrate with your existing infrastructure or can serve as a complete standalone solution.
## Concepts
-The core concepts that power Rivet Actor applications:
+The core concepts that power Rivet Worker applications:
- **State Is Automatically Persisted**: State automatically persists between restarts, upgrades, & crashes
- **State Is Stored In-Memory**: State is stored in memory for high-performance reads/writes while also automatically persisted
-- **Isolated State Ownership**: Actors only manage their own state, which can only be modified by the actor itself
-- **Communicates via Actions**: How clients and other actors interact with an actor
+- **Isolated State Ownership**: Workers only manage their own state, which can only be modified by the worker itself
+- **Communicates via Actions**: How clients and other workers interact with a worker
- **Actions Are Low-Latency**: Actions provide WebSocket-like performance for time-sensitive operations
-- **Broadcast Updates With Events**: Actors can publish real-time updates to connected clients
+- **Broadcast Updates With Events**: Workers can publish real-time updates to connected clients
## Quickstart
Run this to get started:
-("http://localhost:6420");
@@ -228,16 +228,16 @@ const document = await client.document.get({
});
```
-## Actor Lifecycle
+## Worker Lifecycle
-Actors are created automatically when needed and persist until explicitly shutdown.
+Workers are created automatically when needed and persist until explicitly shutdown.
-To shut down an actor, use `c.shutdown()` from within an action:
+To shut down a worker, use `c.shutdown()` from within an action:
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
-const chatRoom = actor({
+const chatRoom = worker({
createState: () => ({
messages: []
}),
@@ -246,36 +246,36 @@ const chatRoom = actor({
// Do any cleanup needed
c.broadcast("roomClosed");
- // Shutdown the actor
+ // Shutdown the worker
c.shutdown();
}
}
});
```
-Learn more about the [actor lifecycle](/actor/lifecycle).
+Learn more about the [worker lifecycle](/worker/lifecycle).
## Documentation
-Learn more about Rivet Actors:
+Learn more about Rivet Workers:
-
- Get started with Rivet Actors in minutes
+
+ Get started with Rivet Workers in minutes
-
- Understand how actor state is managed, persisted, and accessed.
+
+ Understand how worker state is managed, persisted, and accessed.
-
- Define and implement actor actions (RPCs) for client interaction.
+
+ Define and implement worker actions (RPCs) for client interaction.
-
+
Real-time communication with events and broadcasts.
-
- Managing the creation, execution, and termination of actors.
+
+ Managing the creation, execution, and termination of workers.
-
- Schedule tasks and alarms with actors for time-based operations.
+
+ Schedule tasks and alarms with workers for time-based operations.
\ No newline at end of file
diff --git a/docs/actor/quickstart.mdx b/docs/workers/quickstart.mdx
similarity index 79%
rename from docs/actor/quickstart.mdx
rename to docs/workers/quickstart.mdx
index e5c3ddef0..c26393c90 100644
--- a/docs/actor/quickstart.mdx
+++ b/docs/workers/quickstart.mdx
@@ -8,16 +8,16 @@ description: Start building awesome documentation in under 5 minutes
```sh
-npm install rivetkit/actor
+npm install rivetkit/worker
```
-
+
```ts
-import { actor, setup } from "@rivetkit/actor";
+import { worker, setup } from "rivetkit";
-const myActor = actor({
+const myWorker = worker({
});
```
@@ -52,13 +52,13 @@ const myActor = actor({
```ts Hono
const app = new Hono();
-app.route("rivetkit", setup({ myWf, myActor }));
+app.route("rivetkit", setup({ myWf, myWorker }));
serve(app);
```
```ts Express.js
const app = new Hono();
-app.route("rivetkit", setup({ myWf, myActor }));
+app.route("rivetkit", setup({ myWf, myWorker }));
serve(app);
```
@@ -115,7 +115,7 @@ rivet deploy
diff --git a/docs/actor/schedule.mdx b/docs/workers/schedule.mdx
similarity index 85%
rename from docs/actor/schedule.mdx
rename to docs/workers/schedule.mdx
index 026037308..79c0b7a63 100644
--- a/docs/actor/schedule.mdx
+++ b/docs/workers/schedule.mdx
@@ -3,7 +3,7 @@ title: Schedule
icon: clock
---
-Scheduling is used to trigger events in the future. The actor scheduler is like `setTimeout`, except the timeout will persist even if the actor restarts, upgrades, or crashes.
+Scheduling is used to trigger events in the future. The worker scheduler is like `setTimeout`, except the timeout will persist even if the worker restarts, upgrades, or crashes.
## Use Cases
@@ -13,7 +13,7 @@ Scheduling is helpful for long-running timeouts like month-long billing periods
### `c.schedule.after(duration, fn, ...args)`
-Schedules a function to be executed after a specified duration. This function persists across actor restarts, upgrades, or crashes.
+Schedules a function to be executed after a specified duration. This function persists across worker restarts, upgrades, or crashes.
Parameters:
@@ -23,7 +23,7 @@ Parameters:
### `c.schedule.at(timestamp, fn, ...args)`
-Schedules a function to be executed at a specific timestamp. This function persists across actor restarts, upgrades, or crashes.
+Schedules a function to be executed at a specific timestamp. This function persists across worker restarts, upgrades, or crashes.
Parameters:
@@ -38,9 +38,9 @@ Currently, scheduling can only trigger public actions. If the scheduled action i
## Full Example
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
-const reminderService = actor({
+const reminderService = worker({
state: {
reminders: {}
},
diff --git a/docs/actor/state.mdx b/docs/workers/state.mdx
similarity index 68%
rename from docs/actor/state.mdx
rename to docs/workers/state.mdx
index c86470848..5f644fdf7 100644
--- a/docs/actor/state.mdx
+++ b/docs/workers/state.mdx
@@ -3,26 +3,26 @@ title: State
icon: floppy-disk
---
-Actor state provides the best of both worlds: it's stored in-memory and persisted automatically. This lets you work with the data without added latency while still being able to survive crashes & upgrades.
+Worker state provides the best of both worlds: it's stored in-memory and persisted automatically. This lets you work with the data without added latency while still being able to survive crashes & upgrades.
**Using External SQL Databases**
-Actors can also be used with external SQL databases. This can be useful to integrate actors with existing
+Workers can also be used with external SQL databases. This can be useful to integrate workers with existing
applications or for storing relational data. Read more [here](/concepts/external-sql).
## Initializing State
-There are two ways to define an actor's initial state:
+There are two ways to define a worker's initial state:
**Method 1: Static Initial State**
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
// Simple state with a constant
-const counter = actor({
+const counter = worker({
// Define state as a constant
state: { count: 0 },
@@ -35,10 +35,10 @@ const counter = actor({
**Method 2: Dynamic Initial State**
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
// State with initialization logic
-const counter = actor({
+const counter = worker({
// Define state using a creation function
createState: () => {
return { count: 0 };
@@ -50,16 +50,16 @@ const counter = actor({
});
```
-The `createState` function is called once when the actor is first created. See [Lifecycle](/concepts/lifecycle) for more details.
+The `createState` function is called once when the worker is first created. See [Lifecycle](/concepts/lifecycle) for more details.
## Modifying State
To update state, modify the `state` property on the context object (`c.state`) in your actions:
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
-const counter = actor({
+const counter = worker({
state: { count: 0 },
actions: {
@@ -84,14 +84,14 @@ Only state stored in the `state` object will be persisted. Any other variables o
## State Saves
-Actors automatically handle persisting state transparently. This happens at the end of every action if the state has changed.
+Workers automatically handle persisting state transparently. This happens at the end of every action if the state has changed.
In the rare occasion you need to force a state change mid-action, you can use `c.saveState()`. This should only be used if your action makes an important state change that needs to be persisted before the action completes.
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
-const criticalProcess = actor({
+const criticalProcess = worker({
state: {
steps: [],
currentStep: 0
@@ -120,34 +120,34 @@ const criticalProcess = actor({
## State Isolation
-Each actor's state is completely isolated, meaning it cannot be accessed directly by other actors or clients. This allows actors to maintain a high level of security and data integrity, ensuring that state changes are controlled and predictable.
+Each worker's state is completely isolated, meaning it cannot be accessed directly by other workers or clients. This allows workers to maintain a high level of security and data integrity, ensuring that state changes are controlled and predictable.
-To interact with an actor's state, you must use [Actions](/concepts/actions). Actions provide a controlled way to read from and write to the state.
+To interact with a worker's state, you must use [Actions](/concepts/actions). Actions provide a controlled way to read from and write to the state.
-## Sharing State Between Actors
+## Sharing State Between Workers
-If you need a shared state between multiple actors, you have two options:
+If you need a shared state between multiple workers, you have two options:
-1. Create an actor that holds the shared state that other actors can make action calls to
+1. Create a worker that holds the shared state that other workers can make action calls to
2. Use an external database, see [External SQL Databases](/concepts/external-sql)
## Ephemeral Variables
-In addition to persisted state, RivetKit provides a way to store ephemeral data that is not saved to permanent storage using `vars`. This is useful for temporary data that only needs to exist while the actor is running or data that cannot be serialized.
+In addition to persisted state, RivetKit provides a way to store ephemeral data that is not saved to permanent storage using `vars`. This is useful for temporary data that only needs to exist while the worker is running or data that cannot be serialized.
-`vars` is designed to complement `state`, not replace it. Most actors should use both: `state` for critical business data and `vars` for ephemeral or non-serializable data.
+`vars` is designed to complement `state`, not replace it. Most workers should use both: `state` for critical business data and `vars` for ephemeral or non-serializable data.
### Initializing Variables
-There are two ways to define an actor's initial vars:
+There are two ways to define a worker's initial vars:
**Method 1: Static Initial Variables**
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
// Define vars as a constant
-const counter = actor({
+const counter = worker({
state: { count: 0 },
// Define ephemeral variables
@@ -169,10 +169,10 @@ When using static `vars`, all values must be compatible with `structuredClone()`
**Method 2: Dynamic Initial Variables**
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
// Define vars with initialization logic
-const counter = actor({
+const counter = worker({
state: { count: 0 },
// Define vars using a creation function
@@ -194,10 +194,10 @@ const counter = actor({
Vars can be accessed and modified through the context object with `c.vars`:
```typescript
-import { actor } from "@rivetkit/actor";
+import { worker } from "rivetkit";
import { createNanoEvents } from "nanoevents";
-const counter = actor({
+const counter = worker({
// Persistent state - saved to storage
state: { count: 0 },
@@ -230,7 +230,7 @@ const counter = actor({
### When to Use `vars` vs `state`
-In practice, most actors will use both: `state` for critical business data and `vars` for ephemeral, non-serializable, or performance-sensitive data.
+In practice, most workers will use both: `state` for critical business data and `vars` for ephemeral, non-serializable, or performance-sensitive data.
Use `vars` when:
@@ -239,8 +239,8 @@ Use `vars` when:
Use `state` when:
-- The data must be preserved across actor sleeps, restarts, updates, or crashes
-- The information is essential to the actor's core functionality and business logic
+- The data must be preserved across worker sleeps, restarts, updates, or crashes
+- The information is essential to the worker's core functionality and business logic
## Limitations
diff --git a/docs/actor/types.mdx b/docs/workers/types.mdx
similarity index 58%
rename from docs/actor/types.mdx
rename to docs/workers/types.mdx
index feacdb211..44a079705 100644
--- a/docs/actor/types.mdx
+++ b/docs/workers/types.mdx
@@ -2,20 +2,20 @@
title: Helper Types
---
-RivetKit provides several TypeScript helper types to make it easier to work with actors in a type-safe way.
+RivetKit provides several TypeScript helper types to make it easier to work with workers in a type-safe way.
## `Context` Types
-When working with actors, you often need to access the context object. RivetKit provides helper types to extract the context types from actor definitions.
+When working with workers, you often need to access the context object. RivetKit provides helper types to extract the context types from worker definitions.
-### `ActorContextOf`
+### `WorkerContextOf`
-Extracts the full actor context type from an actor definition. This is the type of the context object (`c`) available in lifecycle hooks such as `onCreate`, `onStart`, etc.
+Extracts the full worker context type from a worker definition. This is the type of the context object (`c`) available in lifecycle hooks such as `onCreate`, `onStart`, etc.
```typescript
-import { actor, ActorContextOf } from "@rivetkit/actor";
+import { worker, WorkerContextOf } from "rivetkit";
-const chatRoom = actor({
+const chatRoom = worker({
state: { messages: [] },
actions: {
sendMessage: (c, message) => {
@@ -25,7 +25,7 @@ const chatRoom = actor({
});
// Extract the chat room context type
-type ChatRoomContext = ActorContextOf;
+type ChatRoomContext = WorkerContextOf;
// Now you can use this type elsewhere
function processChatRoomContext(context: ChatRoomContext) {
@@ -35,14 +35,14 @@ function processChatRoomContext(context: ChatRoomContext) {
}
```
-### `ActionContextOf`
+### `ActionContextOf`
-Extracts the action context type from an actor definition. This is the type of the context object (`c`) available in action handlers.
+Extracts the action context type from a worker definition. This is the type of the context object (`c`) available in action handlers.
```typescript
-import { actor, ActionContextOf } from "@rivetkit/actor";
+import { worker, ActionContextOf } from "rivetkit";
-const counter = actor({
+const counter = worker({
state: { count: 0 },
actions: {
increment: (c) => {
diff --git a/docs/workflows/overview.mdx b/docs/workflows/overview.mdx
new file mode 100644
index 000000000..ec51d8b17
--- /dev/null
+++ b/docs/workflows/overview.mdx
@@ -0,0 +1,8 @@
+---
+title: Rivet Workflows
+icon: square-info
+sidebarTitle: "Overview"
+description: TODO
+---
+
+TODO
diff --git a/examples/chat-room-python/actors/app.ts b/examples/chat-room-python/actors/app.ts
index 589544a7b..e48f81b22 100644
--- a/examples/chat-room-python/actors/app.ts
+++ b/examples/chat-room-python/actors/app.ts
@@ -1,4 +1,4 @@
-import { actor, setup } from "@rivetkit/actor";
+import { actor, setup } from "rivetkit";
// state managed by the actor
export interface State {
diff --git a/examples/chat-room-python/package.json b/examples/chat-room-python/package.json
index af699b5d7..4ec21f0db 100644
--- a/examples/chat-room-python/package.json
+++ b/examples/chat-room-python/package.json
@@ -9,8 +9,8 @@
"pytest": "pytest tests/test_chat_room.py -v"
},
"devDependencies": {
- "@rivetkit/actor": "workspace:*",
"@types/node": "^22.13.9",
+ "rivetkit": "workspace:*",
"tsx": "^3.12.7",
"typescript": "^5.5.2"
},
diff --git a/examples/chat-room/actors/app.ts b/examples/chat-room/actors/app.ts
index 589544a7b..e48f81b22 100644
--- a/examples/chat-room/actors/app.ts
+++ b/examples/chat-room/actors/app.ts
@@ -1,4 +1,4 @@
-import { actor, setup } from "@rivetkit/actor";
+import { actor, setup } from "rivetkit";
// state managed by the actor
export interface State {
diff --git a/examples/chat-room/package.json b/examples/chat-room/package.json
index 1cbcc9cb5..863d73b14 100644
--- a/examples/chat-room/package.json
+++ b/examples/chat-room/package.json
@@ -9,10 +9,10 @@
"test": "vitest run"
},
"devDependencies": {
- "@rivetkit/actor": "workspace:*",
"@types/node": "^22.13.9",
"@types/prompts": "^2",
"prompts": "^2.4.2",
+ "rivetkit": "workspace:*",
"tsx": "^3.12.7",
"typescript": "^5.5.2",
"vitest": "^3.1.1"
diff --git a/examples/chat-room/scripts/cli.ts b/examples/chat-room/scripts/cli.ts
index eb0a93858..d1e17713c 100644
--- a/examples/chat-room/scripts/cli.ts
+++ b/examples/chat-room/scripts/cli.ts
@@ -1,4 +1,4 @@
-import { createClient } from "@rivetkit/actor/client";
+import { createClient } from "rivetkit/client";
import type { App } from "../actors/app";
import prompts from "prompts";
diff --git a/examples/chat-room/scripts/connect.ts b/examples/chat-room/scripts/connect.ts
index 5720e685c..922ece3a4 100644
--- a/examples/chat-room/scripts/connect.ts
+++ b/examples/chat-room/scripts/connect.ts
@@ -1,5 +1,5 @@
/// ;
-
-/**
- * Extracts the context type from an ActorDefinition
- */
-export type ActorContextOf =
- AD extends ActorDefinition
- ? ActorContext
- : never;
-
-/**
- * Extracts the context type from an ActorDefinition
- */
-export type ActionContextOf =
- AD extends ActorDefinition
- ? ActionContext
- : never;
-
-export class ActorDefinition> {
- #config: ActorConfig;
-
- constructor(config: ActorConfig) {
- this.#config = config;
- }
-
- instantiate(): ActorInstance {
- return new ActorInstance(this.#config);
- }
-}
diff --git a/packages/actor/src/actor/log.ts b/packages/actor/src/actor/log.ts
deleted file mode 100644
index 6f97702ca..000000000
--- a/packages/actor/src/actor/log.ts
+++ /dev/null
@@ -1,16 +0,0 @@
-import { getLogger } from "@/common//log";
-
-/** Logger for this library. */
-export const RUNTIME_LOGGER_NAME = "actor-runtime";
-
-/** Logger used for logs from the actor instance itself. */
-export const ACTOR_LOGGER_NAME = "actor";
-
-export function logger() {
- return getLogger(RUNTIME_LOGGER_NAME);
-}
-
-export function instanceLogger() {
- return getLogger(ACTOR_LOGGER_NAME);
-}
-
diff --git a/packages/actor/src/actor/mod.ts b/packages/actor/src/actor/mod.ts
deleted file mode 100644
index 877fcd10c..000000000
--- a/packages/actor/src/actor/mod.ts
+++ /dev/null
@@ -1,28 +0,0 @@
-import {
- type ActorConfigInput,
- ActorConfigSchema,
- type Actions,
- type ActorConfig,
-} from "./config";
-import { ActorDefinition } from "./definition";
-
-export type { ActorContext } from "./context";
-export { UserError, type UserErrorOptions } from "./errors";
-export type { Conn } from "./connection";
-export type { ActionContext } from "./action";
-export type { ActorConfig, OnConnectOptions } from "./config";
-export type { Encoding } from "@/actor/protocol/serde";
-export type { ActorKey } from "@/common/utils";
-export type {
- ActorDefinition,
- AnyActorDefinition,
- ActorContextOf,
- ActionContextOf,
-} from "./definition";
-
-export function actor>(
- input: ActorConfigInput,
-): ActorDefinition {
- const config = ActorConfigSchema.parse(input) as ActorConfig;
- return new ActorDefinition(config);
-}
diff --git a/packages/actor/src/actor/schedule.ts b/packages/actor/src/actor/schedule.ts
deleted file mode 100644
index 8948e8ccf..000000000
--- a/packages/actor/src/actor/schedule.ts
+++ /dev/null
@@ -1,17 +0,0 @@
-import type { AnyActorInstance } from "./instance";
-
-export class Schedule {
- #actor: AnyActorInstance;
-
- constructor(actor: AnyActorInstance) {
- this.#actor = actor;
- }
-
- async after(duration: number, fn: string, ...args: unknown[]) {
- await this.#actor.scheduleEvent(Date.now() + duration, fn, args);
- }
-
- async at(timestamp: number, fn: string, ...args: unknown[]) {
- await this.#actor.scheduleEvent(timestamp, fn, args);
- }
-}
diff --git a/packages/actor/src/client/actor-common.ts b/packages/actor/src/client/actor-common.ts
deleted file mode 100644
index 2616f656d..000000000
--- a/packages/actor/src/client/actor-common.ts
+++ /dev/null
@@ -1,37 +0,0 @@
-import type { AnyActorDefinition, ActorDefinition } from "@/actor/definition";
-import type * as protoHttpResolve from "@/actor/protocol/http/resolve";
-import type { Encoding } from "@/actor/protocol/serde";
-import type { ActorQuery } from "@/manager/protocol/query";
-import { logger } from "./log";
-import * as errors from "./errors";
-import { sendHttpRequest } from "./utils";
-import { HEADER_ACTOR_QUERY, HEADER_ENCODING } from "@/actor/router-endpoints";
-
-/**
- * Action function returned by Actor connections and handles.
- *
- * @typedef {Function} ActorActionFunction
- * @template Args
- * @template Response
- * @param {...Args} args - Arguments for the action function.
- * @returns {Promise}
- */
-export type ActorActionFunction<
- Args extends Array = unknown[],
- Response = unknown,
-> = (
- ...args: Args extends [unknown, ...infer Rest] ? Rest : Args
-) => Promise;
-
-/**
- * Maps action methods from actor definition to typed function signatures.
- */
-export type ActorDefinitionActions =
- AD extends ActorDefinition
- ? {
- [K in keyof R]: R[K] extends (...args: infer Args) => infer Return
- ? ActorActionFunction
- : never;
- }
- : never;
-
diff --git a/packages/actor/src/client/actor-handle.ts b/packages/actor/src/client/actor-handle.ts
deleted file mode 100644
index 0da6fa69b..000000000
--- a/packages/actor/src/client/actor-handle.ts
+++ /dev/null
@@ -1,151 +0,0 @@
-import type { AnyActorDefinition } from "@/actor/definition";
-import type { Encoding } from "@/actor/protocol/serde";
-import type { ActorQuery } from "@/manager/protocol/query";
-import { type ActorDefinitionActions } from "./actor-common";
-import { type ActorConn, ActorConnRaw } from "./actor-conn";
-import {
- ClientDriver,
- CREATE_ACTOR_CONN_PROXY,
- type ClientRaw,
-} from "./client";
-import { logger } from "./log";
-import invariant from "invariant";
-import { assertUnreachable } from "@/actor/utils";
-
-/**
- * Provides underlying functions for stateless {@link ActorHandle} for action calls.
- * Similar to ActorConnRaw but doesn't maintain a connection.
- *
- * @see {@link ActorHandle}
- */
-export class ActorHandleRaw {
- #client: ClientRaw;
- #driver: ClientDriver;
- #encodingKind: Encoding;
- #actorQuery: ActorQuery;
- #params: unknown;
-
- /**
- * Do not call this directly.
- *
- * Creates an instance of ActorHandleRaw.
- *
- * @protected
- */
- public constructor(
- client: any,
- driver: ClientDriver,
- params: unknown,
- encodingKind: Encoding,
- actorQuery: ActorQuery,
- ) {
- this.#client = client;
- this.#driver = driver;
- this.#encodingKind = encodingKind;
- this.#actorQuery = actorQuery;
- this.#params = params;
- }
-
- /**
- * Call a raw action. This method sends an HTTP request to invoke the named action.
- *
- * @see {@link ActorHandle}
- * @template Args - The type of arguments to pass to the action function.
- * @template Response - The type of the response returned by the action function.
- * @param {string} name - The name of the action function to call.
- * @param {...Args} args - The arguments to pass to the action function.
- * @returns {Promise} - A promise that resolves to the response of the action function.
- */
- async action = unknown[], Response = unknown>(
- name: string,
- ...args: Args
- ): Promise {
- return await this.#driver.action(
- undefined,
- this.#actorQuery,
- this.#encodingKind,
- this.#params,
- name,
- ...args,
- );
- }
-
- /**
- * Establishes a persistent connection to the actor.
- *
- * @template AD The actor class that this connection is for.
- * @returns {ActorConn} A connection to the actor.
- */
- connect(): ActorConn {
- logger().debug("establishing connection from handle", {
- query: this.#actorQuery,
- });
-
- const conn = new ActorConnRaw(
- this.#client,
- this.#driver,
- this.#params,
- this.#encodingKind,
- this.#actorQuery,
- );
-
- return this.#client[CREATE_ACTOR_CONN_PROXY](
- conn,
- ) as ActorConn;
- }
-
- /**
- * Resolves the actor to get its unique actor ID
- *
- * @returns {Promise} - A promise that resolves to the actor's ID
- */
- async resolve(): Promise {
- if (
- "getForKey" in this.#actorQuery ||
- "getOrCreateForKey" in this.#actorQuery
- ) {
- // TODO:
- const actorId = await this.#driver.resolveActorId(
- undefined,
- this.#actorQuery,
- this.#encodingKind,
- );
- this.#actorQuery = { getForId: { actorId } };
- return actorId;
- } else if ("getForId" in this.#actorQuery) {
- // SKip since it's already resolved
- return this.#actorQuery.getForId.actorId;
- } else if ("create" in this.#actorQuery) {
- // Cannot create a handle with this query
- invariant(false, "actorQuery cannot be create");
- } else {
- assertUnreachable(this.#actorQuery);
- }
- }
-}
-
-/**
- * Stateless handle to an actor. Allows calling actor's remote procedure calls with inferred types
- * without establishing a persistent connection.
- *
- * @example
- * ```
- * const room = client.get(...etc...);
- * // This calls the action named `sendMessage` on the `ChatRoom` actor without a connection.
- * await room.sendMessage('Hello, world!');
- * ```
- *
- * Private methods (e.g. those starting with `_`) are automatically excluded.
- *
- * @template AD The actor class that this handle is for.
- * @see {@link ActorHandleRaw}
- */
-export type ActorHandle = Omit<
- ActorHandleRaw,
- "connect"
-> & {
- // Add typed version of ActorConn (instead of using AnyActorDefinition)
- connect(): ActorConn;
- // Resolve method returns the actor ID
- resolve(): Promise;
-} & ActorDefinitionActions;
diff --git a/packages/actor/src/client/client.ts b/packages/actor/src/client/client.ts
deleted file mode 100644
index b0f574158..000000000
--- a/packages/actor/src/client/client.ts
+++ /dev/null
@@ -1,593 +0,0 @@
-import type { Transport } from "@/actor/protocol/message/mod";
-import type { Encoding } from "@/actor/protocol/serde";
-import type { ActorQuery } from "@/manager/protocol/query";
-import {
- ActorConn,
- ActorConnRaw,
- CONNECT_SYMBOL,
- SendHttpMessageOpts,
-} from "./actor-conn";
-import { ActorHandle, ActorHandleRaw } from "./actor-handle";
-import { ActorActionFunction } from "./actor-common";
-import { logger } from "./log";
-import type { ActorCoreApp } from "@/mod";
-import type { AnyActorDefinition } from "@/actor/definition";
-import type * as wsToServer from "@/actor/protocol/message/to-server";
-import type { EventSource } from "eventsource";
-import { createHttpClientDriver } from "./http-client-driver";
-import { HonoRequest } from "hono";
-
-/** Extract the actor registry from the app definition. */
-export type ExtractActorsFromApp> =
- A extends ActorCoreApp ? Actors : never;
-
-/** Extract the app definition from the client. */
-export type ExtractAppFromClient>> =
- C extends Client ? A : never;
-
-/**
- * Represents an actor accessor that provides methods to interact with a specific actor.
- */
-export interface ActorAccessor {
- /**
- * Gets a stateless handle to an actor by its key, but does not create the actor if it doesn't exist.
- * The actor name is automatically injected from the property accessor.
- *
- * @template AD The actor class that this handle is for.
- * @param {string | string[]} [key=[]] - The key to identify the actor. Can be a single string or an array of strings.
- * @param {GetWithIdOptions} [opts] - Options for getting the actor.
- * @returns {ActorHandle} - A handle to the actor.
- */
- get(key?: string | string[], opts?: GetWithIdOptions): ActorHandle;
-
- /**
- * Gets a stateless handle to an actor by its key, creating it if necessary.
- * The actor name is automatically injected from the property accessor.
- *
- * @template AD The actor class that this handle is for.
- * @param {string | string[]} [key=[]] - The key to identify the actor. Can be a single string or an array of strings.
- * @param {GetOptions} [opts] - Options for getting the actor.
- * @returns {ActorHandle} - A handle to the actor.
- */
- getOrCreate(
- key?: string | string[],
- opts?: GetOrCreateOptions,
- ): ActorHandle;
-
- /**
- * Gets a stateless handle to an actor by its ID.
- *
- * @template AD The actor class that this handle is for.
- * @param {string} actorId - The ID of the actor.
- * @param {GetWithIdOptions} [opts] - Options for getting the actor.
- * @returns {ActorHandle} - A handle to the actor.
- */
- getForId(actorId: string, opts?: GetWithIdOptions): ActorHandle;
-
- /**
- * Creates a new actor with the name automatically injected from the property accessor,
- * and returns a stateless handle to it with the actor ID resolved.
- *
- * @template AD The actor class that this handle is for.
- * @param {string | string[]} key - The key to identify the actor. Can be a single string or an array of strings.
- * @param {CreateOptions} [opts] - Options for creating the actor (excluding name and key).
- * @returns {Promise>} - A promise that resolves to a handle to the actor.
- */
- create(
- key?: string | string[],
- opts?: CreateOptions,
- ): Promise>;
-}
-
-/**
- * Options for configuring the client.
- * @typedef {Object} ClientOptions
- */
-export interface ClientOptions {
- encoding?: Encoding;
- transport?: Transport;
-}
-
-/**
- * Options for querying actors.
- * @typedef {Object} QueryOptions
- * @property {unknown} [parameters] - Parameters to pass to the connection.
- */
-export interface QueryOptions {
- /** Parameters to pass to the connection. */
- params?: unknown;
-}
-
-/**
- * Options for getting an actor by ID.
- * @typedef {QueryOptions} GetWithIdOptions
- */
-export interface GetWithIdOptions extends QueryOptions {}
-
-/**
- * Options for getting an actor.
- * @typedef {QueryOptions} GetOptions
- */
-export interface GetOptions extends QueryOptions {}
-
-/**
- * Options for getting or creating an actor.
- * @typedef {QueryOptions} GetOrCreateOptions
- * @property {string} [createInRegion] - Region to create the actor in if it doesn't exist.
- */
-export interface GetOrCreateOptions extends QueryOptions {
- /** Region to create the actor in if it doesn't exist. */
- createInRegion?: string;
- /** Input data to pass to the actor. */
- createWithInput?: unknown;
-}
-
-/**
- * Options for creating an actor.
- * @typedef {QueryOptions} CreateOptions
- * @property {string} [region] - The region to create the actor in.
- */
-export interface CreateOptions extends QueryOptions {
- /** The region to create the actor in. */
- region?: string;
- /** Input data to pass to the actor. */
- input?: unknown;
-}
-
-/**
- * Represents a region to connect to.
- * @typedef {Object} Region
- * @property {string} id - The region ID.
- * @property {string} name - The region name.
- * @see {@link https://rivet.gg/docs/edge|Edge Networking}
- * @see {@link https://rivet.gg/docs/regions|Available Regions}
- */
-export interface Region {
- /**
- * The region slug.
- */
- id: string;
-
- /**
- * The human-friendly region name.
- */
- name: string;
-}
-
-export const ACTOR_CONNS_SYMBOL = Symbol("actorConns");
-export const CREATE_ACTOR_CONN_PROXY = Symbol("createActorConnProxy");
-export const TRANSPORT_SYMBOL = Symbol("transport");
-
-export interface ClientDriver {
- action = unknown[], Response = unknown>(
- req: HonoRequest | undefined,
- actorQuery: ActorQuery,
- encoding: Encoding,
- params: unknown,
- name: string,
- ...args: Args
- ): Promise;
- resolveActorId(
- req: HonoRequest | undefined,
- actorQuery: ActorQuery,
- encodingKind: Encoding,
- ): Promise;
- connectWebSocket(
- req: HonoRequest | undefined,
- actorQuery: ActorQuery,
- encodingKind: Encoding,
- ): Promise;
- connectSse(
- req: HonoRequest | undefined,
- actorQuery: ActorQuery,
- encodingKind: Encoding,
- params: unknown,
- ): Promise;
- sendHttpMessage(
- req: HonoRequest | undefined,
- actorId: string,
- encoding: Encoding,
- connectionId: string,
- connectionToken: string,
- message: wsToServer.ToServer,
- ): Promise;
-}
-
-/**
- * Client for managing & connecting to actors.
- *
- * @template A The actors map type that defines the available actors.
- * @see {@link https://rivet.gg/docs/manage|Create & Manage Actors}
- */
-export class ClientRaw {
- #disposed = false;
-
- [ACTOR_CONNS_SYMBOL] = new Set();
-
- #driver: ClientDriver;
- #encodingKind: Encoding;
- [TRANSPORT_SYMBOL]: Transport;
-
- /**
- * Creates an instance of Client.
- *
- * @param {string} managerEndpoint - The manager endpoint. See {@link https://rivet.gg/docs/setup|Initial Setup} for instructions on getting the manager endpoint.
- * @param {ClientOptions} [opts] - Options for configuring the client.
- * @see {@link https://rivet.gg/docs/setup|Initial Setup}
- */
- public constructor(driver: ClientDriver, opts?: ClientOptions) {
- this.#driver = driver;
-
- this.#encodingKind = opts?.encoding ?? "cbor";
- this[TRANSPORT_SYMBOL] = opts?.transport ?? "websocket";
- }
-
- /**
- * Gets a stateless handle to an actor by its ID.
- *
- * @template AD The actor class that this handle is for.
- * @param {string} name - The name of the actor.
- * @param {string} actorId - The ID of the actor.
- * @param {GetWithIdOptions} [opts] - Options for getting the actor.
- * @returns {ActorHandle} - A handle to the actor.
- */
- getForId(
- name: string,
- actorId: string,
- opts?: GetWithIdOptions,
- ): ActorHandle {
- logger().debug("get handle to actor with id", {
- name,
- actorId,
- params: opts?.params,
- });
-
- const actorQuery = {
- getForId: {
- actorId,
- },
- };
-
- const handle = this.#createHandle(opts?.params, actorQuery);
- return createActorProxy(handle) as ActorHandle;
- }
-
- /**
- * Gets a stateless handle to an actor by its key, but does not create the actor if it doesn't exist.
- *
- * @template AD The actor class that this handle is for.
- * @param {string} name - The name of the actor.
- * @param {string | string[]} [key=[]] - The key to identify the actor. Can be a single string or an array of strings.
- * @param {GetWithIdOptions} [opts] - Options for getting the actor.
- * @returns {ActorHandle} - A handle to the actor.
- */
- get(
- name: string,
- key?: string | string[],
- opts?: GetWithIdOptions,
- ): ActorHandle {
- // Convert string to array of strings
- const keyArray: string[] = typeof key === "string" ? [key] : key || [];
-
- logger().debug("get handle to actor", {
- name,
- key: keyArray,
- parameters: opts?.params,
- });
-
- const actorQuery: ActorQuery = {
- getForKey: {
- name,
- key: keyArray,
- },
- };
-
- const handle = this.#createHandle(opts?.params, actorQuery);
- return createActorProxy(handle) as ActorHandle;
- }
-
- /**
- * Gets a stateless handle to an actor by its key, creating it if necessary.
- *
- * @template AD The actor class that this handle is for.
- * @param {string} name - The name of the actor.
- * @param {string | string[]} [key=[]] - The key to identify the actor. Can be a single string or an array of strings.
- * @param {GetOptions} [opts] - Options for getting the actor.
- * @returns {ActorHandle} - A handle to the actor.
- */
- getOrCreate(
- name: string,
- key?: string | string[],
- opts?: GetOrCreateOptions,
- ): ActorHandle {
- // Convert string to array of strings
- const keyArray: string[] = typeof key === "string" ? [key] : key || [];
-
- logger().debug("get or create handle to actor", {
- name,
- key: keyArray,
- parameters: opts?.params,
- createInRegion: opts?.createInRegion,
- });
-
- const actorQuery: ActorQuery = {
- getOrCreateForKey: {
- name,
- key: keyArray,
- input: opts?.createWithInput,
- region: opts?.createInRegion,
- },
- };
-
- const handle = this.#createHandle(opts?.params, actorQuery);
- return createActorProxy(handle) as ActorHandle;
- }
-
- /**
- * Creates a new actor with the provided key and returns a stateless handle to it.
- * Resolves the actor ID and returns a handle with getForId query.
- *
- * @template AD The actor class that this handle is for.
- * @param {string} name - The name of the actor.
- * @param {string | string[]} key - The key to identify the actor. Can be a single string or an array of strings.
- * @param {CreateOptions} [opts] - Options for creating the actor (excluding name and key).
- * @returns {Promise>} - A promise that resolves to a handle to the actor.
- */
- async create(
- name: string,
- key?: string | string[],
- opts?: CreateOptions,
- ): Promise> {
- // Convert string to array of strings
- const keyArray: string[] = typeof key === "string" ? [key] : key || [];
-
- const createQuery = {
- create: {
- ...opts,
- // Do these last to override `opts`
- name,
- key: keyArray,
- },
- } satisfies ActorQuery;
-
- logger().debug("create actor handle", {
- name,
- key: keyArray,
- parameters: opts?.params,
- create: createQuery.create,
- });
-
- // Create the actor
- const actorId = await this.#driver.resolveActorId(
- undefined,
- createQuery,
- this.#encodingKind,
- );
- logger().debug("created actor with ID", {
- name,
- key: keyArray,
- actorId,
- });
-
- // Create handle with actor ID
- const getForIdQuery = {
- getForId: {
- actorId,
- },
- } satisfies ActorQuery;
- const handle = this.#createHandle(opts?.params, getForIdQuery);
-
- const proxy = createActorProxy(handle) as ActorHandle;
-
- return proxy;
- }
-
- #createHandle(params: unknown, actorQuery: ActorQuery): ActorHandleRaw {
- return new ActorHandleRaw(
- this,
- this.#driver,
- params,
- this.#encodingKind,
- actorQuery,
- );
- }
-
- [CREATE_ACTOR_CONN_PROXY](
- conn: ActorConnRaw,
- ): ActorConn {
- // Save to connection list
- this[ACTOR_CONNS_SYMBOL].add(conn);
-
- // Start connection
- conn[CONNECT_SYMBOL]();
-
- return createActorProxy(conn) as ActorConn;
- }
-
- /**
- * Disconnects from all actors.
- *
- * @returns {Promise} A promise that resolves when all connections are closed.
- */
- async dispose(): Promise {
- if (this.#disposed) {
- logger().warn("client already disconnected");
- return;
- }
- this.#disposed = true;
-
- logger().debug("disposing client");
-
- const disposePromises = [];
-
- // Dispose all connections
- for (const conn of this[ACTOR_CONNS_SYMBOL].values()) {
- disposePromises.push(conn.dispose());
- }
-
- await Promise.all(disposePromises);
- }
-}
-
-/**
- * Client type with actor accessors.
- * This adds property accessors for actor names to the ClientRaw base class.
- *
- * @template A The actor application type.
- */
-export type Client> = ClientRaw & {
- [K in keyof ExtractActorsFromApp]: ActorAccessor<
- ExtractActorsFromApp[K]
- >;
-};
-
-export function createClientWithDriver>(
- driver: ClientDriver,
- opts?: ClientOptions,
-): Client {
- const client = new ClientRaw(driver, opts);
-
- // Create proxy for accessing actors by name
- return new Proxy(client, {
- get: (target: ClientRaw, prop: string | symbol, receiver: unknown) => {
- // Get the real property if it exists
- if (typeof prop === "symbol" || prop in target) {
- const value = Reflect.get(target, prop, receiver);
- // Preserve method binding
- if (typeof value === "function") {
- return value.bind(target);
- }
- return value;
- }
-
- // Handle actor accessor for string properties (actor names)
- if (typeof prop === "string") {
- // Return actor accessor object with methods
- return {
- // Handle methods (stateless action)
- get: (
- key?: string | string[],
- opts?: GetWithIdOptions,
- ): ActorHandle[typeof prop]> => {
- return target.get[typeof prop]>(
- prop,
- key,
- opts,
- );
- },
- getOrCreate: (
- key?: string | string[],
- opts?: GetOptions,
- ): ActorHandle[typeof prop]> => {
- return target.getOrCreate[typeof prop]>(
- prop,
- key,
- opts,
- );
- },
- getForId: (
- actorId: string,
- opts?: GetWithIdOptions,
- ): ActorHandle[typeof prop]> => {
- return target.getForId[typeof prop]>(
- prop,
- actorId,
- opts,
- );
- },
- create: async (
- key: string | string[],
- opts: CreateOptions = {},
- ): Promise[typeof prop]>> => {
- return await target.create[typeof prop]>(
- prop,
- key,
- opts,
- );
- },
- } as ActorAccessor[typeof prop]>;
- }
-
- return undefined;
- },
- }) as Client;
-}
-
-/**
- * Creates a proxy for an actor that enables calling actions without explicitly using `.action`.
- **/
-function createActorProxy(
- handle: ActorHandleRaw | ActorConnRaw,
-): ActorHandle | ActorConn {
- // Stores returned action functions for faster calls
- const methodCache = new Map();
- return new Proxy(handle, {
- get(target: ActorHandleRaw, prop: string | symbol, receiver: unknown) {
- // Handle built-in Symbol properties
- if (typeof prop === "symbol") {
- return Reflect.get(target, prop, receiver);
- }
-
- // Handle built-in Promise methods and existing properties
- if (prop === "constructor" || prop in target) {
- const value = Reflect.get(target, prop, receiver);
- // Preserve method binding
- if (typeof value === "function") {
- return value.bind(target);
- }
- return value;
- }
-
- // Create action function that preserves 'this' context
- if (typeof prop === "string") {
- // If JS is attempting to calling this as a promise, ignore it
- if (prop === "then") return undefined;
-
- let method = methodCache.get(prop);
- if (!method) {
- method = (...args: unknown[]) => target.action(prop, ...args);
- methodCache.set(prop, method);
- }
- return method;
- }
- },
-
- // Support for 'in' operator
- has(target: ActorHandleRaw, prop: string | symbol) {
- // All string properties are potentially action functions
- if (typeof prop === "string") {
- return true;
- }
- // For symbols, defer to the target's own has behavior
- return Reflect.has(target, prop);
- },
-
- // Support instanceof checks
- getPrototypeOf(target: ActorHandleRaw) {
- return Reflect.getPrototypeOf(target);
- },
-
- // Prevent property enumeration of non-existent action methods
- ownKeys(target: ActorHandleRaw) {
- return Reflect.ownKeys(target);
- },
-
- // Support proper property descriptors
- getOwnPropertyDescriptor(target: ActorHandleRaw, prop: string | symbol) {
- const targetDescriptor = Reflect.getOwnPropertyDescriptor(target, prop);
- if (targetDescriptor) {
- return targetDescriptor;
- }
- if (typeof prop === "string") {
- // Make action methods appear non-enumerable
- return {
- configurable: true,
- enumerable: false,
- writable: false,
- value: (...args: unknown[]) => target.action(prop, ...args),
- };
- }
- return undefined;
- },
- }) as ActorHandle | ActorConn;
-}
diff --git a/packages/actor/src/driver-test-suite/tests/actor-driver.ts b/packages/actor/src/driver-test-suite/tests/actor-driver.ts
deleted file mode 100644
index 22c89fe24..000000000
--- a/packages/actor/src/driver-test-suite/tests/actor-driver.ts
+++ /dev/null
@@ -1,16 +0,0 @@
-import { describe } from "vitest";
-import type { DriverTestConfig } from "../mod";
-import { runActorStateTests } from "./actor-state";
-import { runActorScheduleTests } from "./actor-schedule";
-
-export function runActorDriverTests(
- driverTestConfig: DriverTestConfig
-) {
- describe("Actor Driver Tests", () => {
- // Run state persistence tests
- runActorStateTests(driverTestConfig);
-
- // Run scheduled alarms tests
- runActorScheduleTests(driverTestConfig);
- });
-}
\ No newline at end of file
diff --git a/packages/actor/src/manager/protocol/mod.ts b/packages/actor/src/manager/protocol/mod.ts
deleted file mode 100644
index 5ca94297f..000000000
--- a/packages/actor/src/manager/protocol/mod.ts
+++ /dev/null
@@ -1,24 +0,0 @@
-import { z } from "zod";
-import { ActorQuerySchema } from "./query";
-import { TransportSchema } from "@/actor/protocol/message/mod";
-export * from "./query";
-
-export const ActorsRequestSchema = z.object({
- query: ActorQuerySchema,
-});
-
-export const ActorsResponseSchema = z.object({
- actorId: z.string(),
- supportedTransports: z.array(TransportSchema),
-});
-
-//export const RivetConfigResponseSchema = z.object({
-// endpoint: z.string(),
-// project: z.string().optional(),
-// environment: z.string().optional(),
-//});
-
-export type ActorsRequest = z.infer;
-export type ActorsResponse = z.infer;
-//export type RivetConfigResponse = z.infer;
-
diff --git a/packages/actor/src/test/driver/actor.ts b/packages/actor/src/test/driver/actor.ts
deleted file mode 100644
index 6dd4bddae..000000000
--- a/packages/actor/src/test/driver/actor.ts
+++ /dev/null
@@ -1,40 +0,0 @@
-import type { ActorDriver, AnyActorInstance } from "@/driver-helpers/mod";
-import type { TestGlobalState } from "./global-state";
-
-export interface ActorDriverContext {
- // Used to test that the actor context works from tests
- isTest: boolean;
-}
-
-export class TestActorDriver implements ActorDriver {
- #state: TestGlobalState;
-
- constructor(state: TestGlobalState) {
- this.#state = state;
- }
-
- getContext(_actorId: string): ActorDriverContext {
- return {
- isTest: true,
- };
- }
-
- async readInput(actorId: string): Promise {
- return this.#state.readInput(actorId);
- }
-
- async readPersistedData(actorId: string): Promise {
- return this.#state.readPersistedData(actorId);
- }
-
- async writePersistedData(actorId: string, data: unknown): Promise {
- this.#state.writePersistedData(actorId, data);
- }
-
- async setAlarm(actor: AnyActorInstance, timestamp: number): Promise {
- const delay = Math.max(timestamp - Date.now(), 0);
- setTimeout(() => {
- actor.onAlarm();
- }, delay);
- }
-}
diff --git a/packages/actor/src/test/driver/global-state.ts b/packages/actor/src/test/driver/global-state.ts
deleted file mode 100644
index 0f3d69fb0..000000000
--- a/packages/actor/src/test/driver/global-state.ts
+++ /dev/null
@@ -1,70 +0,0 @@
-import type { ActorKey } from "@/mod";
-
-export interface ActorState {
- id: string;
- name: string;
- key: ActorKey;
- persistedData: unknown;
- input?: unknown;
-}
-
-export class TestGlobalState {
- #actors: Map = new Map();
-
- #getActor(actorId: string): ActorState {
- const actor = this.#actors.get(actorId);
- if (!actor) {
- throw new Error(`Actor does not exist for ID: ${actorId}`);
- }
- return actor;
- }
-
- readInput(actorId: string): unknown | undefined {
- return this.#getActor(actorId).input;
- }
-
- readPersistedData(actorId: string): unknown | undefined {
- return this.#getActor(actorId).persistedData;
- }
-
- writePersistedData(actorId: string, data: unknown) {
- this.#getActor(actorId).persistedData = data;
- }
-
- createActor(
- actorId: string,
- name: string,
- key: ActorKey,
- input?: unknown,
- ): void {
- // Create actor state if it doesn't exist
- if (!this.#actors.has(actorId)) {
- this.#actors.set(actorId, {
- id: actorId,
- name,
- key,
- persistedData: undefined,
- input,
- });
- } else {
- throw new Error(`Actor already exists for ID: ${actorId}`);
- }
- }
-
- findActor(filter: (actor: ActorState) => boolean): ActorState | undefined {
- for (const actor of this.#actors.values()) {
- if (filter(actor)) {
- return actor;
- }
- }
- return undefined;
- }
-
- getActor(actorId: string): ActorState | undefined {
- return this.#actors.get(actorId);
- }
-
- getAllActors(): ActorState[] {
- return Array.from(this.#actors.values());
- }
-}
diff --git a/packages/actor/src/test/driver/manager.ts b/packages/actor/src/test/driver/manager.ts
deleted file mode 100644
index aa1c875cb..000000000
--- a/packages/actor/src/test/driver/manager.ts
+++ /dev/null
@@ -1,145 +0,0 @@
-import type {
- GetForIdInput,
- GetWithKeyInput,
- GetOrCreateWithKeyInput,
- ManagerDriver,
- CreateInput,
-} from "@/driver-helpers/mod";
-import { ActorAlreadyExists } from "@/actor/errors";
-import type { TestGlobalState } from "./global-state";
-import * as crypto from "node:crypto";
-import { ManagerInspector } from "@/inspector/manager";
-import type { ActorCoreApp } from "@/app/mod";
-import { ActorOutput } from "@/manager/driver";
-
-export class TestManagerDriver implements ManagerDriver {
- #state: TestGlobalState;
-
- /**
- * @internal
- */
- inspector: ManagerInspector = new ManagerInspector(this, {
- getAllActors: () => this.#state.getAllActors(),
- getAllTypesOfActors: () => Object.keys(this.app.config.actors),
- });
-
- constructor(
- private readonly app: ActorCoreApp,
- state: TestGlobalState,
- ) {
- this.#state = state;
- }
-
- async getForId({ actorId }: GetForIdInput): Promise {
- // Validate the actor exists
- const actor = this.#state.getActor(actorId);
- if (!actor) {
- return undefined;
- }
-
- return {
- actorId,
- name: actor.name,
- key: actor.key,
- };
- }
-
- async getWithKey({
- name,
- key,
- }: GetWithKeyInput): Promise {
- // NOTE: This is a slow implementation that checks each actor individually.
- // This can be optimized with an index in the future.
-
- const actor = this.#state.findActor((actor) => {
- if (actor.name !== name) {
- return false;
- }
-
- // handle empty key
- if (key === null || key === undefined) {
- return actor.key === null || actor.key === undefined;
- }
-
- // handle array
- if (Array.isArray(key)) {
- if (!Array.isArray(actor.key)) {
- return false;
- }
- if (key.length !== actor.key.length) {
- return false;
- }
- // Check if all elements in key are in actor.key
- for (let i = 0; i < key.length; i++) {
- if (key[i] !== actor.key[i]) {
- return false;
- }
- }
- return true;
- }
-
- // Handle object
- if (typeof key === "object" && !Array.isArray(key)) {
- if (typeof actor.key !== "object" || Array.isArray(actor.key)) {
- return false;
- }
- if (actor.key === null) {
- return false;
- }
-
- // Check if all keys in key are in actor.key
- const keyObj = key as Record;
- const actorKeyObj = actor.key as unknown as Record;
- for (const k in keyObj) {
- if (!(k in actorKeyObj) || keyObj[k] !== actorKeyObj[k]) {
- return false;
- }
- }
- return true;
- }
-
- // handle scalar
- return key === actor.key;
- });
-
- if (actor) {
- return {
- actorId: actor.id,
- name,
- key: actor.key,
- };
- }
-
- return undefined;
- }
-
- async getOrCreateWithKey(
- input: GetOrCreateWithKeyInput,
- ): Promise {
- const getOutput = await this.getWithKey(input);
- if (getOutput) {
- return getOutput;
- } else {
- return await this.createActor(input);
- }
- }
-
- async createActor({ name, key, input }: CreateInput): Promise {
- // Check if actor with the same name and key already exists
- const existingActor = await this.getWithKey({ name, key });
- if (existingActor) {
- throw new ActorAlreadyExists(name, key);
- }
-
- const actorId = crypto.randomUUID();
- this.#state.createActor(actorId, name, key, input);
-
- this.inspector.onActorsChange(this.#state.getAllActors());
-
- return {
- actorId,
- name,
- key,
- };
- }
-}
diff --git a/packages/actor/src/topologies/partition/mod.ts b/packages/actor/src/topologies/partition/mod.ts
deleted file mode 100644
index ca533cc9a..000000000
--- a/packages/actor/src/topologies/partition/mod.ts
+++ /dev/null
@@ -1 +0,0 @@
-export { PartitionTopologyManager, PartitionTopologyActor } from "./topology";
diff --git a/packages/actor/tests/actor-types.test.ts b/packages/actor/tests/actor-types.test.ts
deleted file mode 100644
index fa84f1d2f..000000000
--- a/packages/actor/tests/actor-types.test.ts
+++ /dev/null
@@ -1,51 +0,0 @@
-import { describe, it, expect, expectTypeOf } from "vitest";
-import { ActorDefinition, type ActorContextOf } from "@/actor/definition";
-import type { ActorContext } from "@/actor/context";
-
-describe("ActorDefinition", () => {
- describe("ActorContextOf type utility", () => {
- it("should correctly extract the context type from an ActorDefinition", () => {
- // Define some simple types for testing
- interface TestState {
- counter: number;
- }
-
- interface TestConnParams {
- clientId: string;
- }
-
- interface TestConnState {
- lastSeen: number;
- }
-
- interface TestVars {
- foo: string;
- }
-
- // For testing type utilities, we don't need a real actor instance
- // We just need a properly typed ActorDefinition to check against
- type TestActions = Record;
- const dummyDefinition = {} as ActorDefinition<
- TestState,
- TestConnParams,
- TestConnState,
- TestVars,
- TestActions
- >;
-
- // Use expectTypeOf to verify our type utility works correctly
- expectTypeOf>().toEqualTypeOf<
- ActorContext
- >();
-
- // Make sure that different types are not compatible
- interface DifferentState {
- value: string;
- }
-
- expectTypeOf>().not.toEqualTypeOf<
- ActorContext
- >();
- });
- });
-});
diff --git a/packages/actor/README.md b/packages/core/README.md
similarity index 100%
rename from packages/actor/README.md
rename to packages/core/README.md
diff --git a/packages/actor/fixtures/driver-test-suite/action-inputs.ts b/packages/core/fixtures/driver-test-suite/action-inputs.ts
similarity index 75%
rename from packages/actor/fixtures/driver-test-suite/action-inputs.ts
rename to packages/core/fixtures/driver-test-suite/action-inputs.ts
index 483612194..2c81bf2ef 100644
--- a/packages/actor/fixtures/driver-test-suite/action-inputs.ts
+++ b/packages/core/fixtures/driver-test-suite/action-inputs.ts
@@ -1,12 +1,12 @@
-import { actor, setup } from "@rivetkit/actor";
+import { worker, setup } from "rivetkit";
interface State {
initialInput?: unknown;
onCreateInput?: unknown;
}
-// Test actor that can capture input during creation
-const inputActor = actor({
+// Test worker that can capture input during creation
+const inputWorker = worker({
createState: (c, { input }): State => {
return {
initialInput: input,
@@ -29,7 +29,7 @@ const inputActor = actor({
});
export const app = setup({
- actors: { inputActor },
+ workers: { inputWorker },
});
export type App = typeof app;
diff --git a/packages/actor/fixtures/driver-test-suite/action-timeout.ts b/packages/core/fixtures/driver-test-suite/action-timeout.ts
similarity index 72%
rename from packages/actor/fixtures/driver-test-suite/action-timeout.ts
rename to packages/core/fixtures/driver-test-suite/action-timeout.ts
index 4fa691934..2aa998b71 100644
--- a/packages/actor/fixtures/driver-test-suite/action-timeout.ts
+++ b/packages/core/fixtures/driver-test-suite/action-timeout.ts
@@ -1,7 +1,7 @@
-import { actor, setup } from "@rivetkit/actor";
+import { worker, setup } from "rivetkit";
-// Short timeout actor
-const shortTimeoutActor = actor({
+// Short timeout worker
+const shortTimeoutWorker = worker({
state: { value: 0 },
options: {
action: {
@@ -20,8 +20,8 @@ const shortTimeoutActor = actor({
},
});
-// Long timeout actor
-const longTimeoutActor = actor({
+// Long timeout worker
+const longTimeoutWorker = worker({
state: { value: 0 },
options: {
action: {
@@ -37,8 +37,8 @@ const longTimeoutActor = actor({
},
});
-// Default timeout actor
-const defaultTimeoutActor = actor({
+// Default timeout worker
+const defaultTimeoutWorker = worker({
state: { value: 0 },
actions: {
normalAction: async (c) => {
@@ -48,8 +48,8 @@ const defaultTimeoutActor = actor({
},
});
-// Sync actor (timeout shouldn't apply)
-const syncActor = actor({
+// Sync worker (timeout shouldn't apply)
+const syncWorker = worker({
state: { value: 0 },
options: {
action: {
@@ -64,11 +64,11 @@ const syncActor = actor({
});
export const app = setup({
- actors: {
- shortTimeoutActor,
- longTimeoutActor,
- defaultTimeoutActor,
- syncActor,
+ workers: {
+ shortTimeoutWorker,
+ longTimeoutWorker,
+ defaultTimeoutWorker,
+ syncWorker,
},
});
diff --git a/packages/actor/fixtures/driver-test-suite/action-types.ts b/packages/core/fixtures/driver-test-suite/action-types.ts
similarity index 86%
rename from packages/actor/fixtures/driver-test-suite/action-types.ts
rename to packages/core/fixtures/driver-test-suite/action-types.ts
index 9a19b96eb..fe920fabd 100644
--- a/packages/actor/fixtures/driver-test-suite/action-types.ts
+++ b/packages/core/fixtures/driver-test-suite/action-types.ts
@@ -1,7 +1,7 @@
-import { actor, setup, UserError } from "@rivetkit/actor";
+import { worker, setup, UserError } from "rivetkit";
-// Actor with synchronous actions
-const syncActor = actor({
+// Worker with synchronous actions
+const syncWorker = worker({
state: { value: 0 },
actions: {
// Simple synchronous action that returns a value directly
@@ -23,8 +23,8 @@ const syncActor = actor({
},
});
-// Actor with asynchronous actions
-const asyncActor = actor({
+// Worker with asynchronous actions
+const asyncWorker = worker({
state: { value: 0, data: null as any },
actions: {
// Async action with a delay
@@ -55,8 +55,8 @@ const asyncActor = actor({
},
});
-// Actor with promise actions
-const promiseActor = actor({
+// Worker with promise actions
+const promiseWorker = worker({
state: { results: [] as string[] },
actions: {
// Action that returns a resolved promise
@@ -82,10 +82,10 @@ const promiseActor = actor({
});
export const app = setup({
- actors: {
- syncActor,
- asyncActor,
- promiseActor,
+ workers: {
+ syncWorker,
+ asyncWorker,
+ promiseWorker,
},
});
diff --git a/packages/actor/fixtures/driver-test-suite/conn-params.ts b/packages/core/fixtures/driver-test-suite/conn-params.ts
similarity index 83%
rename from packages/actor/fixtures/driver-test-suite/conn-params.ts
rename to packages/core/fixtures/driver-test-suite/conn-params.ts
index 7e6eb54e4..6f7c48cc3 100644
--- a/packages/actor/fixtures/driver-test-suite/conn-params.ts
+++ b/packages/core/fixtures/driver-test-suite/conn-params.ts
@@ -1,6 +1,6 @@
-import { actor, setup } from "@rivetkit/actor";
+import { worker, setup } from "rivetkit";
-const counterWithParams = actor({
+const counterWithParams = worker({
state: { count: 0, initializers: [] as string[] },
createConnState: (c, { params }: { params: { name?: string } }) => {
return {
@@ -27,7 +27,7 @@ const counterWithParams = actor({
});
export const app = setup({
- actors: { counter: counterWithParams },
+ workers: { counter: counterWithParams },
});
export type App = typeof app;
diff --git a/packages/actor/fixtures/driver-test-suite/conn-state.ts b/packages/core/fixtures/driver-test-suite/conn-state.ts
similarity index 95%
rename from packages/actor/fixtures/driver-test-suite/conn-state.ts
rename to packages/core/fixtures/driver-test-suite/conn-state.ts
index 7716980a0..81844b87d 100644
--- a/packages/actor/fixtures/driver-test-suite/conn-state.ts
+++ b/packages/core/fixtures/driver-test-suite/conn-state.ts
@@ -1,4 +1,4 @@
-import { actor, setup } from "@rivetkit/actor";
+import { worker, setup } from "rivetkit";
type ConnState = {
username: string;
@@ -7,7 +7,7 @@ type ConnState = {
createdAt: number;
};
-const connStateActor = actor({
+const connStateWorker = worker({
state: {
sharedCounter: 0,
disconnectionCount: 0,
@@ -95,7 +95,7 @@ const connStateActor = actor({
});
export const app = setup({
- actors: { connStateActor },
+ workers: { connStateWorker },
});
export type App = typeof app;
diff --git a/packages/actor/fixtures/driver-test-suite/counter.ts b/packages/core/fixtures/driver-test-suite/counter.ts
similarity index 75%
rename from packages/actor/fixtures/driver-test-suite/counter.ts
rename to packages/core/fixtures/driver-test-suite/counter.ts
index 12b52fc44..5b91c482f 100644
--- a/packages/actor/fixtures/driver-test-suite/counter.ts
+++ b/packages/core/fixtures/driver-test-suite/counter.ts
@@ -1,6 +1,6 @@
-import { actor, setup } from "@rivetkit/actor";
+import { worker, setup } from "rivetkit";
-const counter = actor({
+const counter = worker({
state: { count: 0 },
actions: {
increment: (c, x: number) => {
@@ -15,7 +15,7 @@ const counter = actor({
});
export const app = setup({
- actors: { counter },
+ workers: { counter },
});
export type App = typeof app;
diff --git a/packages/actor/fixtures/driver-test-suite/error-handling.ts b/packages/core/fixtures/driver-test-suite/error-handling.ts
similarity index 88%
rename from packages/actor/fixtures/driver-test-suite/error-handling.ts
rename to packages/core/fixtures/driver-test-suite/error-handling.ts
index 448d3c62a..b717b8366 100644
--- a/packages/actor/fixtures/driver-test-suite/error-handling.ts
+++ b/packages/core/fixtures/driver-test-suite/error-handling.ts
@@ -1,6 +1,6 @@
-import { actor, setup, UserError } from "@rivetkit/actor";
+import { worker, setup, UserError } from "rivetkit";
-const errorHandlingActor = actor({
+const errorHandlingWorker = worker({
state: {
errorLog: [] as string[],
},
@@ -68,15 +68,15 @@ const errorHandlingActor = actor({
},
},
options: {
- // Set a short timeout for this actor's actions
+ // Set a short timeout for this worker's actions
action: {
timeout: 500, // 500ms timeout for actions
},
},
});
-// Actor with custom timeout
-const customTimeoutActor = actor({
+// Worker with custom timeout
+const customTimeoutWorker = worker({
state: {},
actions: {
quickAction: async () => {
@@ -96,9 +96,9 @@ const customTimeoutActor = actor({
});
export const app = setup({
- actors: {
- errorHandlingActor,
- customTimeoutActor,
+ workers: {
+ errorHandlingWorker,
+ customTimeoutWorker,
},
});
diff --git a/packages/actor/fixtures/driver-test-suite/lifecycle.ts b/packages/core/fixtures/driver-test-suite/lifecycle.ts
similarity index 86%
rename from packages/actor/fixtures/driver-test-suite/lifecycle.ts
rename to packages/core/fixtures/driver-test-suite/lifecycle.ts
index 49f6fa0ef..4eec992d4 100644
--- a/packages/actor/fixtures/driver-test-suite/lifecycle.ts
+++ b/packages/core/fixtures/driver-test-suite/lifecycle.ts
@@ -1,6 +1,6 @@
-import { actor, setup } from "@rivetkit/actor";
+import { worker, setup } from "rivetkit";
-const lifecycleActor = actor({
+const lifecycleWorker = worker({
state: {
count: 0,
events: [] as string[],
@@ -35,7 +35,7 @@ const lifecycleActor = actor({
});
export const app = setup({
- actors: { counter: lifecycleActor },
+ workers: { counter: lifecycleWorker },
});
export type App = typeof app;
diff --git a/packages/actor/fixtures/driver-test-suite/metadata.ts b/packages/core/fixtures/driver-test-suite/metadata.ts
similarity index 80%
rename from packages/actor/fixtures/driver-test-suite/metadata.ts
rename to packages/core/fixtures/driver-test-suite/metadata.ts
index 018b5721c..3adfa4cac 100644
--- a/packages/actor/fixtures/driver-test-suite/metadata.ts
+++ b/packages/core/fixtures/driver-test-suite/metadata.ts
@@ -1,19 +1,19 @@
-import { actor, setup } from "@rivetkit/actor";
+import { worker, setup } from "rivetkit";
// Note: For testing only - metadata API will need to be mocked
// in tests since this is implementation-specific
-const metadataActor = actor({
+const metadataWorker = worker({
state: {
lastMetadata: null as any,
- actorName: "",
+ workerName: "",
// Store tags and region in state for testing since they may not be
// available in the context in all environments
storedTags: {} as Record,
storedRegion: null as string | null,
},
onStart: (c) => {
- // Store the actor name during initialization
- c.state.actorName = c.name;
+ // Store the worker name during initialization
+ c.state.workerName = c.name;
},
actions: {
// Set up test tags - this will be called by tests to simulate tags
@@ -42,8 +42,8 @@ const metadataActor = actor({
return metadata;
},
- // Get the actor name
- getActorName: (c) => {
+ // Get the worker name
+ getWorkerName: (c) => {
return c.name;
},
@@ -62,9 +62,9 @@ const metadataActor = actor({
return c.state.storedRegion;
},
- // Get the stored actor name (from onStart)
- getStoredActorName: (c) => {
- return c.state.actorName;
+ // Get the stored worker name (from onStart)
+ getStoredWorkerName: (c) => {
+ return c.state.workerName;
},
// Get last retrieved metadata
@@ -75,7 +75,7 @@ const metadataActor = actor({
});
export const app = setup({
- actors: { metadataActor },
+ workers: { metadataWorker },
});
export type App = typeof app;
diff --git a/packages/actor/fixtures/driver-test-suite/scheduled.ts b/packages/core/fixtures/driver-test-suite/scheduled.ts
similarity index 94%
rename from packages/actor/fixtures/driver-test-suite/scheduled.ts
rename to packages/core/fixtures/driver-test-suite/scheduled.ts
index 3e650f32b..fd2f606e3 100644
--- a/packages/actor/fixtures/driver-test-suite/scheduled.ts
+++ b/packages/core/fixtures/driver-test-suite/scheduled.ts
@@ -1,6 +1,6 @@
-import { actor, setup } from "@rivetkit/actor";
+import { worker, setup } from "rivetkit";
-const scheduled = actor({
+const scheduled = worker({
state: {
lastRun: 0,
scheduledCount: 0,
@@ -76,7 +76,7 @@ const scheduled = actor({
});
export const app = setup({
- actors: { scheduled },
+ workers: { scheduled },
});
export type App = typeof app;
diff --git a/packages/actor/fixtures/driver-test-suite/vars.ts b/packages/core/fixtures/driver-test-suite/vars.ts
similarity index 68%
rename from packages/actor/fixtures/driver-test-suite/vars.ts
rename to packages/core/fixtures/driver-test-suite/vars.ts
index 8e4852785..57bc3fa27 100644
--- a/packages/actor/fixtures/driver-test-suite/vars.ts
+++ b/packages/core/fixtures/driver-test-suite/vars.ts
@@ -1,10 +1,10 @@
-import { actor, setup } from "@rivetkit/actor";
+import { worker, setup } from "rivetkit";
-// Actor with static vars
-const staticVarActor = actor({
+// Worker with static vars
+const staticVarWorker = worker({
state: { value: 0 },
connState: { hello: "world" },
- vars: { counter: 42, name: "test-actor" },
+ vars: { counter: 42, name: "test-worker" },
actions: {
getVars: (c) => {
return c.vars;
@@ -15,8 +15,8 @@ const staticVarActor = actor({
},
});
-// Actor with nested vars
-const nestedVarActor = actor({
+// Worker with nested vars
+const nestedVarWorker = worker({
state: { value: 0 },
connState: { hello: "world" },
vars: {
@@ -41,14 +41,14 @@ const nestedVarActor = actor({
},
});
-// Actor with dynamic vars
-const dynamicVarActor = actor({
+// Worker with dynamic vars
+const dynamicVarWorker = worker({
state: { value: 0 },
connState: { hello: "world" },
createVars: () => {
return {
random: Math.random(),
- computed: `Actor-${Math.floor(Math.random() * 1000)}`,
+ computed: `Worker-${Math.floor(Math.random() * 1000)}`,
};
},
actions: {
@@ -58,8 +58,8 @@ const dynamicVarActor = actor({
},
});
-// Actor with unique vars per instance
-const uniqueVarActor = actor({
+// Worker with unique vars per instance
+const uniqueVarWorker = worker({
state: { value: 0 },
connState: { hello: "world" },
createVars: () => {
@@ -74,8 +74,8 @@ const uniqueVarActor = actor({
},
});
-// Actor that uses driver context
-const driverCtxActor = actor({
+// Worker that uses driver context
+const driverCtxWorker = worker({
state: { value: 0 },
connState: { hello: "world" },
createVars: (c, driverCtx: any) => {
@@ -91,12 +91,12 @@ const driverCtxActor = actor({
});
export const app = setup({
- actors: {
- staticVarActor,
- nestedVarActor,
- dynamicVarActor,
- uniqueVarActor,
- driverCtxActor,
+ workers: {
+ staticVarWorker,
+ nestedVarWorker,
+ dynamicVarWorker,
+ uniqueVarWorker,
+ driverCtxWorker,
},
});
diff --git a/packages/actor/package.json b/packages/core/package.json
similarity index 85%
rename from packages/actor/package.json
rename to packages/core/package.json
index 496b7f580..7d7eeddfb 100644
--- a/packages/actor/package.json
+++ b/packages/core/package.json
@@ -1,5 +1,5 @@
{
- "name": "@rivetkit/actor",
+ "name": "rivetkit",
"version": "0.9.0-rc.1",
"license": "Apache-2.0",
"files": [
@@ -43,12 +43,12 @@
},
"./errors": {
"import": {
- "types": "./dist/actor/errors.d.ts",
- "default": "./dist/actor/errors.js"
+ "types": "./dist/worker/errors.d.ts",
+ "default": "./dist/worker/errors.js"
},
"require": {
- "types": "./dist/actor/errors.d.cts",
- "default": "./dist/actor/errors.cjs"
+ "types": "./dist/worker/errors.d.cts",
+ "default": "./dist/worker/errors.cjs"
}
},
"./utils": {
@@ -121,14 +121,14 @@
"default": "./dist/inspector/mod.cjs"
}
},
- "./inspector/protocol/actor": {
+ "./inspector/protocol/worker": {
"import": {
- "types": "./dist/inspector/protocol/actor/mod.d.ts",
- "default": "./dist/inspector/protocol/actor/mod.js"
+ "types": "./dist/inspector/protocol/worker/mod.d.ts",
+ "default": "./dist/inspector/protocol/worker/mod.js"
},
"require": {
- "types": "./dist/inspector/protocol/actor/mod.d.cts",
- "default": "./dist/inspector/protocol/actor/mod.cjs"
+ "types": "./dist/inspector/protocol/worker/mod.d.cts",
+ "default": "./dist/inspector/protocol/worker/mod.cjs"
}
},
"./inspector/protocol/manager": {
@@ -148,7 +148,7 @@
"sideEffects": false,
"scripts": {
"dev": "yarn build --watch",
- "build": "tsup src/mod.ts src/client/mod.ts src/common/log.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/actor/protocol/inspector/mod.ts src/test/mod.ts src/inspector/protocol/actor/mod.ts src/inspector/protocol/manager/mod.ts src/inspector/mod.ts",
+ "build": "tsup src/mod.ts src/client/mod.ts src/common/log.ts src/worker/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/worker/protocol/inspector/mod.ts src/test/mod.ts src/inspector/protocol/worker/mod.ts src/inspector/protocol/manager/mod.ts src/inspector/mod.ts",
"check-types": "tsc --noEmit",
"boop": "tsc --outDir dist/test -d",
"test": "vitest run",
diff --git a/packages/actor/scripts/dump-openapi.ts b/packages/core/scripts/dump-openapi.ts
similarity index 87%
rename from packages/actor/scripts/dump-openapi.ts
rename to packages/core/scripts/dump-openapi.ts
index e7a61ce85..85e6be0c9 100644
--- a/packages/actor/scripts/dump-openapi.ts
+++ b/packages/core/scripts/dump-openapi.ts
@@ -1,10 +1,10 @@
import { createManagerRouter } from "@/manager/router";
import { AppConfig, AppConfigSchema, setup } from "@/mod";
-import { ConnectionHandlers } from "@/actor/router-endpoints";
+import { ConnectionHandlers } from "@/worker/router-endpoints";
import { DriverConfig } from "@/driver-helpers/config";
import {
TestGlobalState,
- TestActorDriver,
+ TestWorkerDriver,
TestManagerDriver,
} from "@/test/driver/mod";
import { OpenAPIHono } from "@hono/zod-openapi";
@@ -13,13 +13,13 @@ import * as fs from "node:fs/promises";
import { resolve } from "node:path";
function main() {
- const appConfig: AppConfig = AppConfigSchema.parse({ actors: {} });
+ const appConfig: AppConfig = AppConfigSchema.parse({ workers: {} });
const app = setup(appConfig);
const memoryState = new TestGlobalState();
const driverConfig: DriverConfig = {
drivers: {
- actor: new TestActorDriver(memoryState),
+ worker: new TestWorkerDriver(memoryState),
manager: new TestManagerDriver(app, memoryState),
},
getUpgradeWebSocket: () => () => unimplemented(),
@@ -52,7 +52,7 @@ function main() {
openapi: "3.0.0",
info: {
version: VERSION,
- title: "ActorCore API",
+ title: "WorkerCore API",
},
});
diff --git a/packages/actor/src/app/config.ts b/packages/core/src/app/config.ts
similarity index 70%
rename from packages/actor/src/app/config.ts
rename to packages/core/src/app/config.ts
index 88d392bb4..c6c2fd595 100644
--- a/packages/actor/src/app/config.ts
+++ b/packages/core/src/app/config.ts
@@ -1,16 +1,16 @@
-//! These configs configs hold anything that's not platform-specific about running actors.
+//! These configs configs hold anything that's not platform-specific about running workers.
import { z } from "zod";
import type { cors } from "hono/cors";
-import { ActorDefinition, AnyActorDefinition } from "@/actor/definition";
+import { WorkerDefinition, AnyWorkerDefinition } from "@/worker/definition";
import { InspectorConfigSchema } from "@/inspector/config";
// Define CORS options schema
type CorsOptions = NonNullable[0]>;
-export const ActorPeerConfigSchema = z.object({
+export const WorkerPeerConfigSchema = z.object({
/**
- * How long the actor leader holds a lease for.
+ * How long the worker leader holds a lease for.
*
* Milliseconds
**/
@@ -40,22 +40,22 @@ export const ActorPeerConfigSchema = z.object({
*/
messageAckTimeout: z.number().optional().default(1000),
});
-export type ActorPeerConfig = z.infer;
+export type WorkerPeerConfig = z.infer;
-export const ActorsSchema = z.record(
+export const WorkersSchema = z.record(
z.string(),
- z.custom>(),
+ z.custom>(),
);
-export type Actors = z.infer;
+export type Workers = z.infer;
-/** Base config used for the actor config across all platforms. */
+/** Base config used for the worker config across all platforms. */
export const AppConfigSchema = z.object({
- actors: z.record(z.string(), z.custom()),
+ workers: z.record(z.string(), z.custom()),
/** CORS configuration for the router. Uses Hono's CORS middleware options. */
cors: z.custom().optional(),
- /** Base path used to build URLs from. This is specifically used when returning the endpoint to connect to for actors. */
+ /** Base path used to build URLs from. This is specifically used when returning the endpoint to connect to for workers. */
basePath: z.string().optional(),
/** This goes in the URL so it needs to be short. */
@@ -67,13 +67,13 @@ export const AppConfigSchema = z.object({
webSocketInitTimeout: z.number().optional().default(5_000),
/** Peer configuration for coordinated topology. */
- actorPeer: ActorPeerConfigSchema.optional().default({}),
+ workerPeer: WorkerPeerConfigSchema.optional().default({}),
/** Inspector configuration. */
inspector: InspectorConfigSchema.optional().default({ enabled: false }),
});
export type AppConfig = z.infer;
-export type AppConfigInput = Omit<
+export type AppConfigInput = Omit<
z.input,
- "actors"
-> & { actors: A };
+ "workers"
+> & { workers: A };
diff --git a/packages/actor/src/app/inline-client-driver.ts b/packages/core/src/app/inline-client-driver.ts
similarity index 65%
rename from packages/actor/src/app/inline-client-driver.ts
rename to packages/core/src/app/inline-client-driver.ts
index c8a2f2fe0..37503d38e 100644
--- a/packages/actor/src/app/inline-client-driver.ts
+++ b/packages/core/src/app/inline-client-driver.ts
@@ -1,23 +1,23 @@
-import * as errors from "@/actor/errors";
-import * as protoHttpAction from "@/actor/protocol/http/action";
+import * as errors from "@/worker/errors";
+import * as protoHttpAction from "@/worker/protocol/http/action";
import { logger } from "./log";
import type { EventSource } from "eventsource";
-import type * as wsToServer from "@/actor/protocol/message/to-server";
-import { type Encoding, serialize } from "@/actor/protocol/serde";
+import type * as wsToServer from "@/worker/protocol/message/to-server";
+import { type Encoding, serialize } from "@/worker/protocol/serde";
import {
HEADER_CONN_PARAMS,
HEADER_ENCODING,
type ConnectionHandlers,
-} from "@/actor/router-endpoints";
+} from "@/worker/router-endpoints";
import { HonoRequest, type Context as HonoContext, type Next } from "hono";
import invariant from "invariant";
import { ClientDriver } from "@/client/client";
import { ManagerDriver } from "@/manager/driver";
-import { ActorQuery } from "@/manager/protocol/query";
-import { ConnRoutingHandler } from "@/actor/conn-routing-handler";
+import { WorkerQuery } from "@/manager/protocol/query";
+import { ConnRoutingHandler } from "@/worker/conn-routing-handler";
import { sendHttpRequest, serializeWithEncoding } from "@/client/utils";
-import { ActionRequest, ActionResponse } from "@/actor/protocol/http/action";
-import { assertUnreachable } from "@/actor/utils";
+import { ActionRequest, ActionResponse } from "@/worker/protocol/http/action";
+import { assertUnreachable } from "@/worker/utils";
/**
* Client driver that calls the manager driver inline.
@@ -48,20 +48,20 @@ export function createInlineClientDriver(
const driver: ClientDriver = {
action: async = unknown[], Response = unknown>(
req: HonoRequest | undefined,
- actorQuery: ActorQuery,
+ workerQuery: WorkerQuery,
encoding: Encoding,
params: unknown,
actionName: string,
...args: Args
): Promise => {
- // Get the actor ID and meta
- const { actorId, meta } = await queryActor(
+ // Get the worker ID and meta
+ const { workerId, meta } = await queryWorker(
req,
- actorQuery,
+ workerQuery,
managerDriver,
);
- logger().debug("found actor for action", { actorId, meta });
- invariant(actorId, "Missing actor ID");
+ logger().debug("found worker for action", { workerId, meta });
+ invariant(workerId, "Missing worker ID");
// Invoke the action
logger().debug("handling action", { actionName, encoding });
@@ -71,7 +71,7 @@ export function createInlineClientDriver(
params,
actionName,
actionArgs: args,
- actorId,
+ workerId,
});
return output as Response;
} else if ("custom" in routingHandler) {
@@ -79,7 +79,7 @@ export function createInlineClientDriver(
ActionRequest,
ActionResponse
>({
- url: `http://actor/action/${encodeURIComponent(actionName)}`,
+ url: `http://worker/action/${encodeURIComponent(actionName)}`,
method: "POST",
headers: {
[HEADER_ENCODING]: encoding,
@@ -91,7 +91,7 @@ export function createInlineClientDriver(
encoding: encoding,
customFetch: routingHandler.custom.sendRequest.bind(
undefined,
- actorId,
+ workerId,
meta,
),
});
@@ -102,22 +102,22 @@ export function createInlineClientDriver(
}
},
- resolveActorId: async (
+ resolveWorkerId: async (
req: HonoRequest | undefined,
- actorQuery: ActorQuery,
+ workerQuery: WorkerQuery,
_encodingKind: Encoding,
): Promise => {
- // Get the actor ID and meta
- const { actorId } = await queryActor(req, actorQuery, managerDriver);
- logger().debug("resolved actor", { actorId });
- invariant(actorId, "missing actor ID");
+ // Get the worker ID and meta
+ const { workerId } = await queryWorker(req, workerQuery, managerDriver);
+ logger().debug("resolved worker", { workerId });
+ invariant(workerId, "missing worker ID");
- return actorId;
+ return workerId;
},
connectWebSocket: async (
req: HonoRequest | undefined,
- actorQuery: ActorQuery,
+ workerQuery: WorkerQuery,
encodingKind: Encoding,
): Promise => {
throw "UNIMPLEMENTED";
@@ -125,7 +125,7 @@ export function createInlineClientDriver(
connectSse: async (
req: HonoRequest | undefined,
- actorQuery: ActorQuery,
+ workerQuery: WorkerQuery,
encodingKind: Encoding,
params: unknown,
): Promise => {
@@ -134,7 +134,7 @@ export function createInlineClientDriver(
sendHttpMessage: async (
req: HonoRequest | undefined,
- actorId: string,
+ workerId: string,
encoding: Encoding,
connectionId: string,
connectionToken: string,
@@ -148,34 +148,34 @@ export function createInlineClientDriver(
}
/**
- * Query the manager driver to get or create an actor based on the provided query
+ * Query the manager driver to get or create a worker based on the provided query
*/
-export async function queryActor(
+export async function queryWorker(
req: HonoRequest | undefined,
- query: ActorQuery,
+ query: WorkerQuery,
driver: ManagerDriver,
-): Promise<{ actorId: string; meta?: unknown }> {
- logger().debug("querying actor", { query });
- let actorOutput: { actorId: string; meta?: unknown };
+): Promise<{ workerId: string; meta?: unknown }> {
+ logger().debug("querying worker", { query });
+ let workerOutput: { workerId: string; meta?: unknown };
if ("getForId" in query) {
const output = await driver.getForId({
req,
- actorId: query.getForId.actorId,
+ workerId: query.getForId.workerId,
});
- if (!output) throw new errors.ActorNotFound(query.getForId.actorId);
- actorOutput = output;
+ if (!output) throw new errors.WorkerNotFound(query.getForId.workerId);
+ workerOutput = output;
} else if ("getForKey" in query) {
- const existingActor = await driver.getWithKey({
+ const existingWorker = await driver.getWithKey({
req,
name: query.getForKey.name,
key: query.getForKey.key,
});
- if (!existingActor) {
- throw new errors.ActorNotFound(
+ if (!existingWorker) {
+ throw new errors.WorkerNotFound(
`${query.getForKey.name}:${JSON.stringify(query.getForKey.key)}`,
);
}
- actorOutput = existingActor;
+ workerOutput = existingWorker;
} else if ("getOrCreateForKey" in query) {
const getOrCreateOutput = await driver.getOrCreateWithKey({
req,
@@ -184,29 +184,29 @@ export async function queryActor(
input: query.getOrCreateForKey.input,
region: query.getOrCreateForKey.region,
});
- actorOutput = {
- actorId: getOrCreateOutput.actorId,
+ workerOutput = {
+ workerId: getOrCreateOutput.workerId,
meta: getOrCreateOutput.meta,
};
} else if ("create" in query) {
- const createOutput = await driver.createActor({
+ const createOutput = await driver.createWorker({
req,
name: query.create.name,
key: query.create.key,
input: query.create.input,
region: query.create.region,
});
- actorOutput = {
- actorId: createOutput.actorId,
+ workerOutput = {
+ workerId: createOutput.workerId,
meta: createOutput.meta,
};
} else {
throw new errors.InvalidRequest("Invalid query format");
}
- logger().debug("actor query result", {
- actorId: actorOutput.actorId,
- meta: actorOutput.meta,
+ logger().debug("worker query result", {
+ workerId: workerOutput.workerId,
+ meta: workerOutput.meta,
});
- return { actorId: actorOutput.actorId, meta: actorOutput.meta };
+ return { workerId: workerOutput.workerId, meta: workerOutput.meta };
}
diff --git a/packages/actor/src/app/log.ts b/packages/core/src/app/log.ts
similarity index 72%
rename from packages/actor/src/app/log.ts
rename to packages/core/src/app/log.ts
index d56c5aa74..539a71f50 100644
--- a/packages/actor/src/app/log.ts
+++ b/packages/core/src/app/log.ts
@@ -1,6 +1,6 @@
import { getLogger } from "@/common//log";
-export const LOGGER_NAME = "actor-app";
+export const LOGGER_NAME = "worker-app";
export function logger() {
return getLogger(LOGGER_NAME);
diff --git a/packages/actor/src/app/mod.ts b/packages/core/src/app/mod.ts
similarity index 69%
rename from packages/actor/src/app/mod.ts
rename to packages/core/src/app/mod.ts
index c65f90c2b..2b652bb44 100644
--- a/packages/actor/src/app/mod.ts
+++ b/packages/core/src/app/mod.ts
@@ -1,11 +1,11 @@
import {
- type Actors,
+ type Workers,
type AppConfig,
type AppConfigInput,
AppConfigSchema,
} from "./config";
-export class ActorCoreApp {
+export class WorkerCoreApp {
#config: AppConfig;
public get config(): AppConfig {
@@ -17,11 +17,11 @@ export class ActorCoreApp {
}
}
-export function setup(
+export function setup(
input: AppConfigInput,
-): ActorCoreApp {
+): WorkerCoreApp {
const config = AppConfigSchema.parse(input);
- return new ActorCoreApp(config);
+ return new WorkerCoreApp(config);
}
export type { AppConfig };
diff --git a/packages/core/src/client/client.ts b/packages/core/src/client/client.ts
new file mode 100644
index 000000000..1a09ffbd1
--- /dev/null
+++ b/packages/core/src/client/client.ts
@@ -0,0 +1,593 @@
+import type { Transport } from "@/worker/protocol/message/mod";
+import type { Encoding } from "@/worker/protocol/serde";
+import type { WorkerQuery } from "@/manager/protocol/query";
+import {
+ WorkerConn,
+ WorkerConnRaw,
+ CONNECT_SYMBOL,
+ SendHttpMessageOpts,
+} from "./worker-conn";
+import { WorkerHandle, WorkerHandleRaw } from "./worker-handle";
+import { WorkerActionFunction } from "./worker-common";
+import { logger } from "./log";
+import type { WorkerCoreApp } from "@/mod";
+import type { AnyWorkerDefinition } from "@/worker/definition";
+import type * as wsToServer from "@/worker/protocol/message/to-server";
+import type { EventSource } from "eventsource";
+import { createHttpClientDriver } from "./http-client-driver";
+import { HonoRequest } from "hono";
+
+/** Extract the worker registry from the app definition. */
+export type ExtractWorkersFromApp> =
+ A extends WorkerCoreApp ? Workers : never;
+
+/** Extract the app definition from the client. */
+export type ExtractAppFromClient>> =
+ C extends Client ? A : never;
+
+/**
+ * Represents a worker accessor that provides methods to interact with a specific worker.
+ */
+export interface WorkerAccessor {
+ /**
+ * Gets a stateless handle to a worker by its key, but does not create the worker if it doesn't exist.
+ * The worker name is automatically injected from the property accessor.
+ *
+ * @template AD The worker class that this handle is for.
+ * @param {string | string[]} [key=[]] - The key to identify the worker. Can be a single string or an array of strings.
+ * @param {GetWithIdOptions} [opts] - Options for getting the worker.
+ * @returns {WorkerHandle} - A handle to the worker.
+ */
+ get(key?: string | string[], opts?: GetWithIdOptions): WorkerHandle;
+
+ /**
+ * Gets a stateless handle to a worker by its key, creating it if necessary.
+ * The worker name is automatically injected from the property accessor.
+ *
+ * @template AD The worker class that this handle is for.
+ * @param {string | string[]} [key=[]] - The key to identify the worker. Can be a single string or an array of strings.
+ * @param {GetOptions} [opts] - Options for getting the worker.
+ * @returns {WorkerHandle} - A handle to the worker.
+ */
+ getOrCreate(
+ key?: string | string[],
+ opts?: GetOrCreateOptions,
+ ): WorkerHandle;
+
+ /**
+ * Gets a stateless handle to a worker by its ID.
+ *
+ * @template AD The worker class that this handle is for.
+ * @param {string} workerId - The ID of the worker.
+ * @param {GetWithIdOptions} [opts] - Options for getting the worker.
+ * @returns {WorkerHandle} - A handle to the worker.
+ */
+ getForId(workerId: string, opts?: GetWithIdOptions): WorkerHandle;
+
+ /**
+ * Creates a new worker with the name automatically injected from the property accessor,
+ * and returns a stateless handle to it with the worker ID resolved.
+ *
+ * @template AD The worker class that this handle is for.
+ * @param {string | string[]} key - The key to identify the worker. Can be a single string or an array of strings.
+ * @param {CreateOptions} [opts] - Options for creating the worker (excluding name and key).
+ * @returns {Promise>} - A promise that resolves to a handle to the worker.
+ */
+ create(
+ key?: string | string[],
+ opts?: CreateOptions,
+ ): Promise>;
+}
+
+/**
+ * Options for configuring the client.
+ * @typedef {Object} ClientOptions
+ */
+export interface ClientOptions {
+ encoding?: Encoding;
+ transport?: Transport;
+}
+
+/**
+ * Options for querying workers.
+ * @typedef {Object} QueryOptions
+ * @property {unknown} [parameters] - Parameters to pass to the connection.
+ */
+export interface QueryOptions {
+ /** Parameters to pass to the connection. */
+ params?: unknown;
+}
+
+/**
+ * Options for getting a worker by ID.
+ * @typedef {QueryOptions} GetWithIdOptions
+ */
+export interface GetWithIdOptions extends QueryOptions {}
+
+/**
+ * Options for getting a worker.
+ * @typedef {QueryOptions} GetOptions
+ */
+export interface GetOptions extends QueryOptions {}
+
+/**
+ * Options for getting or creating a worker.
+ * @typedef {QueryOptions} GetOrCreateOptions
+ * @property {string} [createInRegion] - Region to create the worker in if it doesn't exist.
+ */
+export interface GetOrCreateOptions extends QueryOptions {
+ /** Region to create the worker in if it doesn't exist. */
+ createInRegion?: string;
+ /** Input data to pass to the worker. */
+ createWithInput?: unknown;
+}
+
+/**
+ * Options for creating a worker.
+ * @typedef {QueryOptions} CreateOptions
+ * @property {string} [region] - The region to create the worker in.
+ */
+export interface CreateOptions extends QueryOptions {
+ /** The region to create the worker in. */
+ region?: string;
+ /** Input data to pass to the worker. */
+ input?: unknown;
+}
+
+/**
+ * Represents a region to connect to.
+ * @typedef {Object} Region
+ * @property {string} id - The region ID.
+ * @property {string} name - The region name.
+ * @see {@link https://rivet.gg/docs/edge|Edge Networking}
+ * @see {@link https://rivet.gg/docs/regions|Available Regions}
+ */
+export interface Region {
+ /**
+ * The region slug.
+ */
+ id: string;
+
+ /**
+ * The human-friendly region name.
+ */
+ name: string;
+}
+
+export const WORKER_CONNS_SYMBOL = Symbol("workerConns");
+export const CREATE_WORKER_CONN_PROXY = Symbol("createWorkerConnProxy");
+export const TRANSPORT_SYMBOL = Symbol("transport");
+
+export interface ClientDriver {
+ action = unknown[], Response = unknown>(
+ req: HonoRequest | undefined,
+ workerQuery: WorkerQuery,
+ encoding: Encoding,
+ params: unknown,
+ name: string,
+ ...args: Args
+ ): Promise;
+ resolveWorkerId(
+ req: HonoRequest | undefined,
+ workerQuery: WorkerQuery,
+ encodingKind: Encoding,
+ ): Promise;
+ connectWebSocket(
+ req: HonoRequest | undefined,
+ workerQuery: WorkerQuery,
+ encodingKind: Encoding,
+ ): Promise;
+ connectSse(
+ req: HonoRequest | undefined,
+ workerQuery: WorkerQuery,
+ encodingKind: Encoding,
+ params: unknown,
+ ): Promise;
+ sendHttpMessage(
+ req: HonoRequest | undefined,
+ workerId: string,
+ encoding: Encoding,
+ connectionId: string,
+ connectionToken: string,
+ message: wsToServer.ToServer,
+ ): Promise;
+}
+
+/**
+ * Client for managing & connecting to workers.
+ *
+ * @template A The workers map type that defines the available workers.
+ * @see {@link https://rivet.gg/docs/manage|Create & Manage Workers}
+ */
+export class ClientRaw {
+ #disposed = false;
+
+ [WORKER_CONNS_SYMBOL] = new Set();
+
+ #driver: ClientDriver;
+ #encodingKind: Encoding;
+ [TRANSPORT_SYMBOL]: Transport;
+
+ /**
+ * Creates an instance of Client.
+ *
+ * @param {string} managerEndpoint - The manager endpoint. See {@link https://rivet.gg/docs/setup|Initial Setup} for instructions on getting the manager endpoint.
+ * @param {ClientOptions} [opts] - Options for configuring the client.
+ * @see {@link https://rivet.gg/docs/setup|Initial Setup}
+ */
+ public constructor(driver: ClientDriver, opts?: ClientOptions) {
+ this.#driver = driver;
+
+ this.#encodingKind = opts?.encoding ?? "cbor";
+ this[TRANSPORT_SYMBOL] = opts?.transport ?? "websocket";
+ }
+
+ /**
+ * Gets a stateless handle to a worker by its ID.
+ *
+ * @template AD The worker class that this handle is for.
+ * @param {string} name - The name of the worker.
+ * @param {string} workerId - The ID of the worker.
+ * @param {GetWithIdOptions} [opts] - Options for getting the worker.
+ * @returns {WorkerHandle