llmtxt 2026.4.3 → 2026.4.4

package/dist/disclosure.d.ts

@@ -1,3 +1,13 @@
+/**
+ * Progressive disclosure: structural analysis, section extraction,
+ * line-range access, content search, and JSONPath queries.
+ *
+ * All logic now lives in `crates/llmtxt-core::disclosure` (Rust/WASM).
+ * This module is a thin TypeScript wrapper that delegates to the WASM
+ * entry-points via `wasm.ts`.
+ *
+ * @see {@link https://github.com/kryptobaseddev/llmtxt/tree/main/crates/llmtxt-core/src/disclosure}
+ */
 /**
  * A logical section identified within a document.
  *
@@ -81,135 +91,5 @@ export interface LineRangeResult {
     /** Number of tokens saved by extracting only this range. */
     tokensSaved: number;
 }
-/**
- * Extract a range of lines from a document, returning content and token statistics.
- *
- * @remarks
- * Line numbers are 1-based and clamped to the document boundaries. This
- * enables agents to request only the portion of a document they need,
- * reducing token consumption.
- *
- * @param content - The full document content.
- * @param start - The 1-based starting line number.
- * @param end - The 1-based ending line number (inclusive).
- * @returns A {@link LineRangeResult} with the extracted content and token savings.
- *
- * @example
- * ```ts
- * const range = getLineRange(doc, 10, 25);
- * console.log(`Saved ${range.tokensSaved} tokens`);
- * ```
- */
-export declare function getLineRange(content: string, start: number, end: number): LineRangeResult;
-/**
- * Search document content for lines matching a query string or regex.
- *
- * @remarks
- * Supports plain-text substring matching (case-insensitive) and regex
- * patterns delimited with slashes (e.g. `/pattern/i`). Results include
- * configurable surrounding context lines to help agents understand each
- * match in context.
- *
- * @param content - The full document content to search.
- * @param query - A plain-text substring or `/regex/flags` pattern.
- * @param contextLines - Number of context lines before and after each match (default: 2).
- * @param maxResults - Maximum number of matches to return (default: 20).
- * @returns An array of {@link SearchResult} objects for each matching line.
- *
- * @example
- * ```ts
- * const hits = searchContent(doc, 'TODO', 3, 10);
- * ```
- */
-export declare function searchContent(content: string, query: string, contextLines?: number, maxResults?: number): SearchResult[];
-/**
- * Detect the structural format of a document using content heuristics.
- *
- * @remarks
- * Applies the following precedence: JSON (valid `JSON.parse`), then
- * markdown (2+ markdown signals such as headings, lists, or links), then
- * code (2+ code signals such as `import`, `function`, or arrow syntax),
- * and finally falls back to plain text.
- *
- * @param content - The document content to classify.
- * @returns The detected format: `"json"`, `"markdown"`, `"code"`, or `"text"`.
- *
- * @example
- * ```ts
- * detectDocumentFormat('# Title\n- item'); // "markdown"
- * ```
- */
-export declare function detectDocumentFormat(content: string): 'json' | 'markdown' | 'code' | 'text';
-/**
- * Generate a structural overview of a document for progressive disclosure.
- *
- * @remarks
- * Detects the document format, splits it into logical sections, computes
- * token counts, and extracts format-specific metadata (JSON keys or
- * markdown table of contents). The overview allows agents to decide
- * which sections to request in full, minimizing total token usage.
- *
- * @param content - The full document content to analyze.
- * @returns A {@link DocumentOverview} with format, sections, and token counts.
- *
- * @example
- * ```ts
- * const overview = generateOverview(markdownDoc);
- * console.log(`${overview.sections.length} sections, ${overview.tokenCount} tokens`);
- * ```
- */
-export declare function generateOverview(content: string): DocumentOverview;
-/**
- * Execute a JSONPath-style query against JSON content.
- *
- * @remarks
- * Parses the content as JSON and resolves the dot/bracket path (e.g.
- * `$.messages[0].content` or `data.items`). Supports wildcard (`*`) for
- * arrays and objects. Throws on invalid JSON or missing keys to provide
- * clear error messages to calling agents.
- *
- * @param content - A valid JSON string to query.
- * @param path - A JSONPath expression (e.g. `"$.key"`, `"items[0].name"`).
- * @returns An object containing the resolved `result`, its `tokenCount`, and the original `path`.
- * @throws Error if the JSON is invalid or the path cannot be resolved.
- *
- * @example
- * ```ts
- * const { result } = queryJsonPath('{"a":{"b":42}}', '$.a.b');
- * // result === 42
- * ```
- */
-export declare function queryJsonPath(content: string, path: string): {
-    result: unknown;
-    tokenCount: number;
-    path: string;
-};
-/**
- * Extract a named section from a document by title.
- *
- * @remarks
- * Searches the document's sections (from {@link generateOverview}) for a
- * matching title using progressively looser comparisons: exact match,
- * substring match, and alphanumeric-only substring match. When
- * `depthAll` is `true`, child sections at deeper nesting levels are
- * included in the extracted content.
- *
- * @param content - The full document content.
- * @param sectionName - The section title (or substring) to search for.
- * @param depthAll - When `true`, include all child sections nested under the match (default: `false`).
- * @returns An object with the matched section, extracted content, and token savings, or `null` if not found.
- *
- * @example
- * ```ts
- * const section = getSection(doc, 'Installation', true);
- * if (section) console.log(section.content);
- * ```
- */
-export declare function getSection(content: string, sectionName: string, depthAll?: boolean): {
-    section: Section;
-    content: string;
-    tokenCount: number;
-    totalTokens: number;
-    tokensSaved: number;
-} | null;
+export { detectDocumentFormat, generateOverview, getLineRange, searchContent, queryJsonPath, getSection, } from './wasm.js';
 //# sourceMappingURL=disclosure.d.ts.map

package/dist/disclosure.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"disclosure.d.ts","sourceRoot":"","sources":["../src/disclosure.ts"],"names":[],"mappings":"AAWA;;;;;;GAMG;AACH,MAAM,WAAW,OAAO;IACtB,6EAA6E;IAC7E,KAAK,EAAE,MAAM,CAAC;IACd,+DAA+D;IAC/D,KAAK,EAAE,MAAM,CAAC;IACd,oDAAoD;IACpD,SAAS,EAAE,MAAM,CAAC;IAClB,8DAA8D;IAC9D,OAAO,EAAE,MAAM,CAAC;IAChB,qDAAqD;IACrD,UAAU,EAAE,MAAM,CAAC;IACnB,0CAA0C;IAC1C,IAAI,EAAE,SAAS,GAAG,UAAU,GAAG,YAAY,GAAG,UAAU,GAAG,OAAO,CAAC;CACpE;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,gBAAgB;IAC/B,oCAAoC;IACpC,MAAM,EAAE,MAAM,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,CAAC;IAC9C,6CAA6C;IAC7C,SAAS,EAAE,MAAM,CAAC;IAClB,2DAA2D;IAC3D,UAAU,EAAE,MAAM,CAAC;IACnB,sDAAsD;IACtD,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB,4EAA4E;IAC5E,IAAI,CAAC,EAAE,KAAK,CAAC;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC7D,oEAAoE;IACpE,GAAG,CAAC,EAAE,KAAK,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CAC7D;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,gDAAgD;IAChD,IAAI,EAAE,MAAM,CAAC;IACb,0CAA0C;IAC1C,OAAO,EAAE,MAAM,CAAC;IAChB,oEAAoE;IACpE,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,oEAAoE;IACpE,YAAY,EAAE,MAAM,EAAE,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,4DAA4D;IAC5D,SAAS,EAAE,MAAM,CAAC;IAClB,sEAAsE;IACtE,OAAO,EAAE,MAAM,CAAC;IAChB,+DAA+D;IAC/D,OAAO,EAAE,MAAM,CAAC;IAChB,uDAAuD;IACvD,UAAU,EAAE,MAAM,CAAC;IACnB,kDAAkD;IAClD,UAAU,EAAE,MAAM,CAAC;IACnB,yDAAyD;IACzD,WAAW,EAAE,MAAM,CAAC;IACpB,4DAA4D;IAC5D,WAAW,EAAE,MAAM,CAAC;CACrB;AAID;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,eAAe,CAqBzF;AAID;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,aAAa,CAC3B,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,MAAM,EACb,YAAY,SAAI,EAChB,UAAU,SAAK,GACd,YAAY,EAAE,CAoChB;AAID;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,CAkC3F;AAID;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,gBAAgB,CA0BlE;AAID;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG;IAC5D,MAAM,EAAE,OAAO,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;CACd,CASA;AAID;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,QAAQ,UAAQ,GAAG;IAClF,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;CACrB,GAAG,IAAI,CA2CP"}
+{"version":3,"file":"disclosure.d.ts","sourceRoot":"","sources":["../src/disclosure.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAIH;;;;;;GAMG;AACH,MAAM,WAAW,OAAO;IACtB,6EAA6E;IAC7E,KAAK,EAAE,MAAM,CAAC;IACd,+DAA+D;IAC/D,KAAK,EAAE,MAAM,CAAC;IACd,oDAAoD;IACpD,SAAS,EAAE,MAAM,CAAC;IAClB,8DAA8D;IAC9D,OAAO,EAAE,MAAM,CAAC;IAChB,qDAAqD;IACrD,UAAU,EAAE,MAAM,CAAC;IACnB,0CAA0C;IAC1C,IAAI,EAAE,SAAS,GAAG,UAAU,GAAG,YAAY,GAAG,UAAU,GAAG,OAAO,CAAC;CACpE;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,gBAAgB;IAC/B,oCAAoC;IACpC,MAAM,EAAE,MAAM,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,CAAC;IAC9C,6CAA6C;IAC7C,SAAS,EAAE,MAAM,CAAC;IAClB,2DAA2D;IAC3D,UAAU,EAAE,MAAM,CAAC;IACnB,sDAAsD;IACtD,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB,4EAA4E;IAC5E,IAAI,CAAC,EAAE,KAAK,CAAC;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC7D,oEAAoE;IACpE,GAAG,CAAC,EAAE,KAAK,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CAC7D;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,gDAAgD;IAChD,IAAI,EAAE,MAAM,CAAC;IACb,0CAA0C;IAC1C,OAAO,EAAE,MAAM,CAAC;IAChB,oEAAoE;IACpE,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,oEAAoE;IACpE,YAAY,EAAE,MAAM,EAAE,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,4DAA4D;IAC5D,SAAS,EAAE,MAAM,CAAC;IAClB,sEAAsE;IACtE,OAAO,EAAE,MAAM,CAAC;IAChB,+DAA+D;IAC/D,OAAO,EAAE,MAAM,CAAC;IAChB,uDAAuD;IACvD,UAAU,EAAE,MAAM,CAAC;IACnB,kDAAkD;IAClD,UAAU,EAAE,MAAM,CAAC;IACnB,yDAAyD;IACzD,WAAW,EAAE,MAAM,CAAC;IACpB,4DAA4D;IAC5D,WAAW,EAAE,MAAM,CAAC;CACrB;AAQD,OAAO,EACL,oBAAoB,EACpB,gBAAgB,EAChB,YAAY,EACZ,aAAa,EACb,aAAa,EACb,UAAU,GACX,MAAM,WAAW,CAAC"}