@dikolab/kbdb 0.3.1 → 0.4.0

package/src/shared/worker-daemon/typings/write-lock.interface.ts

@@ -1,13 +0,0 @@
-/**
- * Mutable state for the single-writer lock used by WorkerDaemon.
- *
- * Holds the current lock flag and the queue of pending waiters.
- * Both fields are mutated by `acquireWriteLock` and
- * `releaseWriteLock`.
- */
-export interface WriteLockState {
-   /** Whether the write lock is currently held. */
-   locked: boolean;
-   /** Queue of resolve callbacks for pending lock waiters. */
-   queue: { resolve: () => void }[];
-}

package/src/wasm/fs-database/kbdb_fs_database.d.ts

@@ -1,259 +0,0 @@
-declare namespace wasm_bindgen {
-    /* tslint:disable */
-    /* 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.
-     */
-    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.
-     */
-    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.
-     */
-    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.
-     */
-    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;
-
-    /**
-     * 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.
-     */
-    export function db_init(ptr: number, len: number): number;
-
-    /**
-     * 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.
-     */
-    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.
-     */
-    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.
-     */
-    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.
-     */
-    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.
-     */
-    export function db_read_document(ptr: number, len: number): number;
-
-    /**
-     * Reads a section by kbid. `ptr`/`len` point to a UTF-8 kbid string.
-     */
-    export function db_read_section(ptr: number, len: number): number;
-
-    /**
-     * Reads multiple sections. `ptr`/`len` point to encoded `Vec<KbId>` (count + kbids).
-     */
-    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.
-     */
-    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.
-     */
-    export function db_remove_section(ptr: number, len: number): number;
-
-    /**
-     * Updates a section. `ptr`/`len` point to encoded (old_kbid_str, AddSectionParams).
-     */
-    export function db_update_section(ptr: number, len: number): number;
-
-    /**
-     * Writes/updates the catalog. `ptr`/`len` point to encoded catalog TOML text.
-     */
-    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`.
-     */
-    export function db_write_document(ptr: number, len: number): number;
-
-}
-declare type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
-
-declare interface InitOutput {
-    readonly memory: WebAssembly.Memory;
-    readonly set_return: (a: number, b: number) => void;
-    readonly kbdb_free: (a: number, b: number) => void;
-    readonly db_add_section: (a: number, b: number) => number;
-    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;
-    readonly db_init: (a: number, b: number) => number;
-    readonly db_init_catalog: (a: number, b: number) => number;
-    readonly db_init_directory: (a: number, b: number) => number;
-    readonly db_list_documents: (a: number, b: number) => number;
-    readonly db_list_sections: (a: number, b: number) => number;
-    readonly db_query: (a: number, b: number) => number;
-    readonly db_read_catalog: (a: number, b: number) => number;
-    readonly db_read_corpus_stats: (a: number, b: number) => number;
-    readonly db_read_document: (a: number, b: number) => number;
-    readonly db_read_section: (a: number, b: number) => number;
-    readonly db_read_sections: (a: number, b: number) => number;
-    readonly db_rebuild_index: (a: number, b: number) => number;
-    readonly db_remove_document: (a: number, b: number) => number;
-    readonly db_remove_from_index: (a: number, b: number) => number;
-    readonly db_remove_section: (a: number, b: number) => number;
-    readonly db_update_section: (a: number, b: number) => number;
-    readonly db_write_catalog: (a: number, b: number) => number;
-    readonly db_write_corpus_stats: (a: number, b: number) => number;
-    readonly db_write_document: (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>;