hermes-wasm 1.8.133 → 1.8.134

package/README.md

@@ -359,3 +359,34 @@ the configured retrieval depth and does not run Boolean clauses independently.
 The diagnostic window is capped at 10,000; candidate/ordinal bounds and a 64 MiB
 JSON response limit reject oversized exports. WASM supports its existing RRF and
 weighted-sum fusion modes; server L1/reranker features remain server APIs.
+
+## Delete and upsert local documents
+
+LocalIndex supports primary-key schemas and enforces uniqueness on insert and
+reopen. Delete removes the document and every chunk, including indexed-only data.
+Upserts are complete replacements; an absent key is inserted.
+
+```javascript
+const index = await LocalIndex.create(`index documents {
+  field id: text<raw> [primary, indexed, stored]
+  field body: text<simple> [indexed<chunked>]
+}`);
+await index.addDocument({ id: "a", body: ["first chunk", "second chunk"] });
+await index.commit();
+await index.upsertDocument({ id: "a", body: ["replacement"] });
+await index.commit();
+index.deleteDocument("a");
+await index.commit();
+```
+
+`deleteDocuments(keys)` and `await upsertDocuments(documents)` return
+`{ acceptedCount, errors: [{ index, error }] }`. Inspect errors and commit accepted
+work. A pending insertion/replacement must be committed before another mutation
+of the same key. `await index.abort()` discards the entire pending transaction.
+A failed builder requires abort; a failed storage commit can be retried without
+replaying mutations. RemoteIndex and IpfsIndex remain read-only.
+
+Deletion batches allow 100,000 keys / 8 MiB key bytes; replacement batches allow
+1,000 documents / 32 MiB JSON. Keep one writable LocalIndex per storage namespace,
+and implement atomic per-file replacement in the storage adapter. Physical
+compaction is available through native core, CLI, and the server ForceMerge API.

package/hermes_wasm.d.ts

@@ -67,10 +67,6 @@ export class IpfsIndex {
      * Import cache
      */
     import_cache(data: Uint8Array): void;
-    /**
-     * Load cache from IndexedDB
-     */
-    load_cache_from_idb(): Promise<boolean>;
     /**
      * Load index using JavaScript fetch functions
      *
@@ -78,6 +74,10 @@ export class IpfsIndex {
      * @param size_fn - JS function: (path: string) => Promise<number>
      */
     load(fetch_fn: Function, size_fn: Function): Promise<void>;
+    /**
+     * Load cache from IndexedDB
+     */
+    load_cache_from_idb(): Promise<boolean>;
     /**
      * Load index with IndexedDB cache pre-loaded
      *
@@ -151,6 +151,10 @@ export class LocalIndex {
     private constructor();
     free(): void;
     [Symbol.dispose](): void;
+    /**
+     * Discard the entire pending transaction, retaining published documents.
+     */
+    abort(): Promise<void>;
     /**
      * Add a single document (JSON object with field names matching the schema).
      */
@@ -171,6 +175,15 @@ export class LocalIndex {
      * Data is lost on page refresh. Use `withStorage()` for persistence.
      */
     static create(schema_sdl: string): Promise<LocalIndex>;
+    /**
+     * Stage a whole-document deletion by exact primary key, including all chunks.
+     */
+    deleteDocument(primary_key: string): void;
+    /**
+     * Stage deletions. Returns { acceptedCount, errors: [{ index, error }] }.
+     * Commit publishes accepted operations; missing keys are accepted.
+     */
+    deleteDocuments(primary_keys: any): any;
     /**
      * Get field names from the schema.
      */
@@ -216,6 +229,14 @@ export class LocalIndex {
      * Returns `{ hits: [{ address: { segment_id, doc_id }, score }], total_hits }`.
      */
     search(query_str: string, limit: number): Promise<any>;
+    /**
+     * Stage a complete replacement (insert if absent); call commit to publish.
+     */
+    upsertDocument(document: any): Promise<void>;
+    /**
+     * Stage replacements, returning { acceptedCount, errors: [{ index, error }] }.
+     */
+    upsertDocuments(documents: any): Promise<any>;
     /**
      * Create or open an index with a pluggable storage backend.
      *
@@ -284,12 +305,6 @@ export class RemoteIndex {
      * network requests for previously fetched data.
      */
     import_cache(data: Uint8Array): void;
-    /**
-     * Load the slice cache from IndexedDB
-     *
-     * Call this after load() to restore cached data from a previous session.
-     */
-    load_cache_from_idb(): Promise<boolean>;
     /**
      * Load index from URL using hermes-core Index with slice caching
      *
@@ -297,6 +312,12 @@ export class RemoteIndex {
      * to prefill the cache with hot data, reducing cold-start latency.
      */
     load(): Promise<void>;
+    /**
+     * Load the slice cache from IndexedDB
+     *
+     * Call this after load() to restore cached data from a previous session.
+     */
+    load_cache_from_idb(): Promise<boolean>;
     /**
      * Load index with IndexedDB cache pre-loaded
      *
@@ -405,10 +426,13 @@ export interface InitOutput {
     readonly ipfsindex_searchStructured: (a: number, b: any) => any;
     readonly ipfsindex_search_offset: (a: number, b: number, c: number, d: number, e: number) => any;
     readonly ipfsindex_with_cache_size: (a: number, b: number, c: number) => number;
+    readonly localindex_abort: (a: number) => any;
     readonly localindex_addDocument: (a: number, b: any) => any;
     readonly localindex_addDocuments: (a: number, b: any) => any;
     readonly localindex_commit: (a: number) => any;
     readonly localindex_create: (a: number, b: number) => any;
+    readonly localindex_deleteDocument: (a: number, b: number, c: number) => [number, number];
+    readonly localindex_deleteDocuments: (a: number, b: any) => [number, number, number];
     readonly localindex_fieldNames: (a: number) => any;
     readonly localindex_getDocument: (a: number, b: number, c: number, d: number) => any;
     readonly localindex_getDocumentWithFields: (a: number, b: number, c: number, d: number, e: number, f: number) => any;
@@ -417,6 +441,8 @@ export interface InitOutput {
     readonly localindex_search: (a: number, b: number, c: number, d: number) => any;
     readonly localindex_searchOffset: (a: number, b: number, c: number, d: number, e: number) => any;
     readonly localindex_searchStructured: (a: number, b: any) => any;
+    readonly localindex_upsertDocument: (a: number, b: any) => any;
+    readonly localindex_upsertDocuments: (a: number, b: any) => any;
     readonly localindex_withStorage: (a: any, b: number, c: number) => any;
     readonly remoteindex_cache_stats: (a: number) => any;
     readonly remoteindex_clear_idb_cache: (a: number) => any;
@@ -452,7 +478,7 @@ export interface InitOutput {
     readonly wasm_bindgen_7dc0dc7663c6ddce___convert__closures_____invoke___js_sys_59b4256fe4dcc1af___Function_fn_wasm_bindgen_7dc0dc7663c6ddce___JsValue_____wasm_bindgen_7dc0dc7663c6ddce___sys__Undefined___js_sys_59b4256fe4dcc1af___Function_fn_wasm_bindgen_7dc0dc7663c6ddce___JsValue_____wasm_bindgen_7dc0dc7663c6ddce___sys__Undefined_______true_: (a: number, b: number, c: any, d: any) => void;
     readonly wasm_bindgen_7dc0dc7663c6ddce___convert__closures_____invoke___wasm_bindgen_7dc0dc7663c6ddce___JsValue__core_ed718c3d60ebd546___result__Result_____wasm_bindgen_7dc0dc7663c6ddce___JsError___true_: (a: number, b: number, c: any) => [number, number];
     readonly wasm_bindgen_7dc0dc7663c6ddce___convert__closures_____invoke___web_sys_456b715baf4530bf___features__gen_IdbVersionChangeEvent__IdbVersionChangeEvent______true_: (a: number, b: number, c: any) => void;
-    readonly wasm_bindgen_7dc0dc7663c6ddce___convert__closures_____invoke___web_sys_456b715baf4530bf___features__gen_IdbVersionChangeEvent__IdbVersionChangeEvent______true__66: (a: number, b: number, c: any) => void;
+    readonly wasm_bindgen_7dc0dc7663c6ddce___convert__closures_____invoke___web_sys_456b715baf4530bf___features__gen_IdbVersionChangeEvent__IdbVersionChangeEvent______true__71: (a: number, b: number, c: any) => void;
     readonly wasm_bindgen_7dc0dc7663c6ddce___convert__closures_____invoke_______true_: (a: number, b: number) => void;
     readonly __wbindgen_malloc: (a: number, b: number) => number;
     readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;

package/hermes_wasm.js

@@ -176,14 +176,6 @@ export class IpfsIndex {
             throw takeFromExternrefTable0(ret[0]);
         }
     }
-    /**
-     * Load cache from IndexedDB
-     * @returns {Promise<boolean>}
-     */
-    load_cache_from_idb() {
-        const ret = wasm.ipfsindex_load_cache_from_idb(this.__wbg_ptr);
-        return ret;
-    }
     /**
      * Load index using JavaScript fetch functions
      *
@@ -197,6 +189,14 @@ export class IpfsIndex {
         const ret = wasm.ipfsindex_load(this.__wbg_ptr, fetch_fn, size_fn);
         return ret;
     }
+    /**
+     * Load cache from IndexedDB
+     * @returns {Promise<boolean>}
+     */
+    load_cache_from_idb() {
+        const ret = wasm.ipfsindex_load_cache_from_idb(this.__wbg_ptr);
+        return ret;
+    }
     /**
      * Load index with IndexedDB cache pre-loaded
      *
@@ -346,6 +346,14 @@ export class LocalIndex {
         const ptr = this.__destroy_into_raw();
         wasm.__wbg_localindex_free(ptr, 0);
     }
+    /**
+     * Discard the entire pending transaction, retaining published documents.
+     * @returns {Promise<void>}
+     */
+    abort() {
+        const ret = wasm.localindex_abort(this.__wbg_ptr);
+        return ret;
+    }
     /**
      * Add a single document (JSON object with field names matching the schema).
      * @param {any} doc_json
@@ -387,6 +395,31 @@ export class LocalIndex {
         const ret = wasm.localindex_create(ptr0, len0);
         return ret;
     }
+    /**
+     * Stage a whole-document deletion by exact primary key, including all chunks.
+     * @param {string} primary_key
+     */
+    deleteDocument(primary_key) {
+        const ptr0 = passStringToWasm0(primary_key, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len0 = WASM_VECTOR_LEN;
+        const ret = wasm.localindex_deleteDocument(this.__wbg_ptr, ptr0, len0);
+        if (ret[1]) {
+            throw takeFromExternrefTable0(ret[0]);
+        }
+    }
+    /**
+     * Stage deletions. Returns { acceptedCount, errors: [{ index, error }] }.
+     * Commit publishes accepted operations; missing keys are accepted.
+     * @param {any} primary_keys
+     * @returns {any}
+     */
+    deleteDocuments(primary_keys) {
+        const ret = wasm.localindex_deleteDocuments(this.__wbg_ptr, primary_keys);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        return takeFromExternrefTable0(ret[0]);
+    }
     /**
      * Get field names from the schema.
      * @returns {any}
@@ -485,6 +518,24 @@ export class LocalIndex {
         const ret = wasm.localindex_search(this.__wbg_ptr, ptr0, len0, limit);
         return ret;
     }
+    /**
+     * Stage a complete replacement (insert if absent); call commit to publish.
+     * @param {any} document
+     * @returns {Promise<void>}
+     */
+    upsertDocument(document) {
+        const ret = wasm.localindex_upsertDocument(this.__wbg_ptr, document);
+        return ret;
+    }
+    /**
+     * Stage replacements, returning { acceptedCount, errors: [{ index, error }] }.
+     * @param {any} documents
+     * @returns {Promise<any>}
+     */
+    upsertDocuments(documents) {
+        const ret = wasm.localindex_upsertDocuments(this.__wbg_ptr, documents);
+        return ret;
+    }
     /**
      * Create or open an index with a pluggable storage backend.
      *
@@ -628,16 +679,6 @@ export class RemoteIndex {
             throw takeFromExternrefTable0(ret[0]);
         }
     }
-    /**
-     * Load the slice cache from IndexedDB
-     *
-     * Call this after load() to restore cached data from a previous session.
-     * @returns {Promise<boolean>}
-     */
-    load_cache_from_idb() {
-        const ret = wasm.remoteindex_load_cache_from_idb(this.__wbg_ptr);
-        return ret;
-    }
     /**
      * Load index from URL using hermes-core Index with slice caching
      *
@@ -649,6 +690,16 @@ export class RemoteIndex {
         const ret = wasm.remoteindex_load(this.__wbg_ptr);
         return ret;
     }
+    /**
+     * Load the slice cache from IndexedDB
+     *
+     * Call this after load() to restore cached data from a previous session.
+     * @returns {Promise<boolean>}
+     */
+    load_cache_from_idb() {
+        const ret = wasm.remoteindex_load_cache_from_idb(this.__wbg_ptr);
+        return ret;
+    }
     /**
      * Load index with IndexedDB cache pre-loaded
      *
@@ -1344,22 +1395,22 @@ function __wbg_get_imports() {
             console.warn(arg0);
         },
         __wbindgen_generic_0000000000000001: function(arg0, arg1) {
-            // Cast intrinsic for `Closure(Closure { owned: true, function: Function { arguments: [Externref], shim_idx: 1954, ret: Result(Unit), inner_ret: Some(Result(Unit)) }, mutable: true }) -> Externref`.
+            // Cast intrinsic for `Closure(Closure { owned: true, function: Function { arguments: [Externref], shim_idx: 1976, ret: Result(Unit), inner_ret: Some(Result(Unit)) }, mutable: true }) -> Externref`.
             const ret = makeMutClosure(arg0, arg1, wasm_bindgen_7dc0dc7663c6ddce___convert__closures_____invoke___wasm_bindgen_7dc0dc7663c6ddce___JsValue__core_ed718c3d60ebd546___result__Result_____wasm_bindgen_7dc0dc7663c6ddce___JsError___true_);
             return ret;
         },
         __wbindgen_generic_0000000000000002: function(arg0, arg1) {
-            // Cast intrinsic for `Closure(Closure { owned: true, function: Function { arguments: [NamedExternref("Event")], shim_idx: 357, ret: Unit, inner_ret: Some(Unit) }, mutable: true }) -> Externref`.
+            // Cast intrinsic for `Closure(Closure { owned: true, function: Function { arguments: [NamedExternref("Event")], shim_idx: 523, ret: Unit, inner_ret: Some(Unit) }, mutable: true }) -> Externref`.
             const ret = makeMutClosure(arg0, arg1, wasm_bindgen_7dc0dc7663c6ddce___convert__closures_____invoke___web_sys_456b715baf4530bf___features__gen_IdbVersionChangeEvent__IdbVersionChangeEvent______true_);
             return ret;
         },
         __wbindgen_generic_0000000000000003: function(arg0, arg1) {
-            // Cast intrinsic for `Closure(Closure { owned: true, function: Function { arguments: [NamedExternref("IDBVersionChangeEvent")], shim_idx: 357, ret: Unit, inner_ret: Some(Unit) }, mutable: true }) -> Externref`.
-            const ret = makeMutClosure(arg0, arg1, wasm_bindgen_7dc0dc7663c6ddce___convert__closures_____invoke___web_sys_456b715baf4530bf___features__gen_IdbVersionChangeEvent__IdbVersionChangeEvent______true__66);
+            // Cast intrinsic for `Closure(Closure { owned: true, function: Function { arguments: [NamedExternref("IDBVersionChangeEvent")], shim_idx: 523, ret: Unit, inner_ret: Some(Unit) }, mutable: true }) -> Externref`.
+            const ret = makeMutClosure(arg0, arg1, wasm_bindgen_7dc0dc7663c6ddce___convert__closures_____invoke___web_sys_456b715baf4530bf___features__gen_IdbVersionChangeEvent__IdbVersionChangeEvent______true__71);
             return ret;
         },
         __wbindgen_generic_0000000000000004: function(arg0, arg1) {
-            // Cast intrinsic for `Closure(Closure { owned: true, function: Function { arguments: [], shim_idx: 1086, ret: Unit, inner_ret: Some(Unit) }, mutable: true }) -> Externref`.
+            // Cast intrinsic for `Closure(Closure { owned: true, function: Function { arguments: [], shim_idx: 1108, ret: Unit, inner_ret: Some(Unit) }, mutable: true }) -> Externref`.
             const ret = makeMutClosure(arg0, arg1, wasm_bindgen_7dc0dc7663c6ddce___convert__closures_____invoke_______true_);
             return ret;
         },
@@ -1407,8 +1458,8 @@ function wasm_bindgen_7dc0dc7663c6ddce___convert__closures_____invoke___web_sys_
     wasm.wasm_bindgen_7dc0dc7663c6ddce___convert__closures_____invoke___web_sys_456b715baf4530bf___features__gen_IdbVersionChangeEvent__IdbVersionChangeEvent______true_(arg0, arg1, arg2);
 }
 
-function wasm_bindgen_7dc0dc7663c6ddce___convert__closures_____invoke___web_sys_456b715baf4530bf___features__gen_IdbVersionChangeEvent__IdbVersionChangeEvent______true__66(arg0, arg1, arg2) {
-    wasm.wasm_bindgen_7dc0dc7663c6ddce___convert__closures_____invoke___web_sys_456b715baf4530bf___features__gen_IdbVersionChangeEvent__IdbVersionChangeEvent______true__66(arg0, arg1, arg2);
+function wasm_bindgen_7dc0dc7663c6ddce___convert__closures_____invoke___web_sys_456b715baf4530bf___features__gen_IdbVersionChangeEvent__IdbVersionChangeEvent______true__71(arg0, arg1, arg2) {
+    wasm.wasm_bindgen_7dc0dc7663c6ddce___convert__closures_____invoke___web_sys_456b715baf4530bf___features__gen_IdbVersionChangeEvent__IdbVersionChangeEvent______true__71(arg0, arg1, arg2);
 }
 
 function wasm_bindgen_7dc0dc7663c6ddce___convert__closures_____invoke___wasm_bindgen_7dc0dc7663c6ddce___JsValue__core_ed718c3d60ebd546___result__Result_____wasm_bindgen_7dc0dc7663c6ddce___JsError___true_(arg0, arg1, arg2) {

package/package.json

@@ -5,7 +5,7 @@
     "izihawa"
   ],
   "description": "WASM bindings for Hermes search engine",
-  "version": "1.8.133",
+  "version": "1.8.134",
   "license": "MIT",
   "repository": {
     "type": "git",