@taladb/web 0.2.9 → 0.2.11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@taladb/web",
-  "version": "0.2.9",
+  "version": "0.2.11",
   "description": "TalaDB WASM bindings — document queries and vector search in the browser",
   "main": "pkg/taladb_web.js",
   "types": "pkg/taladb_web.d.ts",

package/pkg/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "taladb-web",
+  "type": "module",
+  "collaborators": [
+    "thinkgrid-labs"
+  ],
+  "description": "TalaDB browser WASM bindings (wasm-bindgen + OPFS)",
+  "version": "0.2.11",
+  "license": "MIT",
+  "files": [
+    "taladb_web_bg.wasm",
+    "taladb_web.js",
+    "taladb_web.d.ts"
+  ],
+  "main": "taladb_web.js",
+  "types": "taladb_web.d.ts",
+  "sideEffects": [
+    "./snippets/*"
+  ]
+}

package/pkg/taladb_web.d.ts

@@ -0,0 +1,316 @@
+/* tslint:disable */
+/* eslint-disable */
+
+export class CollectionWasm {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Count documents matching the filter.
+     */
+    count(filter: any): number;
+    /**
+     * Create a secondary index on a field.
+     */
+    createIndex(field: string): void;
+    /**
+     * Create a vector index on `field`.
+     *
+     * `dimensions` — expected vector length.
+     * `metric`     — optional string: `"cosine"` (default), `"dot"`, or `"euclidean"`.
+     */
+    createVectorIndex(field: string, dimensions: number, metric?: string | null): void;
+    /**
+     * Delete all matching documents. Returns the count deleted.
+     */
+    deleteMany(filter: any): number;
+    /**
+     * Delete the first matching document. Returns true if deleted.
+     */
+    deleteOne(filter: any): boolean;
+    /**
+     * Drop a secondary index.
+     */
+    dropIndex(field: string): void;
+    /**
+     * Drop a vector index.
+     */
+    dropVectorIndex(field: string): void;
+    /**
+     * Find documents matching the filter. Returns a JS array of plain objects.
+     */
+    find(filter: any): any;
+    /**
+     * Find the `top_k` nearest documents to `query` on a vector index.
+     *
+     * `filter` — optional pre-filter (same format as `find`). Pass `null` to
+     *            search across all documents that have the vector field.
+     *
+     * Returns a JSON array of `{ document: {...}, score: number }` objects.
+     */
+    findNearest(field: string, query: Float32Array, top_k: number, filter: any): any;
+    /**
+     * Find a single document. Returns the document or null.
+     */
+    findOne(filter: any): any;
+    /**
+     * Insert a document. Accepts a plain JS object, returns the ULID string id.
+     */
+    insert(doc: any): string;
+    /**
+     * Insert multiple documents. Returns an array of ULID string ids.
+     */
+    insertMany(docs: any): any;
+    /**
+     * Update all matching documents. Returns the count updated.
+     */
+    updateMany(filter: any, update: any): number;
+    /**
+     * Update the first matching document. Returns true if a document was updated.
+     */
+    updateOne(filter: any, update: any): boolean;
+}
+
+export class TalaDBWasm {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Get a collection handle by name.
+     */
+    collection(name: string): CollectionWasm;
+    /**
+     * Serialize the entire in-memory database to bytes.
+     *
+     * Pass the returned `Uint8Array` to `opfs_flush_snapshot` to persist, or
+     * store it yourself.  On the next page load, pass the same bytes to
+     * `openWithSnapshot` to restore all data.
+     */
+    exportSnapshot(): Uint8Array;
+    /**
+     * Open an in-memory database (suitable for tests and environments without OPFS).
+     */
+    static openInMemory(): TalaDBWasm;
+    /**
+     * Open a database, restoring from a previously exported snapshot if provided.
+     *
+     * Pass the bytes returned by `opfs_load_snapshot` (or `null`/`undefined` for
+     * a fresh empty database).  After each write, call `exportSnapshot()` and
+     * pass the bytes to `opfs_flush_snapshot` to persist across page reloads.
+     *
+     * ```js
+     * const bytes = await opfs_load_snapshot('myapp.db');   // null on first open
+     * const db = TalaDBWasm.openWithSnapshot(bytes);
+     * // … mutations …
+     * await opfs_flush_snapshot('myapp.db', db.exportSnapshot());
+     * ```
+     */
+    static openWithSnapshot(snapshot?: Uint8Array | null): TalaDBWasm;
+}
+
+export class WorkerDB {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Count matching documents.
+     */
+    count(collection: string, filter_json: string): number;
+    createFtsIndex(collection: string, field: string): void;
+    createIndex(collection: string, field: string): void;
+    /**
+     * Create a vector index. `metric_str`: `"cosine"` | `"dot"` | `"euclidean"` (default cosine).
+     */
+    createVectorIndex(collection: string, field: string, dimensions: number, metric_str?: string | null): void;
+    /**
+     * Delete all matching documents. Returns the count deleted.
+     */
+    deleteMany(collection: string, filter_json: string): number;
+    /**
+     * Delete the first matching document. Returns `true` / `false`.
+     */
+    deleteOne(collection: string, filter_json: string): boolean;
+    dropFtsIndex(collection: string, field: string): void;
+    dropIndex(collection: string, field: string): void;
+    /**
+     * Drop a vector index.
+     */
+    dropVectorIndex(collection: string, field: string): void;
+    /**
+     * Find documents. Returns a JSON array of document objects.
+     */
+    find(collection: string, filter_json: string): string;
+    /**
+     * Find nearest neighbours. Returns a JSON string of `[{ document, score }]`.
+     */
+    findNearest(collection: string, field: string, query_json: string, top_k: number, filter_json: string): string;
+    /**
+     * Find one document. Returns a JSON object or `"null"`.
+     */
+    findOne(collection: string, filter_json: string): string;
+    /**
+     * Insert a document. Returns the new ULID as a string.
+     */
+    insert(collection: string, doc_json: string): string;
+    /**
+     * Insert many documents. Returns a JSON array of ULID strings.
+     */
+    insertMany(collection: string, docs_json: string): string;
+    /**
+     * Open an in-memory database (for tests and OPFS-unavailable fallback).
+     */
+    static openInMemory(): WorkerDB;
+    /**
+     * Open a database backed by an OPFS `FileSystemSyncAccessHandle`.
+     *
+     * Call sequence in the SharedWorker:
+     * ```js
+     * const handle = await file_handle.createSyncAccessHandle();
+     * const workerDb = WorkerDB.openWithOpfs(handle);
+     * ```
+     */
+    static openWithOpfs(sync_handle: FileSystemSyncAccessHandle): WorkerDB;
+    /**
+     * Update all matching documents. Returns the count updated.
+     */
+    updateMany(collection: string, filter_json: string, update_json: string): number;
+    /**
+     * Update the first matching document. Returns `true` / `false`.
+     */
+    updateOne(collection: string, filter_json: string, update_json: string): boolean;
+}
+
+/**
+ * Load a previous database snapshot from IndexedDB.
+ * Returns None if no snapshot exists yet.
+ */
+export function idb_load_snapshot(db_name: string): Promise<Uint8Array | undefined>;
+
+/**
+ * Persist a database snapshot to IndexedDB (via localStorage for simplicity in v1).
+ * In v2 this should use a proper IDBObjectStore for binary data.
+ */
+export function idb_save_snapshot(db_name: string, data: Uint8Array): Promise<boolean>;
+
+/**
+ * Initialize panic hook for better error messages in the browser console.
+ */
+export function init(): void;
+
+/**
+ * Returns true if OPFS is available in the current browser context.
+ * Always returns false in Workers without storage access.
+ */
+export function is_opfs_available(): Promise<boolean>;
+
+/**
+ * Delete the OPFS snapshot file for `db_name`.
+ * No-op if the file does not exist.
+ */
+export function opfs_delete_snapshot(db_name: string): Promise<boolean>;
+
+/**
+ * Persist a database snapshot to OPFS.
+ * Creates the file on first call. Subsequent calls overwrite atomically.
+ */
+export function opfs_flush_snapshot(db_name: string, data: Uint8Array): Promise<boolean>;
+
+/**
+ * Load the last persisted database snapshot from OPFS.
+ * Returns `None` if the file does not exist yet (first open).
+ */
+export function opfs_load_snapshot(db_name: string): Promise<Uint8Array | undefined>;
+
+/**
+ * Open (or create) an OPFS file and return an `OpfsBackend` for redb.
+ *
+ * This function is **async** because `getFileHandle` and `createSyncAccessHandle`
+ * are both async in the OPFS API. Call it once at worker startup.
+ */
+export function opfs_open_backend(db_name: string): Promise<any>;
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+    readonly memory: WebAssembly.Memory;
+    readonly __wbg_workerdb_free: (a: number, b: number) => void;
+    readonly workerdb_count: (a: number, b: number, c: number, d: number, e: number) => [number, number, number];
+    readonly workerdb_createFtsIndex: (a: number, b: number, c: number, d: number, e: number) => [number, number];
+    readonly workerdb_createIndex: (a: number, b: number, c: number, d: number, e: number) => [number, number];
+    readonly workerdb_createVectorIndex: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number) => [number, number];
+    readonly workerdb_deleteMany: (a: number, b: number, c: number, d: number, e: number) => [number, number, number];
+    readonly workerdb_deleteOne: (a: number, b: number, c: number, d: number, e: number) => [number, number, number];
+    readonly workerdb_dropFtsIndex: (a: number, b: number, c: number, d: number, e: number) => [number, number];
+    readonly workerdb_dropIndex: (a: number, b: number, c: number, d: number, e: number) => [number, number];
+    readonly workerdb_dropVectorIndex: (a: number, b: number, c: number, d: number, e: number) => [number, number];
+    readonly workerdb_find: (a: number, b: number, c: number, d: number, e: number) => [number, number, number, number];
+    readonly workerdb_findNearest: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number) => [number, number, number, number];
+    readonly workerdb_findOne: (a: number, b: number, c: number, d: number, e: number) => [number, number, number, number];
+    readonly workerdb_insert: (a: number, b: number, c: number, d: number, e: number) => [number, number, number, number];
+    readonly workerdb_insertMany: (a: number, b: number, c: number, d: number, e: number) => [number, number, number, number];
+    readonly workerdb_openInMemory: () => [number, number, number];
+    readonly workerdb_openWithOpfs: (a: any) => [number, number, number];
+    readonly workerdb_updateMany: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => [number, number, number];
+    readonly workerdb_updateOne: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => [number, number, number];
+    readonly __wbg_collectionwasm_free: (a: number, b: number) => void;
+    readonly __wbg_taladbwasm_free: (a: number, b: number) => void;
+    readonly collectionwasm_count: (a: number, b: any) => [number, number, number];
+    readonly collectionwasm_createIndex: (a: number, b: number, c: number) => [number, number];
+    readonly collectionwasm_createVectorIndex: (a: number, b: number, c: number, d: number, e: number, f: number) => [number, number];
+    readonly collectionwasm_deleteMany: (a: number, b: any) => [number, number, number];
+    readonly collectionwasm_deleteOne: (a: number, b: any) => [number, number, number];
+    readonly collectionwasm_dropIndex: (a: number, b: number, c: number) => [number, number];
+    readonly collectionwasm_dropVectorIndex: (a: number, b: number, c: number) => [number, number];
+    readonly collectionwasm_find: (a: number, b: any) => [number, number, number];
+    readonly collectionwasm_findNearest: (a: number, b: number, c: number, d: number, e: number, f: number, g: any) => [number, number, number];
+    readonly collectionwasm_findOne: (a: number, b: any) => [number, number, number];
+    readonly collectionwasm_insert: (a: number, b: any) => [number, number, number, number];
+    readonly collectionwasm_insertMany: (a: number, b: any) => [number, number, number];
+    readonly collectionwasm_updateMany: (a: number, b: any, c: any) => [number, number, number];
+    readonly collectionwasm_updateOne: (a: number, b: any, c: any) => [number, number, number];
+    readonly taladbwasm_collection: (a: number, b: number, c: number) => number;
+    readonly taladbwasm_exportSnapshot: (a: number) => [number, number, number, number];
+    readonly taladbwasm_openInMemory: () => [number, number, number];
+    readonly taladbwasm_openWithSnapshot: (a: number, b: number) => [number, number, number];
+    readonly init: () => void;
+    readonly idb_load_snapshot: (a: number, b: number) => any;
+    readonly idb_save_snapshot: (a: number, b: number, c: number, d: number) => any;
+    readonly is_opfs_available: () => any;
+    readonly opfs_delete_snapshot: (a: number, b: number) => any;
+    readonly opfs_flush_snapshot: (a: number, b: number, c: number, d: number) => any;
+    readonly opfs_load_snapshot: (a: number, b: number) => any;
+    readonly opfs_open_backend: (a: number, b: number) => any;
+    readonly wasm_bindgen__closure__destroy__h1411c0b1433bd547: (a: number, b: number) => void;
+    readonly wasm_bindgen__convert__closures_____invoke__h4bd31e7387ab665d: (a: number, b: number, c: any) => [number, number];
+    readonly wasm_bindgen__convert__closures_____invoke__h675f15260128efbc: (a: number, b: number, c: any, d: any) => void;
+    readonly __wbindgen_malloc: (a: number, b: number) => number;
+    readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
+    readonly __wbindgen_exn_store: (a: number) => void;
+    readonly __externref_table_alloc: () => number;
+    readonly __wbindgen_externrefs: WebAssembly.Table;
+    readonly __wbindgen_free: (a: number, b: number, c: number) => void;
+    readonly __externref_table_dealloc: (a: number) => void;
+    readonly __wbindgen_start: () => void;
+}
+
+export type SyncInitInput = BufferSource | WebAssembly.Module;
+
+/**
+ * Instantiates the given `module`, which can either be bytes or
+ * a precompiled `WebAssembly.Module`.
+ *
+ * @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
+ *
+ * @returns {InitOutput}
+ */
+export function initSync(module: { module: SyncInitInput } | SyncInitInput): InitOutput;
+
+/**
+ * If `module_or_path` is {RequestInfo} or {URL}, makes a request and
+ * for everything else, calls `WebAssembly.instantiate` directly.
+ *
+ * @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
+ *
+ * @returns {Promise<InitOutput>}
+ */
+export default function __wbg_init (module_or_path?: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;

package/pkg/taladb_web_bg.wasm.d.ts

@@ -0,0 +1,61 @@
+/* tslint:disable */
+/* eslint-disable */
+export const memory: WebAssembly.Memory;
+export const __wbg_workerdb_free: (a: number, b: number) => void;
+export const workerdb_count: (a: number, b: number, c: number, d: number, e: number) => [number, number, number];
+export const workerdb_createFtsIndex: (a: number, b: number, c: number, d: number, e: number) => [number, number];
+export const workerdb_createIndex: (a: number, b: number, c: number, d: number, e: number) => [number, number];
+export const workerdb_createVectorIndex: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number) => [number, number];
+export const workerdb_deleteMany: (a: number, b: number, c: number, d: number, e: number) => [number, number, number];
+export const workerdb_deleteOne: (a: number, b: number, c: number, d: number, e: number) => [number, number, number];
+export const workerdb_dropFtsIndex: (a: number, b: number, c: number, d: number, e: number) => [number, number];
+export const workerdb_dropIndex: (a: number, b: number, c: number, d: number, e: number) => [number, number];
+export const workerdb_dropVectorIndex: (a: number, b: number, c: number, d: number, e: number) => [number, number];
+export const workerdb_find: (a: number, b: number, c: number, d: number, e: number) => [number, number, number, number];
+export const workerdb_findNearest: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number) => [number, number, number, number];
+export const workerdb_findOne: (a: number, b: number, c: number, d: number, e: number) => [number, number, number, number];
+export const workerdb_insert: (a: number, b: number, c: number, d: number, e: number) => [number, number, number, number];
+export const workerdb_insertMany: (a: number, b: number, c: number, d: number, e: number) => [number, number, number, number];
+export const workerdb_openInMemory: () => [number, number, number];
+export const workerdb_openWithOpfs: (a: any) => [number, number, number];
+export const workerdb_updateMany: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => [number, number, number];
+export const workerdb_updateOne: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => [number, number, number];
+export const __wbg_collectionwasm_free: (a: number, b: number) => void;
+export const __wbg_taladbwasm_free: (a: number, b: number) => void;
+export const collectionwasm_count: (a: number, b: any) => [number, number, number];
+export const collectionwasm_createIndex: (a: number, b: number, c: number) => [number, number];
+export const collectionwasm_createVectorIndex: (a: number, b: number, c: number, d: number, e: number, f: number) => [number, number];
+export const collectionwasm_deleteMany: (a: number, b: any) => [number, number, number];
+export const collectionwasm_deleteOne: (a: number, b: any) => [number, number, number];
+export const collectionwasm_dropIndex: (a: number, b: number, c: number) => [number, number];
+export const collectionwasm_dropVectorIndex: (a: number, b: number, c: number) => [number, number];
+export const collectionwasm_find: (a: number, b: any) => [number, number, number];
+export const collectionwasm_findNearest: (a: number, b: number, c: number, d: number, e: number, f: number, g: any) => [number, number, number];
+export const collectionwasm_findOne: (a: number, b: any) => [number, number, number];
+export const collectionwasm_insert: (a: number, b: any) => [number, number, number, number];
+export const collectionwasm_insertMany: (a: number, b: any) => [number, number, number];
+export const collectionwasm_updateMany: (a: number, b: any, c: any) => [number, number, number];
+export const collectionwasm_updateOne: (a: number, b: any, c: any) => [number, number, number];
+export const taladbwasm_collection: (a: number, b: number, c: number) => number;
+export const taladbwasm_exportSnapshot: (a: number) => [number, number, number, number];
+export const taladbwasm_openInMemory: () => [number, number, number];
+export const taladbwasm_openWithSnapshot: (a: number, b: number) => [number, number, number];
+export const init: () => void;
+export const idb_load_snapshot: (a: number, b: number) => any;
+export const idb_save_snapshot: (a: number, b: number, c: number, d: number) => any;
+export const is_opfs_available: () => any;
+export const opfs_delete_snapshot: (a: number, b: number) => any;
+export const opfs_flush_snapshot: (a: number, b: number, c: number, d: number) => any;
+export const opfs_load_snapshot: (a: number, b: number) => any;
+export const opfs_open_backend: (a: number, b: number) => any;
+export const wasm_bindgen__closure__destroy__h1411c0b1433bd547: (a: number, b: number) => void;
+export const wasm_bindgen__convert__closures_____invoke__h4bd31e7387ab665d: (a: number, b: number, c: any) => [number, number];
+export const wasm_bindgen__convert__closures_____invoke__h675f15260128efbc: (a: number, b: number, c: any, d: any) => void;
+export const __wbindgen_malloc: (a: number, b: number) => number;
+export const __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
+export const __wbindgen_exn_store: (a: number) => void;
+export const __externref_table_alloc: () => number;
+export const __wbindgen_externrefs: WebAssembly.Table;
+export const __wbindgen_free: (a: number, b: number, c: number) => void;
+export const __externref_table_dealloc: (a: number) => void;
+export const __wbindgen_start: () => void;