@gmb/bitmark-parser 6.1.1 → 6.1.3

package/wasm/bitmark_wasm.d.ts

@@ -1,30 +1,22 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Re-emit input in its own format in canonical form at `mode`.
- */
-export function canonicalize(input: string, mode: string, pretty: boolean, indent: number, spaces_around_values: number): string;
-/**
- * Re-emit input in its own format at full mode (all keys).
- */
-export function fullize(input: string, pretty: boolean, indent: number): string;
-/**
- * Apply a patch (a JSON array of patch entries) to every bit and re-emit.
+ * Lex bitmark input text, returning one line per token in the same format as
+ * the Rust CLI: `{kind:?} {span:?} "{text}"`.
  *
- * `input_format_sel`: `"auto"` | `"bitmark"` | `"json"`.
- * `output_format_sel`: `"bitmark"` | `"json"` (default json).
- * `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: …`.
+ * `stage` selects the lexer pipeline:
+ *   - `"lex"` — combined (default)
+ *   - `"lex-json"` — combined, JSON array output
  */
-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;
+export function lex(input: string, stage: string): string;
 /**
- * Split a bitmark document into per-bit source slices.
+ * Parse bitmark input text and return the reference JSON format.
  *
- * Returns a JSON array of `{ index, byteStart, byteEnd, source }`. Lets a JS
- * caller chunk a document at bit boundaries (e.g. to feed a worker pool).
+ * Uses the full pipeline: parse → validate → serialize.
+ *
+ * `mode`: `"optimized"` (default) or `"full"`
  */
-export function split_bits(input: string): string;
+export function parse(input: string, mode: string): string;
 /**
  * Breakscape text (escape bitmark special characters).
  *
@@ -33,14 +25,12 @@ export function split_bits(input: string): string;
  */
 export function breakscape_text(input: string, format: string, location: string): string;
 /**
- * Lex bitmark input text, returning one line per token in the same format as
- * the Rust CLI: `{kind:?} {span:?} "{text}"`.
+ * Unbreakscape text (unescape bitmark special characters).
  *
- * `stage` selects the lexer pipeline:
- *   - `"lex"` — combined (default)
- *   - `"lex-json"` — combined, JSON array output
+ * `format`: `"bitmark++"` (default) or `"plainText"`
+ * `location`: `"body"` (default) or `"tag"`
  */
-export function lex(input: string, stage: string): string;
+export function unbreakscape_text(input: string, format: string, location: string): string;
 /**
  * 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
@@ -49,21 +39,21 @@ export function lex(input: string, stage: string): string;
  */
 export function split_json_bits(input: string): string;
 /**
- * Unbreakscape text (unescape bitmark special characters).
- *
- * `format`: `"bitmark++"` (default) or `"plainText"`
- * `location`: `"body"` (default) or `"tag"`
- */
-export function unbreakscape_text(input: string, format: string, location: string): string;
-/**
- * Count the bits in `input` (auto-detecting bitmark vs JSON).
- * Returns the count as a decimal string, or `error: …`.
+ * Pretty-print a compact JSON string with the given indent. Used to format a
+ * document recombined on the JS side (the per-bit hook path) so its output
+ * matches the in-Rust recombination byte-for-byte.
  */
-export function count_bits(input: string): string;
+export function prettify(json: string, indent: number): string;
 /**
- * Re-emit input in its own format at optimized mode (omit natural defaults).
+ * 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).
+ * `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: …`.
  */
-export function optimize(input: string, pretty: boolean, indent: number): string;
+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;
 /**
  * Query information about supported bit types.
  *
@@ -75,30 +65,49 @@ export function optimize(input: string, pretty: boolean, indent: number): string
  */
 export function info(info_type: string, format: string, bit: string, pretty: boolean, indent: number): string;
 /**
- * Parse bitmark input text and return the reference JSON format.
+ * Convert between bitmark and JSON with explicit input/output formats + mode.
  *
- * Uses the full pipeline: parse → validate → serialize.
+ * `input_format`: `"auto"` (default) | `"bitmark"` | `"json"`.
+ * `output_format`: `"auto"` (opposite of input) | `"bitmark"` | `"json"`.
+ * `mode`: `"optimized"` (default) | `"full"`.
+ * Returns the converted text/JSON, or a string prefixed `error:` 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): string;
+/**
+ * Re-emit input in its own format at optimized mode (omit natural defaults).
  *
- * `mode`: `"optimized"` (default) or `"full"`
+ * `input_format`: `"auto"` (default) | `"bitmark"` | `"json"` | any config
+ * mapping id (`html`, `xml`, …). The output is re-emitted in this same format.
  */
-export function parse(input: string, mode: string): string;
+export function optimize(input: string, input_format_sel: string, pretty: boolean, indent: number): string;
 /**
- * Whether `input` looks like bitmark (vs JSON). Mirrors the auto-detection
- * used across the API so a JS caller can resolve `"auto"` consistently.
+ * Re-emit input in its own format at full mode (all keys).
+ *
+ * `input_format`: `"auto"` (default) | `"bitmark"` | `"json"` | any config
+ * mapping id (`html`, `xml`, …). The output is re-emitted in this same format.
  */
-export function is_bitmark(input: string): boolean;
+export function fullize(input: string, input_format_sel: string, pretty: boolean, indent: number): string;
 /**
- * Pretty-print a compact JSON string with the given indent. Used to format a
- * document recombined on the JS side (the per-bit hook path) so its output
- * matches the in-Rust recombination byte-for-byte.
+ * Re-emit input in its own format in canonical form at `mode`.
+ *
+ * `input_format`: `"auto"` (default) | `"bitmark"` | `"json"` | any config
+ * mapping id (`html`, `xml`, …). The output is re-emitted in this same format.
  */
-export function prettify(json: string, indent: number): string;
+export function canonicalize(input: string, input_format_sel: string, mode: string, pretty: boolean, indent: number, spaces_around_values: number): string;
 /**
- * Convert between bitmark and JSON with explicit input/output formats + mode.
+ * Count the bits in `input` (auto-detecting bitmark vs JSON).
+ * Returns the count as a decimal string, or `error: …`.
+ */
+export function count_bits(input: string): string;
+/**
+ * Split a bitmark document into per-bit source slices.
  *
- * `input_format`: `"auto"` (default) | `"bitmark"` | `"json"`.
- * `output_format`: `"auto"` (opposite of input) | `"bitmark"` | `"json"`.
- * `mode`: `"optimized"` (default) | `"full"`.
- * Returns the converted text/JSON, or a string prefixed `error:` on failure.
+ * Returns a JSON array of `{ index, byteStart, byteEnd, source }`. Lets a JS
+ * caller chunk a document at bit boundaries (e.g. to feed a worker pool).
  */
-export function convert(input: string, input_format_sel: string, output_format_sel: string, mode: string, pretty: boolean, indent: number, spaces_around_values: number): string;
+export function split_bits(input: string): string;
+/**
+ * Whether `input` looks like bitmark (vs JSON). Mirrors the auto-detection
+ * used across the API so a JS caller can resolve `"auto"` consistently.
+ */
+export function is_bitmark(input: string): boolean;