@gmb/bitmark-parser 7.7.0 → 7.8.0

package/dist/index.d.cts

@@ -14799,30 +14799,42 @@ interface SemanticTokensOptions {
     tokensLayout?: TokensLayout;
 }
 
-/** Where one top-level bit's text is in an output. */
+/** Where one top-level bit's text is in the input and in the output. */
 interface BitSpan {
     /**
      * The bit's position in the INPUT: its {@link splitBits} index for bitmark
-     * input, its entry index in the top-level array for JSON input. An entry
-     * that is not a bit gets no span, so the indexes can have gaps.
+     * input, its entry index in the top-level array for JSON input, its
+     * position among the bits the import finds for markup input. An entry that
+     * is not a bit gets no span, so the indexes can have gaps.
      */
     index: number;
+    /**
+     * Offset of the bit's first character in the input: for bitmark, its
+     * {@link splitBits} `start`; for JSON, the start of its top-level entry;
+     * for markup, the start of the element it was read from.
+     */
+    inputStart: number;
+    /**
+     * Offset just past its last character in the input. A markup element that
+     * holds the next bit's element ends where that element starts.
+     */
+    inputEnd: number;
     /** Offset of the bit's first character in the output. */
-    start: number;
+    outputStart: number;
     /**
-     * Offset just past its last character. A bit that produced no output
-     * (e.g. an empty bit in `"text"` output) has `end === start`, at the point
-     * where its output would begin.
+     * Offset just past its last character in the output. A bit that produced
+     * no output (e.g. an empty bit in `"text"` output) has
+     * `outputEnd === outputStart`, at the point where its output would begin.
      */
-    end: number;
+    outputEnd: number;
 }
 /**
- * The bit spans of one output, in the encoding their offsets are counted in
+ * The bit spans of one conversion, in the encoding their offsets are counted in
  * — echoed, as {@link Diagnostics} and {@link SemanticTokens} echo theirs.
  */
 interface BitSpans {
     positionEncoding: PositionEncoding;
-    /** In output order; they never overlap. */
+    /** In output order; they never overlap, on either side. */
     spans: BitSpan[];
 }
 /** Options for {@link convertWithDetails}: {@link ConvertOptions} plus one
@@ -14841,7 +14853,7 @@ interface ConvertResult {
     /** The converted output — exactly what {@link convert} returns. */
     output: string;
     /**
-     * Where each top-level bit landed in `output`. Present whenever `bitSpans`
+     * Where each top-level bit is in the input and in `output`. Present whenever `bitSpans`
      * was asked for; `spans` is empty for an output that is not a document
      * (`"lex"`, `"ast"`, `"semantic-tokens"`, `"diagnostics"`, a mapping
      * report).
@@ -17580,15 +17592,16 @@ declare function objectsToBitmark(bits: readonly (Bit | AnyBit | BitEntry)[], op
 declare function convert(input: string, options?: ConvertOptions$1): string;
 /**
  * {@link convert}, returning the output together with the extras asked for
- * (PLAN-221) — today `bitSpans`: where each top-level bit's text landed in
- * the output, for linking a source pane to an output pane bit by bit. The
+ * (PLAN-221) — today `bitSpans`: where each top-level bit's text is in the
+ * input and in the output (PLAN-223), for linking the panes that show them
+ * bit by bit. The
  * conversion runs once; `output` is exactly what {@link convert} returns for
  * the same input and options, and it throws exactly as {@link convert} does.
  *
  * Spans are reported for the document outputs — `"bitmark"`, `"json"`
  * (compact or pretty), `"text"` and the markup formats (`"html"`, `"xml"`,
- * …). A span covers the bit's text only: never the separators between bits,
- * nor the JSON array's `[` / `]`.
+ * …), from any input format. A span covers the bit's text only, on either
+ * side: never the separators between bits, nor the JSON array's `[` / `]`.
  *
  * @example
  * const { output, bitSpans } = convertWithDetails(source, {
@@ -17596,8 +17609,8 @@ declare function convert(input: string, options?: ConvertOptions$1): string;
  *   outputFormat: "html",
  *   bitSpans: true,
  * });
- * for (const { index, start, end } of bitSpans!.spans) {
- *   console.log(index, output.slice(start, end));
+ * for (const { index, inputStart, inputEnd, outputStart, outputEnd } of bitSpans!.spans) {
+ *   console.log(index, source.slice(inputStart, inputEnd), output.slice(outputStart, outputEnd));
  * }
  *
  * @param input - Bitmark, JSON, or mapped-format input text.

package/dist/index.d.ts

@@ -14799,30 +14799,42 @@ interface SemanticTokensOptions {
     tokensLayout?: TokensLayout;
 }
 
-/** Where one top-level bit's text is in an output. */
+/** Where one top-level bit's text is in the input and in the output. */
 interface BitSpan {
     /**
      * The bit's position in the INPUT: its {@link splitBits} index for bitmark
-     * input, its entry index in the top-level array for JSON input. An entry
-     * that is not a bit gets no span, so the indexes can have gaps.
+     * input, its entry index in the top-level array for JSON input, its
+     * position among the bits the import finds for markup input. An entry that
+     * is not a bit gets no span, so the indexes can have gaps.
      */
     index: number;
+    /**
+     * Offset of the bit's first character in the input: for bitmark, its
+     * {@link splitBits} `start`; for JSON, the start of its top-level entry;
+     * for markup, the start of the element it was read from.
+     */
+    inputStart: number;
+    /**
+     * Offset just past its last character in the input. A markup element that
+     * holds the next bit's element ends where that element starts.
+     */
+    inputEnd: number;
     /** Offset of the bit's first character in the output. */
-    start: number;
+    outputStart: number;
     /**
-     * Offset just past its last character. A bit that produced no output
-     * (e.g. an empty bit in `"text"` output) has `end === start`, at the point
-     * where its output would begin.
+     * Offset just past its last character in the output. A bit that produced
+     * no output (e.g. an empty bit in `"text"` output) has
+     * `outputEnd === outputStart`, at the point where its output would begin.
      */
-    end: number;
+    outputEnd: number;
 }
 /**
- * The bit spans of one output, in the encoding their offsets are counted in
+ * The bit spans of one conversion, in the encoding their offsets are counted in
  * — echoed, as {@link Diagnostics} and {@link SemanticTokens} echo theirs.
  */
 interface BitSpans {
     positionEncoding: PositionEncoding;
-    /** In output order; they never overlap. */
+    /** In output order; they never overlap, on either side. */
     spans: BitSpan[];
 }
 /** Options for {@link convertWithDetails}: {@link ConvertOptions} plus one
@@ -14841,7 +14853,7 @@ interface ConvertResult {
     /** The converted output — exactly what {@link convert} returns. */
     output: string;
     /**
-     * Where each top-level bit landed in `output`. Present whenever `bitSpans`
+     * Where each top-level bit is in the input and in `output`. Present whenever `bitSpans`
      * was asked for; `spans` is empty for an output that is not a document
      * (`"lex"`, `"ast"`, `"semantic-tokens"`, `"diagnostics"`, a mapping
      * report).
@@ -17580,15 +17592,16 @@ declare function objectsToBitmark(bits: readonly (Bit | AnyBit | BitEntry)[], op
 declare function convert(input: string, options?: ConvertOptions$1): string;
 /**
  * {@link convert}, returning the output together with the extras asked for
- * (PLAN-221) — today `bitSpans`: where each top-level bit's text landed in
- * the output, for linking a source pane to an output pane bit by bit. The
+ * (PLAN-221) — today `bitSpans`: where each top-level bit's text is in the
+ * input and in the output (PLAN-223), for linking the panes that show them
+ * bit by bit. The
  * conversion runs once; `output` is exactly what {@link convert} returns for
  * the same input and options, and it throws exactly as {@link convert} does.
  *
  * Spans are reported for the document outputs — `"bitmark"`, `"json"`
  * (compact or pretty), `"text"` and the markup formats (`"html"`, `"xml"`,
- * …). A span covers the bit's text only: never the separators between bits,
- * nor the JSON array's `[` / `]`.
+ * …), from any input format. A span covers the bit's text only, on either
+ * side: never the separators between bits, nor the JSON array's `[` / `]`.
  *
  * @example
  * const { output, bitSpans } = convertWithDetails(source, {
@@ -17596,8 +17609,8 @@ declare function convert(input: string, options?: ConvertOptions$1): string;
  *   outputFormat: "html",
  *   bitSpans: true,
  * });
- * for (const { index, start, end } of bitSpans!.spans) {
- *   console.log(index, output.slice(start, end));
+ * for (const { index, inputStart, inputEnd, outputStart, outputEnd } of bitSpans!.spans) {
+ *   console.log(index, source.slice(inputStart, inputEnd), output.slice(outputStart, outputEnd));
  * }
  *
  * @param input - Bitmark, JSON, or mapped-format input text.

package/dist/index.js

@@ -10,7 +10,7 @@ import { createRequire } from "module";
 // src/generated/package_info.ts
 var PACKAGE_INFO = {
   "name": "@gmb/bitmark-parser",
-  "version": "7.7.0",
+  "version": "7.8.0",
   "author": "Get More Brain Ltd <info@getmorebrain.com>",
   "license": "ISC",
   "description": "A parser for bitmark text, powered by WebAssembly."
@@ -1491,9 +1491,15 @@ function convertWithDetails(input, options = {}) {
     const result = { output: details.take_data() };
     const flat = details.bit_spans();
     if (flat !== void 0) {
-      const spans = new Array(flat.length / 3);
-      for (let i = 0, j = 0; j < flat.length; i++, j += 3) {
-        spans[i] = { index: flat[j], start: flat[j + 1], end: flat[j + 2] };
+      const spans = new Array(flat.length / 5);
+      for (let i = 0, j = 0; j < flat.length; i++, j += 5) {
+        spans[i] = {
+          index: flat[j],
+          inputStart: flat[j + 1],
+          inputEnd: flat[j + 2],
+          outputStart: flat[j + 3],
+          outputEnd: flat[j + 4]
+        };
       }
       result.bitSpans = {
         positionEncoding: details.bit_spans_encoding(),