@rivetkit/rivetkit-native 0.0.0-main.31c444e

package/index.d.ts

@@ -0,0 +1,92 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/* auto-generated by NAPI-RS */
+
+export interface JsBindParam {
+  kind: string
+  intValue?: number
+  floatValue?: number
+  textValue?: string
+  blobValue?: Buffer
+}
+export interface ExecuteResult {
+  changes: number
+}
+export interface QueryResult {
+  columns: Array<string>
+  rows: Array<Array<any>>
+}
+/** Open a native SQLite database backed by the envoy's KV channel. */
+export declare function openDatabaseFromEnvoy(jsHandle: JsEnvoyHandle, actorId: string): Promise<JsNativeDatabase>
+/** Configuration for starting the native envoy client. */
+export interface JsEnvoyConfig {
+  endpoint: string
+  token: string
+  namespace: string
+  poolName: string
+  version: number
+  metadata?: any
+  /**
+   * Log level for the Rust tracing subscriber (e.g. "trace", "debug", "info", "warn", "error").
+   * Falls back to RIVET_LOG_LEVEL, then LOG_LEVEL, then RUST_LOG env vars. Defaults to "warn".
+   */
+  logLevel?: string
+}
+/** Options for KV list operations. */
+export interface JsKvListOptions {
+  reverse?: boolean
+  limit?: number
+}
+/** A key-value entry returned from KV list operations. */
+export interface JsKvEntry {
+  key: Buffer
+  value: Buffer
+}
+/** A single hibernating request entry. */
+export interface HibernatingRequestEntry {
+  gatewayId: Buffer
+  requestId: Buffer
+}
+/**
+ * Start the native envoy client synchronously.
+ *
+ * Returns a handle immediately. The caller must call `await handle.started()`
+ * to wait for the connection to be ready.
+ */
+export declare function startEnvoySyncJs(config: JsEnvoyConfig, eventCallback: (event: any) => void): JsEnvoyHandle
+/** Start the native envoy client asynchronously. */
+export declare function startEnvoyJs(config: JsEnvoyConfig, eventCallback: (event: any) => void): JsEnvoyHandle
+/** Native SQLite database handle exposed to JavaScript. */
+export declare class JsNativeDatabase {
+  run(sql: string, params?: Array<JsBindParam> | undefined | null): Promise<ExecuteResult>
+  query(sql: string, params?: Array<JsBindParam> | undefined | null): Promise<QueryResult>
+  exec(sql: string): Promise<QueryResult>
+  close(): Promise<void>
+}
+/** Native envoy handle exposed to JavaScript via N-API. */
+export declare class JsEnvoyHandle {
+  started(): Promise<void>
+  shutdown(immediate: boolean): void
+  get envoyKey(): string
+  sleepActor(actorId: string, generation?: number | undefined | null): void
+  stopActor(actorId: string, generation?: number | undefined | null, error?: string | undefined | null): void
+  destroyActor(actorId: string, generation?: number | undefined | null): void
+  setAlarm(actorId: string, alarmTs?: number | undefined | null, generation?: number | undefined | null): void
+  kvGet(actorId: string, keys: Array<Buffer>): Promise<Array<Buffer | undefined | null>>
+  kvPut(actorId: string, entries: Array<JsKvEntry>): Promise<void>
+  kvDelete(actorId: string, keys: Array<Buffer>): Promise<void>
+  kvDeleteRange(actorId: string, start: Buffer, end: Buffer): Promise<void>
+  kvListAll(actorId: string, options?: JsKvListOptions | undefined | null): Promise<Array<JsKvEntry>>
+  kvListRange(actorId: string, start: Buffer, end: Buffer, exclusive?: boolean | undefined | null, options?: JsKvListOptions | undefined | null): Promise<Array<JsKvEntry>>
+  kvListPrefix(actorId: string, prefix: Buffer, options?: JsKvListOptions | undefined | null): Promise<Array<JsKvEntry>>
+  kvDrop(actorId: string): Promise<void>
+  restoreHibernatingRequests(actorId: string, requests: Array<HibernatingRequestEntry>): void
+  sendHibernatableWebSocketMessageAck(gatewayId: Buffer, requestId: Buffer, clientMessageIndex: number): void
+  /** Send a message on an open WebSocket connection identified by messageIdHex. */
+  sendWsMessage(gatewayId: Buffer, requestId: Buffer, data: Buffer, binary: boolean): Promise<void>
+  /** Close an open WebSocket connection. */
+  closeWebsocket(gatewayId: Buffer, requestId: Buffer, code?: number | undefined | null, reason?: string | undefined | null): Promise<void>
+  startServerless(payload: Buffer): Promise<void>
+  respondCallback(responseId: string, data: any): Promise<void>
+}

package/index.js

@@ -0,0 +1,319 @@
+/* tslint:disable */
+/* eslint-disable */
+/* prettier-ignore */
+
+/* auto-generated by NAPI-RS */
+
+const { existsSync, readFileSync } = require('fs')
+const { join } = require('path')
+
+const { platform, arch } = process
+
+let nativeBinding = null
+let localFileExisted = false
+let loadError = null
+
+function isMusl() {
+  // For Node 10
+  if (!process.report || typeof process.report.getReport !== 'function') {
+    try {
+      const lddPath = require('child_process').execSync('which ldd').toString().trim()
+      return readFileSync(lddPath, 'utf8').includes('musl')
+    } catch (e) {
+      return true
+    }
+  } else {
+    const { glibcVersionRuntime } = process.report.getReport().header
+    return !glibcVersionRuntime
+  }
+}
+
+switch (platform) {
+  case 'android':
+    switch (arch) {
+      case 'arm64':
+        localFileExisted = existsSync(join(__dirname, 'rivetkit-native.android-arm64.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./rivetkit-native.android-arm64.node')
+          } else {
+            nativeBinding = require('@rivetkit/rivetkit-native-android-arm64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm':
+        localFileExisted = existsSync(join(__dirname, 'rivetkit-native.android-arm-eabi.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./rivetkit-native.android-arm-eabi.node')
+          } else {
+            nativeBinding = require('@rivetkit/rivetkit-native-android-arm-eabi')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Android ${arch}`)
+    }
+    break
+  case 'win32':
+    switch (arch) {
+      case 'x64':
+        localFileExisted = existsSync(
+          join(__dirname, 'rivetkit-native.win32-x64-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./rivetkit-native.win32-x64-msvc.node')
+          } else {
+            nativeBinding = require('@rivetkit/rivetkit-native-win32-x64-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'ia32':
+        localFileExisted = existsSync(
+          join(__dirname, 'rivetkit-native.win32-ia32-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./rivetkit-native.win32-ia32-msvc.node')
+          } else {
+            nativeBinding = require('@rivetkit/rivetkit-native-win32-ia32-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm64':
+        localFileExisted = existsSync(
+          join(__dirname, 'rivetkit-native.win32-arm64-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./rivetkit-native.win32-arm64-msvc.node')
+          } else {
+            nativeBinding = require('@rivetkit/rivetkit-native-win32-arm64-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Windows: ${arch}`)
+    }
+    break
+  case 'darwin':
+    localFileExisted = existsSync(join(__dirname, 'rivetkit-native.darwin-universal.node'))
+    try {
+      if (localFileExisted) {
+        nativeBinding = require('./rivetkit-native.darwin-universal.node')
+      } else {
+        nativeBinding = require('@rivetkit/rivetkit-native-darwin-universal')
+      }
+      break
+    } catch {}
+    switch (arch) {
+      case 'x64':
+        localFileExisted = existsSync(join(__dirname, 'rivetkit-native.darwin-x64.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./rivetkit-native.darwin-x64.node')
+          } else {
+            nativeBinding = require('@rivetkit/rivetkit-native-darwin-x64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm64':
+        localFileExisted = existsSync(
+          join(__dirname, 'rivetkit-native.darwin-arm64.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./rivetkit-native.darwin-arm64.node')
+          } else {
+            nativeBinding = require('@rivetkit/rivetkit-native-darwin-arm64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on macOS: ${arch}`)
+    }
+    break
+  case 'freebsd':
+    if (arch !== 'x64') {
+      throw new Error(`Unsupported architecture on FreeBSD: ${arch}`)
+    }
+    localFileExisted = existsSync(join(__dirname, 'rivetkit-native.freebsd-x64.node'))
+    try {
+      if (localFileExisted) {
+        nativeBinding = require('./rivetkit-native.freebsd-x64.node')
+      } else {
+        nativeBinding = require('@rivetkit/rivetkit-native-freebsd-x64')
+      }
+    } catch (e) {
+      loadError = e
+    }
+    break
+  case 'linux':
+    switch (arch) {
+      case 'x64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'rivetkit-native.linux-x64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./rivetkit-native.linux-x64-musl.node')
+            } else {
+              nativeBinding = require('@rivetkit/rivetkit-native-linux-x64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'rivetkit-native.linux-x64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./rivetkit-native.linux-x64-gnu.node')
+            } else {
+              nativeBinding = require('@rivetkit/rivetkit-native-linux-x64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'arm64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'rivetkit-native.linux-arm64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./rivetkit-native.linux-arm64-musl.node')
+            } else {
+              nativeBinding = require('@rivetkit/rivetkit-native-linux-arm64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'rivetkit-native.linux-arm64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./rivetkit-native.linux-arm64-gnu.node')
+            } else {
+              nativeBinding = require('@rivetkit/rivetkit-native-linux-arm64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'arm':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'rivetkit-native.linux-arm-musleabihf.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./rivetkit-native.linux-arm-musleabihf.node')
+            } else {
+              nativeBinding = require('@rivetkit/rivetkit-native-linux-arm-musleabihf')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'rivetkit-native.linux-arm-gnueabihf.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./rivetkit-native.linux-arm-gnueabihf.node')
+            } else {
+              nativeBinding = require('@rivetkit/rivetkit-native-linux-arm-gnueabihf')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'riscv64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'rivetkit-native.linux-riscv64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./rivetkit-native.linux-riscv64-musl.node')
+            } else {
+              nativeBinding = require('@rivetkit/rivetkit-native-linux-riscv64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'rivetkit-native.linux-riscv64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./rivetkit-native.linux-riscv64-gnu.node')
+            } else {
+              nativeBinding = require('@rivetkit/rivetkit-native-linux-riscv64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 's390x':
+        localFileExisted = existsSync(
+          join(__dirname, 'rivetkit-native.linux-s390x-gnu.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./rivetkit-native.linux-s390x-gnu.node')
+          } else {
+            nativeBinding = require('@rivetkit/rivetkit-native-linux-s390x-gnu')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Linux: ${arch}`)
+    }
+    break
+  default:
+    throw new Error(`Unsupported OS: ${platform}, architecture: ${arch}`)
+}
+
+if (!nativeBinding) {
+  if (loadError) {
+    throw loadError
+  }
+  throw new Error(`Failed to load native binding`)
+}
+
+const { JsNativeDatabase, openDatabaseFromEnvoy, JsEnvoyHandle, startEnvoySyncJs, startEnvoyJs } = nativeBinding
+
+module.exports.JsNativeDatabase = JsNativeDatabase
+module.exports.openDatabaseFromEnvoy = openDatabaseFromEnvoy
+module.exports.JsEnvoyHandle = JsEnvoyHandle
+module.exports.startEnvoySyncJs = startEnvoySyncJs
+module.exports.startEnvoyJs = startEnvoyJs

package/package.json

@@ -0,0 +1,63 @@
+{
+	"name": "@rivetkit/rivetkit-native",
+	"version": "0.0.0-main.31c444e",
+	"description": "Native N-API addon for RivetKit providing envoy client and SQLite access",
+	"license": "Apache-2.0",
+	"main": "index.js",
+	"types": "index.d.ts",
+	"exports": {
+		".": {
+			"types": "./index.d.ts",
+			"default": "./index.js"
+		},
+		"./wrapper": {
+			"types": "./wrapper.d.ts",
+			"default": "./wrapper.js"
+		}
+	},
+	"engines": {
+		"node": ">= 20.0.0"
+	},
+	"napi": {
+		"name": "rivetkit-native",
+		"triples": {
+			"defaults": false,
+			"additional": [
+				"x86_64-unknown-linux-gnu",
+				"aarch64-unknown-linux-gnu",
+				"x86_64-unknown-linux-musl",
+				"aarch64-unknown-linux-musl",
+				"x86_64-apple-darwin",
+				"aarch64-apple-darwin",
+				"x86_64-pc-windows-msvc"
+			]
+		}
+	},
+	"files": [
+		"index.js",
+		"index.d.ts",
+		"wrapper.js",
+		"wrapper.d.ts",
+		"package.json",
+		"scripts/build.mjs"
+	],
+	"scripts": {
+		"build": "node scripts/build.mjs",
+		"build:release": "node scripts/build.mjs --release",
+		"build:force": "node scripts/build.mjs --force",
+		"build:force:release": "node scripts/build.mjs --force --release"
+	},
+	"dependencies": {
+		"@napi-rs/cli": "^2.18.4",
+		"@rivetkit/engine-envoy-protocol": "0.0.0-main.31c444e"
+	},
+	"optionalDependencies": {
+		"@rivetkit/rivetkit-native-darwin-arm64": "0.0.0-main.31c444e",
+		"@rivetkit/rivetkit-native-darwin-x64": "0.0.0-main.31c444e",
+		"@rivetkit/rivetkit-native-linux-arm64-gnu": "0.0.0-main.31c444e",
+		"@rivetkit/rivetkit-native-linux-arm64-musl": "0.0.0-main.31c444e",
+		"@rivetkit/rivetkit-native-linux-x64-gnu": "0.0.0-main.31c444e",
+		"@rivetkit/rivetkit-native-linux-x64-musl": "0.0.0-main.31c444e",
+		"@rivetkit/rivetkit-native-win32-x64-msvc": "0.0.0-main.31c444e"
+	}
+}

package/scripts/build.mjs

@@ -0,0 +1,66 @@
+#!/usr/bin/env node
+/**
+ * Smart build wrapper for rivetkit-native.
+ *
+ * Skips the napi build if a prebuilt .node file already exists next to
+ * this package (either a root-level `rivetkit-native.*.node` or one inside
+ * a `npm/<platform>/` directory). This lets CI skip a redundant napi build
+ * when the cross-compiled artifacts have already been downloaded from the
+ * platform build jobs.
+ *
+ * Pass `--force` to always run the napi build.
+ */
+import { execSync } from "node:child_process";
+import { existsSync, readdirSync, statSync } from "node:fs";
+import { dirname, join } from "node:path";
+import { fileURLToPath } from "node:url";
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+const packageDir = join(__dirname, "..");
+
+const args = process.argv.slice(2);
+const force = args.includes("--force");
+const releaseArg = args.find((a) => a === "--release");
+const extraFlags = releaseArg ? ["--release"] : [];
+
+// Explicit skip for environments that don't need the native binary (e.g.
+// Docker engine-frontend build which only consumes TypeScript types).
+if (!force && process.env.SKIP_NAPI_BUILD === "1") {
+	console.log(
+		"[rivetkit-native/build] SKIP_NAPI_BUILD=1 — skipping napi build",
+	);
+	process.exit(0);
+}
+
+function hasPrebuiltArtifact() {
+	// Check for root-level .node files.
+	const rootFiles = readdirSync(packageDir);
+	if (rootFiles.some((f) => f.endsWith(".node"))) {
+		return true;
+	}
+	// Check for any npm/<platform>/*.node files.
+	const npmDir = join(packageDir, "npm");
+	if (existsSync(npmDir) && statSync(npmDir).isDirectory()) {
+		for (const entry of readdirSync(npmDir)) {
+			const platDir = join(npmDir, entry);
+			if (!statSync(platDir).isDirectory()) continue;
+			const files = readdirSync(platDir);
+			if (files.some((f) => f.endsWith(".node"))) {
+				return true;
+			}
+		}
+	}
+	return false;
+}
+
+if (!force && hasPrebuiltArtifact()) {
+	console.log(
+		"[rivetkit-native/build] prebuilt .node artifact found — skipping napi build",
+	);
+	console.log("[rivetkit-native/build] use --force to rebuild from source");
+	process.exit(0);
+}
+
+const cmd = ["napi", "build", "--platform", ...extraFlags].join(" ");
+console.log(`[rivetkit-native/build] running: ${cmd}`);
+execSync(cmd, { stdio: "inherit", cwd: packageDir });

package/wrapper.d.ts

@@ -0,0 +1,144 @@
+import type { JsNativeDatabase, JsKvEntry, JsKvListOptions } from "./index";
+
+export type { JsNativeDatabase, JsKvEntry, JsKvListOptions };
+
+// Re-export protocol types from the envoy protocol package
+export * as protocol from "@rivetkit/engine-envoy-protocol";
+
+export interface HibernatingWebSocketMetadata {
+	gatewayId: ArrayBuffer;
+	requestId: ArrayBuffer;
+	envoyMessageIndex: number;
+	rivetMessageIndex: number;
+	path: string;
+	headers: Record<string, string>;
+}
+
+export interface KvListOptions {
+	reverse?: boolean;
+	limit?: number;
+}
+
+/** Matches the TS EnvoyHandle interface from @rivetkit/engine-envoy-client */
+export interface EnvoyHandle {
+	shutdown(immediate: boolean): void;
+	getProtocolMetadata(): any | undefined;
+	getEnvoyKey(): string;
+	started(): Promise<void>;
+	getActor(actorId: string, generation?: number): any | undefined;
+	sleepActor(actorId: string, generation?: number): void;
+	stopActor(actorId: string, generation?: number, error?: string): void;
+	destroyActor(actorId: string, generation?: number): void;
+	setAlarm(actorId: string, alarmTs: number | null, generation?: number): void;
+	kvGet(actorId: string, keys: Uint8Array[]): Promise<(Uint8Array | null)[]>;
+	kvListAll(actorId: string, options?: KvListOptions): Promise<[Uint8Array, Uint8Array][]>;
+	kvListRange(
+		actorId: string,
+		start: Uint8Array,
+		end: Uint8Array,
+		exclusive?: boolean,
+		options?: KvListOptions,
+	): Promise<[Uint8Array, Uint8Array][]>;
+	kvListPrefix(
+		actorId: string,
+		prefix: Uint8Array,
+		options?: KvListOptions,
+	): Promise<[Uint8Array, Uint8Array][]>;
+	kvPut(actorId: string, entries: [Uint8Array, Uint8Array][]): Promise<void>;
+	kvDelete(actorId: string, keys: Uint8Array[]): Promise<void>;
+	kvDeleteRange(actorId: string, start: Uint8Array, end: Uint8Array): Promise<void>;
+	kvDrop(actorId: string): Promise<void>;
+	restoreHibernatingRequests(
+		actorId: string,
+		metaEntries: HibernatingWebSocketMetadata[],
+	): void;
+	sendHibernatableWebSocketMessageAck(
+		gatewayId: ArrayBuffer,
+		requestId: ArrayBuffer,
+		clientMessageIndex: number,
+	): void;
+	startServerlessActor(payload: ArrayBuffer): Promise<void>;
+}
+
+/** Matches the TS EnvoyConfig interface from @rivetkit/engine-envoy-client */
+export interface EnvoyConfig {
+	logger?: any;
+	version: number;
+	endpoint: string;
+	token?: string;
+	namespace: string;
+	poolName: string;
+	prepopulateActorNames: Record<string, { metadata: Record<string, any> }>;
+	metadata?: Record<string, any>;
+	notGlobal?: boolean;
+	debugLatencyMs?: number;
+	serverlessStartPayload?: ArrayBuffer;
+	fetch: (
+		envoyHandle: EnvoyHandle,
+		actorId: string,
+		gatewayId: ArrayBuffer,
+		requestId: ArrayBuffer,
+		request: Request,
+	) => Promise<Response>;
+	websocket: (
+		envoyHandle: EnvoyHandle,
+		actorId: string,
+		ws: any,
+		gatewayId: ArrayBuffer,
+		requestId: ArrayBuffer,
+		request: Request,
+		path: string,
+		headers: Record<string, string>,
+		isHibernatable: boolean,
+		isRestoringHibernatable: boolean,
+	) => Promise<void>;
+	hibernatableWebSocket: {
+		canHibernate: (
+			actorId: string,
+			gatewayId: ArrayBuffer,
+			requestId: ArrayBuffer,
+			request: Request,
+		) => boolean;
+	};
+	onActorStart: (
+		envoyHandle: EnvoyHandle,
+		actorId: string,
+		generation: number,
+		config: import("@rivetkit/engine-envoy-protocol").ActorConfig,
+		preloadedKv: import("@rivetkit/engine-envoy-protocol").PreloadedKv | null,
+	) => Promise<void>;
+	onActorStop: (
+		envoyHandle: EnvoyHandle,
+		actorId: string,
+		generation: number,
+		reason: import("@rivetkit/engine-envoy-protocol").StopActorReason,
+	) => Promise<void>;
+	onShutdown: () => void;
+}
+
+/** Start the native envoy synchronously. Returns a handle immediately. */
+export declare function startEnvoySync(config: EnvoyConfig): EnvoyHandle;
+
+/** Start the native envoy and wait for it to be ready. */
+export declare function startEnvoy(config: EnvoyConfig): Promise<EnvoyHandle>;
+
+/** Open a native database backed by envoy KV for the specified actor. */
+export declare function openDatabaseFromEnvoy(
+	handle: EnvoyHandle,
+	actorId: string,
+): Promise<JsNativeDatabase>;
+
+export interface NativeRawDatabase {
+	execute: <TRow extends Record<string, unknown> = Record<string, unknown>>(
+		query: string,
+		...args: unknown[]
+	) => Promise<TRow[]>;
+	close: () => Promise<void>;
+}
+
+export declare function openRawDatabaseFromEnvoy(
+	handle: EnvoyHandle,
+	actorId: string,
+): Promise<NativeRawDatabase>;
+
+export declare const utils: {};

package/wrapper.js

@@ -0,0 +1,577 @@
+/**
+ * Thin JS wrapper that adapts native callback envelopes to the
+ * EnvoyConfig callback shape used by the TypeScript envoy client.
+ *
+ * The native addon sends JSON envelopes with a "kind" field.
+ * This wrapper routes them to the appropriate EnvoyConfig callbacks.
+ */
+
+const native = require("./index");
+
+// CloseEvent was added to Node.js in v22. Polyfill for older versions.
+if (typeof CloseEvent === "undefined") {
+	global.CloseEvent = class CloseEvent extends Event {
+		constructor(type, init = {}) {
+			super(type);
+			this.code = init.code ?? 0;
+			this.reason = init.reason ?? "";
+			this.wasClean = init.wasClean ?? false;
+		}
+	};
+}
+
+// Re-export protocol for consumers that need protocol types at runtime
+let _protocol;
+try {
+	_protocol = require("@rivetkit/engine-envoy-protocol");
+} catch {
+	_protocol = {};
+}
+module.exports.protocol = _protocol;
+module.exports.utils = {};
+
+/**
+ * Create a wrapped EnvoyHandle that matches the TS EnvoyHandle interface.
+ */
+function wrapHandle(jsHandle) {
+	const handle = {
+		started: () => jsHandle.started(),
+		shutdown: (immediate) => jsHandle.shutdown(immediate ?? false),
+		getProtocolMetadata: () => undefined,
+		getEnvoyKey: () => jsHandle.envoyKey,
+		getActor: (_actorId, _generation) => undefined,
+		sleepActor: (actorId, generation) =>
+			jsHandle.sleepActor(actorId, generation ?? null),
+		stopActor: (actorId, generation, error) =>
+			jsHandle.stopActor(actorId, generation ?? null, error ?? null),
+		destroyActor: (actorId, generation) =>
+			jsHandle.destroyActor(actorId, generation ?? null),
+		setAlarm: (actorId, alarmTs, generation) =>
+			jsHandle.setAlarm(actorId, alarmTs ?? null, generation ?? null),
+		kvGet: async (actorId, keys) => {
+			const bufKeys = keys.map((k) => Buffer.from(k));
+			const result = await jsHandle.kvGet(actorId, bufKeys);
+			return result.map((v) => (v ? new Uint8Array(v) : null));
+		},
+		kvPut: async (actorId, entries) => {
+			const jsEntries = entries.map(([k, v]) => ({
+				key: Buffer.from(k),
+				value: Buffer.from(v),
+			}));
+			return jsHandle.kvPut(actorId, jsEntries);
+		},
+		kvDelete: async (actorId, keys) => {
+			const bufKeys = keys.map((k) => Buffer.from(k));
+			return jsHandle.kvDelete(actorId, bufKeys);
+		},
+		kvDeleteRange: async (actorId, start, end) => {
+			return jsHandle.kvDeleteRange(
+				actorId,
+				Buffer.from(start),
+				Buffer.from(end),
+			);
+		},
+		kvListAll: async (actorId, options) => {
+			const result = await jsHandle.kvListAll(actorId, options || null);
+			return result.map((e) => [new Uint8Array(e.key), new Uint8Array(e.value)]);
+		},
+		kvListRange: async (actorId, start, end, exclusive, options) => {
+			const result = await jsHandle.kvListRange(
+				actorId,
+				Buffer.from(start),
+				Buffer.from(end),
+				exclusive,
+				options || null,
+			);
+			return result.map((e) => [new Uint8Array(e.key), new Uint8Array(e.value)]);
+		},
+		kvListPrefix: async (actorId, prefix, options) => {
+			const result = await jsHandle.kvListPrefix(
+				actorId,
+				Buffer.from(prefix),
+				options || null,
+			);
+			return result.map((e) => [new Uint8Array(e.key), new Uint8Array(e.value)]);
+		},
+		kvDrop: (actorId) => jsHandle.kvDrop(actorId),
+		restoreHibernatingRequests: (actorId, metaEntries) => {
+			const requests = (metaEntries || []).map((e) => ({
+				gatewayId: Buffer.from(e.gatewayId),
+				requestId: Buffer.from(e.requestId),
+			}));
+			jsHandle.restoreHibernatingRequests(actorId, requests);
+		},
+		sendHibernatableWebSocketMessageAck: (
+			gatewayId,
+			requestId,
+			clientMessageIndex,
+		) =>
+			jsHandle.sendHibernatableWebSocketMessageAck(
+				Buffer.from(gatewayId),
+				Buffer.from(requestId),
+				clientMessageIndex,
+			),
+		startServerlessActor: async (payload) =>
+			await jsHandle.startServerless(Buffer.from(payload)),
+		// Internal: expose raw handle for openDatabaseFromEnvoy
+		_raw: jsHandle,
+	};
+	return handle;
+}
+
+/**
+ * Start the native envoy synchronously with EnvoyConfig callbacks.
+ * Returns a wrapped handle matching the TS EnvoyHandle interface.
+ */
+function startEnvoySync(config) {
+	const wrappedHandle = { current: null };
+
+	const jsHandle = native.startEnvoySyncJs(
+		{
+			endpoint: config.endpoint,
+			token: config.token || "",
+			namespace: config.namespace,
+			poolName: config.poolName,
+			version: config.version,
+			metadata: config.metadata || null,
+			notGlobal: config.notGlobal,
+		},
+		(event) => {
+			handleEvent(event, config, wrappedHandle);
+		},
+	);
+
+	const handle = wrapHandle(jsHandle);
+	wrappedHandle.current = handle;
+	return handle;
+}
+
+/**
+ * Start the native envoy and wait for it to be ready.
+ */
+async function startEnvoy(config) {
+	const handle = startEnvoySync(config);
+	await handle.started();
+	return handle;
+}
+
+/**
+ * Open a native database backed by envoy KV.
+ */
+async function openDatabaseFromEnvoy(handle, actorId) {
+	const rawHandle = handle._raw || handle;
+	return native.openDatabaseFromEnvoy(rawHandle, actorId);
+}
+
+function isPlainObject(value) {
+	return (
+		!!value &&
+		typeof value === "object" &&
+		!Array.isArray(value) &&
+		Object.getPrototypeOf(value) === Object.prototype
+	);
+}
+
+function toNativeBinding(value) {
+	if (value === null || value === undefined) {
+		return { kind: "null" };
+	}
+	if (typeof value === "bigint") {
+		return { kind: "int", intValue: Number(value) };
+	}
+	if (typeof value === "number") {
+		return Number.isInteger(value)
+			? { kind: "int", intValue: value }
+			: { kind: "float", floatValue: value };
+	}
+	if (typeof value === "string") {
+		return { kind: "text", textValue: value };
+	}
+	if (value instanceof ArrayBuffer) {
+		return { kind: "blob", blobValue: Buffer.from(value) };
+	}
+	if (ArrayBuffer.isView(value)) {
+		return {
+			kind: "blob",
+			blobValue: Buffer.from(value.buffer, value.byteOffset, value.byteLength),
+		};
+	}
+
+	throw new Error(`unsupported sqlite binding type: ${typeof value}`);
+}
+
+function extractNamedSqliteParameters(sql) {
+	return [...sql.matchAll(/([:@$][A-Za-z_][A-Za-z0-9_]*)/g)].map(
+		(match) => match[1],
+	);
+}
+
+function getNamedSqliteBinding(bindings, name) {
+	if (name in bindings) {
+		return bindings[name];
+	}
+
+	const bareName = name.slice(1);
+	if (bareName in bindings) {
+		return bindings[bareName];
+	}
+
+	for (const prefix of [":", "@", "$"]) {
+		const candidate = `${prefix}${bareName}`;
+		if (candidate in bindings) {
+			return bindings[candidate];
+		}
+	}
+
+	return undefined;
+}
+
+function normalizeBindings(sql, args) {
+	if (!args || args.length === 0) {
+		return [];
+	}
+
+	if (
+		args.length === 1 &&
+		isPlainObject(args[0]) &&
+		!(args[0] instanceof Uint8Array)
+	) {
+		const names = extractNamedSqliteParameters(sql);
+		if (names.length === 0) {
+			throw new Error(
+				"native sqlite object bindings require named placeholders in the SQL statement",
+			);
+		}
+		return names.map((name) => {
+			const value = getNamedSqliteBinding(args[0], name);
+			if (value === undefined) {
+				throw new Error(`missing bind parameter: ${name}`);
+			}
+			return toNativeBinding(value);
+		});
+	}
+
+	return args.map(toNativeBinding);
+}
+
+function mapRows(rows, columns) {
+	return rows.map((row) => {
+		const rowObject = {};
+		for (let i = 0; i < columns.length; i++) {
+			rowObject[columns[i]] = row[i];
+		}
+		return rowObject;
+	});
+}
+
+async function openRawDatabaseFromEnvoy(handle, actorId) {
+	const nativeDb = await openDatabaseFromEnvoy(handle, actorId);
+	let closed = false;
+
+	const ensureOpen = () => {
+		if (closed) {
+			throw new Error("database is closed");
+		}
+	};
+
+	return {
+		execute: async (query, ...args) => {
+			ensureOpen();
+
+			if (args.length > 0) {
+				const bindings = normalizeBindings(query, args);
+				const token = query.trimStart().slice(0, 16).toUpperCase();
+				const returnsRows =
+					token.startsWith("SELECT") ||
+					token.startsWith("PRAGMA") ||
+					token.startsWith("WITH") ||
+					/\bRETURNING\b/i.test(query);
+
+				if (returnsRows) {
+					const result = await nativeDb.query(query, bindings);
+					return mapRows(result.rows, result.columns);
+				}
+
+				await nativeDb.run(query, bindings);
+				return [];
+			}
+
+			const result = await nativeDb.exec(query);
+			return mapRows(result.rows, result.columns);
+		},
+		close: async () => {
+			if (closed) {
+				return;
+			}
+			closed = true;
+			await nativeDb.close();
+		},
+	};
+}
+
+/**
+ * Route callback envelopes from the native addon to EnvoyConfig callbacks.
+ */
+function handleEvent(event, config, wrappedHandle) {
+	const handle = wrappedHandle.current;
+
+	switch (event.kind) {
+		case "actor_start": {
+			const input = event.input ? Buffer.from(event.input, "base64") : undefined;
+			const actorConfig = {
+				name: event.name,
+				key: event.key || undefined,
+				createTs: event.createTs,
+				input,
+			};
+			Promise.resolve(
+				config.onActorStart(
+					handle,
+					event.actorId,
+					event.generation,
+					actorConfig,
+					null, // preloadedKv
+				),
+			).then(
+				async () => {
+					if (handle._raw) {
+						await handle._raw.respondCallback(event.responseId, {});
+					}
+				},
+				async (err) => {
+					console.error("onActorStart error:", err);
+					if (handle._raw) {
+						await handle._raw.respondCallback(event.responseId, {
+							error: String(err),
+						});
+					}
+				},
+			);
+			break;
+		}
+		case "actor_stop": {
+			Promise.resolve(
+				config.onActorStop(
+					handle,
+					event.actorId,
+					event.generation,
+					event.reason || "stopped",
+				),
+			).then(
+				async () => {
+					if (handle._raw) {
+						await handle._raw.respondCallback(event.responseId, {});
+					}
+				},
+				async (err) => {
+					console.error("onActorStop error:", err);
+					if (handle._raw) {
+						await handle._raw.respondCallback(event.responseId, {
+							error: String(err),
+						});
+					}
+				},
+			);
+			break;
+		}
+		case "http_request": {
+			const body = event.body ? Buffer.from(event.body, "base64") : undefined;
+			const messageId = Buffer.from(event.messageId);
+			const gatewayId = messageId.subarray(0, 4);
+			const requestId = messageId.subarray(4, 8);
+
+			// Build a Request object matching the TS envoy-client interface
+			const headers = new Headers(event.headers || {});
+			const url = `http://actor${event.path}`;
+			const request = new Request(url, {
+				method: event.method,
+				headers,
+				body: body || undefined,
+			});
+
+			Promise.resolve(
+				config.fetch(handle, event.actorId, gatewayId, requestId, request),
+			).then(
+				async (response) => {
+					if (handle._raw && response) {
+						const respHeaders = {};
+						if (response.headers) {
+							response.headers.forEach((value, key) => {
+								respHeaders[key] = value;
+							});
+						}
+						const respBody = response.body
+							? Buffer.from(await response.arrayBuffer()).toString("base64")
+							: undefined;
+						await handle._raw.respondCallback(event.responseId, {
+							status: response.status || 200,
+							headers: respHeaders,
+							body: respBody,
+						});
+					}
+				},
+				async (err) => {
+					console.error("fetch callback error:", err);
+					if (handle._raw) {
+						await handle._raw.respondCallback(event.responseId, {
+							status: 500,
+							headers: { "content-type": "text/plain" },
+							body: Buffer.from(String(err)).toString("base64"),
+						});
+					}
+				},
+			);
+			break;
+		}
+		case "websocket_open": {
+			if (config.websocket) {
+				const messageId = Buffer.from(event.messageId);
+				const gatewayId = messageId.subarray(0, 4);
+				const requestId = messageId.subarray(4, 8);
+				const wsIdHex = gatewayId.toString("hex") + requestId.toString("hex");
+
+				const headers = new Headers(event.headers || {});
+				headers.set("Upgrade", "websocket");
+				headers.set("Connection", "Upgrade");
+				const url = `http://actor${event.path}`;
+				const request = new Request(url, {
+					method: "GET",
+					headers,
+				});
+
+				// Create a WebSocket-like object backed by EventTarget.
+				// The EngineActorDriver calls addEventListener on this.
+				// Events are dispatched when native websocket_message/close events arrive.
+				const target = new EventTarget();
+				const OPEN = 1;
+				const CLOSED = 3;
+				const ws = Object.create(target, {
+					readyState: { value: OPEN, writable: true },
+					OPEN: { value: OPEN },
+					CLOSED: { value: CLOSED },
+					send: {
+						value: (data) => {
+							if (handle._raw) {
+								const isBinary =
+									data instanceof ArrayBuffer || ArrayBuffer.isView(data);
+								const bytes = isBinary
+									? Buffer.from(data instanceof ArrayBuffer ? data : data.buffer, data instanceof ArrayBuffer ? 0 : data.byteOffset, data instanceof ArrayBuffer ? data.byteLength : data.byteLength)
+									: Buffer.from(String(data));
+								handle._raw.sendWsMessage(gatewayId, requestId, bytes, isBinary);
+							}
+						}
+					},
+					close: {
+						value: (code, reason) => {
+							ws.readyState = CLOSED;
+							if (handle._raw) {
+								handle._raw.closeWebsocket(
+									gatewayId,
+									requestId,
+									code != null ? code : undefined,
+									reason != null ? String(reason) : undefined,
+								);
+							}
+						}
+					},
+					addEventListener: { value: target.addEventListener.bind(target) },
+					removeEventListener: { value: target.removeEventListener.bind(target) },
+					dispatchEvent: { value: target.dispatchEvent.bind(target) },
+				});
+
+				// Store the ws object so websocket_message/close events can dispatch to it
+				if (!handle._wsMap) handle._wsMap = new Map();
+				handle._wsMap.set(wsIdHex, ws);
+
+				const canHibernate = config.hibernatableWebSocket
+					? config.hibernatableWebSocket.canHibernate(
+						event.actorId,
+						gatewayId,
+						requestId,
+						request,
+					)
+					: false;
+
+				Promise.resolve(
+					config.websocket(
+						handle,
+						event.actorId,
+						ws,
+						gatewayId,
+						requestId,
+						request,
+						event.path,
+						event.headers || {},
+						canHibernate,
+						false,
+					),
+				).then(() => {
+					ws.dispatchEvent(new Event("open"));
+				}).catch((err) => {
+					console.error("[wrapper] websocket callback error:", err);
+				});
+			}
+			break;
+		}
+		case "websocket_message": {
+			if (handle._wsMap && event.messageId) {
+				const messageId = Buffer.from(event.messageId);
+				const gatewayId = messageId.subarray(0, 4);
+				const requestId = messageId.subarray(4, 8);
+				const wsIdHex = gatewayId.toString("hex") + requestId.toString("hex");
+
+				const ws = handle._wsMap.get(wsIdHex);
+
+				if (ws) {
+					const data = event.data
+						? (event.binary
+							? Buffer.from(event.data, "base64")
+							: Buffer.from(event.data, "base64").toString())
+						: "";
+					const msgEvent = new MessageEvent("message", { data });
+					msgEvent.rivetGatewayId = messageId.subarray(0, 4);
+					msgEvent.rivetRequestId = messageId.subarray(4, 8);
+					msgEvent.rivetMessageIndex = messageId.readUint16LE(8);
+					ws.dispatchEvent(msgEvent);
+				}
+			}
+			break;
+		}
+		case "websocket_close": {
+			if (handle._wsMap && event.messageId) {
+				const messageId = Buffer.from(event.messageId);
+				const gatewayId = messageId.subarray(0, 4);
+				const requestId = messageId.subarray(4, 8);
+				const wsIdHex = gatewayId.toString("hex") + requestId.toString("hex");
+
+				const ws = handle._wsMap.get(wsIdHex);
+				if (ws) {
+					ws.readyState = 3;
+					ws.dispatchEvent(new CloseEvent("close", {
+						code: event.code || 1000,
+						reason: event.reason || "",
+					}));
+					handle._wsMap.delete(wsIdHex);
+				}
+			}
+			break;
+		}
+		case "hibernation_restore":
+		case "alarm":
+		case "wake":
+			break;
+		case "shutdown": {
+			if (config.onShutdown) {
+				config.onShutdown();
+			}
+			break;
+		}
+		default:
+			console.warn("unknown native event kind:", event.kind);
+	}
+}
+
+module.exports.startEnvoy = startEnvoy;
+module.exports.startEnvoySync = startEnvoySync;
+module.exports.openDatabaseFromEnvoy = openDatabaseFromEnvoy;
+module.exports.openRawDatabaseFromEnvoy = openRawDatabaseFromEnvoy;