@dikolab/kbdb 0.3.1 → 0.4.0

package/src/shared/wasm-codec/functions/decode-one-recall-result.function.ts

@@ -1,86 +0,0 @@
-import { decodeString } from './decode-string.function.ts';
-import { decodeOptionString } from './decode-option-string.function.ts';
-import { decodeWasmList } from './decode-wasm-list.function.ts';
-import { decodeRecallReference } from './decode-recall-reference.function.ts';
-import { decodeRecallSibling } from './decode-recall-sibling.function.ts';
-import { decodeRecallDocument } from './decode-recall-document.function.ts';
-import type { DecodeResult } from './decode-string.function.ts';
-import type {
-   RecallResult,
-   RecallDocument,
-   RecallSibling,
-   RecallReference,
-} from '../../worker-client/typings/recall-result.model.ts';
-
-/**
- * Decodes a single `RecallResult` record from WASM binary output.
- *
- * Wire format: kbid, heading, section_type, content, docid list,
- * document list, back_references list, siblings list,
- * references list.
- *
- * @param bytes - raw binary buffer
- * @param startOffset - byte position of the record start
- * @returns decoded result and number of bytes consumed
- */
-export function decodeOneRecallResult(
-   bytes: Uint8Array,
-   startOffset: number,
-): DecodeResult<RecallResult> {
-   let pos = startOffset;
-
-   const kbid = decodeString(bytes, pos);
-   pos += kbid.bytesRead;
-   const heading = decodeOptionString(bytes, pos);
-   pos += heading.bytesRead;
-   const sectionType = decodeString(bytes, pos);
-   pos += sectionType.bytesRead;
-   const content = decodeString(bytes, pos);
-   pos += content.bytesRead;
-
-   const docids = decodeWasmList(bytes, pos, decodeString);
-   pos += docids.bytesRead;
-
-   const documents = decodeWasmList<RecallDocument>(
-      bytes,
-      pos,
-      decodeRecallDocument,
-   );
-   pos += documents.bytesRead;
-
-   const back_references = decodeWasmList<RecallReference>(
-      bytes,
-      pos,
-      decodeRecallReference,
-   );
-   pos += back_references.bytesRead;
-
-   const siblings = decodeWasmList<RecallSibling>(
-      bytes,
-      pos,
-      decodeRecallSibling,
-   );
-   pos += siblings.bytesRead;
-
-   const references = decodeWasmList<RecallReference>(
-      bytes,
-      pos,
-      decodeRecallReference,
-   );
-   pos += references.bytesRead;
-
-   return {
-      value: {
-         kbid: kbid.value,
-         heading: heading.value,
-         type: sectionType.value,
-         content: content.value,
-         docids: docids.items,
-         documents: documents.items,
-         back_references: back_references.items,
-         siblings: siblings.items,
-         references: references.items,
-      },
-      bytesRead: pos - startOffset,
-   };
-}

package/src/shared/wasm-codec/functions/decode-option-string.function.ts

@@ -1,24 +0,0 @@
-import type { DecodeResult } from './decode-string.function.ts';
-import { decodeString } from './decode-string.function.ts';
-
-/**
- * Decodes an `Option<String>` from WASM binary output.
- *
- * Wire format: `u8` tag byte (`0x00` = `None`, any other value =
- * `Some`) followed by a length-prefixed UTF-8 string when present.
- *
- * @param bytes - raw binary buffer
- * @param offset - byte position of the tag byte
- * @returns decoded nullable string and number of bytes consumed
- */
-export function decodeOptionString(
-   bytes: Uint8Array,
-   offset: number,
-): DecodeResult<string | null> {
-   const tag = bytes[offset];
-   if (tag === 0x00) {
-      return { value: null, bytesRead: 1 };
-   }
-   const str = decodeString(bytes, offset + 1);
-   return { value: str.value, bytesRead: 1 + str.bytesRead };
-}

package/src/shared/wasm-codec/functions/decode-recall-document.function.ts

@@ -1,59 +0,0 @@
-import { decodeString } from './decode-string.function.ts';
-import { decodeU32 } from './decode-u32.function.ts';
-import { decodeOptionString } from './decode-option-string.function.ts';
-import type { DecodeResult } from './decode-string.function.ts';
-import type { RecallDocument } from '../../worker-client/typings/recall-result.model.ts';
-
-/**
- * Decodes a single `RecallDocument` record from WASM binary output.
- *
- * Wire format: docid (String), title (String), section_count (u32),
- * then each section as kbid (String), heading (Option<String>),
- * section_type (String).
- *
- * @param bytes - raw binary buffer
- * @param offset - byte position of the record start
- * @returns decoded document and number of bytes consumed
- */
-export function decodeRecallDocument(
-   bytes: Uint8Array,
-   offset: number,
-): DecodeResult<RecallDocument> {
-   let pos = offset;
-
-   const docid = decodeString(bytes, pos);
-   pos += docid.bytesRead;
-
-   const title = decodeString(bytes, pos);
-   pos += title.bytesRead;
-
-   const sectionCount = decodeU32(bytes, pos);
-   pos += sectionCount.bytesRead;
-
-   const sections: RecallDocument['sections'][number][] = [];
-   for (let i = 0; i < sectionCount.value; i++) {
-      const secKbid = decodeString(bytes, pos);
-      pos += secKbid.bytesRead;
-
-      const secHeading = decodeOptionString(bytes, pos);
-      pos += secHeading.bytesRead;
-
-      const secType = decodeString(bytes, pos);
-      pos += secType.bytesRead;
-
-      sections.push({
-         kbid: secKbid.value,
-         heading: secHeading.value,
-         type: secType.value,
-      });
-   }
-
-   return {
-      value: {
-         docid: docid.value,
-         title: title.value,
-         sections,
-      },
-      bytesRead: pos - offset,
-   };
-}

package/src/shared/wasm-codec/functions/decode-recall-reference.function.ts

@@ -1,52 +0,0 @@
-import { decodeString } from './decode-string.function.ts';
-import { decodeOptionString } from './decode-option-string.function.ts';
-import type { DecodeResult } from './decode-string.function.ts';
-import type { RecallReference } from '../../worker-client/typings/recall-result.model.ts';
-
-/**
- * Decodes a single `RecallReference` record from WASM binary output.
- *
- * Wire format: kbid (String), heading (Option<String>),
- * section_type (String), marker_type (String),
- * context_snippet (String), direction (String).
- *
- * @param bytes - raw binary buffer
- * @param offset - byte position of the record start
- * @returns decoded reference and number of bytes consumed
- */
-export function decodeRecallReference(
-   bytes: Uint8Array,
-   offset: number,
-): DecodeResult<RecallReference> {
-   let pos = offset;
-
-   const kbid = decodeString(bytes, pos);
-   pos += kbid.bytesRead;
-
-   const heading = decodeOptionString(bytes, pos);
-   pos += heading.bytesRead;
-
-   const sectionType = decodeString(bytes, pos);
-   pos += sectionType.bytesRead;
-
-   const markerType = decodeString(bytes, pos);
-   pos += markerType.bytesRead;
-
-   const contextSnippet = decodeString(bytes, pos);
-   pos += contextSnippet.bytesRead;
-
-   const direction = decodeString(bytes, pos);
-   pos += direction.bytesRead;
-
-   return {
-      value: {
-         kbid: kbid.value,
-         heading: heading.value,
-         type: sectionType.value,
-         marker_type: markerType.value,
-         context_snippet: contextSnippet.value,
-         direction: direction.value as 'forward' | 'back',
-      },
-      bytesRead: pos - offset,
-   };
-}

package/src/shared/wasm-codec/functions/decode-recall-result.function.ts

@@ -1,267 +0,0 @@
-import { decodeString } from './decode-string.function.ts';
-import { decodeU32 } from './decode-u32.function.ts';
-import type {
-   RecallResult,
-   RecallDocument,
-   RecallSibling,
-   RecallReference,
-} from '../../worker-client/typings/recall-result.model.ts';
-
-/**
- * Decodes recall result binary output from the `worker_recall` WASM
- * export.
- *
- * Binary layout:
- * - `u8 tag`: `0` = single result, `1` = batch
- * - If tag=0: one RecallResult record
- * - If tag=1: `u32 count` + `count` RecallResult records
- *
- * Each RecallResult:
- * ```
- * String kbid
- * Option<String> heading  (0x00=null, 0x01 + String)
- * String section_type
- * String content
- * u32 docids_count + String[] docids
- * u32 documents_count + RecallDocument[]
- * u32 back_references_count + RecallReference[]
- * u32 siblings_count + RecallSibling[]
- * u32 references_count + RecallReference[]
- * ```
- *
- * @param bytes - raw binary output from the WASM export
- * @returns a single `RecallResult` for tag=0, or `RecallResult[]`
- *   for tag=1
- */
-export function decodeRecallResult(
-   bytes: Uint8Array,
-): RecallResult | RecallResult[] {
-   const tag = bytes[0];
-   let offset = 1;
-
-   if (tag === 0x01) {
-      // Batch
-      const countResult = decodeU32(bytes, offset);
-      offset += countResult.bytesRead;
-      const items: RecallResult[] = [];
-      for (let i = 0; i < countResult.value; i++) {
-         const { item, bytesRead } = decodeOneResult(bytes, offset);
-         offset += bytesRead;
-         items.push(item);
-      }
-      return items;
-   }
-
-   // Single (tag=0 or any other value)
-   const { item } = decodeOneResult(bytes, offset);
-   return item;
-}
-
-// ---------------------------------------------------------------------------
-// Private helpers
-// ---------------------------------------------------------------------------
-
-interface DecodeResultPair {
-   item: RecallResult;
-   bytesRead: number;
-}
-
-function decodeOptionString(
-   bytes: Uint8Array,
-   offset: number,
-): { value: string | null; bytesRead: number } {
-   const tag = bytes[offset];
-   if (tag === 0x00) {
-      return { value: null, bytesRead: 1 };
-   }
-   const str = decodeString(bytes, offset + 1);
-   return { value: str.value, bytesRead: 1 + str.bytesRead };
-}
-
-function decodeReference(
-   bytes: Uint8Array,
-   offset: number,
-): { value: RecallReference; bytesRead: number } {
-   let pos = offset;
-
-   const kbid = decodeString(bytes, pos);
-   pos += kbid.bytesRead;
-
-   const heading = decodeOptionString(bytes, pos);
-   pos += heading.bytesRead;
-
-   const sectionType = decodeString(bytes, pos);
-   pos += sectionType.bytesRead;
-
-   const markerType = decodeString(bytes, pos);
-   pos += markerType.bytesRead;
-
-   const contextSnippet = decodeString(bytes, pos);
-   pos += contextSnippet.bytesRead;
-
-   const direction = decodeString(bytes, pos);
-   pos += direction.bytesRead;
-
-   return {
-      value: {
-         kbid: kbid.value,
-         heading: heading.value,
-         type: sectionType.value,
-         marker_type: markerType.value,
-         context_snippet: contextSnippet.value,
-         direction: direction.value as 'forward' | 'back',
-      },
-      bytesRead: pos - offset,
-   };
-}
-
-function decodeSibling(
-   bytes: Uint8Array,
-   offset: number,
-): { value: RecallSibling; bytesRead: number } {
-   let pos = offset;
-
-   const kbid = decodeString(bytes, pos);
-   pos += kbid.bytesRead;
-
-   const heading = decodeOptionString(bytes, pos);
-   pos += heading.bytesRead;
-
-   const sectionType = decodeString(bytes, pos);
-   pos += sectionType.bytesRead;
-
-   const content = decodeString(bytes, pos);
-   pos += content.bytesRead;
-
-   return {
-      value: {
-         kbid: kbid.value,
-         heading: heading.value,
-         type: sectionType.value,
-         content: content.value,
-      },
-      bytesRead: pos - offset,
-   };
-}
-
-function decodeDocument(
-   bytes: Uint8Array,
-   offset: number,
-): { value: RecallDocument; bytesRead: number } {
-   let pos = offset;
-
-   const docid = decodeString(bytes, pos);
-   pos += docid.bytesRead;
-
-   const title = decodeString(bytes, pos);
-   pos += title.bytesRead;
-
-   const sectionCount = decodeU32(bytes, pos);
-   pos += sectionCount.bytesRead;
-
-   const sections: RecallDocument['sections'][number][] = [];
-   for (let i = 0; i < sectionCount.value; i++) {
-      const secKbid = decodeString(bytes, pos);
-      pos += secKbid.bytesRead;
-
-      const secHeading = decodeOptionString(bytes, pos);
-      pos += secHeading.bytesRead;
-
-      const secType = decodeString(bytes, pos);
-      pos += secType.bytesRead;
-
-      sections.push({
-         kbid: secKbid.value,
-         heading: secHeading.value,
-         type: secType.value,
-      });
-   }
-
-   return {
-      value: {
-         docid: docid.value,
-         title: title.value,
-         sections,
-      },
-      bytesRead: pos - offset,
-   };
-}
-
-function decodeOneResult(
-   bytes: Uint8Array,
-   startOffset: number,
-): DecodeResultPair {
-   let pos = startOffset;
-
-   const kbid = decodeString(bytes, pos);
-   pos += kbid.bytesRead;
-
-   const heading = decodeOptionString(bytes, pos);
-   pos += heading.bytesRead;
-
-   const sectionType = decodeString(bytes, pos);
-   pos += sectionType.bytesRead;
-
-   const content = decodeString(bytes, pos);
-   pos += content.bytesRead;
-
-   const docidCount = decodeU32(bytes, pos);
-   pos += docidCount.bytesRead;
-   const docids: string[] = [];
-   for (let i = 0; i < docidCount.value; i++) {
-      const docid = decodeString(bytes, pos);
-      pos += docid.bytesRead;
-      docids.push(docid.value);
-   }
-
-   const docCount = decodeU32(bytes, pos);
-   pos += docCount.bytesRead;
-   const documents: RecallDocument[] = [];
-   for (let i = 0; i < docCount.value; i++) {
-      const doc = decodeDocument(bytes, pos);
-      pos += doc.bytesRead;
-      documents.push(doc.value);
-   }
-
-   const backRefCount = decodeU32(bytes, pos);
-   pos += backRefCount.bytesRead;
-   const back_references: RecallReference[] = [];
-   for (let i = 0; i < backRefCount.value; i++) {
-      const ref = decodeReference(bytes, pos);
-      pos += ref.bytesRead;
-      back_references.push(ref.value);
-   }
-
-   const sibCount = decodeU32(bytes, pos);
-   pos += sibCount.bytesRead;
-   const siblings: RecallSibling[] = [];
-   for (let i = 0; i < sibCount.value; i++) {
-      const sib = decodeSibling(bytes, pos);
-      pos += sib.bytesRead;
-      siblings.push(sib.value);
-   }
-
-   const refCount = decodeU32(bytes, pos);
-   pos += refCount.bytesRead;
-   const references: RecallReference[] = [];
-   for (let i = 0; i < refCount.value; i++) {
-      const ref = decodeReference(bytes, pos);
-      pos += ref.bytesRead;
-      references.push(ref.value);
-   }
-
-   return {
-      item: {
-         kbid: kbid.value,
-         heading: heading.value,
-         type: sectionType.value,
-         content: content.value,
-         docids,
-         documents,
-         back_references,
-         siblings,
-         references,
-      },
-      bytesRead: pos - startOffset,
-   };
-}

package/src/shared/wasm-codec/functions/decode-recall-sibling.function.ts

@@ -1,43 +0,0 @@
-import { decodeString } from './decode-string.function.ts';
-import { decodeOptionString } from './decode-option-string.function.ts';
-import type { DecodeResult } from './decode-string.function.ts';
-import type { RecallSibling } from '../../worker-client/typings/recall-result.model.ts';
-
-/**
- * Decodes a single `RecallSibling` record from WASM binary output.
- *
- * Wire format: kbid (String), heading (Option<String>),
- * section_type (String), content (String).
- *
- * @param bytes - raw binary buffer
- * @param offset - byte position of the record start
- * @returns decoded sibling and number of bytes consumed
- */
-export function decodeRecallSibling(
-   bytes: Uint8Array,
-   offset: number,
-): DecodeResult<RecallSibling> {
-   let pos = offset;
-
-   const kbid = decodeString(bytes, pos);
-   pos += kbid.bytesRead;
-
-   const heading = decodeOptionString(bytes, pos);
-   pos += heading.bytesRead;
-
-   const sectionType = decodeString(bytes, pos);
-   pos += sectionType.bytesRead;
-
-   const content = decodeString(bytes, pos);
-   pos += content.bytesRead;
-
-   return {
-      value: {
-         kbid: kbid.value,
-         heading: heading.value,
-         type: sectionType.value,
-         content: content.value,
-      },
-      bytesRead: pos - offset,
-   };
-}

package/src/shared/wasm-codec/functions/decode-remove-flag.function.ts

@@ -1,3 +0,0 @@
-export function decodeRemoveFlag(bytes: Uint8Array): boolean {
-   return bytes.length > 0 && bytes[0] === 0x01;
-}