@temelj/mdx 0.14.0 → 0.16.0

package/dist/source.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"source.mjs","names":[],"sources":["../src/source.ts"],"sourcesContent":["import { isString } from \"@temelj/value\";\n\nimport type { SourceRange } from \"./ranges.ts\";\n\nimport { InputError } from \"./errors.ts\";\nimport { sourceRange } from \"./ranges.ts\";\nimport { SourceText } from \"./source-text.ts\";\n\nexport interface SourceFileInput {\n  readonly name?: string;\n  readonly text: string;\n}\n\nexport interface SourceLocation {\n  readonly offset: number;\n  readonly line: number;\n  readonly column: number;\n}\n\n/** A range in a specific source file. Diagnostics carry spans because they outlive trees. */\nexport interface SourceSpan {\n  readonly file: SourceFile;\n  readonly start: number;\n  readonly end: number;\n}\n\nexport interface PhysicalLine {\n  readonly line: number;\n  readonly range: SourceRange;\n  readonly content: SourceRange;\n  readonly ending: \"\" | \"\\n\" | \"\\r\" | \"\\r\\n\";\n}\n\n/** The semantic character represented by NUL in parsed source. */\nexport const REPLACEMENT_CHARACTER = \"\\uFFFD\";\n\nexport function semanticCharacter(value: string): string {\n  return value === \"\\0\" ? REPLACEMENT_CHARACTER : value;\n}\n\n/** The column after a tab, with four-column tab stops. */\nexport function nextTabColumn(column: number): number {\n  return column + (4 - ((column - 1) % 4));\n}\n\n/**\n * Physical lines of a text that only grows. The files of one buffer generation\n * share one index, which scans each character once instead of once per file.\n */\nclass LineIndex {\n  readonly lines: PhysicalLine[] = [];\n  readonly #scanner = new PhysicalLineScanner();\n  #length = 0;\n\n  /** Scans `text`, which extends every text scanned before, from where the last scan ended. */\n  public extend(text: SourceText): void {\n    if (text.length > this.#length) {\n      this.lines.push(...this.#scanner.append(text.slice(this.#length)));\n      this.#length = text.length;\n    }\n  }\n}\n\n/** A file's lines: the index's complete lines it contains, then its own last lines. */\ninterface LineTable {\n  readonly complete: readonly PhysicalLine[];\n  readonly count: number;\n  readonly tail: readonly PhysicalLine[];\n}\n\nlet createFile: (name: string, text: SourceText, index: LineIndex) => SourceFile;\n\nlet readText: (file: SourceFile) => SourceText;\n\n/**\n * Immutable authored source with UTF-16 offsets and exact physical line\n * boundaries. Files from a `SourceBuffer` share text chunks and a line index,\n * so reading a growing document never copies it whole.\n */\nexport class SourceFile {\n  #source: SourceText;\n  #index: LineIndex | undefined;\n  #table: LineTable | undefined;\n  public readonly name: string;\n\n  static {\n    createFile = (name, text, index) => {\n      const file = new SourceFile({ name, text: \"\" });\n      file.#source = text;\n      file.#index = index;\n\n      return file;\n    };\n\n    readText = (file) => file.#source;\n  }\n\n  public constructor(input: string | SourceFileInput) {\n    this.#source = SourceText.of(isString(input) ? input : input.text);\n    this.name = isString(input) ? \"source.mdx\" : (input.name ?? \"source.mdx\");\n    Object.freeze(this);\n  }\n\n  /** The whole text. Prefer `slice` and `length`, which do not join a growing text. */\n  public get text(): string {\n    return this.#source.toString();\n  }\n\n  public get length(): number {\n    return this.#source.length;\n  }\n\n  /**\n   * Whether `other` is known to start with this file's text: both come from\n   * the same `SourceBuffer` with only appends between them.\n   */\n  public isPrefixOf(other: SourceFile): boolean {\n    return (\n      this === other ||\n      (this.#index !== undefined && this.#index === other.#index && this.length <= other.length)\n    );\n  }\n\n  public location(offset: number): SourceLocation {\n    if (!Number.isInteger(offset) || offset < 0 || offset > this.length) {\n      throw InputError.sourceOffsetOutsideFile(offset, this.length);\n    }\n\n    let low = 0;\n    let high = this.lineCount;\n\n    while (low + 1 < high) {\n      const middle = Math.floor((low + high) / 2);\n\n      if (this.physicalLine(middle).range.start <= offset) {\n        low = middle;\n      } else {\n        high = middle;\n      }\n    }\n\n    let column = 1;\n\n    for (let index = this.physicalLine(low).range.start; index < offset; index++) {\n      column = this.#source.char(index) === \"\\t\" ? nextTabColumn(column) : column + 1;\n    }\n\n    return Object.freeze({ offset, line: low + 1, column });\n  }\n\n  public lineStart(line: number): number | undefined {\n    return this.line(line)?.range.start;\n  }\n\n  public get lineCount(): number {\n    const table = this.table();\n\n    return table.count + table.tail.length;\n  }\n\n  public line(line: number): PhysicalLine | undefined {\n    return line >= 1 && line <= this.lineCount ? this.physicalLine(line - 1) : undefined;\n  }\n\n  public lineAt(offset: number): PhysicalLine {\n    return this.physicalLine(this.location(offset).line - 1);\n  }\n\n  public character(offset: number): string | undefined {\n    if (!Number.isSafeInteger(offset) || offset < 0 || offset > this.length) {\n      throw InputError.sourceOffsetOutsideFile(offset, this.length);\n    }\n\n    const value = this.#source.char(offset);\n\n    return value === undefined ? undefined : semanticCharacter(value);\n  }\n\n  public slice(range: SourceRange): string {\n    if (\n      !Number.isSafeInteger(range.start) ||\n      !Number.isSafeInteger(range.end) ||\n      range.start < 0 ||\n      range.end < range.start ||\n      range.end > this.length\n    ) {\n      throw InputError.replacementRangeOutsideSource(range.start, range.end, this.length);\n    }\n\n    return this.#source.slice(range.start, range.end);\n  }\n\n  public semanticSlice(range: SourceRange): string {\n    return this.slice(range).replaceAll(\"\\0\", \"\\uFFFD\");\n  }\n\n  private physicalLine(index: number): PhysicalLine {\n    const table = this.table();\n\n    return index < table.count ? table.complete[index] : table.tail[index - table.count];\n  }\n\n  private table(): LineTable {\n    if (this.#table !== undefined) {\n      return this.#table;\n    }\n\n    const index = this.#index;\n\n    if (index === undefined) {\n      const lines = Object.freeze(indexLines(this.text));\n      this.#table = { complete: lines, count: lines.length, tail: [] };\n\n      return this.#table;\n    }\n\n    index.extend(this.#source);\n    const { lines } = index;\n    let count = lines.length;\n\n    // An earlier file in the chain holds a prefix of the indexed text.\n    while (count > 0 && lines[count - 1].range.end > this.length) {\n      count--;\n    }\n\n    const last = lines[count - 1];\n\n    const scanner = new PhysicalLineScanner({\n      offset: last?.range.end ?? 0,\n      line: (last?.line ?? 0) + 1,\n    });\n\n    const tail = Object.freeze([\n      ...scanner.append(this.#source.slice(last?.range.end ?? 0)),\n      ...scanner.complete(),\n    ]);\n\n    this.#table = { complete: lines, count, tail };\n\n    return this.#table;\n  }\n}\n\n/**\n * Source that a stream owns and changes. Appends keep one line index, so\n * successive files do not rescan their lines; an edit starts a new generation.\n * Each change returns an immutable `SourceFile` for that version.\n */\nexport class SourceBuffer {\n  readonly #name: string;\n  #index = new LineIndex();\n  #text: SourceText;\n  #file: SourceFile;\n\n  public constructor(input: SourceFileInput) {\n    this.#name = input.name ?? \"source.mdx\";\n    this.#text = SourceText.of(input.text);\n    this.#file = createFile(this.#name, this.#text, this.#index);\n  }\n\n  public get file(): SourceFile {\n    return this.#file;\n  }\n\n  public append(text: string): SourceFile {\n    this.#text = this.#text.append(text);\n    this.#file = createFile(this.#name, this.#text, this.#index);\n\n    return this.#file;\n  }\n\n  /** Replaces `start..end` with `text`. Earlier files keep their own lines. */\n  public replace(start: number, end: number, text: string): SourceFile {\n    const previous = this.#text;\n    this.#text = SourceText.of(previous.slice(0, start) + text + previous.slice(end));\n    this.#index = new LineIndex();\n    this.#file = createFile(this.#name, this.#text, this.#index);\n\n    return this.#file;\n  }\n}\n\n/** The chunked text behind a file, for readers that index it by offset. */\nexport function sourceText(file: SourceFile): SourceText {\n  return readText(file);\n}\n\nfunction indexLines(source: string): PhysicalLine[] {\n  const scanner = new PhysicalLineScanner();\n\n  return [...scanner.append(source), ...scanner.complete()];\n}\n\nfunction physicalLine(\n  line: number,\n  start: number,\n  contentEnd: number,\n  end: number,\n  ending: PhysicalLine[\"ending\"],\n): PhysicalLine {\n  return Object.freeze({\n    line,\n    range: sourceRange(start, end),\n    content: sourceRange(start, contentEnd),\n    ending,\n  });\n}\n\n/** Incremental physical-line scanner. Each appended code unit is visited once. */\nexport class PhysicalLineScanner {\n  #complete = false;\n  #length: number;\n  #line: number;\n  #lineStart: number;\n  #pendingCarriageReturn: number | undefined;\n\n  public constructor(options: Readonly<{ offset?: number; line?: number }> = {}) {\n    const offset = options.offset ?? 0;\n    const line = options.line ?? 1;\n\n    if (!Number.isSafeInteger(offset) || offset < 0 || !Number.isSafeInteger(line) || line < 1) {\n      throw new RangeError(\"Invalid physical-line scanner origin\");\n    }\n\n    this.#length = offset;\n    this.#lineStart = offset;\n    this.#line = line;\n  }\n\n  public append(text: string): readonly PhysicalLine[] {\n    if (this.#complete) {\n      throw new Error(\"Cannot append to a completed physical-line scanner\");\n    }\n\n    const lines: PhysicalLine[] = [];\n\n    const endings = /\\r\\n|[\\r\\n]/gu;\n\n    if (text.length > 0 && this.#pendingCarriageReturn !== undefined) {\n      const offset = this.#pendingCarriageReturn;\n\n      if (text[0] === \"\\n\") {\n        lines.push(this.emit(offset, this.#length + 1, \"\\r\\n\"));\n        endings.lastIndex = 1;\n      } else {\n        lines.push(this.emit(offset, offset + 1, \"\\r\"));\n      }\n\n      this.#pendingCarriageReturn = undefined;\n    }\n\n    for (let match = endings.exec(text); match !== null; match = endings.exec(text)) {\n      const offset = this.#length + match.index;\n      const ending = match[0];\n\n      if (ending === \"\\r\" && match.index === text.length - 1) {\n        this.#pendingCarriageReturn = offset;\n      } else {\n        lines.push(\n          this.emit(\n            offset,\n            offset + ending.length,\n            ending === \"\\r\\n\" ? \"\\r\\n\" : ending === \"\\r\" ? \"\\r\" : \"\\n\",\n          ),\n        );\n      }\n    }\n\n    this.#length += text.length;\n\n    return Object.freeze(lines);\n  }\n\n  public clone(): PhysicalLineScanner {\n    const copy = new PhysicalLineScanner({ offset: this.#length, line: this.#line });\n    copy.#complete = this.#complete;\n    copy.#lineStart = this.#lineStart;\n    copy.#pendingCarriageReturn = this.#pendingCarriageReturn;\n\n    return copy;\n  }\n\n  public complete(): readonly PhysicalLine[] {\n    if (this.#complete) {\n      throw new Error(\"Physical-line scanner is already complete\");\n    }\n\n    this.#complete = true;\n    const lines: PhysicalLine[] = [];\n\n    if (this.#pendingCarriageReturn !== undefined) {\n      lines.push(this.emit(this.#pendingCarriageReturn, this.#pendingCarriageReturn + 1, \"\\r\"));\n      this.#pendingCarriageReturn = undefined;\n    }\n\n    lines.push(physicalLine(this.#line, this.#lineStart, this.#length, this.#length, \"\"));\n\n    return Object.freeze(lines);\n  }\n\n  private emit(\n    contentEnd: number,\n    end: number,\n    ending: Exclude<PhysicalLine[\"ending\"], \"\">,\n  ): PhysicalLine {\n    const line = physicalLine(this.#line++, this.#lineStart, contentEnd, end, ending);\n    this.#lineStart = end;\n\n    return line;\n  }\n}\n"],"mappings":";;;;;;AAkCA,MAAa,wBAAwB;AAErC,SAAgB,kBAAkB,OAAuB;CACvD,OAAO,UAAU,OAAA,MAA+B;AAClD;;AAGA,SAAgB,cAAc,QAAwB;CACpD,OAAO,UAAU,KAAM,SAAS,KAAK;AACvC;;;;;AAMA,IAAM,YAAN,MAAgB;CACd,QAAiC,CAAC;CAClC,WAAoB,IAAI,oBAAoB;CAC5C,UAAU;;CAGV,OAAc,MAAwB;EACpC,IAAI,KAAK,SAAS,KAAK,SAAS;GAC9B,KAAK,MAAM,KAAK,GAAG,KAAK,SAAS,OAAO,KAAK,MAAM,KAAK,OAAO,CAAC,CAAC;GACjE,KAAK,UAAU,KAAK;EACtB;CACF;AACF;AASA,IAAI;AAEJ,IAAI;;;;;;AAOJ,IAAa,aAAb,MAAa,WAAW;CACtB;CACA;CACA;CACA;CAEA;EACE,cAAc,MAAM,MAAM,UAAU;GAClC,MAAM,OAAO,IAAI,WAAW;IAAE;IAAM,MAAM;GAAG,CAAC;GAC9C,KAAK,UAAU;GACf,KAAK,SAAS;GAEd,OAAO;EACT;EAEA,YAAY,SAAS,KAAK;CAC5B;CAEA,YAAmB,OAAiC;EAClD,KAAK,UAAU,WAAW,GAAG,SAAS,KAAK,IAAI,QAAQ,MAAM,IAAI;EACjE,KAAK,OAAO,SAAS,KAAK,IAAI,eAAgB,MAAM,QAAQ;EAC5D,OAAO,OAAO,IAAI;CACpB;;CAGA,IAAW,OAAe;EACxB,OAAO,KAAK,QAAQ,SAAS;CAC/B;CAEA,IAAW,SAAiB;EAC1B,OAAO,KAAK,QAAQ;CACtB;;;;;CAMA,WAAkB,OAA4B;EAC5C,OACE,SAAS,SACR,KAAK,WAAW,KAAA,KAAa,KAAK,WAAW,MAAM,UAAU,KAAK,UAAU,MAAM;CAEvF;CAEA,SAAgB,QAAgC;EAC9C,IAAI,CAAC,OAAO,UAAU,MAAM,KAAK,SAAS,KAAK,SAAS,KAAK,QAC3D,MAAM,WAAW,wBAAwB,QAAQ,KAAK,MAAM;EAG9D,IAAI,MAAM;EACV,IAAI,OAAO,KAAK;EAEhB,OAAO,MAAM,IAAI,MAAM;GACrB,MAAM,SAAS,KAAK,OAAO,MAAM,QAAQ,CAAC;GAE1C,IAAI,KAAK,aAAa,MAAM,CAAC,CAAC,MAAM,SAAS,QAC3C,MAAM;QAEN,OAAO;EAEX;EAEA,IAAI,SAAS;EAEb,KAAK,IAAI,QAAQ,KAAK,aAAa,GAAG,CAAC,CAAC,MAAM,OAAO,QAAQ,QAAQ,SACnE,SAAS,KAAK,QAAQ,KAAK,KAAK,MAAM,MAAO,cAAc,MAAM,IAAI,SAAS;EAGhF,OAAO,OAAO,OAAO;GAAE;GAAQ,MAAM,MAAM;GAAG;EAAO,CAAC;CACxD;CAEA,UAAiB,MAAkC;EACjD,OAAO,KAAK,KAAK,IAAI,CAAC,EAAE,MAAM;CAChC;CAEA,IAAW,YAAoB;EAC7B,MAAM,QAAQ,KAAK,MAAM;EAEzB,OAAO,MAAM,QAAQ,MAAM,KAAK;CAClC;CAEA,KAAY,MAAwC;EAClD,OAAO,QAAQ,KAAK,QAAQ,KAAK,YAAY,KAAK,aAAa,OAAO,CAAC,IAAI,KAAA;CAC7E;CAEA,OAAc,QAA8B;EAC1C,OAAO,KAAK,aAAa,KAAK,SAAS,MAAM,CAAC,CAAC,OAAO,CAAC;CACzD;CAEA,UAAiB,QAAoC;EACnD,IAAI,CAAC,OAAO,cAAc,MAAM,KAAK,SAAS,KAAK,SAAS,KAAK,QAC/D,MAAM,WAAW,wBAAwB,QAAQ,KAAK,MAAM;EAG9D,MAAM,QAAQ,KAAK,QAAQ,KAAK,MAAM;EAEtC,OAAO,UAAU,KAAA,IAAY,KAAA,IAAY,kBAAkB,KAAK;CAClE;CAEA,MAAa,OAA4B;EACvC,IACE,CAAC,OAAO,cAAc,MAAM,KAAK,KACjC,CAAC,OAAO,cAAc,MAAM,GAAG,KAC/B,MAAM,QAAQ,KACd,MAAM,MAAM,MAAM,SAClB,MAAM,MAAM,KAAK,QAEjB,MAAM,WAAW,8BAA8B,MAAM,OAAO,MAAM,KAAK,KAAK,MAAM;EAGpF,OAAO,KAAK,QAAQ,MAAM,MAAM,OAAO,MAAM,GAAG;CAClD;CAEA,cAAqB,OAA4B;EAC/C,OAAO,KAAK,MAAM,KAAK,CAAC,CAAC,WAAW,MAAM,GAAQ;CACpD;CAEA,aAAqB,OAA6B;EAChD,MAAM,QAAQ,KAAK,MAAM;EAEzB,OAAO,QAAQ,MAAM,QAAQ,MAAM,SAAS,SAAS,MAAM,KAAK,QAAQ,MAAM;CAChF;CAEA,QAA2B;EACzB,IAAI,KAAK,WAAW,KAAA,GAClB,OAAO,KAAK;EAGd,MAAM,QAAQ,KAAK;EAEnB,IAAI,UAAU,KAAA,GAAW;GACvB,MAAM,QAAQ,OAAO,OAAO,WAAW,KAAK,IAAI,CAAC;GACjD,KAAK,SAAS;IAAE,UAAU;IAAO,OAAO,MAAM;IAAQ,MAAM,CAAC;GAAE;GAE/D,OAAO,KAAK;EACd;EAEA,MAAM,OAAO,KAAK,OAAO;EACzB,MAAM,EAAE,UAAU;EAClB,IAAI,QAAQ,MAAM;EAGlB,OAAO,QAAQ,KAAK,MAAM,QAAQ,EAAE,CAAC,MAAM,MAAM,KAAK,QACpD;EAGF,MAAM,OAAO,MAAM,QAAQ;EAE3B,MAAM,UAAU,IAAI,oBAAoB;GACtC,QAAQ,MAAM,MAAM,OAAO;GAC3B,OAAO,MAAM,QAAQ,KAAK;EAC5B,CAAC;EAED,MAAM,OAAO,OAAO,OAAO,CACzB,GAAG,QAAQ,OAAO,KAAK,QAAQ,MAAM,MAAM,MAAM,OAAO,CAAC,CAAC,GAC1D,GAAG,QAAQ,SAAS,CACtB,CAAC;EAED,KAAK,SAAS;GAAE,UAAU;GAAO;GAAO;EAAK;EAE7C,OAAO,KAAK;CACd;AACF;;;;;;AAOA,IAAa,eAAb,MAA0B;CACxB;CACA,SAAS,IAAI,UAAU;CACvB;CACA;CAEA,YAAmB,OAAwB;EACzC,KAAK,QAAQ,MAAM,QAAQ;EAC3B,KAAK,QAAQ,WAAW,GAAG,MAAM,IAAI;EACrC,KAAK,QAAQ,WAAW,KAAK,OAAO,KAAK,OAAO,KAAK,MAAM;CAC7D;CAEA,IAAW,OAAmB;EAC5B,OAAO,KAAK;CACd;CAEA,OAAc,MAA0B;EACtC,KAAK,QAAQ,KAAK,MAAM,OAAO,IAAI;EACnC,KAAK,QAAQ,WAAW,KAAK,OAAO,KAAK,OAAO,KAAK,MAAM;EAE3D,OAAO,KAAK;CACd;;CAGA,QAAe,OAAe,KAAa,MAA0B;EACnE,MAAM,WAAW,KAAK;EACtB,KAAK,QAAQ,WAAW,GAAG,SAAS,MAAM,GAAG,KAAK,IAAI,OAAO,SAAS,MAAM,GAAG,CAAC;EAChF,KAAK,SAAS,IAAI,UAAU;EAC5B,KAAK,QAAQ,WAAW,KAAK,OAAO,KAAK,OAAO,KAAK,MAAM;EAE3D,OAAO,KAAK;CACd;AACF;;AAGA,SAAgB,WAAW,MAA8B;CACvD,OAAO,SAAS,IAAI;AACtB;AAEA,SAAS,WAAW,QAAgC;CAClD,MAAM,UAAU,IAAI,oBAAoB;CAExC,OAAO,CAAC,GAAG,QAAQ,OAAO,MAAM,GAAG,GAAG,QAAQ,SAAS,CAAC;AAC1D;AAEA,SAAS,aACP,MACA,OACA,YACA,KACA,QACc;CACd,OAAO,OAAO,OAAO;EACnB;EACA,OAAO,YAAY,OAAO,GAAG;EAC7B,SAAS,YAAY,OAAO,UAAU;EACtC;CACF,CAAC;AACH;;AAGA,IAAa,sBAAb,MAAa,oBAAoB;CAC/B,YAAY;CACZ;CACA;CACA;CACA;CAEA,YAAmB,UAAwD,CAAC,GAAG;EAC7E,MAAM,SAAS,QAAQ,UAAU;EACjC,MAAM,OAAO,QAAQ,QAAQ;EAE7B,IAAI,CAAC,OAAO,cAAc,MAAM,KAAK,SAAS,KAAK,CAAC,OAAO,cAAc,IAAI,KAAK,OAAO,GACvF,MAAM,IAAI,WAAW,sCAAsC;EAG7D,KAAK,UAAU;EACf,KAAK,aAAa;EAClB,KAAK,QAAQ;CACf;CAEA,OAAc,MAAuC;EACnD,IAAI,KAAK,WACP,MAAM,IAAI,MAAM,oDAAoD;EAGtE,MAAM,QAAwB,CAAC;EAE/B,MAAM,UAAU;EAEhB,IAAI,KAAK,SAAS,KAAK,KAAK,2BAA2B,KAAA,GAAW;GAChE,MAAM,SAAS,KAAK;GAEpB,IAAI,KAAK,OAAO,MAAM;IACpB,MAAM,KAAK,KAAK,KAAK,QAAQ,KAAK,UAAU,GAAG,MAAM,CAAC;IACtD,QAAQ,YAAY;GACtB,OACE,MAAM,KAAK,KAAK,KAAK,QAAQ,SAAS,GAAG,IAAI,CAAC;GAGhD,KAAK,yBAAyB,KAAA;EAChC;EAEA,KAAK,IAAI,QAAQ,QAAQ,KAAK,IAAI,GAAG,UAAU,MAAM,QAAQ,QAAQ,KAAK,IAAI,GAAG;GAC/E,MAAM,SAAS,KAAK,UAAU,MAAM;GACpC,MAAM,SAAS,MAAM;GAErB,IAAI,WAAW,QAAQ,MAAM,UAAU,KAAK,SAAS,GACnD,KAAK,yBAAyB;QAE9B,MAAM,KACJ,KAAK,KACH,QACA,SAAS,OAAO,QAChB,WAAW,SAAS,SAAS,WAAW,OAAO,OAAO,IACxD,CACF;EAEJ;EAEA,KAAK,WAAW,KAAK;EAErB,OAAO,OAAO,OAAO,KAAK;CAC5B;CAEA,QAAoC;EAClC,MAAM,OAAO,IAAI,oBAAoB;GAAE,QAAQ,KAAK;GAAS,MAAM,KAAK;EAAM,CAAC;EAC/E,KAAK,YAAY,KAAK;EACtB,KAAK,aAAa,KAAK;EACvB,KAAK,yBAAyB,KAAK;EAEnC,OAAO;CACT;CAEA,WAA2C;EACzC,IAAI,KAAK,WACP,MAAM,IAAI,MAAM,2CAA2C;EAG7D,KAAK,YAAY;EACjB,MAAM,QAAwB,CAAC;EAE/B,IAAI,KAAK,2BAA2B,KAAA,GAAW;GAC7C,MAAM,KAAK,KAAK,KAAK,KAAK,wBAAwB,KAAK,yBAAyB,GAAG,IAAI,CAAC;GACxF,KAAK,yBAAyB,KAAA;EAChC;EAEA,MAAM,KAAK,aAAa,KAAK,OAAO,KAAK,YAAY,KAAK,SAAS,KAAK,SAAS,EAAE,CAAC;EAEpF,OAAO,OAAO,OAAO,KAAK;CAC5B;CAEA,KACE,YACA,KACA,QACc;EACd,MAAM,OAAO,aAAa,KAAK,SAAS,KAAK,YAAY,YAAY,KAAK,MAAM;EAChF,KAAK,aAAa;EAElB,OAAO;CACT;AACF"}

package/dist/stream-events.d.mts

@@ -0,0 +1,59 @@
+import { HtmlFootnoteSectionNode, HtmlRootNode } from "./html.mjs";
+import { DiagnosticSeverity } from "./diagnostics.mjs";
+import { ParserLimit } from "./parser/config.mjs";
+import { CompletedBlock, MdxPreview, MdxStreamChange, MdxStreamCompletion, MdxStreamOptions, PreviewBlock } from "./stream-types.mjs";
+//#region src/stream-events.d.ts
+/** The preview as one HTML tree, joined like a lowered document. */
+export declare function previewDocument(preview: MdxPreview): HtmlRootNode;
+/** A diagnostic without its source file, so it can cross a network boundary. */
+export interface MdxEventDiagnostic {
+  readonly severity: DiagnosticSeverity;
+  readonly code: string;
+  readonly message: string;
+  readonly start?: number;
+  readonly end?: number;
+}
+/**
+ * A JSON-serializable stream update. A server runs the stream and sends events;
+ * a client applies them with `applyBlockEvent` and renders without parsing.
+ */
+export type MdxBlockEvent = Readonly<{
+  kind: "update";
+  /** Blocks before this index stay, except `refreshed`; `blocks` replaces the rest. */
+  start: number;
+  blocks: readonly PreviewBlock[];
+  refreshed: readonly PreviewBlock[];
+  /** Present when the section changed; `null` removes it. */
+  footnotes?: HtmlFootnoteSectionNode | null;
+  limit?: ParserLimit;
+}> | Readonly<{
+  kind: "complete";
+  html: HtmlRootNode;
+  blocks: readonly CompletedBlock[];
+}> | Readonly<{
+  kind: "failed";
+  diagnostics: readonly MdxEventDiagnostic[];
+}>;
+/** The update event for one stream change. */
+export declare function blockEvent(change: MdxStreamChange): Extract<MdxBlockEvent, {
+  kind: "update";
+}>;
+/** The final event for a completion; `html` is the completed document's lowered HTML. */
+export declare function completionEvent(completion: MdxStreamCompletion, html?: HtmlRootNode): MdxBlockEvent;
+/** Applies an update event to the preview a client holds. */
+export declare function applyBlockEvent(preview: MdxPreview, event: Extract<MdxBlockEvent, {
+  kind: "update";
+}>): MdxPreview;
+export interface StreamBlockEventsOptions extends MdxStreamOptions {
+  /** Lowers the completed document, for example through a `Processor` with HTML plugins. */
+  readonly html?: (completion: MdxStreamCompletion) => HtmlRootNode;
+}
+/**
+ * Streams text through an `MdxStream`.
+ * A server forwards the events to a client as JSON.
+ *
+ * @yields One update event per chunk, then a completion event.
+ */
+export declare function streamBlockEvents(chunks: AsyncIterable<string>, options?: StreamBlockEventsOptions): AsyncGenerator<MdxBlockEvent>;
+//#endregion
+//# sourceMappingURL=stream-events.d.mts.map

package/dist/stream-events.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stream-events.d.mts","names":[],"sources":["../src/stream-events.ts"],"mappings":";;;;;;wBAiBgB,gBAAgB,SAAS,aAAa;;iBAWrC;WACN,UAAU;WACV;WACA;WACA;WACA;;;;;;YAOC,gBACR;EACE;;EAEA;EACA,iBAAiB;EACjB,oBAAoB;;EAEpB,YAAY;EACZ,QAAQ;KAEV;EAAW;EAAkB,MAAM;EAAc,iBAAiB;KAClE;EAAW;EAAgB,sBAAsB;;;wBAGrC,WAAW,QAAQ,kBAAkB,QAAQ;EAAiB;;;wBAsB9D,gBACd,YAAY,qBACZ,OAAO,eACN;;wBASa,gBACd,SAAS,YACT,OAAO,QAAQ;EAAiB;KAC/B;iBAcc,iCAAiC;;WAEvC,QAAQ,YAAY,wBAAwB;;;;;;;;wBAShC,kBACrB,QAAQ,uBACR,UAAS,2BACR,eAAe"}

package/dist/stream-events.mjs

@@ -0,0 +1,115 @@
+import { LimitError, ParseError } from "./errors.mjs";
+import { joinBlocks, lowerHtml } from "./html-lower.mjs";
+import { MdxStream } from "./stream.mjs";
+//#region src/stream-events.ts
+/** The preview as one HTML tree, joined like a lowered document. */
+function previewDocument(preview) {
+	const children = preview.blocks.flatMap((block) => block.nodes);
+	if (preview.footnotes !== void 0) children.push(preview.footnotes);
+	return {
+		kind: "root",
+		children: joinBlocks(children)
+	};
+}
+/** The update event for one stream change. */
+function blockEvent(change) {
+	const { snapshot } = change;
+	let event = {
+		kind: "update",
+		start: change.start,
+		blocks: snapshot.blocks.slice(change.start).map(previewBlock),
+		refreshed: change.refreshed.map(previewBlock)
+	};
+	if (change.footnotesChanged) event = {
+		...event,
+		footnotes: snapshot.footnotes ?? null
+	};
+	if (snapshot.limit !== void 0) event = {
+		...event,
+		limit: snapshot.limit
+	};
+	return event;
+}
+/** The final event for a completion; `html` is the completed document's lowered HTML. */
+function completionEvent(completion, html) {
+	return {
+		kind: "complete",
+		html: html ?? lowerHtml(completion.document, { source: completion.file }),
+		blocks: completion.blocks
+	};
+}
+/** Applies an update event to the preview a client holds. */
+function applyBlockEvent(preview, event) {
+	let kept = preview.blocks.slice(0, event.start);
+	if (event.refreshed.length > 0) {
+		const refreshed = new Map(event.refreshed.map((block) => [block.id, block]));
+		kept = kept.map((block) => refreshed.get(block.id) ?? block);
+	}
+	return Object.freeze({
+		blocks: Object.freeze([...kept, ...event.blocks]),
+		footnotes: event.footnotes === void 0 ? preview.footnotes : event.footnotes ?? void 0
+	});
+}
+/**
+* Streams text through an `MdxStream`.
+* A server forwards the events to a client as JSON.
+*
+* @yields One update event per chunk, then a completion event.
+*/
+async function* streamBlockEvents(chunks, options = {}) {
+	const stream = new MdxStream(options);
+	const changes = [];
+	const unsubscribe = stream.subscribe((change) => changes.push(change));
+	try {
+		const initial = stream.snapshot();
+		if (initial.kind === "preview" && initial.file.length > 0) yield blockEvent({
+			snapshot: initial,
+			start: 0,
+			refreshed: [],
+			footnotesChanged: true
+		});
+		for await (const chunk of chunks) {
+			stream.append(chunk);
+			for (const change of changes.splice(0)) yield blockEvent(change);
+		}
+	} finally {
+		unsubscribe();
+	}
+	let completion;
+	try {
+		completion = stream.complete();
+	} catch (error) {
+		if (!(error instanceof ParseError) && !(error instanceof LimitError)) throw error;
+		yield {
+			kind: "failed",
+			diagnostics: error.diagnostics.map(eventDiagnostic)
+		};
+		return;
+	}
+	yield completionEvent(completion, options.html?.(completion));
+}
+function eventDiagnostic(diagnostic) {
+	const message = {
+		severity: diagnostic.severity,
+		code: diagnostic.code,
+		message: diagnostic.message
+	};
+	return diagnostic.span === void 0 ? message : {
+		...message,
+		start: diagnostic.span.start,
+		end: diagnostic.span.end
+	};
+}
+function previewBlock(block) {
+	return {
+		id: block.id,
+		origin: block.origin,
+		nodes: block.nodes,
+		status: block.status,
+		settled: block.settled
+	};
+}
+//#endregion
+export { applyBlockEvent, blockEvent, completionEvent, previewDocument, streamBlockEvents };
+
+//# sourceMappingURL=stream-events.mjs.map

package/dist/stream-events.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"stream-events.mjs","names":[],"sources":["../src/stream-events.ts"],"sourcesContent":["import type { Diagnostic, DiagnosticSeverity } from \"./diagnostics.ts\";\nimport type { HtmlFootnoteSectionNode, HtmlRootNode } from \"./html.ts\";\nimport type { ParserLimit } from \"./parser/config.ts\";\nimport type {\n  CompletedBlock,\n  MdxPreview,\n  MdxStreamChange,\n  MdxStreamCompletion,\n  MdxStreamOptions,\n  PreviewBlock,\n} from \"./stream-types.ts\";\n\nimport { LimitError, ParseError } from \"./errors.ts\";\nimport { joinBlocks, lowerHtml } from \"./html-lower.ts\";\nimport { MdxStream } from \"./stream.ts\";\n\n/** The preview as one HTML tree, joined like a lowered document. */\nexport function previewDocument(preview: MdxPreview): HtmlRootNode {\n  const children = preview.blocks.flatMap((block) => block.nodes);\n\n  if (preview.footnotes !== undefined) {\n    children.push(preview.footnotes);\n  }\n\n  return { kind: \"root\", children: joinBlocks(children) };\n}\n\n/** A diagnostic without its source file, so it can cross a network boundary. */\nexport interface MdxEventDiagnostic {\n  readonly severity: DiagnosticSeverity;\n  readonly code: string;\n  readonly message: string;\n  readonly start?: number;\n  readonly end?: number;\n}\n\n/**\n * A JSON-serializable stream update. A server runs the stream and sends events;\n * a client applies them with `applyBlockEvent` and renders without parsing.\n */\nexport type MdxBlockEvent =\n  | Readonly<{\n      kind: \"update\";\n      /** Blocks before this index stay, except `refreshed`; `blocks` replaces the rest. */\n      start: number;\n      blocks: readonly PreviewBlock[];\n      refreshed: readonly PreviewBlock[];\n      /** Present when the section changed; `null` removes it. */\n      footnotes?: HtmlFootnoteSectionNode | null;\n      limit?: ParserLimit;\n    }>\n  | Readonly<{ kind: \"complete\"; html: HtmlRootNode; blocks: readonly CompletedBlock[] }>\n  | Readonly<{ kind: \"failed\"; diagnostics: readonly MdxEventDiagnostic[] }>;\n\n/** The update event for one stream change. */\nexport function blockEvent(change: MdxStreamChange): Extract<MdxBlockEvent, { kind: \"update\" }> {\n  const { snapshot } = change;\n\n  let event: Extract<MdxBlockEvent, { kind: \"update\" }> = {\n    kind: \"update\",\n    start: change.start,\n    blocks: snapshot.blocks.slice(change.start).map(previewBlock),\n    refreshed: change.refreshed.map(previewBlock),\n  };\n\n  if (change.footnotesChanged) {\n    event = { ...event, footnotes: snapshot.footnotes ?? null };\n  }\n\n  if (snapshot.limit !== undefined) {\n    event = { ...event, limit: snapshot.limit };\n  }\n\n  return event;\n}\n\n/** The final event for a completion; `html` is the completed document's lowered HTML. */\nexport function completionEvent(\n  completion: MdxStreamCompletion,\n  html?: HtmlRootNode,\n): MdxBlockEvent {\n  return {\n    kind: \"complete\",\n    html: html ?? lowerHtml(completion.document, { source: completion.file }),\n    blocks: completion.blocks,\n  };\n}\n\n/** Applies an update event to the preview a client holds. */\nexport function applyBlockEvent(\n  preview: MdxPreview,\n  event: Extract<MdxBlockEvent, { kind: \"update\" }>,\n): MdxPreview {\n  let kept = preview.blocks.slice(0, event.start);\n\n  if (event.refreshed.length > 0) {\n    const refreshed = new Map(event.refreshed.map((block) => [block.id, block]));\n    kept = kept.map((block) => refreshed.get(block.id) ?? block);\n  }\n\n  return Object.freeze({\n    blocks: Object.freeze([...kept, ...event.blocks]),\n    footnotes: event.footnotes === undefined ? preview.footnotes : (event.footnotes ?? undefined),\n  });\n}\n\nexport interface StreamBlockEventsOptions extends MdxStreamOptions {\n  /** Lowers the completed document, for example through a `Processor` with HTML plugins. */\n  readonly html?: (completion: MdxStreamCompletion) => HtmlRootNode;\n}\n\n/**\n * Streams text through an `MdxStream`.\n * A server forwards the events to a client as JSON.\n *\n * @yields One update event per chunk, then a completion event.\n */\nexport async function* streamBlockEvents(\n  chunks: AsyncIterable<string>,\n  options: StreamBlockEventsOptions = {},\n): AsyncGenerator<MdxBlockEvent> {\n  const stream = new MdxStream(options);\n  const changes: MdxStreamChange[] = [];\n  const unsubscribe = stream.subscribe((change) => changes.push(change));\n\n  try {\n    const initial = stream.snapshot();\n\n    if (initial.kind === \"preview\" && initial.file.length > 0) {\n      yield blockEvent({\n        snapshot: initial,\n        start: 0,\n        refreshed: [],\n        footnotesChanged: true,\n      });\n    }\n\n    for await (const chunk of chunks) {\n      stream.append(chunk);\n\n      for (const change of changes.splice(0)) {\n        yield blockEvent(change);\n      }\n    }\n  } finally {\n    unsubscribe();\n  }\n\n  let completion: MdxStreamCompletion;\n\n  try {\n    completion = stream.complete();\n  } catch (error) {\n    if (!(error instanceof ParseError) && !(error instanceof LimitError)) {\n      throw error;\n    }\n\n    yield { kind: \"failed\", diagnostics: error.diagnostics.map(eventDiagnostic) };\n\n    return;\n  }\n\n  yield completionEvent(completion, options.html?.(completion));\n}\n\nfunction eventDiagnostic(diagnostic: Diagnostic): MdxEventDiagnostic {\n  const message = {\n    severity: diagnostic.severity,\n    code: diagnostic.code,\n    message: diagnostic.message,\n  };\n\n  return diagnostic.span === undefined\n    ? message\n    : { ...message, start: diagnostic.span.start, end: diagnostic.span.end };\n}\n\nfunction previewBlock(block: PreviewBlock): PreviewBlock {\n  return {\n    id: block.id,\n    origin: block.origin,\n    nodes: block.nodes,\n    status: block.status,\n    settled: block.settled,\n  };\n}\n"],"mappings":";;;;;AAiBA,SAAgB,gBAAgB,SAAmC;CACjE,MAAM,WAAW,QAAQ,OAAO,SAAS,UAAU,MAAM,KAAK;CAE9D,IAAI,QAAQ,cAAc,KAAA,GACxB,SAAS,KAAK,QAAQ,SAAS;CAGjC,OAAO;EAAE,MAAM;EAAQ,UAAU,WAAW,QAAQ;CAAE;AACxD;;AA8BA,SAAgB,WAAW,QAAqE;CAC9F,MAAM,EAAE,aAAa;CAErB,IAAI,QAAoD;EACtD,MAAM;EACN,OAAO,OAAO;EACd,QAAQ,SAAS,OAAO,MAAM,OAAO,KAAK,CAAC,CAAC,IAAI,YAAY;EAC5D,WAAW,OAAO,UAAU,IAAI,YAAY;CAC9C;CAEA,IAAI,OAAO,kBACT,QAAQ;EAAE,GAAG;EAAO,WAAW,SAAS,aAAa;CAAK;CAG5D,IAAI,SAAS,UAAU,KAAA,GACrB,QAAQ;EAAE,GAAG;EAAO,OAAO,SAAS;CAAM;CAG5C,OAAO;AACT;;AAGA,SAAgB,gBACd,YACA,MACe;CACf,OAAO;EACL,MAAM;EACN,MAAM,QAAQ,UAAU,WAAW,UAAU,EAAE,QAAQ,WAAW,KAAK,CAAC;EACxE,QAAQ,WAAW;CACrB;AACF;;AAGA,SAAgB,gBACd,SACA,OACY;CACZ,IAAI,OAAO,QAAQ,OAAO,MAAM,GAAG,MAAM,KAAK;CAE9C,IAAI,MAAM,UAAU,SAAS,GAAG;EAC9B,MAAM,YAAY,IAAI,IAAI,MAAM,UAAU,KAAK,UAAU,CAAC,MAAM,IAAI,KAAK,CAAC,CAAC;EAC3E,OAAO,KAAK,KAAK,UAAU,UAAU,IAAI,MAAM,EAAE,KAAK,KAAK;CAC7D;CAEA,OAAO,OAAO,OAAO;EACnB,QAAQ,OAAO,OAAO,CAAC,GAAG,MAAM,GAAG,MAAM,MAAM,CAAC;EAChD,WAAW,MAAM,cAAc,KAAA,IAAY,QAAQ,YAAa,MAAM,aAAa,KAAA;CACrF,CAAC;AACH;;;;;;;AAaA,gBAAuB,kBACrB,QACA,UAAoC,CAAC,GACN;CAC/B,MAAM,SAAS,IAAI,UAAU,OAAO;CACpC,MAAM,UAA6B,CAAC;CACpC,MAAM,cAAc,OAAO,WAAW,WAAW,QAAQ,KAAK,MAAM,CAAC;CAErE,IAAI;EACF,MAAM,UAAU,OAAO,SAAS;EAEhC,IAAI,QAAQ,SAAS,aAAa,QAAQ,KAAK,SAAS,GACtD,MAAM,WAAW;GACf,UAAU;GACV,OAAO;GACP,WAAW,CAAC;GACZ,kBAAkB;EACpB,CAAC;EAGH,WAAW,MAAM,SAAS,QAAQ;GAChC,OAAO,OAAO,KAAK;GAEnB,KAAK,MAAM,UAAU,QAAQ,OAAO,CAAC,GACnC,MAAM,WAAW,MAAM;EAE3B;CACF,UAAU;EACR,YAAY;CACd;CAEA,IAAI;CAEJ,IAAI;EACF,aAAa,OAAO,SAAS;CAC/B,SAAS,OAAO;EACd,IAAI,EAAE,iBAAiB,eAAe,EAAE,iBAAiB,aACvD,MAAM;EAGR,MAAM;GAAE,MAAM;GAAU,aAAa,MAAM,YAAY,IAAI,eAAe;EAAE;EAE5E;CACF;CAEA,MAAM,gBAAgB,YAAY,QAAQ,OAAO,UAAU,CAAC;AAC9D;AAEA,SAAS,gBAAgB,YAA4C;CACnE,MAAM,UAAU;EACd,UAAU,WAAW;EACrB,MAAM,WAAW;EACjB,SAAS,WAAW;CACtB;CAEA,OAAO,WAAW,SAAS,KAAA,IACvB,UACA;EAAE,GAAG;EAAS,OAAO,WAAW,KAAK;EAAO,KAAK,WAAW,KAAK;CAAI;AAC3E;AAEA,SAAS,aAAa,OAAmC;CACvD,OAAO;EACL,IAAI,MAAM;EACV,QAAQ,MAAM;EACd,OAAO,MAAM;EACb,QAAQ,MAAM;EACd,SAAS,MAAM;CACjB;AACF"}

package/dist/stream-session.d.mts

@@ -0,0 +1,79 @@
+import { SyntaxOptions } from "./syntax-options.mjs";
+import { ResolvedParserLimits } from "./parser/config.mjs";
+import { MdxEdit, MdxStreamChange, MdxStreamCompletion } from "./stream-types.mjs";
+//#region src/stream-session.d.ts
+export interface StreamSessionOptions {
+  readonly name: string;
+  readonly source: string;
+  readonly syntax: SyntaxOptions | undefined;
+  readonly limits: ResolvedParserLimits;
+  readonly maximumPendingBlockLength: number;
+}
+/**
+ * Owns the parser and the rendered blocks of one stream. A top-level block
+ * settles once later input cannot change it, and then materializes and lowers
+ * once. Each append renders only the open tail; a settled block renders again
+ * only when a definition or footnote number it uses changes.
+ */
+export declare class StreamSession {
+  #private;
+  constructor(options: StreamSessionOptions);
+  /** The latest change, whose snapshot is the current preview. */
+  get current(): MdxStreamChange;
+  append(text: string): MdxStreamChange;
+  edit(edit: MdxEdit): MdxStreamChange;
+  /**
+   * Finishes the tail strictly and assembles the document from the settled
+   * blocks' nodes, so only the tail materializes again.
+   */
+  complete(): MdxStreamCompletion;
+  /**
+   * Settles queued blocks, renders the blocks whose definitions or footnote
+   * numbers changed, renders the open tail, and assembles the snapshot.
+   */
+  private update;
+  /**
+   * Drops settled blocks that an edit replaced, which settle again from the
+   * queue, and returns how many settled blocks remain.
+   */
+  private dropChangedSettled;
+  /** Settles queued parser output and returns the indexes of blocks adopted from the tail. */
+  private settleQueued;
+  /**
+   * Renders newly settled blocks, and settled blocks whose definitions or
+   * footnote numbers changed. Returns the re-rendered blocks before `start`.
+   */
+  private refreshSettled;
+  /** Adopts the tail's rendering for a block that settled unchanged, or queues it to render. */
+  private settle;
+  private materializeTail;
+  private materialize;
+  /** Adds one settled block to the running totals. Its rendering may still be pending. */
+  private addSettled;
+  /** Drops the settled blocks from `length` on, after an edit before them. */
+  private truncate;
+  /**
+   * Numbers footnote references in settled blocks from `from` on, continuing
+   * the numbering before them, and returns the blocks whose numbers changed.
+   */
+  private renumber;
+  private renderTail;
+  /** Lowers one block in the stream's scope. */
+  private render;
+  private isFootnoteDefined;
+  private effectiveDefinitions;
+  /** The footnote section, rebuilt only when its numbering or definitions change. */
+  private footnoteSection;
+  /** The first limit the stream exceeds, if any. */
+  private limitState;
+  /** Keeps the last preview within limits, with its block identities. */
+  private limitChange;
+  private limitError;
+  /** A block keeps its identity across appends, and across edits that do not touch it. */
+  private blockId;
+  /** Identities of blocks an edit does not touch, keyed by their range after the edit. */
+  private retiredIds;
+  private newId;
+}
+//#endregion
+//# sourceMappingURL=stream-session.d.mts.map

package/dist/stream-session.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stream-session.d.mts","names":[],"sources":["../src/stream-session.ts"],"mappings":";;;;iBA6CiB;WACN;WACA;WACA,QAAQ;WACR,QAAQ;WACR;;;;;;;;qBA0EE;;EA6CX,YAAmB,SAAS;;MAgBjB,WAAW;EAIf,OAAO,eAAe;EAUtB,KAAK,MAAM,UAAU;;;;;EAarB,YAAY;;;;;UA4FX;;;;;UAiFA;;UAeA;;;;;UA6BA;;UAoIA;UA2BA;UAgBA;;UAuDA;;UA2CA;;;;;UA2BA;UA2BA;;UA6DA;UA2FA;UAMA;;UAgBA;;UAgCA;;UA4CA;UAoBA;;UAgBA;;UAaA;UAgBA"}