@dikolab/kbdb 0.2.2 → 0.3.0

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

@@ -5,7 +5,10 @@ declare namespace wasm_bindgen {
     /**
      * Adds a section. `ptr`/`len` point to an encoded `AddSectionParams`.
      *
-     * On success: writes encoded kbid string to return slot, returns 0.
+     * 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.
      */
     export function db_add_section(ptr: number, len: number): number;
@@ -42,6 +45,23 @@ declare namespace wasm_bindgen {
      */
     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.
@@ -344,6 +364,10 @@ 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;
 
@@ -365,6 +389,19 @@ declare namespace wasm_bindgen {
      */
     export function worker_compose(ptr: number, len: number): number;
 
+    /**
+     * 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.
      *
@@ -444,6 +481,14 @@ 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;
 
@@ -525,6 +570,7 @@ declare interface InitOutput {
     readonly worker_add_section: (a: number, b: number) => number;
     readonly worker_check_integrity: () => number;
     readonly worker_compose: (a: number, b: number) => number;
+    readonly worker_export: (a: number, b: number) => number;
     readonly worker_garbage_collect: () => number;
     readonly worker_get_result: (a: number) => number;
     readonly worker_group_sections: (a: number, b: number) => number;
@@ -565,6 +611,7 @@ declare interface InitOutput {
     readonly db_add_to_index: (a: number, b: number) => number;
     readonly db_check_integrity: (a: number, b: number) => number;
     readonly db_check_version: (a: number, b: number) => number;
+    readonly db_export: (a: number, b: number) => number;
     readonly db_gc: (a: number, b: number) => number;
     readonly db_get_back_refs: (a: number, b: number) => number;
     readonly db_get_forward_refs: (a: number, b: number) => number;

package/src/wasm/kb-worker/kbdb_worker.js

@@ -7,7 +7,10 @@ let wasm_bindgen = (function(exports) {
     /**
      * Adds a section. `ptr`/`len` point to an encoded `AddSectionParams`.
      *
-     * On success: writes encoded kbid string to return slot, returns 0.
+     * 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.
      * @param {number} ptr
      * @param {number} len
@@ -72,6 +75,30 @@ let wasm_bindgen = (function(exports) {
     }
     exports.db_check_version = db_check_version;
 
+    /**
+     * 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}`
+     * @param {number} ptr
+     * @param {number} len
+     * @returns {number}
+     */
+    function db_export(ptr, len) {
+        const ret = wasm.db_export(ptr, len);
+        return ret;
+    }
+    exports.db_export = db_export;
+
     /**
      * Runs garbage collection. Returns 0 on success.
      * On success a summary string is placed in the return slot.
@@ -644,6 +671,10 @@ let wasm_bindgen = (function(exports) {
 
     /**
      * 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.
      * @param {number} ptr
      * @param {number} len
      * @returns {number}
@@ -684,6 +715,26 @@ let wasm_bindgen = (function(exports) {
     }
     exports.worker_compose = worker_compose;
 
+    /**
+     * 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).
+     * @param {number} ptr
+     * @param {number} len
+     * @returns {number}
+     */
+    function worker_export(ptr, len) {
+        const ret = wasm.worker_export(ptr, len);
+        return ret;
+    }
+    exports.worker_export = worker_export;
+
     /**
      * Runs garbage collection and invalidates all cache entries.
      *
@@ -835,6 +886,14 @@ let wasm_bindgen = (function(exports) {
 
     /**
      * 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.
      * @returns {number}
      */
     function worker_rebuild_indexes() {

package/src/wasm/kb-worker/kbdb_worker_bg.wasm.d.ts

@@ -8,6 +8,7 @@ export const set_return: (a: number, b: number) => void;
 export const worker_add_section: (a: number, b: number) => number;
 export const worker_check_integrity: () => number;
 export const worker_compose: (a: number, b: number) => number;
+export const worker_export: (a: number, b: number) => number;
 export const worker_garbage_collect: () => number;
 export const worker_get_result: (a: number) => number;
 export const worker_group_sections: (a: number, b: number) => number;
@@ -48,6 +49,7 @@ 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_export: (a: number, b: number) => number;
 export const db_gc: (a: number, b: number) => number;
 export const db_get_back_refs: (a: number, b: number) => number;
 export const db_get_forward_refs: (a: number, b: number) => number;