@dikolab/kbdb 0.3.2 → 0.4.1

package/dist/wasm/fs-migration/kbdb_fs_migration.d.ts

@@ -0,0 +1,38 @@
+declare namespace wasm_bindgen {
+    /* tslint:disable */
+    /* eslint-disable */
+
+    /**
+     * Runs database migrations from the current catalog version up to
+     * `DB_FORMAT_VERSION`. `ptr`/`len` point to the UTF-8 context path.
+     *
+     * - Returns 0 if the database is already at the current version.
+     * - Returns 0 after successfully running all required migrations.
+     * - Returns -1 if the catalog version is newer than `DB_FORMAT_VERSION`
+     *   (error message in return slot).
+     * - Returns -1 on any I/O or parse error (message in return slot).
+     */
+    export function db_migrate(ptr: number, len: number): number;
+
+}
+declare type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+declare interface InitOutput {
+    readonly memory: WebAssembly.Memory;
+    readonly kbdb_free: (a: number, b: number) => void;
+    readonly set_return: (a: number, b: number) => void;
+    readonly db_migrate: (a: number, b: number) => number;
+    readonly kbdb_alloc: (a: number) => number;
+    readonly get_return_len: () => number;
+    readonly get_return_ptr: () => number;
+}
+
+/**
+ * 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>}
+ */
+declare function wasm_bindgen (module_or_path?: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;

package/dist/wasm/fs-migration/kbdb_fs_migration.js

@@ -0,0 +1,130 @@
+let wasm_bindgen = (function(exports) {
+    let script_src;
+    if (typeof document !== 'undefined' && document.currentScript !== null) {
+        script_src = new URL(document.currentScript.src, location.href).toString();
+    }
+
+    /**
+     * Runs database migrations from the current catalog version up to
+     * `DB_FORMAT_VERSION`. `ptr`/`len` point to the UTF-8 context path.
+     *
+     * - Returns 0 if the database is already at the current version.
+     * - Returns 0 after successfully running all required migrations.
+     * - Returns -1 if the catalog version is newer than `DB_FORMAT_VERSION`
+     *   (error message in return slot).
+     * - Returns -1 on any I/O or parse error (message in return slot).
+     * @param {number} ptr
+     * @param {number} len
+     * @returns {number}
+     */
+    function db_migrate(ptr, len) {
+        const ret = wasm.db_migrate(ptr, len);
+        return ret;
+    }
+    exports.db_migrate = db_migrate;
+    const import1 = require("env");
+    const import2 = require("env");
+
+    function __wbg_get_imports() {
+        const import0 = {
+            __proto__: null,
+        };
+        return {
+            __proto__: null,
+            "./kbdb_fs_migration_bg.js": import0,
+            "env": import1,
+            "env": import2,
+        };
+    }
+
+    let wasmModule, wasmInstance, wasm;
+    function __wbg_finalize_init(instance, module) {
+        wasmInstance = instance;
+        wasm = instance.exports;
+        wasmModule = module;
+        return wasm;
+    }
+
+    async function __wbg_load(module, imports) {
+        if (typeof Response === 'function' && module instanceof Response) {
+            if (typeof WebAssembly.instantiateStreaming === 'function') {
+                try {
+                    return await WebAssembly.instantiateStreaming(module, imports);
+                } catch (e) {
+                    const validResponse = module.ok && expectedResponseType(module.type);
+
+                    if (validResponse && module.headers.get('Content-Type') !== 'application/wasm') {
+                        console.warn("`WebAssembly.instantiateStreaming` failed because your server does not serve Wasm with `application/wasm` MIME type. Falling back to `WebAssembly.instantiate` which is slower. Original error:\n", e);
+
+                    } else { throw e; }
+                }
+            }
+
+            const bytes = await module.arrayBuffer();
+            return await WebAssembly.instantiate(bytes, imports);
+        } else {
+            const instance = await WebAssembly.instantiate(module, imports);
+
+            if (instance instanceof WebAssembly.Instance) {
+                return { instance, module };
+            } else {
+                return instance;
+            }
+        }
+
+        function expectedResponseType(type) {
+            switch (type) {
+                case 'basic': case 'cors': case 'default': return true;
+            }
+            return false;
+        }
+    }
+
+    function initSync(module) {
+        if (wasm !== undefined) return wasm;
+
+
+        if (module !== undefined) {
+            if (Object.getPrototypeOf(module) === Object.prototype) {
+                ({module} = module)
+            } else {
+                console.warn('using deprecated parameters for `initSync()`; pass a single object instead')
+            }
+        }
+
+        const imports = __wbg_get_imports();
+        if (!(module instanceof WebAssembly.Module)) {
+            module = new WebAssembly.Module(module);
+        }
+        const instance = new WebAssembly.Instance(module, imports);
+        return __wbg_finalize_init(instance, module);
+    }
+
+    async function __wbg_init(module_or_path) {
+        if (wasm !== undefined) return wasm;
+
+
+        if (module_or_path !== undefined) {
+            if (Object.getPrototypeOf(module_or_path) === Object.prototype) {
+                ({module_or_path} = module_or_path)
+            } else {
+                console.warn('using deprecated parameters for the initialization function; pass a single object instead')
+            }
+        }
+
+        if (module_or_path === undefined && script_src !== undefined) {
+            module_or_path = script_src.replace(/\.js$/, "_bg.wasm");
+        }
+        const imports = __wbg_get_imports();
+
+        if (typeof module_or_path === 'string' || (typeof Request === 'function' && module_or_path instanceof Request) || (typeof URL === 'function' && module_or_path instanceof URL)) {
+            module_or_path = fetch(module_or_path);
+        }
+
+        const { instance, module } = await __wbg_load(await module_or_path, imports);
+
+        return __wbg_finalize_init(instance, module);
+    }
+
+    return Object.assign(__wbg_init, { initSync }, exports);
+})({ __proto__: null });

package/dist/wasm/fs-migration/kbdb_fs_migration_bg.wasm.d.ts

@@ -0,0 +1,9 @@
+/* tslint:disable */
+/* eslint-disable */
+export const memory: WebAssembly.Memory;
+export const kbdb_free: (a: number, b: number) => void;
+export const set_return: (a: number, b: number) => void;
+export const db_migrate: (a: number, b: number) => number;
+export const kbdb_alloc: (a: number) => number;
+export const get_return_len: () => number;
+export const get_return_ptr: () => number;

package/dist/wasm/fs-migration/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "kbdb-fs-migration",
+  "description": "Database migration engine for kbdb -- compiles to fs-migration.wasm",
+  "version": "0.0.1",
+  "license": "ISC",
+  "files": [
+    "kbdb_fs_migration_bg.wasm",
+    "kbdb_fs_migration.js",
+    "kbdb_fs_migration.d.ts"
+  ],
+  "browser": "kbdb_fs_migration.js",
+  "types": "kbdb_fs_migration.d.ts"
+}

package/dist/wasm/kb-worker/kbdb_worker.d.ts

@@ -3,84 +3,42 @@ declare namespace wasm_bindgen {
     /* eslint-disable */
 
     /**
-     * Adds a section. `ptr`/`len` point to an encoded `AddSectionParams`.
-     *
-     * On success: writes an encoded `AddSectionResult` to the return slot and
-     * returns 0.  When `params.replace` is true and a section with the same
-     * `source_key` exists, the superseded section's index entries are removed
-     * and the returned `AddSectionResult.superseded` is set to its kbid.
-     * On error: writes error message to return slot, returns -1.
+     * Adds a section.
      */
     export function db_add_section(ptr: number, len: number): number;
 
     /**
      * Adds a section's terms to the inverted and positional indexes.
-     * `ptr`/`len` point to encoded
-     * (kbid_str, term_count, [(term_str, pos_count, [positions], heading_tf, body_tf, code_tf)]).
      */
     export function db_add_to_index(ptr: number, len: number): number;
 
     /**
-     * Checks database integrity. Returns 0 on success.
-     * On success a summary string is placed in the return slot.
+     * Checks database integrity.
      */
     export function db_check_integrity(_ptr: number, _len: number): number;
 
     /**
-     * Reads `catalog.toml` from the path at `ptr`/`len` and returns the version
-     * status without modifying state.
-     *
-     * On success, the return slot contains 8 bytes:
-     * - bytes 0-3: `catalog_version` as little-endian u32
-     * - bytes 4-7: `required_version` (DB_FORMAT_VERSION) as little-endian u32
-     *
-     * Return value:
-     * - 0: compatible (versions match)
-     * - 1: needs migration (catalog version < required)
-     * - 2: too new (catalog version > required)
-     * - -1: I/O or parse error (message in return slot)
-     *
-     * Note: this export accepts a path directly and does NOT require `db_init`
-     * to have been called first.
+     * Reads `catalog.toml` and returns the version status.
      */
     export function db_check_version(ptr: number, len: number): number;
 
     /**
      * Exports the database to a target directory.
-     *
-     * `ptr`/`len` point to a UTF-8 string containing the target path.
-     *
-     * Copies `sections/`, `documents/`, and `catalog.toml` to the target.
-     * Indexes are not copied because they can be rebuilt from the data.
-     *
-     * The target path may be absolute or relative. It is an external output
-     * destination, not a database-internal path, so no path validation is
-     * applied to it.
-     *
-     * On success a summary string is placed in the return slot:
-     * `path={target}\nsections_exported={N}\ndocuments_exported={M}`
      */
     export function db_export(ptr: number, len: number): number;
 
     /**
-     * Runs garbage collection. Returns 0 on success.
-     * On success a summary string is placed in the return slot.
+     * Runs garbage collection.
      */
     export function db_gc(_ptr: number, _len: number): number;
 
     /**
      * Returns back-references pointing to a section.
-     * `ptr`/`len` point to a UTF-8 kbid string.
-     * On success encodes `u32 count` followed by entries (peer_id, marker_type,
-     * context_snippet) into the return slot.
      */
     export function db_get_back_refs(ptr: number, len: number): number;
 
     /**
      * Returns forward references for a section.
-     * `ptr`/`len` point to a UTF-8 kbid string.
-     * On success encodes `u32 count` followed by entries (peer_id, marker_type,
-     * context_snippet) into the return slot.
      */
     export function db_get_forward_refs(ptr: number, len: number): number;
 
@@ -94,118 +52,91 @@ declare namespace wasm_bindgen {
 
     /**
      * Initialises a new empty catalog at the current context path.
-     * Writes the default catalog to disk and returns 0 on success.
      */
     export function db_init_catalog(_ptr: number, _len: number): number;
 
     /**
-     * Creates the full directory scaffold for a new database at `ptr`/`len` path.
-     *
-     * Creates directories, seeds `catalog.toml` (stamped with `DB_FORMAT_VERSION`),
-     * empty index files, `worker.toml`, and `.gitignore`.
-     *
-     * Returns 0 on success. Returns -1 with an error message in the return slot
-     * if the directory already exists or any I/O fails.
-     *
-     * Note: this export accepts a path directly and does NOT require `db_init`
-     * to have been called first.
+     * Creates the full directory scaffold for a new database.
      */
     export function db_init_directory(ptr: number, len: number): number;
 
     /**
-     * Lists all document manifests. No input parameters (`ptr`/`len` are ignored).
-     *
-     * On success encodes a `u32 count` followed by each `DocumentManifest` into
-     * the return slot and returns 0. On error writes an error message and returns -1.
+     * Lists all document manifests.
      */
     export function db_list_documents(_ptr: number, _len: number): number;
 
     /**
-     * Lists all section records. No input parameters (`ptr`/`len` are ignored).
-     *
-     * On success encodes a `u32 count` followed by each `SectionRecord` into the
-     * return slot and returns 0. On error writes an error message and returns -1.
+     * Lists all section records.
      */
     export function db_list_sections(_ptr: number, _len: number): number;
 
     /**
      * Executes a query plan against the loaded indexes.
-     * `ptr`/`len` point to an encoded `QueryPlan`.
-     * On success writes encoded `Vec<RawMatch>` to the return slot.
      */
     export function db_query(ptr: number, len: number): number;
 
     /**
-     * Reads the catalog. Returns 0 on success.
-     * On success the serialised catalog TOML text is in the return slot.
+     * Reads the catalog.
      */
     export function db_read_catalog(_ptr: number, _len: number): number;
 
     /**
      * Reads corpus statistics from `<ctx>/corpus.bin`.
-     * On success places encoded `CorpusStats` bytes in the return slot.
      */
     export function db_read_corpus_stats(_ptr: number, _len: number): number;
 
     /**
-     * Reads a document manifest. `ptr`/`len` point to a UTF-8 docid string.
+     * Reads a document manifest.
      */
     export function db_read_document(ptr: number, len: number): number;
 
     /**
-     * Reads a section by kbid. `ptr`/`len` point to a UTF-8 kbid string.
+     * Reads a section by kbid.
      */
     export function db_read_section(ptr: number, len: number): number;
 
     /**
-     * Reads multiple sections. `ptr`/`len` point to encoded `Vec<KbId>` (count + kbids).
+     * Reads multiple sections.
      */
     export function db_read_sections(ptr: number, len: number): number;
 
     /**
      * Rebuilds indexes from scratch.
-     *
-     * Clears the existing inverted and positional indexes, then drives the
-     * section-scan rebuild loop. Full per-field tokenization is handled by
-     * `kb-worker.wasm` orchestration; this function provides the read-pass
-     * scaffolding and the final index write.
      */
     export function db_rebuild_index(_ptr: number, _len: number): number;
 
     /**
-     * Removes a document manifest. `ptr`/`len` point to a UTF-8 docid string.
+     * Removes a document manifest.
      */
     export function db_remove_document(ptr: number, len: number): number;
 
     /**
      * Removes a section's entries from the indexes.
-     * `ptr`/`len` point to a UTF-8 kbid string.
      */
     export function db_remove_from_index(ptr: number, len: number): number;
 
     /**
-     * Removes a section by kbid. `ptr`/`len` point to a UTF-8 kbid string.
+     * Removes a section by kbid.
      */
     export function db_remove_section(ptr: number, len: number): number;
 
     /**
-     * Updates a section. `ptr`/`len` point to encoded (old_kbid_str, AddSectionParams).
+     * Updates a section.
      */
     export function db_update_section(ptr: number, len: number): number;
 
     /**
-     * Writes/updates the catalog. `ptr`/`len` point to encoded catalog TOML text.
+     * Writes/updates the catalog.
      */
     export function db_write_catalog(ptr: number, len: number): number;
 
     /**
      * Writes corpus statistics to `<ctx>/corpus.bin`.
-     * `ptr`/`len` point to 12 bytes of encoded `CorpusStats`.
      */
     export function db_write_corpus_stats(ptr: number, len: number): number;
 
     /**
-     * Writes a document manifest. `ptr`/`len` point to an encoded `DocumentManifest`.
+     * Writes a document manifest.
      */
     export function db_write_document(ptr: number, len: number): number;
 
@@ -364,10 +295,6 @@ declare namespace wasm_bindgen {
 
     /**
      * Adds a section. Returns 0 on success, -1 on error.
-     *
-     * On success the return slot holds the binary-encoded `AddSectionResult`
-     * (kbid + indexed_terms_count + elapsed_ms + superseded + warnings +
-     * near_duplicates) using the `Encode` trait wire format.
      */
     export function worker_add_section(ptr: number, len: number): number;
 
@@ -392,21 +319,12 @@ declare namespace wasm_bindgen {
     /**
      * Exports the database to a target directory.
      *
-     * `ptr`/`len` point to a UTF-8 string containing the target path.
-     *
-     * Delegates directly to `db_export` in `kbdb-fs-database`. Does not require
-     * the worker to have been initialised because the target path is given
-     * explicitly by the caller.
-     *
      * Returns 0 on success, -1 on error (message in return slot).
      */
     export function worker_export(ptr: number, len: number): number;
 
     /**
      * Runs garbage collection and invalidates all cache entries.
-     *
-     * After GC the set of valid sections may have changed; the whole cache is
-     * invalidated to prevent stale reads.
      */
     export function worker_garbage_collect(): number;
 
@@ -454,23 +372,18 @@ declare namespace wasm_bindgen {
 
     /**
      * Lists all sections whose `type_name` matches the UTF-8 string at `(ptr, len)`.
-     *
-     * On success encodes `u32 count + SectionRecord[]` into the return slot and
-     * returns 0. On error writes an error message and returns -1.
      */
     export function worker_list_by_type(ptr: number, len: number): number;
 
     /**
      * Lists all document manifests whose `doc_type` matches the UTF-8 string at
      * `(ptr, len)`.
-     *
-     * On success encodes `u32 count + DocumentManifest[]` into the return slot and
-     * returns 0. On error writes an error message and returns -1.
      */
     export function worker_list_docs_by_type(ptr: number, len: number): number;
 
     /**
-     * Async query returning a token. The result can be polled via `worker_result_status`.
+     * Async query returning a token. The result can be polled via
+     * `worker_result_status`.
      */
     export function worker_query(ptr: number, len: number): number;
 
@@ -481,14 +394,6 @@ declare namespace wasm_bindgen {
 
     /**
      * Rebuilds all database indexes.
-     *
-     * First clears the existing inverted, positional, and reference indexes via
-     * `db_rebuild_index`. Then re-tokenizes every stored section and re-populates
-     * the indexes via `rebuild_all_section_indexes`.
-     *
-     * On success the return slot holds the number of reindexed sections as a
-     * little-endian `u32`, and 0 is returned. On error -1 is returned and an
-     * error message is in the return slot.
      */
     export function worker_rebuild_indexes(): number;
 
@@ -543,8 +448,8 @@ declare namespace wasm_bindgen {
     /**
      * Returns worker status. Always returns 0.
      *
-     * As a side effect, evicts any expired cache entries using the
-     * configured TTL. The status string is written to the return slot.
+     * As a side effect, evicts any expired cache entries using the configured TTL.
+     * The status string is written to the return slot.
      */
     export function worker_status(): number;