@rivetkit/rivetkit-native 0.0.0-pr.4669.7c31bd8 → 0.0.0-pr.4672.159c9b3

package/index.d.ts

@@ -18,7 +18,7 @@ export interface QueryResult {
   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>
+export declare function openDatabaseFromEnvoy(jsHandle: JsEnvoyHandle, actorId: string, preloadedEntries?: Array<JsKvEntry> | undefined | null): Promise<JsNativeDatabase>
 /** Configuration for starting the native envoy client. */
 export interface JsEnvoyConfig {
   endpoint: string
@@ -60,6 +60,9 @@ export declare function startEnvoySyncJs(config: JsEnvoyConfig, eventCallback: (
 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
+  resetVfsTelemetry(): void
+  snapshotVfsTelemetry(): any
   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>

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@rivetkit/rivetkit-native",
-	"version": "0.0.0-pr.4669.7c31bd8",
+	"version": "0.0.0-pr.4672.159c9b3",
 	"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.4669.7c31bd8"
+		"@rivetkit/engine-envoy-protocol": "0.0.0-pr.4672.159c9b3"
 	},
 	"optionalDependencies": {
-		"@rivetkit/rivetkit-native-darwin-arm64": "0.0.0-pr.4669.7c31bd8",
-		"@rivetkit/rivetkit-native-darwin-x64": "0.0.0-pr.4669.7c31bd8",
-		"@rivetkit/rivetkit-native-linux-arm64-gnu": "0.0.0-pr.4669.7c31bd8",
-		"@rivetkit/rivetkit-native-linux-arm64-musl": "0.0.0-pr.4669.7c31bd8",
-		"@rivetkit/rivetkit-native-linux-x64-gnu": "0.0.0-pr.4669.7c31bd8",
-		"@rivetkit/rivetkit-native-linux-x64-musl": "0.0.0-pr.4669.7c31bd8",
-		"@rivetkit/rivetkit-native-win32-x64-msvc": "0.0.0-pr.4669.7c31bd8"
+		"@rivetkit/rivetkit-native-darwin-arm64": "0.0.0-pr.4672.159c9b3",
+		"@rivetkit/rivetkit-native-darwin-x64": "0.0.0-pr.4672.159c9b3",
+		"@rivetkit/rivetkit-native-linux-arm64-gnu": "0.0.0-pr.4672.159c9b3",
+		"@rivetkit/rivetkit-native-linux-arm64-musl": "0.0.0-pr.4672.159c9b3",
+		"@rivetkit/rivetkit-native-linux-x64-gnu": "0.0.0-pr.4672.159c9b3",
+		"@rivetkit/rivetkit-native-linux-x64-musl": "0.0.0-pr.4672.159c9b3",
+		"@rivetkit/rivetkit-native-win32-x64-msvc": "0.0.0-pr.4672.159c9b3"
 	}
 }

package/wrapper.d.ts

@@ -29,9 +29,16 @@ 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,
@@ -46,7 +53,11 @@ 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,
@@ -105,7 +116,9 @@ export interface EnvoyConfig {
 		actorId: string,
 		generation: number,
 		config: import("@rivetkit/engine-envoy-protocol").ActorConfig,
-		preloadedKv: import("@rivetkit/engine-envoy-protocol").PreloadedKv | null,
+		preloadedKv:
+			| import("@rivetkit/engine-envoy-protocol").PreloadedKv
+			| null,
 	) => Promise<void>;
 	onActorStop: (
 		envoyHandle: EnvoyHandle,
@@ -126,19 +139,6 @@ 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,
+			notGlobal: config.notGlobal ?? false,
 		},
 		(event) => {
 			handleEvent(event, config, wrappedHandle);
@@ -158,154 +158,39 @@ async function startEnvoy(config) {
 /**
  * Open a native database backed by envoy KV.
  */
-async function openDatabaseFromEnvoy(handle, actorId) {
+async function openDatabaseFromEnvoy(handle, actorId, preloadedEntries) {
 	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
+	const nativePreloadedEntries = preloadedEntries
+		? preloadedEntries.map(([key, value]) => ({
+				key: Buffer.from(key),
+				value: Buffer.from(value),
+			}))
+		: null;
+	return native.openDatabaseFromEnvoy(
+		rawHandle,
+		actorId,
+		nativePreloadedEntries,
 	);
 }
 
-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) };
+function decodePreloadedKv(preloadedKv) {
+	if (!preloadedKv) {
+		return null;
 	}
-	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");
-		}
-	};
+	const decodeBytes = (value) => Uint8Array.from(Buffer.from(value, "base64"));
 
 	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();
-		},
+		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),
 	};
 }
 
@@ -330,7 +215,7 @@ function handleEvent(event, config, wrappedHandle) {
 					event.actorId,
 					event.generation,
 					actorConfig,
-					null, // preloadedKv
+					decodePreloadedKv(event.preloadedKv),
 				),
 			).then(
 				async () => {
@@ -574,4 +459,3 @@ function handleEvent(event, config, wrappedHandle) {
 module.exports.startEnvoy = startEnvoy;
 module.exports.startEnvoySync = startEnvoySync;
 module.exports.openDatabaseFromEnvoy = openDatabaseFromEnvoy;
-module.exports.openRawDatabaseFromEnvoy = openRawDatabaseFromEnvoy;