@gmb/bitmark-parser 6.11.1 → 7.1.0

package/wasm-browser-full/bitmark_browser_full_wasm.d.ts

@@ -1,14 +1,5 @@
 /* tslint:disable */
 /* eslint-disable */
-/**
- * Lex bitmark input text, returning one line per token in the same format as
- * the Rust CLI: `{kind:?} {span:?} "{text}"`.
- *
- * `stage` selects the lexer pipeline:
- *   - `"lex"` — combined (default)
- *   - `"lex-json"` — combined, JSON array output
- */
-export function lex(input: string, stage: string): string;
 /**
  * Breakscape text (escape bitmark special characters).
  *
@@ -41,6 +32,13 @@ export function unbreakscape_text(input: string, format: string, location: strin
  * several (adds a `titles` map), `"all"` for every resolvable language
  */
 export function info(info_type: string, format: string, bit: string, pretty: boolean, indent: number, include_deprecated: boolean, only_deprecated: boolean, full: boolean, language: string): string;
+/**
+ * Whether this build can render `info` as TEXT (PLAN-192 D6). The export is
+ * ABSENT when it cannot — the same "presence is the capability" signal
+ * `diff` uses, so a caller tests for the function rather than for a
+ * variant name.
+ */
+export function info_text_supported(): boolean;
 /**
  * Convert a standalone bitmark text fragment ↔ TextAst (ProseMirror JSON).
  *
@@ -48,28 +46,35 @@ export function info(info_type: string, format: string, bit: string, pretty: boo
  * `format`: a bitmark text format (`"bitmark++"`, `"bitmark+"`) parses
  * inline marks; anything else is treated as plain text (textToAst only).
  * `location`: `"body"` (default) or `"tag"`.
- * Returns the converted fragment, or `error: …`.
+ * Returns the converted fragment; throws on failure.
  */
 export function convert_text(input: string, direction: string, format: string, location: string): string;
 /**
  * Apply a patch (a JSON array of patch entries) to every bit and re-emit.
  *
  * `input_format_sel`: `"auto"` | `"bitmark"` | `"json"`.
- * `output_format_sel`: `"bitmark"` | `"json"` (default json).
+ * `output_format_sel`: the same vocabulary as `convert` — `"bitmark"` |
+ * `"json"` | `"text"` | a mapping id (`"html"`, …), `"auto"` (or empty) being
+ * the opposite of the resolved input format. The whole-document outputs
+ * (`lex`, `semantic-tokens`, `diagnostics`) are not per-bit formats; the
+ * pipeline refuses them and that refusal is what throws.
  * `patch_json`: the patch entry array (empty string = no patches, i.e. a
  * canonicalizing pass). Parallelism is a JS-side concern (web workers); this
- * runs sequentially. Returns the document text/JSON, or `error: …`.
+ * runs sequentially. Returns the document text/JSON; throws on failure.
  */
 export function transform(input: string, input_format_sel: string, output_format_sel: string, mode: string, patch_json: string, pretty: boolean, indent: number, spaces_around_values: number): string;
 /**
  * Resolve a patch document against `input` (bitmark or JSON) into the
  * ordered output items, so a JS per-bit planner (hooks, worker pool) can
  * reorder, drop and insert jobs from the one Rust implementation
- * (PLAN-179). Returns a JSON array of
+ * (PLAN-179). `input_format_sel` is the caller's input-format selector
+ * (`"auto"` | `"bitmark"` | `"json"`): the document is split under the SAME
+ * selection the planner already resolved, never re-sniffed (PLAN-187 D1).
+ * Returns a JSON array of
  * `{ "source": <original index> | null, "bit": <inner bit> | null,
- *    "patch": [ … ] }`, or `error: …`.
+ *    "patch": [ … ] }`; throws on failure.
  */
-export function resolve_patch_document(input: string, patch_json: string): string;
+export function resolve_patch_document(input: string, input_format_sel: string, patch_json: string): string;
 /**
  * Semantic diff of two documents (PLAN-179). Flat arguments like every
  * other export:
@@ -80,10 +85,37 @@ export function resolve_patch_document(input: string, patch_json: string): strin
  *   - `context`, `locate`, `similarity`, `bbox_tolerance`,
  *     `spaces_around_values` as documented on `DiffOptions`.
  * Returns the diff (empty text / `[]` of unchanged bits / a patch document
- * with no entries when the documents are semantically equal), or
- * `error: …`.
+ * with no entries when the documents are semantically equal); throws on
+ * failure.
  */
 export function diff(a: string, b: string, input_format_sel: string, output_format_sel: string, context: number, locate: boolean, similarity: number, bbox_tolerance: number, spaces_around_values: number): string;
+/**
+ * The constructs valid at a position, as an LSP `CompletionList` (PLAN-196
+ * D7; contract `API-EDT-editor-services.tsp`). `line` / `character` are
+ * 0-based, `character` in `position_encoding` units (`"utf-16"`, the
+ * default, or `"utf-8"`); `include_deprecated` offers deprecated bits too;
+ * `trigger_character` is the character the editor sent as the trigger (LSP
+ * `CompletionContext.triggerCharacter`; empty when invoked explicitly) — a
+ * trigger that opens nothing where the cursor is answers the empty list
+ * (PLAN-203 D1). ABSENT on a variant built without `editor` — the same
+ * "presence is the capability" signal `diff` uses. Throws when the line is
+ * past the text.
+ */
+export function complete(input: string, line: number, character: number, position_encoding: string, include_deprecated: boolean, trigger_character: string): string;
+/**
+ * One item of the list `complete` returns at this position, its Markdown
+ * `documentation` filled in — LSP `completionItem/resolve` (PLAN-202):
+ * `complete` ships no documentation, an editor asks for the one item it is
+ * about to show. `label` and `kind` (the LSP `CompletionItemKind` number)
+ * name the item; the JSON `null` when the list has no such item. Arguments
+ * otherwise as `complete`.
+ */
+export function resolve(input: string, line: number, character: number, position_encoding: string, include_deprecated: boolean, label: string, kind: number): string;
+/**
+ * The construct at a position, as an LSP `Hover` — or the JSON `null` when
+ * there is nothing to show (PLAN-196 D8). Arguments as `complete`.
+ */
+export function hover(input: string, line: number, character: number, position_encoding: string): string;
 /**
  * Register data with the parser process (PLAN-173 P12).
  *
@@ -92,24 +124,31 @@ export function diff(a: string, b: string, input_format_sel: string, output_form
  *
  * `data` is the file's own text. Semantics are REPLACE: a second call
  * supersedes the first entirely, and the built-in table (where the variant
- * bakes one) stays underneath. Returns `""` on success, or an
- * `error:`-prefixed message — matching the other string-returning exports.
+ * bakes one) stays underneath. Throws on bad data — like every other
+ * fallible export (PLAN-192 D1).
  *
  * Available in EVERY variant, including those that bake nothing: that is
  * exactly where a consumer must supply the file themselves.
  */
-export function register(data_type: string, data: string): string;
+export function register(data_type: string, data: string): void;
 /**
  * Convert between bitmark and JSON with explicit input/output formats + mode.
  *
- * `input_format`: `"auto"` (default) | `"bitmark"` | `"json"`.
- * `output_format`: `"auto"` (opposite of input) | `"bitmark"` | `"json"`.
+ * `input_format`: `"auto"` (default) | `"bitmark"` | `"json"` | a mapping id.
+ * `output_format`: `"auto"` (opposite of input) | `"bitmark"` | `"json"` |
+ * `"text"` | `"lex"` (the token stream as JSON) | `"semantic-tokens"` |
+ * `"diagnostics"` (the last three bitmark input only) | a mapping id.
  * `mode`: `"optimized"` (default) | `"full"`.
  * `mapping_report`: replace the output with a human-readable report of the
  * input→output mappings, including inputs that are NOT mapped (PLAN-147).
- * Returns the converted text/JSON, or a string prefixed `error:` on failure.
+ * `position_encoding`: `"utf-16"` (default) | `"utf-8"` — the
+ * `semantic-tokens` and `diagnostics` outputs' encoding (PLAN-193 /
+ * PLAN-196) — and `tokens_layout`: `"lsp"` (default) | `"absolute"` — the
+ * `semantic-tokens` layout; `""` means the default, and every other output
+ * format ignores them.
+ * Returns the converted text/JSON; throws on failure.
  */
-export function convert(input: string, input_format_sel: string, output_format_sel: string, mode: string, pretty: boolean, indent: number, spaces_around_values: number, include_unknown_properties: boolean, mapping_report: boolean): string;
+export function convert(input: string, input_format_sel: string, output_format_sel: string, mode: string, pretty: boolean, indent: number, spaces_around_values: number, include_unknown_properties: boolean, mapping_report: boolean, position_encoding: string, tokens_layout: string): string;
 /**
  * Re-emit input in its own format in canonical form at `mode`.
  *
@@ -119,7 +158,7 @@ export function convert(input: string, input_format_sel: string, output_format_s
 export function canonicalize(input: string, input_format_sel: string, mode: string, pretty: boolean, indent: number, spaces_around_values: number): string;
 /**
  * Count the bits in `input` (auto-detecting bitmark vs JSON).
- * Returns the count as a decimal string, or `error: …`.
+ * Returns the count as a decimal string; throws on failure.
  */
 export function count_bits(input: string): string;
 /**
@@ -138,7 +177,7 @@ export function is_bitmark(input: string): boolean;
  * Split a JSON document (a top-level array of bit envelopes) into its per-bit
  * envelope objects, returned as a JSON array string. Lets a JS caller iterate
  * JSON-input bits for per-bit hooks (the JSON counterpart of [`split_bits`]).
- * Returns `error: …` if the input is not a JSON array of bits.
+ * Throws if the input is not a JSON array of bits.
  */
 export function split_json_bits(input: string): string;
 /**