@dikolab/kbdb 0.1.2 → 0.1.3

package/src/wasm/fs-database/kbdb_fs_database.js

@@ -0,0 +1,458 @@
+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();
+    }
+
+    /**
+     * Adds a section. `ptr`/`len` point to an encoded `AddSectionParams`.
+     *
+     * On success: writes encoded kbid string to return slot, returns 0.
+     * On error: writes error message to return slot, returns -1.
+     * @param {number} ptr
+     * @param {number} len
+     * @returns {number}
+     */
+    function db_add_section(ptr, len) {
+        const ret = wasm.db_add_section(ptr, len);
+        return ret;
+    }
+    exports.db_add_section = db_add_section;
+
+    /**
+     * 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)]).
+     * @param {number} ptr
+     * @param {number} len
+     * @returns {number}
+     */
+    function db_add_to_index(ptr, len) {
+        const ret = wasm.db_add_to_index(ptr, len);
+        return ret;
+    }
+    exports.db_add_to_index = db_add_to_index;
+
+    /**
+     * Checks database integrity. Returns 0 on success.
+     * On success a summary string is placed in the return slot.
+     * @param {number} _ptr
+     * @param {number} _len
+     * @returns {number}
+     */
+    function db_check_integrity(_ptr, _len) {
+        const ret = wasm.db_check_integrity(_ptr, _len);
+        return ret;
+    }
+    exports.db_check_integrity = db_check_integrity;
+
+    /**
+     * 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.
+     * @param {number} ptr
+     * @param {number} len
+     * @returns {number}
+     */
+    function db_check_version(ptr, len) {
+        const ret = wasm.db_check_version(ptr, len);
+        return ret;
+    }
+    exports.db_check_version = db_check_version;
+
+    /**
+     * Runs garbage collection. Returns 0 on success.
+     * On success a summary string is placed in the return slot.
+     * @param {number} _ptr
+     * @param {number} _len
+     * @returns {number}
+     */
+    function db_gc(_ptr, _len) {
+        const ret = wasm.db_gc(_ptr, _len);
+        return ret;
+    }
+    exports.db_gc = db_gc;
+
+    /**
+     * Initialises the database context path.
+     *
+     * The JS host must call this before any other function.
+     * `ptr`/`len` point to a UTF-8 context path string in WASM memory.
+     * @param {number} ptr
+     * @param {number} len
+     * @returns {number}
+     */
+    function db_init(ptr, len) {
+        const ret = wasm.db_init(ptr, len);
+        return ret;
+    }
+    exports.db_init = db_init;
+
+    /**
+     * Initialises a new empty catalog at the current context path.
+     * Writes the default catalog to disk and returns 0 on success.
+     * @param {number} _ptr
+     * @param {number} _len
+     * @returns {number}
+     */
+    function db_init_catalog(_ptr, _len) {
+        const ret = wasm.db_init_catalog(_ptr, _len);
+        return ret;
+    }
+    exports.db_init_catalog = db_init_catalog;
+
+    /**
+     * 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.
+     * @param {number} ptr
+     * @param {number} len
+     * @returns {number}
+     */
+    function db_init_directory(ptr, len) {
+        const ret = wasm.db_init_directory(ptr, len);
+        return ret;
+    }
+    exports.db_init_directory = db_init_directory;
+
+    /**
+     * 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.
+     * @param {number} _ptr
+     * @param {number} _len
+     * @returns {number}
+     */
+    function db_list_documents(_ptr, _len) {
+        const ret = wasm.db_list_documents(_ptr, _len);
+        return ret;
+    }
+    exports.db_list_documents = db_list_documents;
+
+    /**
+     * 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.
+     * @param {number} _ptr
+     * @param {number} _len
+     * @returns {number}
+     */
+    function db_list_sections(_ptr, _len) {
+        const ret = wasm.db_list_sections(_ptr, _len);
+        return ret;
+    }
+    exports.db_list_sections = db_list_sections;
+
+    /**
+     * 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.
+     * @param {number} ptr
+     * @param {number} len
+     * @returns {number}
+     */
+    function db_query(ptr, len) {
+        const ret = wasm.db_query(ptr, len);
+        return ret;
+    }
+    exports.db_query = db_query;
+
+    /**
+     * Reads the catalog. Returns 0 on success.
+     * On success the serialised catalog TOML text is in the return slot.
+     * @param {number} _ptr
+     * @param {number} _len
+     * @returns {number}
+     */
+    function db_read_catalog(_ptr, _len) {
+        const ret = wasm.db_read_catalog(_ptr, _len);
+        return ret;
+    }
+    exports.db_read_catalog = db_read_catalog;
+
+    /**
+     * Reads corpus statistics from `<ctx>/corpus.bin`.
+     * On success places encoded `CorpusStats` bytes in the return slot.
+     * @param {number} _ptr
+     * @param {number} _len
+     * @returns {number}
+     */
+    function db_read_corpus_stats(_ptr, _len) {
+        const ret = wasm.db_read_corpus_stats(_ptr, _len);
+        return ret;
+    }
+    exports.db_read_corpus_stats = db_read_corpus_stats;
+
+    /**
+     * Reads a document manifest. `ptr`/`len` point to a UTF-8 docid string.
+     * @param {number} ptr
+     * @param {number} len
+     * @returns {number}
+     */
+    function db_read_document(ptr, len) {
+        const ret = wasm.db_read_document(ptr, len);
+        return ret;
+    }
+    exports.db_read_document = db_read_document;
+
+    /**
+     * Reads a section by kbid. `ptr`/`len` point to a UTF-8 kbid string.
+     * @param {number} ptr
+     * @param {number} len
+     * @returns {number}
+     */
+    function db_read_section(ptr, len) {
+        const ret = wasm.db_read_section(ptr, len);
+        return ret;
+    }
+    exports.db_read_section = db_read_section;
+
+    /**
+     * Reads multiple sections. `ptr`/`len` point to encoded `Vec<KbId>` (count + kbids).
+     * @param {number} ptr
+     * @param {number} len
+     * @returns {number}
+     */
+    function db_read_sections(ptr, len) {
+        const ret = wasm.db_read_sections(ptr, len);
+        return ret;
+    }
+    exports.db_read_sections = db_read_sections;
+
+    /**
+     * 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.
+     * @param {number} _ptr
+     * @param {number} _len
+     * @returns {number}
+     */
+    function db_rebuild_index(_ptr, _len) {
+        const ret = wasm.db_rebuild_index(_ptr, _len);
+        return ret;
+    }
+    exports.db_rebuild_index = db_rebuild_index;
+
+    /**
+     * Removes a document manifest. `ptr`/`len` point to a UTF-8 docid string.
+     * @param {number} ptr
+     * @param {number} len
+     * @returns {number}
+     */
+    function db_remove_document(ptr, len) {
+        const ret = wasm.db_remove_document(ptr, len);
+        return ret;
+    }
+    exports.db_remove_document = db_remove_document;
+
+    /**
+     * Removes a section's entries from the indexes.
+     * `ptr`/`len` point to a UTF-8 kbid string.
+     * @param {number} ptr
+     * @param {number} len
+     * @returns {number}
+     */
+    function db_remove_from_index(ptr, len) {
+        const ret = wasm.db_remove_from_index(ptr, len);
+        return ret;
+    }
+    exports.db_remove_from_index = db_remove_from_index;
+
+    /**
+     * Removes a section by kbid. `ptr`/`len` point to a UTF-8 kbid string.
+     * @param {number} ptr
+     * @param {number} len
+     * @returns {number}
+     */
+    function db_remove_section(ptr, len) {
+        const ret = wasm.db_remove_section(ptr, len);
+        return ret;
+    }
+    exports.db_remove_section = db_remove_section;
+
+    /**
+     * Updates a section. `ptr`/`len` point to encoded (old_kbid_str, AddSectionParams).
+     * @param {number} ptr
+     * @param {number} len
+     * @returns {number}
+     */
+    function db_update_section(ptr, len) {
+        const ret = wasm.db_update_section(ptr, len);
+        return ret;
+    }
+    exports.db_update_section = db_update_section;
+
+    /**
+     * Writes/updates the catalog. `ptr`/`len` point to encoded catalog TOML text.
+     * @param {number} ptr
+     * @param {number} len
+     * @returns {number}
+     */
+    function db_write_catalog(ptr, len) {
+        const ret = wasm.db_write_catalog(ptr, len);
+        return ret;
+    }
+    exports.db_write_catalog = db_write_catalog;
+
+    /**
+     * Writes corpus statistics to `<ctx>/corpus.bin`.
+     * `ptr`/`len` point to 12 bytes of encoded `CorpusStats`.
+     * @param {number} ptr
+     * @param {number} len
+     * @returns {number}
+     */
+    function db_write_corpus_stats(ptr, len) {
+        const ret = wasm.db_write_corpus_stats(ptr, len);
+        return ret;
+    }
+    exports.db_write_corpus_stats = db_write_corpus_stats;
+
+    /**
+     * Writes a document manifest. `ptr`/`len` point to an encoded `DocumentManifest`.
+     * @param {number} ptr
+     * @param {number} len
+     * @returns {number}
+     */
+    function db_write_document(ptr, len) {
+        const ret = wasm.db_write_document(ptr, len);
+        return ret;
+    }
+    exports.db_write_document = db_write_document;
+    const import1 = require("env");
+    const import2 = require("env");
+    const import3 = require("env");
+    const import4 = require("env");
+    const import5 = require("env");
+    const import6 = require("env");
+
+    function __wbg_get_imports() {
+        const import0 = {
+            __proto__: null,
+        };
+        return {
+            __proto__: null,
+            "./kbdb_fs_database_bg.js": import0,
+            "env": import1,
+            "env": import2,
+            "env": import3,
+            "env": import4,
+            "env": import5,
+            "env": import6,
+        };
+    }
+
+    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/src/wasm/fs-database/kbdb_fs_database_bg.wasm.d.ts

@@ -0,0 +1,32 @@
+/* tslint:disable */
+/* eslint-disable */
+export const memory: WebAssembly.Memory;
+export const set_return: (a: number, b: number) => void;
+export const kbdb_free: (a: number, b: number) => void;
+export const db_add_section: (a: number, b: number) => number;
+export const db_add_to_index: (a: number, b: number) => number;
+export const db_check_integrity: (a: number, b: number) => number;
+export const db_check_version: (a: number, b: number) => number;
+export const db_gc: (a: number, b: number) => number;
+export const db_init: (a: number, b: number) => number;
+export const db_init_catalog: (a: number, b: number) => number;
+export const db_init_directory: (a: number, b: number) => number;
+export const db_list_documents: (a: number, b: number) => number;
+export const db_list_sections: (a: number, b: number) => number;
+export const db_query: (a: number, b: number) => number;
+export const db_read_catalog: (a: number, b: number) => number;
+export const db_read_corpus_stats: (a: number, b: number) => number;
+export const db_read_document: (a: number, b: number) => number;
+export const db_read_section: (a: number, b: number) => number;
+export const db_read_sections: (a: number, b: number) => number;
+export const db_rebuild_index: (a: number, b: number) => number;
+export const db_remove_document: (a: number, b: number) => number;
+export const db_remove_from_index: (a: number, b: number) => number;
+export const db_remove_section: (a: number, b: number) => number;
+export const db_update_section: (a: number, b: number) => number;
+export const db_write_catalog: (a: number, b: number) => number;
+export const db_write_corpus_stats: (a: number, b: number) => number;
+export const db_write_document: (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/src/wasm/fs-database/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "kbdb-fs-database",
+  "description": "Filesystem storage engine for kbdb -- compiles to fs-database.wasm",
+  "version": "0.0.1",
+  "license": "ISC",
+  "files": [
+    "kbdb_fs_database_bg.wasm",
+    "kbdb_fs_database.js",
+    "kbdb_fs_database.d.ts"
+  ],
+  "browser": "kbdb_fs_database.js",
+  "types": "kbdb_fs_database.d.ts"
+}