@dikolab/kbdb 0.3.1 → 0.4.0

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

@@ -5,13 +5,7 @@ let wasm_bindgen = (function(exports) {
     }
 
     /**
-     * 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.
      * @param {number} ptr
      * @param {number} len
      * @returns {number}
@@ -24,8 +18,6 @@ let wasm_bindgen = (function(exports) {
 
     /**
      * 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}
@@ -37,8 +29,7 @@ let wasm_bindgen = (function(exports) {
     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.
+     * Checks database integrity.
      * @param {number} _ptr
      * @param {number} _len
      * @returns {number}
@@ -50,21 +41,7 @@ let wasm_bindgen = (function(exports) {
     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.
+     * Reads `catalog.toml` and returns the version status.
      * @param {number} ptr
      * @param {number} len
      * @returns {number}
@@ -77,18 +54,6 @@ let wasm_bindgen = (function(exports) {
 
     /**
      * 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}
@@ -100,8 +65,7 @@ let wasm_bindgen = (function(exports) {
     exports.db_export = db_export;
 
     /**
-     * Runs garbage collection. Returns 0 on success.
-     * On success a summary string is placed in the return slot.
+     * Runs garbage collection.
      * @param {number} _ptr
      * @param {number} _len
      * @returns {number}
@@ -114,9 +78,6 @@ let wasm_bindgen = (function(exports) {
 
     /**
      * 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.
      * @param {number} ptr
      * @param {number} len
      * @returns {number}
@@ -129,9 +90,6 @@ let wasm_bindgen = (function(exports) {
 
     /**
      * 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.
      * @param {number} ptr
      * @param {number} len
      * @returns {number}
@@ -159,7 +117,6 @@ let wasm_bindgen = (function(exports) {
 
     /**
      * 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}
@@ -171,16 +128,7 @@ let wasm_bindgen = (function(exports) {
     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.
+     * Creates the full directory scaffold for a new database.
      * @param {number} ptr
      * @param {number} len
      * @returns {number}
@@ -192,10 +140,7 @@ let wasm_bindgen = (function(exports) {
     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.
+     * Lists all document manifests.
      * @param {number} _ptr
      * @param {number} _len
      * @returns {number}
@@ -207,10 +152,7 @@ let wasm_bindgen = (function(exports) {
     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.
+     * Lists all section records.
      * @param {number} _ptr
      * @param {number} _len
      * @returns {number}
@@ -223,8 +165,6 @@ let wasm_bindgen = (function(exports) {
 
     /**
      * 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}
@@ -236,8 +176,7 @@ let wasm_bindgen = (function(exports) {
     exports.db_query = db_query;
 
     /**
-     * Reads the catalog. Returns 0 on success.
-     * On success the serialised catalog TOML text is in the return slot.
+     * Reads the catalog.
      * @param {number} _ptr
      * @param {number} _len
      * @returns {number}
@@ -250,7 +189,6 @@ let wasm_bindgen = (function(exports) {
 
     /**
      * 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}
@@ -262,7 +200,7 @@ let wasm_bindgen = (function(exports) {
     exports.db_read_corpus_stats = db_read_corpus_stats;
 
     /**
-     * Reads a document manifest. `ptr`/`len` point to a UTF-8 docid string.
+     * Reads a document manifest.
      * @param {number} ptr
      * @param {number} len
      * @returns {number}
@@ -274,7 +212,7 @@ let wasm_bindgen = (function(exports) {
     exports.db_read_document = db_read_document;
 
     /**
-     * Reads a section by kbid. `ptr`/`len` point to a UTF-8 kbid string.
+     * Reads a section by kbid.
      * @param {number} ptr
      * @param {number} len
      * @returns {number}
@@ -286,7 +224,7 @@ let wasm_bindgen = (function(exports) {
     exports.db_read_section = db_read_section;
 
     /**
-     * Reads multiple sections. `ptr`/`len` point to encoded `Vec<KbId>` (count + kbids).
+     * Reads multiple sections.
      * @param {number} ptr
      * @param {number} len
      * @returns {number}
@@ -299,11 +237,6 @@ let wasm_bindgen = (function(exports) {
 
     /**
      * 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}
@@ -315,7 +248,7 @@ let wasm_bindgen = (function(exports) {
     exports.db_rebuild_index = db_rebuild_index;
 
     /**
-     * Removes a document manifest. `ptr`/`len` point to a UTF-8 docid string.
+     * Removes a document manifest.
      * @param {number} ptr
      * @param {number} len
      * @returns {number}
@@ -328,7 +261,6 @@ let wasm_bindgen = (function(exports) {
 
     /**
      * 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}
@@ -340,7 +272,7 @@ let wasm_bindgen = (function(exports) {
     exports.db_remove_from_index = db_remove_from_index;
 
     /**
-     * Removes a section by kbid. `ptr`/`len` point to a UTF-8 kbid string.
+     * Removes a section by kbid.
      * @param {number} ptr
      * @param {number} len
      * @returns {number}
@@ -352,7 +284,7 @@ let wasm_bindgen = (function(exports) {
     exports.db_remove_section = db_remove_section;
 
     /**
-     * Updates a section. `ptr`/`len` point to encoded (old_kbid_str, AddSectionParams).
+     * Updates a section.
      * @param {number} ptr
      * @param {number} len
      * @returns {number}
@@ -364,7 +296,7 @@ let wasm_bindgen = (function(exports) {
     exports.db_update_section = db_update_section;
 
     /**
-     * Writes/updates the catalog. `ptr`/`len` point to encoded catalog TOML text.
+     * Writes/updates the catalog.
      * @param {number} ptr
      * @param {number} len
      * @returns {number}
@@ -377,7 +309,6 @@ let wasm_bindgen = (function(exports) {
 
     /**
      * Writes corpus statistics to `<ctx>/corpus.bin`.
-     * `ptr`/`len` point to 12 bytes of encoded `CorpusStats`.
      * @param {number} ptr
      * @param {number} len
      * @returns {number}
@@ -389,7 +320,7 @@ let wasm_bindgen = (function(exports) {
     exports.db_write_corpus_stats = db_write_corpus_stats;
 
     /**
-     * Writes a document manifest. `ptr`/`len` point to an encoded `DocumentManifest`.
+     * Writes a document manifest.
      * @param {number} ptr
      * @param {number} len
      * @returns {number}

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;