katex 0.16.46 → 0.17.0

package/src/functions/text.ts

@@ -5,7 +5,7 @@ import {makeSpan} from "../buildCommon";
 import * as html from "../buildHTML";
 import * as mml from "../buildMathML";
 import type Options from "../Options";
-import type {ParseNode} from "../parseNode";
+import type {ParseNode} from "../types/nodes";
 
 // Non-mathy text, possibly in a font
 const textFontFamilies: Record<string, TextFont | undefined> = {
@@ -54,12 +54,11 @@ defineFunction({
         // Font Shapes
         "\\textit", "\\textup", "\\emph",
     ],
-    props: {
-        numArgs: 1,
-        argTypes: ["text"],
-        allowedInArgument: true,
-        allowedInText: true,
-    },
+    numArgs: 1,
+    argTypes: ["text"],
+    allowedInArgument: true,
+    allowedInText: true,
+
     handler({parser, funcName}, args) {
         const body = args[0];
         return {
@@ -69,6 +68,7 @@ defineFunction({
             font: funcName,
         };
     },
+
     htmlBuilder(group, options) {
         const newOptions = optionsWithFont(group, options);
         const inner = html.buildExpression(group.body, newOptions, true);

package/src/functions/underline.ts

@@ -8,10 +8,9 @@ import * as mml from "../buildMathML";
 defineFunction({
     type: "underline",
     names: ["\\underline"],
-    props: {
-        numArgs: 1,
-        allowedInText: true,
-    },
+    numArgs: 1,
+    allowedInText: true,
+
     handler({parser}, args) {
         return {
             type: "underline",
@@ -19,6 +18,7 @@ defineFunction({
             body: args[0],
         };
     },
+
     htmlBuilder(group, options) {
         // Underlines are handled in the TeXbook pg 443, Rule 10.
         // Build the inner group.

package/src/functions/utils/assembleSupSub.ts

@@ -4,7 +4,7 @@ import {isCharacterBox} from "../../utils";
 import type {StyleInterface} from "../../Style";
 import type Options from "../../Options";
 import type {DomSpan, SymbolNode} from "../../domTree";
-import type {AnyParseNode} from "../../parseNode";
+import type {AnyParseNode} from "../../types/nodes";
 import {makeEm} from "../../units";
 
 // For an operator with limits, assemble the base, sup, and sub into a span.

package/src/functions/vcenter.ts

@@ -10,11 +10,10 @@ import * as mml from "../buildMathML";
 defineFunction({
     type: "vcenter",
     names: ["\\vcenter"],
-    props: {
-        numArgs: 1,
-        argTypes: ["original"], // In LaTeX, \vcenter can act only on a box.
-        allowedInText: false,
-    },
+    numArgs: 1,
+    argTypes: ["original"], // In LaTeX, \vcenter can act only on a box.
+    allowedInText: false,
+
     handler({parser}, args) {
         return {
             type: "vcenter",
@@ -22,6 +21,7 @@ defineFunction({
             body: args[0],
         };
     },
+
     htmlBuilder(group, options) {
         const body = html.buildGroup(group.body, options);
         const axisHeight = options.fontMetrics().axisHeight;

package/src/functions/verb.ts

@@ -3,15 +3,14 @@ import {makeSpan, makeSymbol, tryCombineChars} from "../buildCommon";
 import {MathNode, TextNode} from "../mathMLTree";
 import ParseError from "../ParseError";
 
-import type {ParseNode} from "../parseNode";
+import type {ParseNode} from "../types/nodes";
 
 defineFunction({
     type: "verb",
     names: ["\\verb"],
-    props: {
-        numArgs: 0,
-        allowedInText: true,
-    },
+    numArgs: 0,
+    allowedInText: true,
+
     handler(context, args, optArgs) {
         // \verb and \verb* are dealt with directly in Parser.js.
         // If we end up here, it's because of a failure to match the two delimiters
@@ -20,6 +19,7 @@ defineFunction({
         throw new ParseError(
             "\\verb ended by end of line instead of matching delimiter");
     },
+
     htmlBuilder(group, options) {
         const text = makeVerb(group);
         const body = [];

package/src/parseNode.ts

@@ -1,479 +1,5 @@
 import {NON_ATOMS} from "./atoms";
-import type {Atom} from "./atoms";
-import type SourceLocation from "./SourceLocation";
-import type {AlignSpec, ColSeparationType} from "./environments/array";
-import type {DelimiterSize, Mode, StyleStr} from "./types";
-import type {MathFont} from "./types/fonts";
-import type {Token} from "./Token";
-import type {Measurement} from "./units";
-export type NodeType = keyof ParseNodeTypes;
-export type ParseNode<TYPE extends NodeType> = ParseNodeTypes[TYPE];
-
-// ParseNode's corresponding to Symbol `Group`s in symbols.js.
-export type SymbolParseNode =
-    ParseNode<"atom"> |
-    ParseNode<"accent-token"> |
-    ParseNode<"mathord"> |
-    ParseNode<"op-token"> |
-    ParseNode<"spacing"> |
-    ParseNode<"textord">;
-
-// ParseNode from `Parser.formatUnsupportedCmd`
-export type UnsupportedCmdParseNode = ParseNode<"color">;
-
-// Union of all possible `ParseNode<>` types.
-export type AnyParseNode = ParseNodeTypes[keyof ParseNodeTypes];
-
-// Map from `NodeType` to the corresponding `ParseNode`.
-type ParseNodeTypes = {
-    "array": {
-        type: "array";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        colSeparationType?: ColSeparationType;
-        hskipBeforeAndAfter?: boolean;
-        addJot?: boolean;
-        cols?: AlignSpec[];
-        arraystretch: number;
-        body: AnyParseNode[][];
-        // List of rows in the (2D) array.
-        rowGaps: (Measurement | null | undefined)[];
-        hLinesBeforeRow: Array<boolean[]>;
-            // Whether each row should be automatically numbered, or an explicit tag
-        tags?: (boolean | AnyParseNode[])[];
-        leqno?: boolean;
-        isCD?: boolean;
-    };
-    "cdlabel": {
-        type: "cdlabel";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        side: string;
-        label: AnyParseNode;
-    };
-    "cdlabelparent": {
-        type: "cdlabelparent";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        fragment: AnyParseNode;
-    };
-    "color": {
-        type: "color";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        color: string;
-        body: AnyParseNode[];
-    };
-    "color-token": {
-        type: "color-token";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        color: string;
-    };
-    // To avoid requiring run-time type assertions, this more carefully captures
-    // the requirements on the fields per the op.js htmlBuilder logic:
-    // - `body` and `value` are NEVER set simultaneously.
-    // - When `symbol` is true, `body` is set.
-    "op": {
-        type: "op";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        limits: boolean;
-        alwaysHandleSupSub?: boolean;
-        suppressBaseShift?: boolean;
-        parentIsSupSub: boolean;
-        symbol: boolean;
-        name: string;
-        body?: void;
-    } | {
-        type: "op";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        limits: boolean;
-        alwaysHandleSupSub?: boolean;
-        suppressBaseShift?: boolean;
-        parentIsSupSub: boolean;
-        symbol: false;
-        // If 'symbol' is true, `body` *must* be set.
-        name?: void;
-        body: AnyParseNode[];
-    };
-    "ordgroup": {
-        type: "ordgroup";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        body: AnyParseNode[];
-        semisimple?: boolean;
-    };
-    "raw": {
-        type: "raw";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        string: string;
-    };
-    "size": {
-        type: "size";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        value: Measurement;
-        isBlank: boolean;
-    };
-    "styling": {
-        type: "styling";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        style: StyleStr;
-        resetFont?: boolean;
-        body: AnyParseNode[];
-    };
-    "supsub": {
-        type: "supsub";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        base: AnyParseNode | null | undefined;
-        sup?: AnyParseNode | null | undefined;
-        sub?: AnyParseNode | null | undefined;
-    };
-    "tag": {
-        type: "tag";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        body: AnyParseNode[];
-        tag: AnyParseNode[];
-    };
-    "text": {
-        type: "text";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        body: AnyParseNode[];
-        font?: string;
-    };
-    "url": {
-        type: "url";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        url: string;
-    };
-    "verb": {
-        type: "verb";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        body: string;
-        star: boolean;
-    };
-    // From symbol groups, constructed in Parser.js via `symbols` lookup.
-    // (Some of these have "-token" suffix to distinguish them from existing
-    // `ParseNode` types.)
-    "atom": {
-        type: "atom";
-        family: Atom;
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        text: string;
-    };
-    "mathord": {
-        type: "mathord";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        text: string;
-    };
-    "spacing": {
-        type: "spacing";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        text: string;
-    };
-    "textord": {
-        type: "textord";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        text: string;
-    };
-    // These "-token" types don't have corresponding HTML/MathML builders.
-    "accent-token": {
-        type: "accent-token";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        text: string;
-    };
-    "op-token": {
-        type: "op-token";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        text: string;
-    };
-    // From functions.js and functions/*.js. See also "color", "op", "styling",
-    // and "text" above.
-    "accent": {
-        type: "accent";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        label: string;
-        isStretchy?: boolean;
-        isShifty?: boolean;
-        base: AnyParseNode;
-    };
-    "accentUnder": {
-        type: "accentUnder";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        label: string;
-        isStretchy?: boolean;
-        isShifty?: boolean;
-        base: AnyParseNode;
-    };
-    "cr": {
-        type: "cr";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        newLine: boolean;
-        size: Measurement | null | undefined;
-    };
-    "delimsizing": {
-        type: "delimsizing";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        size: DelimiterSize;
-        mclass: "mopen" | "mclose" | "mrel" | "mord";
-        delim: string;
-    };
-    "enclose": {
-        type: "enclose";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        label: string;
-        backgroundColor?: string;
-        borderColor?: string;
-        body: AnyParseNode;
-    };
-    "environment": {
-        type: "environment";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        name: string;
-        nameGroup: AnyParseNode;
-    };
-    "font": {
-        type: "font";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        font: Exclude<MathFont, "">;
-        body: AnyParseNode;
-    };
-    "genfrac": {
-        type: "genfrac";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        continued: boolean;
-        numer: AnyParseNode;
-        denom: AnyParseNode;
-        hasBarLine: boolean;
-        leftDelim: string | null | undefined;
-        rightDelim: string | null | undefined;
-        barSize: Measurement | null;
-    };
-    "hbox": {
-        type: "hbox";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        body: AnyParseNode[];
-    };
-    "horizBrace": {
-        type: "horizBrace";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        label: string;
-        isOver: boolean;
-        base: AnyParseNode;
-    };
-    "href": {
-        type: "href";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        href: string;
-        body: AnyParseNode[];
-    };
-    "html": {
-        type: "html";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        attributes: Record<string, string>;
-        body: AnyParseNode[];
-    };
-    "htmlmathml": {
-        type: "htmlmathml";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        html: AnyParseNode[];
-        mathml: AnyParseNode[];
-    };
-    "includegraphics": {
-        type: "includegraphics";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        alt: string;
-        width: Measurement;
-        height: Measurement;
-        totalheight: Measurement;
-        src: string;
-    };
-    "infix": {
-        type: "infix";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        replaceWith: string;
-        size?: Measurement;
-        token: Token | null | undefined;
-    };
-    "internal": {
-        type: "internal";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-    };
-    "kern": {
-        type: "kern";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        dimension: Measurement;
-    };
-    "lap": {
-        type: "lap";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        alignment: string;
-        body: AnyParseNode;
-    };
-    "leftright": {
-        type: "leftright";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        body: AnyParseNode[];
-        left: string;
-        right: string;
-        rightColor: string | null | undefined; // undefined means "inherit"
-    };
-    "leftright-right": {
-        type: "leftright-right";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        delim: string;
-        color: string | null | undefined; // undefined means "inherit"
-    };
-    "mathchoice": {
-        type: "mathchoice";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        display: AnyParseNode[];
-        text: AnyParseNode[];
-        script: AnyParseNode[];
-        scriptscript: AnyParseNode[];
-    };
-    "middle": {
-        type: "middle";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        delim: string;
-    };
-    "mclass": {
-        type: "mclass";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        mclass: string;
-        body: AnyParseNode[];
-        isCharacterBox: boolean;
-    };
-    "operatorname": {
-        type: "operatorname";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        body: AnyParseNode[];
-        alwaysHandleSupSub: boolean;
-        limits: boolean;
-        parentIsSupSub: boolean;
-    };
-    "overline": {
-        type: "overline";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        body: AnyParseNode;
-    };
-    "phantom": {
-        type: "phantom";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        body: AnyParseNode[];
-    };
-    "vphantom": {
-        type: "vphantom";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        body: AnyParseNode;
-    };
-    "pmb": {
-        type: "pmb";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        mclass: string;
-        body: AnyParseNode[];
-    };
-    "raisebox": {
-        type: "raisebox";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        dy: Measurement;
-        body: AnyParseNode;
-    };
-    "rule": {
-        type: "rule";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        shift: Measurement | null | undefined;
-        width: Measurement;
-        height: Measurement;
-    };
-    "sizing": {
-        type: "sizing";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        size: number;
-        body: AnyParseNode[];
-    };
-    "smash": {
-        type: "smash";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        body: AnyParseNode;
-        smashHeight: boolean;
-        smashDepth: boolean;
-    };
-    "sqrt": {
-        type: "sqrt";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        body: AnyParseNode;
-        index: AnyParseNode | null | undefined;
-    };
-    "underline": {
-        type: "underline";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        body: AnyParseNode;
-    };
-    "vcenter": {
-        type: "vcenter";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        body: AnyParseNode;
-    };
-    "xArrow": {
-        type: "xArrow";
-        mode: Mode;
-        loc?: SourceLocation | null | undefined;
-        label: string;
-        body: AnyParseNode;
-        below: AnyParseNode | null | undefined;
-    };
-};
+import type {AnyParseNode, NodeType, ParseNode, SymbolParseNode} from "./types/nodes";
 
 /**
  * Asserts that the node is of the given type and returns it with stricter
@@ -507,7 +33,7 @@ export function assertSymbolNodeType(node: AnyParseNode | null | undefined): Sym
 }
 
 /**
- * Returns the node more strictly typed iff it is of the given type. Otherwise,
+ * Returns the node more strictly typed if it is of the given type. Otherwise,
  * returns null.
  */
 export function checkSymbolNodeType(node: AnyParseNode | null | undefined): SymbolParseNode | null | undefined {

package/src/parseTree.ts

@@ -1,14 +1,9 @@
-/**
- * Provides a single function for parsing an expression using a Parser
- * TODO(emily): Remove this
- */
-
 import Parser from "./Parser";
 import ParseError from "./ParseError";
 import {Token} from "./Token";
 
 import type Settings from "./Settings";
-import type {AnyParseNode} from "./parseNode";
+import type {AnyParseNode} from "./types/nodes";
 
 /**
  * Parses an expression using a Parser, then returns the parsed result.

package/src/spacingData.ts

@@ -1,7 +1,8 @@
 /**
  * Describes spaces between different classes of atoms.
  */
-import type {Measurement} from "./units";
+
+import type {Measurement} from "./types";
 
 const thinspace: Measurement = {
     number: 3,

package/src/stretchy.ts

@@ -10,7 +10,7 @@ import {MathNode, TextNode} from "./mathMLTree";
 import {makeEm} from "./units";
 
 import type Options from "./Options";
-import type {ParseNode} from "./parseNode";
+import type {ParseNode} from "./types/nodes";
 import type {DomSpan, HtmlDomNode, SvgSpan} from "./domTree";
 
 const stretchyCodePoint: Record<string, string> = {

package/src/svgGeometry.ts

@@ -507,8 +507,8 @@ M500 241 v40 H399408 v-40z M500 435 v40 H400000 v-40z`,
 export const tallDelim = function(label: string, midHeight: number): string {
     switch (label) {
         case "lbrack":
-            return `M403 1759 V84 H666 V0 H319 V1759 v${midHeight} v1759 h347 v-84
-H403z M403 1759 V0 H319 V1759 v${midHeight} v1759 h84z`;
+            return `M403 1759 V84 H666 V0 H319 V1759 v${midHeight} v1759 v84 h347 v-84
+H403z M403 1759 V0 H319 V1759 v${midHeight} v1759 v84 h84z`;
         case "rbrack":
             return `M347 1759 V0 H0 V84 H263 V1759 v${midHeight} v1759 H0 v84 H347z
 M347 1759 V0 H263 V1759 v${midHeight} v1759 h84z`;

package/src/types/index.ts

@@ -27,3 +27,15 @@ export type DelimiterSize = 1 | 2 | 3 | 4;
 
 export type Slice1<S extends string> =
     S extends `${string}${infer Rest}` ? Rest : "";
+
+export type Slice4<S extends string> =
+    S extends `${string}${string}${string}${string}${infer Rest}` ? Rest : "";
+
+export type Slice5<S extends string> =
+    S extends `${string}${string}${string}${string}${string}${infer Rest}` ? Rest : "";
+
+export type Measurement = {number: number, unit: string};
+
+export type MathClass = "mord" | "mop" | "mbin" | "mrel" | "mopen" | "mclose" | "mpunct" | "minner";
+
+export type Side = "left" | "right";