explico 0.7.0 → 0.11.0

package/dist/reference/math-glyphs.d.mts

@@ -11,17 +11,56 @@
  * neither module has to import the other.
  */
 export function stripNotationMarkers(latex: any): string;
+/**
+ * The operator-entry `latex` for a decoration name — the decoration over an
+ * empty group: `\hat{}`, `\overline{}`, `{}'`, `{}^{*}`, `{}^{\dagger}`. The
+ * inverse of {@link decorationOfEntry}, and how the decoration alone is shown.
+ *
+ * @param {string} name
+ * @returns {string}
+ */
+export function operatorEntryLatex(name: string): string;
+/**
+ * How a decoration is shown on its own — over a placeholder square, so a
+ * reader sees where it goes: `\hat{\square}`, `\square'`, `\square^{*}`.
+ * A lone `\dot{}` renders as a speck. Display only: the entry's `latex` stays
+ * the empty-group form the resolver keys on.
+ *
+ * @param {string} name
+ * @returns {string}
+ */
+export function operatorDisplayLatex(name: string): string;
+/**
+ * The decoration a notation entry's `latex` is an operator entry for (see
+ * {@link decorationOfTree}), or `undefined`. `\hat{\beta}` is a whole form,
+ * not an operator entry.
+ *
+ * @param {string} latex
+ * @returns {string | undefined}
+ */
+export function decorationOfEntry(latex: string): string | undefined;
 /**
  * Resolve and annotate one KaTeX expression against a page's flat glyph table.
  * Source offsets in the result always refer to the original, unmodified LaTeX.
  *
+ * Decorations (rule N22) are reported in `decorations`: `wholeForm` is the key
+ * of the binding that covers the decorated form (`\hat{\beta}` has its own
+ * entry), else `null`; `operator` is the key of the operator entry
+ * (`latex: \hat{}`) whose `\explain` now wraps the decorated form, else
+ * `null`. A decoration named in `options.suspended` never composes: a
+ * decorated form no whole form covers is reported in `unresolved`, marked
+ * `suspended`.
+ *
  * @param {string} latex
  * @param {Array<{key: string, notation: string}>} definitions
+ * @param {{ suspended?: readonly string[] }} [options]
  */
 export function resolveMathGlyphs(latex: string, definitions: Array<{
     key: string;
     notation: string;
-}>): {
+}>, options?: {
+    suspended?: readonly string[];
+}): {
     latex: string;
     bindings: {
         key: any;
@@ -29,7 +68,15 @@ export function resolveMathGlyphs(latex: string, definitions: Array<{
         match: any;
         token: any;
     }[];
-    unresolved: any;
+    unresolved: any[];
+    decorations: {
+        token: string;
+        wholeForm: any;
+        operator: any;
+        start: any;
+        end: any;
+        name: any;
+    }[];
 };
 /**
  * Every named operator in one KaTeX expression: a built-in `op` node
@@ -57,16 +104,37 @@ export function collectOperators(latex: string): Array<{
     name: string;
     source: "named" | "operatorname";
 }>;
+/**
+ * Every decoration in one KaTeX expression (rule N22): an accent (`\hat`,
+ * `\widehat`, …), `\overline` / `\underline`, or a superscript mark (`'` for
+ * any run of primes, `*` for `*` / `\ast`, `\dagger`). `name` is the
+ * canonical name in {@link DECORATION_NAMES}; `start`/`end` span the whole
+ * decorated form in `latex`; `base` is the source of what it decorates when
+ * that is one symbol (`\beta`, `b`, `\mathbf{x}`), else `undefined`.
+ *
+ * Pure read, the twin of {@link collectOperators}: `\text{}`, `\mathrm{}` and
+ * operator bodies are skipped, and a span that will not parse returns `[]`
+ * (the math gate owns that error).
+ *
+ * @param {string} latex
+ * @returns {Array<{ name: string, start: number, end: number, base: string | undefined }>}
+ */
+export function collectDecorations(latex: string): Array<{
+    name: string;
+    start: number;
+    end: number;
+    base: string | undefined;
+}>;
 /**
  * Every multi-letter `\mathrm{…}` label in one KaTeX expression (`KE`, `PV`,
  * `opt`) — the upright-label counterpart to {@link collectOperators}. A
- * single-letter body (`\mathrm{d}`, the N7 differential) is not collected:
+ * single-letter body (`\mathrm{d}`, the rule-N2 differential) is not collected:
  * that one is a fixed typographic operator, not a named quantity a reader
  * would need explained.
  *
  * Pure read: nothing here rewrites the source. Used by the
  * `roman-label-explained` consistency check (rule N10); the glyph resolver
- * still skips `\mathrm{…}` bodies whole ([N3](../../docs/authoring/notation.md#n3)).
+ * still skips `\mathrm{…}` bodies whole ([N10](../../docs/authoring/notation.md#n10)).
  *
  * Same `stripNotationMarkers` preprocessing as {@link collectOperators}, and
  * for the same reason: an unstripped `\explain{…}{…}` elsewhere in the span
@@ -99,6 +167,14 @@ export function collectRomanLabels(latex: string): Array<{
  * guard below keeps a dependency bump from silently changing its tree.
  */
 export const SUPPORTED_KATEX_PARSE_VERSION: "0.16.47";
+/**
+ * Every decoration rule N22 treats as an operator, by canonical name: each
+ * accent (`\hat`, `\widehat`, … — `\widehat` is not `\hat`), `\overline`,
+ * `\underline`, and the superscript marks `'` (any run of primes), `*` (`*`
+ * or `\ast`) and `\dagger`. `^\top`, `^{-1}`, powers, subscripts and fonts
+ * are not decorations.
+ */
+export const DECORATION_NAMES: Readonly<Set<string>>;
 export class GlyphResolutionError extends Error {
     constructor(code: any, message: any, details?: undefined);
     code: any;