rivetkit 2.0.5 → 2.0.7-rc.1

package/dist/tsup/test/mod.cjs

@@ -1,17 +1,19 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
 
-var _chunkFGFT4FVXcjs = require('../chunk-FGFT4FVX.cjs');
-require('../chunk-MRZS2J4X.cjs');
-require('../chunk-LZIBTLEY.cjs');
-require('../chunk-PHSQJ6QI.cjs');
-require('../chunk-RM2SVURR.cjs');
-require('../chunk-IRMBWX36.cjs');
-require('../chunk-5YTI25C3.cjs');
-require('../chunk-WADSS5X4.cjs');
+var _chunkTZGUSEIJcjs = require('../chunk-TZGUSEIJ.cjs');
+require('../chunk-3Y45CIF4.cjs');
+require('../chunk-G4ABMAQY.cjs');
+require('../chunk-5ZOHIKWG.cjs');
+require('../chunk-B3TLRM4Q.cjs');
+require('../chunk-K4ENQCC4.cjs');
+require('../chunk-DFS77KAA.cjs');
+require('../chunk-SAZCNSVY.cjs');
+require('../chunk-3MBP4WNC.cjs');
+require('../chunk-6EUWRXLT.cjs');
 require('../chunk-5QGQK44L.cjs');
 
 
 
-exports.getPort = _chunkFGFT4FVXcjs.getPort; exports.setupTest = _chunkFGFT4FVXcjs.setupTest;
+exports.getPort = _chunkTZGUSEIJcjs.getPort; exports.setupTest = _chunkTZGUSEIJcjs.setupTest;
 //# sourceMappingURL=mod.cjs.map

package/dist/tsup/test/mod.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["/Users/nathan/rivetkit/packages/rivetkit/dist/tsup/test/mod.cjs"],"names":[],"mappings":"AAAA;AACE;AACA;AACF,yDAA8B;AAC9B,iCAA8B;AAC9B,iCAA8B;AAC9B,iCAA8B;AAC9B,iCAA8B;AAC9B,iCAA8B;AAC9B,iCAA8B;AAC9B,iCAA8B;AAC9B,iCAA8B;AAC9B;AACE;AACA;AACF,6FAAC","file":"/Users/nathan/rivetkit/packages/rivetkit/dist/tsup/test/mod.cjs"}
+{"version":3,"sources":["/Users/nathan/rivetkit/packages/rivetkit/dist/tsup/test/mod.cjs"],"names":[],"mappings":"AAAA;AACE;AACA;AACF,yDAA8B;AAC9B,iCAA8B;AAC9B,iCAA8B;AAC9B,iCAA8B;AAC9B,iCAA8B;AAC9B,iCAA8B;AAC9B,iCAA8B;AAC9B,iCAA8B;AAC9B,iCAA8B;AAC9B,iCAA8B;AAC9B,iCAA8B;AAC9B;AACE;AACA;AACF,6FAAC","file":"/Users/nathan/rivetkit/packages/rivetkit/dist/tsup/test/mod.cjs"}

package/dist/tsup/test/mod.d.cts

@@ -1,16 +1,15 @@
 import { TestContext } from 'vitest';
-import { Q as Registry, C as Client } from '../connection-DTzmWwU5.cjs';
-import 'zod';
-import 'pino';
-import 'hono';
+import { K as Registry, C as Client } from '../conn-DdzHTm2E.cjs';
+import 'hono/streaming';
+import 'hono/ws';
 import '../utils.cjs';
 import '../utils-fwx3o3K9.cjs';
+import 'hono';
 import 'hono/utils/http-status';
+import 'zod';
+import 'pino';
 import 'nanoevents';
-import '../common-CXCe7s6i.cjs';
 import 'zod/v4';
-import 'hono/streaming';
-import 'hono/ws';
 
 interface SetupTestResult<A extends Registry<any>> {
     client: Client<A>;

package/dist/tsup/test/mod.d.ts

@@ -1,16 +1,15 @@
 import { TestContext } from 'vitest';
-import { Q as Registry, C as Client } from '../connection-BvE-Oq7t.js';
-import 'zod';
-import 'pino';
-import 'hono';
+import { K as Registry, C as Client } from '../conn-DCSQgIlw.js';
+import 'hono/streaming';
+import 'hono/ws';
 import '../utils.js';
 import '../utils-fwx3o3K9.js';
+import 'hono';
 import 'hono/utils/http-status';
+import 'zod';
+import 'pino';
 import 'nanoevents';
-import '../common-CXCe7s6i.js';
 import 'zod/v4';
-import 'hono/streaming';
-import 'hono/ws';
 
 interface SetupTestResult<A extends Registry<any>> {
     client: Client<A>;

package/dist/tsup/test/mod.js

@@ -1,14 +1,16 @@
 import {
   getPort,
   setupTest
-} from "../chunk-YW6Y6VNE.js";
-import "../chunk-L7QRXNWP.js";
-import "../chunk-CKA54YQN.js";
-import "../chunk-PG3K2LI7.js";
-import "../chunk-B2QGJGZQ.js";
-import "../chunk-2MD57QF4.js";
-import "../chunk-WNGOBAA7.js";
-import "../chunk-CFFKMUYH.js";
+} from "../chunk-SBKRVQS2.js";
+import "../chunk-HPT3I7UU.js";
+import "../chunk-4GP7BZSR.js";
+import "../chunk-BW5DPM6Z.js";
+import "../chunk-GZVBFXBI.js";
+import "../chunk-E4UVJKSV.js";
+import "../chunk-JD54PXWP.js";
+import "../chunk-YQ4XQYPM.js";
+import "../chunk-PUSQNDJG.js";
+import "../chunk-RVP5RUSC.js";
 import "../chunk-YPZFLUO6.js";
 export {
   getPort,

package/dist/tsup/utils.cjs

@@ -10,7 +10,8 @@
 
 
 
-var _chunkWADSS5X4cjs = require('./chunk-WADSS5X4.cjs');
+
+var _chunk6EUWRXLTcjs = require('./chunk-6EUWRXLT.cjs');
 require('./chunk-5QGQK44L.cjs');
 
 
@@ -24,5 +25,6 @@ require('./chunk-5QGQK44L.cjs');
 
 
 
-exports.SinglePromiseQueue = _chunkWADSS5X4cjs.SinglePromiseQueue; exports.VERSION = _chunkWADSS5X4cjs.VERSION; exports.assertUnreachable = _chunkWADSS5X4cjs.assertUnreachable; exports.bufferToArrayBuffer = _chunkWADSS5X4cjs.bufferToArrayBuffer; exports.combineUrlPath = _chunkWADSS5X4cjs.combineUrlPath; exports.dbg = _chunkWADSS5X4cjs.dbg; exports.getEnvUniversal = _chunkWADSS5X4cjs.getEnvUniversal; exports.httpUserAgent = _chunkWADSS5X4cjs.httpUserAgent; exports.setLongTimeout = _chunkWADSS5X4cjs.setLongTimeout; exports.stringifyError = _chunkWADSS5X4cjs.stringifyError; exports.toUint8Array = _chunkWADSS5X4cjs.toUint8Array;
+
+exports.SinglePromiseQueue = _chunk6EUWRXLTcjs.SinglePromiseQueue; exports.VERSION = _chunk6EUWRXLTcjs.VERSION; exports.assertUnreachable = _chunk6EUWRXLTcjs.assertUnreachable; exports.bufferToArrayBuffer = _chunk6EUWRXLTcjs.bufferToArrayBuffer; exports.combineUrlPath = _chunk6EUWRXLTcjs.combineUrlPath; exports.dbg = _chunk6EUWRXLTcjs.dbg; exports.getEnvUniversal = _chunk6EUWRXLTcjs.getEnvUniversal; exports.httpUserAgent = _chunk6EUWRXLTcjs.httpUserAgent; exports.promiseWithResolvers = _chunk6EUWRXLTcjs.promiseWithResolvers; exports.setLongTimeout = _chunk6EUWRXLTcjs.setLongTimeout; exports.stringifyError = _chunk6EUWRXLTcjs.stringifyError; exports.toUint8Array = _chunk6EUWRXLTcjs.toUint8Array;
 //# sourceMappingURL=utils.cjs.map

package/dist/tsup/utils.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["/Users/nathan/rivetkit/packages/rivetkit/dist/tsup/utils.cjs"],"names":[],"mappings":"AAAA;AACE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACF,wDAA6B;AAC7B,gCAA6B;AAC7B;AACE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACF,wnBAAC","file":"/Users/nathan/rivetkit/packages/rivetkit/dist/tsup/utils.cjs"}
+{"version":3,"sources":["/Users/nathan/rivetkit/packages/rivetkit/dist/tsup/utils.cjs"],"names":[],"mappings":"AAAA;AACE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACF,wDAA6B;AAC7B,gCAA6B;AAC7B;AACE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACF,+rBAAC","file":"/Users/nathan/rivetkit/packages/rivetkit/dist/tsup/utils.cjs"}

package/dist/tsup/utils.d.cts

@@ -18,6 +18,16 @@ declare function toUint8Array(data: ArrayBuffer | ArrayBufferView): Uint8Array;
 type LongTimeoutHandle = {
     abort: () => void;
 };
+/**
+ * Polyfill for Promise.withResolvers().
+ *
+ * This is specifically for Cloudflare Workers. Their implementation of Promise.withResolvers does not work correctly.
+ */
+declare function promiseWithResolvers<T>(): {
+    promise: Promise<T>;
+    resolve: (value: T | PromiseLike<T>) => void;
+    reject: (reason?: any) => void;
+};
 declare function setLongTimeout(listener: () => void, after: number): LongTimeoutHandle;
 /**
  * A tiny utility that coalesces/enqueues async operations so only the latest
@@ -50,4 +60,4 @@ declare function bufferToArrayBuffer(buf: Buffer | Uint8Array): ArrayBuffer;
  */
 declare function combineUrlPath(endpoint: string, path: string, queryParams?: Record<string, string | undefined>): string;
 
-export { type LongTimeoutHandle, SinglePromiseQueue, type UpgradeWebSocket, VERSION, bufferToArrayBuffer, combineUrlPath, dbg, getEnvUniversal, httpUserAgent, setLongTimeout, toUint8Array };
+export { type LongTimeoutHandle, SinglePromiseQueue, type UpgradeWebSocket, VERSION, bufferToArrayBuffer, combineUrlPath, dbg, getEnvUniversal, httpUserAgent, promiseWithResolvers, setLongTimeout, toUint8Array };

package/dist/tsup/utils.d.ts

@@ -18,6 +18,16 @@ declare function toUint8Array(data: ArrayBuffer | ArrayBufferView): Uint8Array;
 type LongTimeoutHandle = {
     abort: () => void;
 };
+/**
+ * Polyfill for Promise.withResolvers().
+ *
+ * This is specifically for Cloudflare Workers. Their implementation of Promise.withResolvers does not work correctly.
+ */
+declare function promiseWithResolvers<T>(): {
+    promise: Promise<T>;
+    resolve: (value: T | PromiseLike<T>) => void;
+    reject: (reason?: any) => void;
+};
 declare function setLongTimeout(listener: () => void, after: number): LongTimeoutHandle;
 /**
  * A tiny utility that coalesces/enqueues async operations so only the latest
@@ -50,4 +60,4 @@ declare function bufferToArrayBuffer(buf: Buffer | Uint8Array): ArrayBuffer;
  */
 declare function combineUrlPath(endpoint: string, path: string, queryParams?: Record<string, string | undefined>): string;
 
-export { type LongTimeoutHandle, SinglePromiseQueue, type UpgradeWebSocket, VERSION, bufferToArrayBuffer, combineUrlPath, dbg, getEnvUniversal, httpUserAgent, setLongTimeout, toUint8Array };
+export { type LongTimeoutHandle, SinglePromiseQueue, type UpgradeWebSocket, VERSION, bufferToArrayBuffer, combineUrlPath, dbg, getEnvUniversal, httpUserAgent, promiseWithResolvers, setLongTimeout, toUint8Array };

package/dist/tsup/utils.js

@@ -7,10 +7,11 @@ import {
   dbg,
   getEnvUniversal,
   httpUserAgent,
+  promiseWithResolvers,
   setLongTimeout,
   stringifyError,
   toUint8Array
-} from "./chunk-CFFKMUYH.js";
+} from "./chunk-RVP5RUSC.js";
 import "./chunk-YPZFLUO6.js";
 export {
   SinglePromiseQueue,
@@ -21,6 +22,7 @@ export {
   dbg,
   getEnvUniversal,
   httpUserAgent,
+  promiseWithResolvers,
   setLongTimeout,
   stringifyError,
   toUint8Array

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rivetkit",
-  "version": "2.0.5",
+  "version": "2.0.7-rc.1",
   "description": "Lightweight libraries for building stateful actors on edge platforms",
   "license": "Apache-2.0",
   "keywords": [
@@ -147,12 +147,15 @@
   "engines": {
     "node": ">=22.0.0"
   },
-  "sideEffects": false,
+  "sideEffects": [
+    "./dist/tsup/chunk-*.js",
+    "./dist/tsup/chunk-*.cjs"
+  ],
   "dependencies": {
     "@bare-ts/lib": "~0.3.0",
     "@hono/standard-validator": "^0.1.3",
     "@hono/zod-openapi": "^0.19.10",
-    "@rivetkit/engine-runner": "https://pkg.pr.new/rivet-dev/engine/@rivetkit/engine-runner@b72b232",
+    "@rivetkit/engine-runner": "https://pkg.pr.new/rivet-dev/engine/@rivetkit/engine-runner@3002",
     "@rivetkit/fast-json-patch": "^3.1.2",
     "cbor-x": "^1.6.0",
     "hono": "^4.7.0",
@@ -177,7 +180,8 @@
     "tsx": "^4.19.4",
     "typescript": "^5.7.3",
     "vitest": "^3.1.1",
-    "ws": "^8.18.1"
+    "ws": "^8.18.1",
+    "bufferutil": "^4.0.9"
   },
   "peerDependencies": {
     "@hono/node-server": "^1.14.0",

package/src/actor/action.ts

@@ -2,7 +2,7 @@ import type { ActorKey } from "@/actor/mod";
 import type { Client } from "@/client/client";
 import type { Logger } from "@/common/log";
 import type { Registry } from "@/registry/mod";
-import type { Conn, ConnId } from "./connection";
+import type { Conn, ConnId } from "./conn";
 import type { ActorContext } from "./context";
 import type { AnyDatabaseProvider, InferDatabaseClient } from "./database";
 import type { SaveStateOptions } from "./instance";

package/src/actor/config.ts

@@ -1,7 +1,7 @@
 import { z } from "zod";
 import type { UniversalWebSocket } from "@/common/websocket-interface";
 import type { ActionContext } from "./action";
-import type { Conn } from "./connection";
+import type { Conn } from "./conn";
 import type { ActorContext } from "./context";
 import type { AnyDatabaseProvider } from "./database";
 

package/src/actor/conn-drivers.ts

@@ -0,0 +1,205 @@
+import type { SSEStreamingApi } from "hono/streaming";
+import type { WSContext } from "hono/ws";
+import type { WebSocket } from "ws";
+import type { AnyConn } from "@/actor/conn";
+import type { AnyActorInstance } from "@/actor/instance";
+import type { CachedSerializer, Encoding } from "@/actor/protocol/serde";
+import { encodeDataToString } from "@/actor/protocol/serde";
+import type * as protocol from "@/schemas/client-protocol/mod";
+import { assertUnreachable, type promiseWithResolvers } from "@/utils";
+
+export enum ConnDriverKind {
+	WEBSOCKET = 0,
+	SSE = 1,
+	HTTP = 2,
+}
+
+export enum ConnReadyState {
+	UNKNOWN = -1,
+	CONNECTING = 0,
+	OPEN = 1,
+	CLOSING = 2,
+	CLOSED = 3,
+}
+
+export interface ConnDriverWebSocketState {
+	encoding: Encoding;
+	websocket: WSContext;
+	closePromise: ReturnType<typeof promiseWithResolvers<void>>;
+}
+
+export interface ConnDriverSseState {
+	encoding: Encoding;
+	stream: SSEStreamingApi;
+}
+
+export type ConnDriverHttpState = Record<never, never>;
+
+export type ConnDriverState =
+	| { [ConnDriverKind.WEBSOCKET]: ConnDriverWebSocketState }
+	| { [ConnDriverKind.SSE]: ConnDriverSseState }
+	| { [ConnDriverKind.HTTP]: ConnDriverHttpState };
+
+export interface ConnDriver<State> {
+	sendMessage?(
+		actor: AnyActorInstance,
+		conn: AnyConn,
+		state: State,
+		message: CachedSerializer<protocol.ToClient>,
+	): void;
+
+	/**
+	 * This returns a promise since we commonly disconnect at the end of a program, and not waiting will cause the socket to not close cleanly.
+	 */
+	disconnect(
+		actor: AnyActorInstance,
+		conn: AnyConn,
+		state: State,
+		reason?: string,
+	): Promise<void>;
+
+	/**
+	 * Returns the ready state of the connection.
+	 * This is used to determine if the connection is ready to send messages, or if the connection is stale.
+	 */
+	getConnectionReadyState(
+		actor: AnyActorInstance,
+		conn: AnyConn,
+		state: State,
+	): ConnReadyState | undefined;
+}
+
+// MARK: WebSocket
+const WEBSOCKET_DRIVER: ConnDriver<ConnDriverWebSocketState> = {
+	sendMessage: (
+		actor: AnyActorInstance,
+		_conn: AnyConn,
+		state: ConnDriverWebSocketState,
+		message: CachedSerializer<protocol.ToClient>,
+	) => {
+		const serialized = message.serialize(state.encoding);
+
+		actor.rLog.debug({
+			msg: "sending websocket message",
+			encoding: state.encoding,
+			dataType: typeof serialized,
+			isUint8Array: serialized instanceof Uint8Array,
+			isArrayBuffer: serialized instanceof ArrayBuffer,
+			dataLength: (serialized as any).byteLength || (serialized as any).length,
+		});
+
+		// Convert Uint8Array to ArrayBuffer for proper transmission
+		if (serialized instanceof Uint8Array) {
+			const buffer = serialized.buffer.slice(
+				serialized.byteOffset,
+				serialized.byteOffset + serialized.byteLength,
+			);
+			// Handle SharedArrayBuffer case
+			if (buffer instanceof SharedArrayBuffer) {
+				const arrayBuffer = new ArrayBuffer(buffer.byteLength);
+				new Uint8Array(arrayBuffer).set(new Uint8Array(buffer));
+				actor.rLog.debug({
+					msg: "converted SharedArrayBuffer to ArrayBuffer",
+					byteLength: arrayBuffer.byteLength,
+				});
+				state.websocket.send(arrayBuffer);
+			} else {
+				actor.rLog.debug({
+					msg: "sending ArrayBuffer",
+					byteLength: buffer.byteLength,
+				});
+				state.websocket.send(buffer);
+			}
+		} else {
+			actor.rLog.debug({
+				msg: "sending string data",
+				length: (serialized as string).length,
+			});
+			state.websocket.send(serialized);
+		}
+	},
+
+	disconnect: async (
+		_actor: AnyActorInstance,
+		_conn: AnyConn,
+		state: ConnDriverWebSocketState,
+		reason?: string,
+	) => {
+		// Close socket
+		state.websocket.close(1000, reason);
+
+		// Create promise to wait for socket to close gracefully
+		await state.closePromise.promise;
+	},
+
+	getConnectionReadyState: (
+		_actor: AnyActorInstance,
+		_conn: AnyConn,
+		state: ConnDriverWebSocketState,
+	): ConnReadyState | undefined => {
+		return state.websocket.readyState;
+	},
+};
+
+// MARK: SSE
+const SSE_DRIVER: ConnDriver<ConnDriverSseState> = {
+	sendMessage: (
+		_actor: AnyActorInstance,
+		_conn: AnyConn,
+		state: ConnDriverSseState,
+		message: CachedSerializer<protocol.ToClient>,
+	) => {
+		state.stream.writeSSE({
+			data: encodeDataToString(message.serialize(state.encoding)),
+		});
+	},
+
+	disconnect: async (
+		_actor: AnyActorInstance,
+		_conn: AnyConn,
+		state: ConnDriverSseState,
+		_reason?: string,
+	) => {
+		state.stream.close();
+	},
+
+	getConnectionReadyState: (
+		_actor: AnyActorInstance,
+		_conn: AnyConn,
+		state: ConnDriverSseState,
+	): ConnReadyState | undefined => {
+		if (state.stream.aborted || state.stream.closed) {
+			return ConnReadyState.CLOSED;
+		}
+
+		return ConnReadyState.OPEN;
+	},
+};
+
+// MARK: HTTP
+const HTTP_DRIVER: ConnDriver<ConnDriverHttpState> = {
+	getConnectionReadyState(_actor, _conn) {
+		// TODO: This might not be the correct logic
+		return ConnReadyState.OPEN;
+	},
+	disconnect: async () => {
+		// Noop
+		// TODO: Abort the request
+	},
+};
+
+/** List of all connection drivers. */
+export const CONN_DRIVERS: Record<ConnDriverKind, ConnDriver<unknown>> = {
+	[ConnDriverKind.WEBSOCKET]: WEBSOCKET_DRIVER,
+	[ConnDriverKind.SSE]: SSE_DRIVER,
+	[ConnDriverKind.HTTP]: HTTP_DRIVER,
+};
+
+export function getConnDriverKindFromState(
+	state: ConnDriverState,
+): ConnDriverKind {
+	if (ConnDriverKind.WEBSOCKET in state) return ConnDriverKind.WEBSOCKET;
+	else if (ConnDriverKind.SSE in state) return ConnDriverKind.SSE;
+	else if (ConnDriverKind.HTTP in state) return ConnDriverKind.HTTP;
+	else assertUnreachable(state);
+}

package/src/actor/conn-socket.ts

@@ -0,0 +1,6 @@
+import type { ConnDriverState } from "./conn-drivers";
+
+export interface ConnSocket {
+	socketId: string;
+	driverState: ConnDriverState;
+}