@rivetkit/rivetkit-native 0.0.0-pr.4673.d7d209b → 0.0.0-pr.4674.b6084cc

package/index.d.ts

@@ -4,54 +4,50 @@
 /* auto-generated by NAPI-RS */
 
 export interface JsBindParam {
-	kind: string;
-	intValue?: number;
-	floatValue?: number;
-	textValue?: string;
-	blobValue?: Buffer;
+  kind: string
+  intValue?: number
+  floatValue?: number
+  textValue?: string
+  blobValue?: Buffer
 }
 export interface ExecuteResult {
-	changes: number;
+  changes: number
 }
 export interface QueryResult {
-	columns: Array<string>;
-	rows: Array<Array<any>>;
+  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,
-	preloadedEntries?: Array<JsKvEntry> | undefined | null,
-): Promise<JsNativeDatabase>;
+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;
-	notGlobal: boolean;
-	/**
-	 * 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;
+  endpoint: string
+  token: string
+  namespace: string
+  poolName: string
+  version: number
+  metadata?: any
+  notGlobal: boolean
+  /**
+   * 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;
+  reverse?: boolean
+  limit?: number
 }
 /** A key-value entry returned from KV list operations. */
 export interface JsKvEntry {
-	key: Buffer;
-	value: Buffer;
+  key: Buffer
+  value: Buffer
 }
 /** A single hibernating request entry. */
 export interface HibernatingRequestEntry {
-	gatewayId: Buffer;
-	requestId: Buffer;
+  gatewayId: Buffer
+  requestId: Buffer
 }
 /**
  * Start the native envoy client synchronously.
@@ -59,93 +55,39 @@ export interface HibernatingRequestEntry {
  * 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;
+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;
+export declare function startEnvoyJs(config: JsEnvoyConfig, eventCallback: (event: any) => void): JsEnvoyHandle
 /** Native SQLite database handle exposed to JavaScript. */
 export declare class JsNativeDatabase {
-	takeLastKvError(): string | null;
-	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>;
+  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>;
+  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/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@rivetkit/rivetkit-native",
-	"version": "0.0.0-pr.4673.d7d209b",
+	"version": "0.0.0-pr.4674.b6084cc",
 	"description": "Native N-API addon for RivetKit providing envoy client and SQLite access",
 	"license": "Apache-2.0",
 	"main": "index.js",
@@ -49,15 +49,15 @@
 	},
 	"dependencies": {
 		"@napi-rs/cli": "^2.18.4",
-		"@rivetkit/engine-envoy-protocol": "0.0.0-pr.4673.d7d209b"
+		"@rivetkit/engine-envoy-protocol": "0.0.0-pr.4674.b6084cc"
 	},
 	"optionalDependencies": {
-		"@rivetkit/rivetkit-native-darwin-arm64": "0.0.0-pr.4673.d7d209b",
-		"@rivetkit/rivetkit-native-darwin-x64": "0.0.0-pr.4673.d7d209b",
-		"@rivetkit/rivetkit-native-linux-arm64-gnu": "0.0.0-pr.4673.d7d209b",
-		"@rivetkit/rivetkit-native-linux-arm64-musl": "0.0.0-pr.4673.d7d209b",
-		"@rivetkit/rivetkit-native-linux-x64-gnu": "0.0.0-pr.4673.d7d209b",
-		"@rivetkit/rivetkit-native-linux-x64-musl": "0.0.0-pr.4673.d7d209b",
-		"@rivetkit/rivetkit-native-win32-x64-msvc": "0.0.0-pr.4673.d7d209b"
+		"@rivetkit/rivetkit-native-darwin-arm64": "0.0.0-pr.4674.b6084cc",
+		"@rivetkit/rivetkit-native-darwin-x64": "0.0.0-pr.4674.b6084cc",
+		"@rivetkit/rivetkit-native-linux-arm64-gnu": "0.0.0-pr.4674.b6084cc",
+		"@rivetkit/rivetkit-native-linux-arm64-musl": "0.0.0-pr.4674.b6084cc",
+		"@rivetkit/rivetkit-native-linux-x64-gnu": "0.0.0-pr.4674.b6084cc",
+		"@rivetkit/rivetkit-native-linux-x64-musl": "0.0.0-pr.4674.b6084cc",
+		"@rivetkit/rivetkit-native-win32-x64-msvc": "0.0.0-pr.4674.b6084cc"
 	}
 }

package/wrapper.d.ts

@@ -29,16 +29,9 @@ export interface EnvoyHandle {
 	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;
+	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][]>;
+	kvListAll(actorId: string, options?: KvListOptions): Promise<[Uint8Array, Uint8Array][]>;
 	kvListRange(
 		actorId: string,
 		start: Uint8Array,
@@ -53,11 +46,7 @@ export interface EnvoyHandle {
 	): 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>;
+	kvDeleteRange(actorId: string, start: Uint8Array, end: Uint8Array): Promise<void>;
 	kvDrop(actorId: string): Promise<void>;
 	restoreHibernatingRequests(
 		actorId: string,
@@ -116,13 +105,7 @@ export interface EnvoyConfig {
 		actorId: string,
 		generation: number,
 		config: import("@rivetkit/engine-envoy-protocol").ActorConfig,
-		preloadedKv:
-			| import("@rivetkit/engine-envoy-protocol").PreloadedKv
-			| null,
-		sqliteSchemaVersion: number,
-		sqliteStartupData:
-			| import("@rivetkit/engine-envoy-protocol").SqliteStartupData
-			| null,
+		preloadedKv: import("@rivetkit/engine-envoy-protocol").PreloadedKv | null,
 	) => Promise<void>;
 	onActorStop: (
 		envoyHandle: EnvoyHandle,
@@ -143,6 +126,19 @@ export declare function startEnvoy(config: EnvoyConfig): Promise<EnvoyHandle>;
 export declare function openDatabaseFromEnvoy(
 	handle: EnvoyHandle,
 	actorId: string,
-	preloadedEntries?: readonly [Uint8Array, Uint8Array][] | null,
 ): 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

@@ -134,7 +134,7 @@ function startEnvoySync(config) {
 			poolName: config.poolName,
 			version: config.version,
 			metadata: config.metadata || null,
-			notGlobal: config.notGlobal ?? false,
+			notGlobal: config.notGlobal,
 		},
 		(event) => {
 			handleEvent(event, config, wrappedHandle);
@@ -158,65 +158,154 @@ async function startEnvoy(config) {
 /**
  * Open a native database backed by envoy KV.
  */
-async function openDatabaseFromEnvoy(handle, actorId, preloadedEntries) {
+async function openDatabaseFromEnvoy(handle, actorId) {
 	const rawHandle = handle._raw || handle;
-	const nativePreloadedEntries = preloadedEntries
-		? preloadedEntries.map(([key, value]) => ({
-				key: Buffer.from(key),
-				value: Buffer.from(value),
-			}))
-		: null;
-	return native.openDatabaseFromEnvoy(
-		rawHandle,
-		actorId,
-		nativePreloadedEntries,
+	return native.openDatabaseFromEnvoy(rawHandle, actorId);
+}
+
+function isPlainObject(value) {
+	return (
+		!!value &&
+		typeof value === "object" &&
+		!Array.isArray(value) &&
+		Object.getPrototypeOf(value) === Object.prototype
 	);
 }
 
-function decodePreloadedKv(preloadedKv) {
-	if (!preloadedKv) {
-		return null;
+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),
+		};
 	}
 
-	const decodeBytes = (value) => Uint8Array.from(Buffer.from(value, "base64"));
+	throw new Error(`unsupported sqlite binding type: ${typeof value}`);
+}
 
-	return {
-		entries: (preloadedKv.entries || []).map((entry) => ({
-			key: decodeBytes(entry.key),
-			value: decodeBytes(entry.value),
-			metadata: {
-				version: decodeBytes(entry.metadata.version),
-				updateTs: entry.metadata.updateTs,
-			},
-		})),
-		requestedGetKeys: (preloadedKv.requestedGetKeys || []).map(decodeBytes),
-		requestedPrefixes: (preloadedKv.requestedPrefixes || []).map(decodeBytes),
-	};
+function extractNamedSqliteParameters(sql) {
+	return [...sql.matchAll(/([:@$][A-Za-z_][A-Za-z0-9_]*)/g)].map(
+		(match) => match[1],
+	);
 }
 
-function decodeSqliteStartupData(sqliteStartupData) {
-	if (!sqliteStartupData) {
-		return null;
+function getNamedSqliteBinding(bindings, name) {
+	if (name in bindings) {
+		return bindings[name];
 	}
 
-	const decodeBytes = (value) => Uint8Array.from(Buffer.from(value, "base64"));
+	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 {
-		generation: sqliteStartupData.generation,
-		meta: {
-			schemaVersion: sqliteStartupData.meta.schemaVersion,
-			generation: sqliteStartupData.meta.generation,
-			headTxid: sqliteStartupData.meta.headTxid,
-			materializedTxid: sqliteStartupData.meta.materializedTxid,
-			dbSizePages: sqliteStartupData.meta.dbSizePages,
-			pageSize: sqliteStartupData.meta.pageSize,
-			creationTsMs: sqliteStartupData.meta.creationTsMs,
-			maxDeltaBytes: sqliteStartupData.meta.maxDeltaBytes,
+		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();
 		},
-		preloadedPages: (sqliteStartupData.preloadedPages || []).map((page) => ({
-			pgno: page.pgno,
-			bytes: page.bytes ? decodeBytes(page.bytes) : null,
-		})),
 	};
 }
 
@@ -241,9 +330,7 @@ function handleEvent(event, config, wrappedHandle) {
 					event.actorId,
 					event.generation,
 					actorConfig,
-					decodePreloadedKv(event.preloadedKv),
-					event.sqliteSchemaVersion,
-					decodeSqliteStartupData(event.sqliteStartupData),
+					null, // preloadedKv
 				),
 			).then(
 				async () => {
@@ -487,3 +574,4 @@ function handleEvent(event, config, wrappedHandle) {
 module.exports.startEnvoy = startEnvoy;
 module.exports.startEnvoySync = startEnvoySync;
 module.exports.openDatabaseFromEnvoy = openDatabaseFromEnvoy;
+module.exports.openRawDatabaseFromEnvoy = openRawDatabaseFromEnvoy;