@dikolab/kbdb 0.3.2 → 0.4.0

package/src/shared/worker-client/typings/recall-result.model.ts

@@ -1,98 +0,0 @@
-/** Parameters for a recall operation. */
-export interface RecallParams {
-   /** Single section identifier to recall. */
-   readonly kbid?: string;
-   /** Batch of section identifiers to recall. */
-   readonly kbids?: readonly string[];
-   /**
-    * Context expansion depth (0-3).
-    *
-    * At depth 0 only the section itself is returned.
-    * Higher values include progressively more context:
-    * documents, siblings, and references.
-    */
-   readonly depth?: number;
-}
-
-/** A document record included at depth >= 1. */
-export interface RecallDocument {
-   /** Unique document identifier. */
-   readonly docid: string;
-   /** Human-readable document title. */
-   readonly title: string;
-   /** Ordered list of section summaries belonging to this document. */
-   readonly sections: readonly {
-      /** Knowledge-base identifier of the section. */
-      readonly kbid: string;
-      /** Section heading text, or `null` when absent. */
-      readonly heading: string | null;
-      /** Semantic type label for the section. */
-      readonly type: string;
-   }[];
-}
-
-/** A sibling section adjacent to the recalled section. */
-export interface RecallSibling {
-   /** Knowledge-base identifier of the sibling section. */
-   readonly kbid: string;
-   /** Sibling heading text, or `null` when absent. */
-   readonly heading: string | null;
-   /** Semantic type label for the sibling section. */
-   readonly type: string;
-   /** Full text content of the sibling section. */
-   readonly content: string;
-}
-
-/** A section that references or is referenced by the recalled section. */
-export interface RecallReference {
-   /** Knowledge-base identifier of the referencing/referenced section. */
-   readonly kbid: string;
-   /** Heading text of the referencing section, or `null` when absent. */
-   readonly heading: string | null;
-   /** Semantic type label of the referencing section. */
-   readonly type: string;
-   /** Application-level marker type (e.g. `'see_also'`, `'link'`). */
-   readonly marker_type: string;
-   /** Short excerpt from the referencing section surrounding the marker. */
-   readonly context_snippet: string;
-   /** Whether the reference is `'forward'` (outgoing) or `'back'` (incoming). */
-   readonly direction: 'forward' | 'back';
-}
-
-/** Full content and context for a recalled knowledge-base section. */
-export interface RecallResult {
-   /** Knowledge-base identifier of the recalled section. */
-   readonly kbid: string;
-   /** Section heading text, or `null` when absent. */
-   readonly heading: string | null;
-   /** Semantic type label for the section. */
-   readonly type: string;
-   /** Full text content of the section. */
-   readonly content: string;
-   /** Identifiers of documents that contain this section. */
-   readonly docids: readonly string[];
-   /**
-    * Full document records containing this section.
-    *
-    * Populated when `depth >= 1`.
-    */
-   readonly documents?: readonly RecallDocument[];
-   /**
-    * Sections that contain a marker pointing back to this section.
-    *
-    * Populated when `depth >= 1`.
-    */
-   readonly back_references?: readonly RecallReference[];
-   /**
-    * Sections adjacent to this section in the same document.
-    *
-    * Populated when `depth >= 1`.
-    */
-   readonly siblings?: readonly RecallSibling[];
-   /**
-    * Sections that this section points to via markers.
-    *
-    * Populated when `depth >= 1`.
-    */
-   readonly references?: readonly RecallReference[];
-}

package/src/shared/worker-client/typings/recall-sibling.model.ts

@@ -1,11 +0,0 @@
-/** A sibling section adjacent to the recalled section. */
-export interface RecallSibling {
-   /** Knowledge-base identifier of the sibling section. */
-   readonly kbid: string;
-   /** Sibling heading text, or `null` when absent. */
-   readonly heading: string | null;
-   /** Semantic type label for the sibling section. */
-   readonly type: string;
-   /** Full text content of the sibling section. */
-   readonly content: string;
-}

package/src/shared/worker-client/typings/recall-single-result.model.ts

@@ -1,41 +0,0 @@
-import type { RecallDocument } from './recall-document.model.ts';
-import type { RecallReference } from './recall-reference.model.ts';
-import type { RecallSibling } from './recall-sibling.model.ts';
-
-/** Full content and context for a recalled knowledge-base section. */
-export interface RecallResult {
-   /** Knowledge-base identifier of the recalled section. */
-   readonly kbid: string;
-   /** Section heading text, or `null` when absent. */
-   readonly heading: string | null;
-   /** Semantic type label for the section. */
-   readonly type: string;
-   /** Full text content of the section. */
-   readonly content: string;
-   /** Identifiers of documents that contain this section. */
-   readonly docids: readonly string[];
-   /**
-    * Full document records containing this section.
-    *
-    * Populated when `depth >= 1`.
-    */
-   readonly documents?: readonly RecallDocument[];
-   /**
-    * Sections that contain a marker pointing back to this section.
-    *
-    * Populated when `depth >= 1`.
-    */
-   readonly back_references?: readonly RecallReference[];
-   /**
-    * Sections adjacent to this section in the same document.
-    *
-    * Populated when `depth >= 1`.
-    */
-   readonly siblings?: readonly RecallSibling[];
-   /**
-    * Sections that this section points to via markers.
-    *
-    * Populated when `depth >= 1`.
-    */
-   readonly references?: readonly RecallReference[];
-}

package/src/shared/worker-client/typings/remove-section-result.model.ts

@@ -1,7 +0,0 @@
-/** Result returned by the daemon after removing a section. */
-export interface RemoveSectionResult {
-   /** `true` when the section was found and successfully removed. */
-   readonly removed: boolean;
-   /** Time taken to perform the removal, in milliseconds. */
-   readonly elapsed_ms: number;
-}

package/src/shared/worker-client/typings/search-params.model.ts

@@ -1,14 +0,0 @@
-/** Parameters for a search query sent to the worker daemon. */
-export interface SearchParams {
-   /** The search query string. */
-   readonly query: string;
-   /**
-    * Controls what entity type is returned.
-    * Defaults to `'sections'` when omitted.
-    */
-   readonly mode?: 'sections' | 'documents' | 'stats';
-   /** Maximum number of results to return. */
-   readonly limit?: number;
-   /** Number of results to skip (pagination offset). */
-   readonly offset?: number;
-}

package/src/shared/worker-client/typings/search-result.model.ts

@@ -1,43 +0,0 @@
-/** A single ranked result returned by a search query. */
-export interface SearchResult {
-   /** Knowledge-base identifier for the matched section. */
-   readonly kbid: string;
-   /** Section heading, or null when untitled. */
-   readonly heading: string | null;
-   /** MIME type of the section content. */
-   readonly type: string;
-   /** Document IDs this section belongs to. */
-   readonly docids: readonly string[];
-   /** Relevance score assigned by the ranking engine. */
-   readonly score: number;
-   /** KWIC snippet (~150 chars around the best match). */
-   readonly snippet: string;
-   /** Query terms that matched within this section. */
-   readonly matched_terms: readonly string[];
-   /**
-    * Fields that contained at least one match
-    * (e.g. `'heading'`, `'body'`).
-    */
-   readonly matched_fields?: readonly string[];
-   /**
-    * Normalised confidence score (0.0-1.0) relative to the top result.
-    * May be absent from older daemon versions.
-    */
-   readonly confidence?: number;
-   /** ISO 8601 creation timestamp of the section. */
-   readonly created_at?: string;
-}
-
-/** Paginated search result envelope. */
-export interface PagedSearchResult {
-   /** Matching sections for the current page. */
-   readonly items: readonly SearchResult[];
-   /** Total number of matches across all pages. */
-   readonly total: number;
-   /** Number of results skipped (pagination offset). */
-   readonly offset: number;
-   /** Maximum results per page. */
-   readonly limit: number;
-   /** Whether more results exist beyond this page. */
-   readonly has_more: boolean;
-}

package/src/shared/worker-client/typings/section.model.ts

@@ -1,43 +0,0 @@
-/** A content section stored in the knowledge-base. */
-export interface Section {
-   /** Knowledge-base identifier for this section. */
-   readonly kbid: string;
-   /** Parent document identifier, if the section belongs to one. */
-   readonly docid?: string;
-   /** Semantic type label assigned to the section. */
-   readonly sectionType: string;
-   /** Raw text content of the section. */
-   readonly content: string;
-   /** Byte size of the stored content. */
-   readonly size: number;
-   /** Unix epoch timestamp (ms) when the section was created. */
-   readonly createdAt: number;
-   /** SHA-256 checksum of the stored content. */
-   readonly checksum: string;
-}
-
-/** Parameters required to add or update a section. */
-export interface AddSectionParams {
-   /** Semantic type label to assign to the section. */
-   readonly sectionType: string;
-   /** Raw text content for the section. */
-   readonly content: string;
-   /** Parent document identifier to associate the section with. */
-   readonly docid?: string;
-   /** Human-readable heading for the section. */
-   readonly title?: string;
-   /** Short summary or description of the section. */
-   readonly description?: string;
-   /** Application-defined tags for scoping and filtering. */
-   readonly tags?: string[];
-   /**
-    * When `true`, supersedes an existing section with the same
-    * source key (derived from `sourcePath` and `title`).
-    */
-   readonly replace?: boolean;
-   /**
-    * Absolute path to the source file. Required for supersession
-    * via source key when `replace` is `true`.
-    */
-   readonly sourcePath?: string;
-}

package/src/shared/worker-client/typings/status-result.model.ts

@@ -1,14 +0,0 @@
-/** Diagnostic status returned by the worker daemon. */
-export interface StatusResult {
-   /** Whether the daemon has finished loading its WASM modules. */
-   readonly initialized: boolean;
-   /** Absolute path to the context directory the daemon serves. */
-   readonly contextPath: string;
-   /** In-memory cache statistics. */
-   readonly cacheStats: {
-      /** Number of content entries currently cached. */
-      readonly contentCount: number;
-      /** Number of index entries currently cached. */
-      readonly indexCount: number;
-   };
-}

package/src/shared/worker-client/typings/version-status.model.ts

@@ -1,28 +0,0 @@
-/**
- * Compatibility status categories returned by a database version check.
- *
- * - `'compatible'` -- database version matches the WASM engine version
- * - `'needs_migration'` -- database is older and must be migrated with
- *   `kbdb --migrate`
- * - `'too_new'` -- database was created by a newer version of kbdb;
- *   upgrade the kbdb binary
- */
-export type VersionCompatibility =
-   | 'compatible'
-   | 'needs_migration'
-   | 'too_new';
-
-/**
- * Version compatibility status returned by a database version check.
- */
-export interface VersionStatus {
-   /** The format version stored in the database's `catalog.toml`. */
-   readonly currentVersion: number;
-   /**
-    * The format version required by the current WASM engine.
-    * Equivalent to `DB_FORMAT_VERSION` from the Rust shared crate.
-    */
-   readonly requiredVersion: number;
-   /** Compatibility result between the database and WASM engine. */
-   readonly status: VersionCompatibility;
-}

package/src/shared/worker-client/typings/worker-client-error.interface.ts

@@ -1,8 +0,0 @@
-/**
- * An error returned by the worker daemon over JSON-RPC,
- * carrying a numeric error code alongside the message.
- */
-export interface WorkerClientError extends Error {
-   /** JSON-RPC error code returned by the daemon. */
-   readonly code: number;
-}

package/src/shared/worker-client/typings/worker-client-options.interface.ts

@@ -1,30 +0,0 @@
-/** Options for configuring a WorkerClient connection. */
-export interface WorkerClientOptions {
-   /**
-    * Path to the directory containing the `.kbdb` database
-    * folder. Defaults to `process.cwd()` when omitted.
-    */
-   readonly dbPath?: string;
-   /**
-    * Absolute path to the context directory. When provided,
-    * skips the `.kbdb` discovery step performed by `dbPath`.
-    */
-   readonly contextPath?: string;
-   /**
-    * When `true` (default), automatically spawns the worker
-    * daemon if it is not already running before connecting.
-    * Set to `false` to require a running daemon.
-    */
-   readonly autoSpawn?: boolean;
-   /**
-    * Maximum milliseconds to wait for the daemon PID file to
-    * appear after spawning. Defaults to 10 000 ms.
-    */
-   readonly connectTimeoutMs?: number;
-   /**
-    * Absolute path to the worker daemon script. Resolved
-    * once at the entry point and injected here so that
-    * `spawnDaemon` needs no runtime-specific path logic.
-    */
-   readonly workerScript?: string;
-}

package/src/shared/worker-daemon/classes/ipc-error.class.ts

@@ -1,22 +0,0 @@
-/**
- * Typed JSON-RPC error thrown inside WorkerDaemon dispatch.
- *
- * Carries a numeric JSON-RPC error code alongside the standard
- * `Error` message so that `handleRequest` can build a well-formed
- * JSON-RPC error response without an additional type check.
- */
-export class IpcError extends Error {
-   /** JSON-RPC error code. */
-   readonly code: number;
-
-   /**
-    * @param code - JSON-RPC error code (e.g. `-32601` for
-    *   method-not-found, `-32000` for application errors)
-    * @param message - human-readable error description
-    */
-   constructor(code: number, message: string) {
-      super(message);
-      this.code = code;
-      this.name = 'IpcError';
-   }
-}