katex 0.16.46 → 0.17.0

package/src/functions/delimsizing.ts

@@ -10,15 +10,13 @@ import * as html from "../buildHTML";
 import * as mml from "../buildMathML";
 
 import type Options from "../Options";
-import type {AnyParseNode, ParseNode, SymbolParseNode} from "../parseNode";
 import type {FunctionContext} from "../defineFunction";
 import type {HtmlDomNode} from "../domTree";
+import type {DelimiterSize, MathClass} from "../types";
+import type {AnyParseNode, ParseNode, SymbolParseNode} from "../types/nodes";
 
 // Extra data needed for the delimiter handler down below
-const delimiterSizes: Record<string, {
-    mclass: "mopen" | "mclose" | "mrel" | "mord";
-    size: 1 | 2 | 3 | 4;
-}> = {
+const delimiterSizes = {
     "\\bigl" : {mclass: "mopen",    size: 1},
     "\\Bigl" : {mclass: "mopen",    size: 2},
     "\\biggl": {mclass: "mopen",    size: 3},
@@ -35,7 +33,10 @@ const delimiterSizes: Record<string, {
     "\\Big"  : {mclass: "mord",     size: 2},
     "\\bigg" : {mclass: "mord",     size: 3},
     "\\Bigg" : {mclass: "mord",     size: 4},
-};
+} as const satisfies Record<string, {
+    mclass: MathClass;
+    size: DelimiterSize;
+}>;
 
 const delimiters = new Set([
     "(", "\\lparen", ")", "\\rparen",
@@ -92,10 +93,9 @@ defineFunction({
         "\\bigm", "\\Bigm", "\\biggm", "\\Biggm",
         "\\big",  "\\Big",  "\\bigg",  "\\Bigg",
     ],
-    props: {
-        numArgs: 1,
-        argTypes: ["primitive"],
-    },
+    numArgs: 1,
+    argTypes: ["primitive"],
+
     handler: (context, args) => {
         const delim = checkDelimiter(args[0], context);
 
@@ -107,6 +107,7 @@ defineFunction({
             delim: delim.text,
         };
     },
+
     htmlBuilder: (group, options) => {
         if (group.delim === ".") {
             // Empty delimiters still count as elements, even though they don't
@@ -157,10 +158,9 @@ function assertParsed(group: ParseNode<"leftright">) {
 defineFunction({
     type: "leftright-right",
     names: ["\\right"],
-    props: {
-        numArgs: 1,
-        primitive: true,
-    },
+    numArgs: 1,
+    primitive: true,
+
     handler: (context, args) => {
         // \left case below triggers parsing of \right in
         //   `const right = parser.parseFunction();`
@@ -174,7 +174,7 @@ defineFunction({
             type: "leftright-right",
             mode: context.parser.mode,
             delim: checkDelimiter(args[0], context).text,
-            color: color as string | null | undefined, // undefined if not set via \color
+            color, // undefined if not set via \color
         };
     },
 });
@@ -183,10 +183,9 @@ defineFunction({
 defineFunction({
     type: "leftright",
     names: ["\\left"],
-    props: {
-        numArgs: 1,
-        primitive: true,
-    },
+    numArgs: 1,
+    primitive: true,
+
     handler: (context, args) => {
         const delim = checkDelimiter(args[0], context);
 
@@ -208,6 +207,7 @@ defineFunction({
             rightColor: right.color,
         };
     },
+
     htmlBuilder: (group, options) => {
         assertParsed(group);
         // Build the inner expression
@@ -312,10 +312,9 @@ defineFunction({
 defineFunction({
     type: "middle",
     names: ["\\middle"],
-    props: {
-        numArgs: 1,
-        primitive: true,
-    },
+    numArgs: 1,
+    primitive: true,
+
     handler: (context, args) => {
         const delim = checkDelimiter(args[0], context);
         if (!context.parser.leftrightDepth) {
@@ -328,6 +327,7 @@ defineFunction({
             delim: delim.text,
         };
     },
+
     htmlBuilder: (group, options) => {
         let middleDelim;
         if (group.delim === ".") {

package/src/functions/enclose.ts

@@ -220,11 +220,10 @@ const mathmlBuilder: MathMLBuilder<"enclose"> = (group, options) => {
 defineFunction({
     type: "enclose",
     names: ["\\colorbox"],
-    props: {
-        numArgs: 2,
-        allowedInText: true,
-        argTypes: ["color", "hbox"],
-    },
+    numArgs: 2,
+    allowedInText: true,
+    argTypes: ["color", "hbox"],
+
     handler({parser, funcName}, args, optArgs) {
         const color = assertNodeType(args[0], "color-token").color;
         const body = args[1];
@@ -236,6 +235,7 @@ defineFunction({
             body,
         };
     },
+
     htmlBuilder,
     mathmlBuilder,
 });
@@ -243,11 +243,10 @@ defineFunction({
 defineFunction({
     type: "enclose",
     names: ["\\fcolorbox"],
-    props: {
-        numArgs: 3,
-        allowedInText: true,
-        argTypes: ["color", "color", "hbox"],
-    },
+    numArgs: 3,
+    allowedInText: true,
+    argTypes: ["color", "color", "hbox"],
+
     handler({parser, funcName}, args, optArgs) {
         const borderColor = assertNodeType(args[0], "color-token").color;
         const backgroundColor = assertNodeType(args[1], "color-token").color;
@@ -261,18 +260,15 @@ defineFunction({
             body,
         };
     },
-    htmlBuilder,
-    mathmlBuilder,
 });
 
 defineFunction({
     type: "enclose",
     names: ["\\fbox"],
-    props: {
-        numArgs: 1,
-        argTypes: ["hbox"],
-        allowedInText: true,
-    },
+    numArgs: 1,
+    argTypes: ["hbox"],
+    allowedInText: true,
+
     handler({parser}, args) {
         return {
             type: "enclose",
@@ -286,9 +282,8 @@ defineFunction({
 defineFunction({
     type: "enclose",
     names: ["\\cancel", "\\bcancel", "\\xcancel", "\\phase"],
-    props: {
-        numArgs: 1,
-    },
+    numArgs: 1,
+
     handler({parser, funcName}, args) {
         const body = args[0];
         return {
@@ -298,17 +293,14 @@ defineFunction({
             body,
         };
     },
-    htmlBuilder,
-    mathmlBuilder,
 });
 
 defineFunction({
     type: "enclose",
     names: ["\\sout"],
-    props: {
-        numArgs: 1,
-        allowedInText: true,
-    },
+    numArgs: 1,
+    allowedInText: true,
+
     handler({parser, funcName}, args) {
         if (parser.mode === "math") {
             parser.settings.reportNonstrict("mathVsSout",
@@ -322,18 +314,15 @@ defineFunction({
             body,
         };
     },
-    htmlBuilder,
-    mathmlBuilder,
 });
 
 defineFunction({
     type: "enclose",
     names: ["\\angl"],
-    props: {
-        numArgs: 1,
-        argTypes: ["hbox"],
-        allowedInText: false,
-    },
+    numArgs: 1,
+    argTypes: ["hbox"],
+    allowedInText: false,
+
     handler({parser}, args) {
         return {
             type: "enclose",

package/src/functions/environment.ts

@@ -3,17 +3,16 @@ import ParseError from "../ParseError";
 import {assertNodeType} from "../parseNode";
 import environments from "../environments";
 
-import type {ParseNode} from "../parseNode";
+import type {ParseNode} from "../types/nodes";
 
 // Environment delimiters. HTML/MathML rendering is defined in the corresponding
 // defineEnvironment definitions.
 defineFunction({
     type: "environment",
     names: ["\\begin", "\\end"],
-    props: {
-        numArgs: 1,
-        argTypes: ["text"],
-    },
+    numArgs: 1,
+    argTypes: ["text"],
+
     handler({parser, funcName}, args) {
         const nameGroup = args[0];
         if (nameGroup.type !== "ordgroup") {

package/src/functions/font.ts

@@ -8,7 +8,7 @@ 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";
 import type {Slice1} from "../types";
 
 const htmlBuilder = (group: ParseNode<"font">, options: Options) => {
@@ -29,12 +29,6 @@ const fontAliases = {
     "\\frak": "\\mathfrak",
 } as const;
 
-type OldFontCommands = "\\rm" | "\\sf" | "\\tt" | "\\bf" | "\\it" | "\\cal";
-type FontCommands =
-    "\\mathrm" | "\\mathit" | "\\mathbf" | "\\mathnormal" | "\\mathsfit" |
-    "\\mathbb" | "\\mathcal" | "\\mathfrak" | "\\mathscr" | "\\mathsf" |
-    "\\mathtt";
-
 defineFunction({
     type: "font",
     names: [
@@ -47,24 +41,23 @@ defineFunction({
 
         // aliases, except \bm defined below
         "\\Bbb", "\\bold", "\\frak",
-    ] satisfies (FontCommands | keyof typeof fontAliases)[],
-    props: {
-        numArgs: 1,
-        allowedInArgument: true,
-    },
+    ],
+    numArgs: 1,
+    allowedInArgument: true,
+
     handler: ({parser, funcName}, args) => {
         const body = normalizeArgument(args[0]);
-        let func = funcName;
-        if (func in fontAliases) {
-            func = fontAliases[func as keyof typeof fontAliases];
-        }
+        const func = funcName in fontAliases
+            ? fontAliases[funcName as keyof typeof fontAliases]
+            : funcName as Exclude<typeof funcName, keyof typeof fontAliases>;
         return {
             type: "font",
             mode: parser.mode,
-            font: func.slice(1) as Slice1<FontCommands>,
+            font: func.slice(1) as Slice1<typeof func>,
             body,
         };
     },
+
     htmlBuilder,
     mathmlBuilder,
 });
@@ -72,9 +65,8 @@ defineFunction({
 defineFunction({
     type: "mclass",
     names: ["\\boldsymbol", "\\bm"],
-    props: {
-        numArgs: 1,
-    },
+    numArgs: 1,
+
     handler: ({parser}, args) => {
         const body = args[0];
         // amsbsy.sty's \boldsymbol uses \binrel spacing to inherit the
@@ -100,10 +92,8 @@ defineFunction({
 defineFunction({
     type: "font",
     names: ["\\rm", "\\sf", "\\tt", "\\bf", "\\it", "\\cal"],
-    props: {
-        numArgs: 0,
-        allowedInText: true,
-    },
+    numArgs: 0,
+    allowedInText: true,
     handler: ({parser, funcName, breakOnTokenText}, args) => {
         const {mode} = parser;
         const body = parser.parseExpression(true, breakOnTokenText);
@@ -111,7 +101,7 @@ defineFunction({
         return {
             type: "font",
             mode: mode,
-            font: `math${funcName.slice(1) as Slice1<OldFontCommands>}`,
+            font: `math${funcName.slice(1) as Slice1<typeof funcName>}` as const,
             body: {
                 type: "ordgroup",
                 mode: parser.mode,
@@ -119,6 +109,4 @@ defineFunction({
             },
         };
     },
-    htmlBuilder,
-    mathmlBuilder,
 });

package/src/functions/genfrac.ts

@@ -2,7 +2,7 @@ import defineFunction, {normalizeArgument} from "../defineFunction";
 import {makeLineSpan, makeSpan, makeVList} from "../buildCommon";
 import {makeCustomSizedDelim} from "../delimiter";
 import {MathNode, TextNode} from "../mathMLTree";
-import type {ParseNode} from "../parseNode";
+import type {ParseNode} from "../types/nodes";
 import Style from "../Style";
 import {assertNodeType} from "../parseNode";
 import * as html from "../buildHTML";
@@ -239,10 +239,9 @@ defineFunction({
         "\\\\atopfrac", // can’t be entered directly
         "\\\\bracefrac", "\\\\brackfrac",   // ditto
     ],
-    props: {
-        numArgs: 2,
-        allowedInArgument: true,
-    },
+    numArgs: 2,
+    allowedInArgument: true,
+
     handler: ({parser, funcName}, args) => {
         const numer = args[0];
         const denom = args[1];
@@ -302,6 +301,7 @@ defineFunction({
         }, style);
     },
 
+
     htmlBuilder,
     mathmlBuilder,
 });
@@ -311,10 +311,9 @@ defineFunction({
 defineFunction({
     type: "infix",
     names: ["\\over", "\\choose", "\\atop", "\\brace", "\\brack"],
-    props: {
-        numArgs: 0,
-        infix: true,
-    },
+    numArgs: 0,
+    infix: true,
+
     handler({parser, funcName, token}) {
         let replaceWith;
         switch (funcName) {
@@ -359,11 +358,10 @@ const delimFromValue = function(delimString: string): string | null {
 defineFunction({
     type: "genfrac",
     names: ["\\genfrac"],
-    props: {
-        numArgs: 6,
-        allowedInArgument: true,
-        argTypes: ["math", "math", "size", "text", "math", "math"],
-    },
+    numArgs: 6,
+    allowedInArgument: true,
+    argTypes: ["math", "math", "size", "text", "math", "math"],
+
     handler({parser}, args) {
         const numer = args[4];
         const denom = args[5];
@@ -420,11 +418,10 @@ defineFunction({
 defineFunction({
     type: "infix",
     names: ["\\above"],
-    props: {
-        numArgs: 1,
-        argTypes: ["size"],
-        infix: true,
-    },
+    numArgs: 1,
+    argTypes: ["size"],
+    infix: true,
+
     handler({parser, funcName, token}, args) {
         return {
             type: "infix",
@@ -439,10 +436,9 @@ defineFunction({
 defineFunction({
     type: "genfrac",
     names: ["\\\\abovefrac"],
-    props: {
-        numArgs: 3,
-        argTypes: ["math", "size", "math"],
-    },
+    numArgs: 3,
+    argTypes: ["math", "size", "math"],
+
     handler: ({parser, funcName}, args) => {
         const numer = args[0];
         const barSize = assertNodeType(args[1], "infix").size;

package/src/functions/hbox.ts

@@ -13,12 +13,11 @@ import * as mml from "../buildMathML";
 defineFunction({
     type: "hbox",
     names: ["\\hbox"],
-    props: {
-        numArgs: 1,
-        argTypes: ["text"],
-        allowedInText: true,
-        primitive: true,
-    },
+    numArgs: 1,
+    argTypes: ["text"],
+    allowedInText: true,
+    primitive: true,
+
     handler({parser}, args) {
         return {
             type: "hbox",
@@ -26,6 +25,7 @@ defineFunction({
             body: ordargument(args[0]),
         };
     },
+
     htmlBuilder(group, options) {
         const elements = html.buildExpression(group.body, options.withFont(''), false);
         return makeFragment(elements);

package/src/functions/horizBrace.ts

@@ -9,7 +9,7 @@ import * as html from "../buildHTML";
 import * as mml from "../buildMathML";
 
 import type {HtmlBuilderSupSub, MathMLBuilder} from "../defineFunction";
-import type {ParseNode} from "../parseNode";
+import type {ParseNode} from "../types/nodes";
 
 // NOTE: Unlike most `htmlBuilder`s, this one handles not only "horizBrace", but
 // also "supsub" since an over/underbrace can affect super/subscripting.
@@ -117,9 +117,8 @@ const mathmlBuilder: MathMLBuilder<"horizBrace"> = (group, options) => {
 defineFunction({
     type: "horizBrace",
     names: ["\\overbrace", "\\underbrace", "\\overbracket", "\\underbracket"],
-    props: {
-        numArgs: 1,
-    },
+    numArgs: 1,
+
     handler({parser, funcName}, args) {
         return {
             type: "horizBrace",
@@ -129,6 +128,7 @@ defineFunction({
             base: args[0],
         };
     },
+
     htmlBuilder,
     mathmlBuilder,
 });

package/src/functions/href.ts

@@ -5,16 +5,15 @@ import {MathNode} from "../mathMLTree";
 
 import * as html from "../buildHTML";
 import * as mml from "../buildMathML";
-import type {ParseNode} from "../parseNode";
+import type {ParseNode} from "../types/nodes";
 
 defineFunction({
     type: "href",
     names: ["\\href"],
-    props: {
-        numArgs: 2,
-        argTypes: ["url", "original"],
-        allowedInText: true,
-    },
+    numArgs: 2,
+    argTypes: ["url", "original"],
+    allowedInText: true,
+
     handler: ({parser}, args) => {
         const body = args[1];
         const href = assertNodeType(args[0], "url").url;
@@ -33,6 +32,7 @@ defineFunction({
             body: ordargument(body),
         };
     },
+
     htmlBuilder: (group, options) => {
         const elements = html.buildExpression(group.body, options, false);
         return makeAnchor(group.href, [], elements, options);
@@ -50,11 +50,10 @@ defineFunction({
 defineFunction({
     type: "href",
     names: ["\\url"],
-    props: {
-        numArgs: 1,
-        argTypes: ["url"],
-        allowedInText: true,
-    },
+    numArgs: 1,
+    argTypes: ["url"],
+    allowedInText: true,
+
     handler: ({parser}, args) => {
         const href = assertNodeType(args[0], "url").url;
 

package/src/functions/html.ts

@@ -10,11 +10,10 @@ import type {AnyTrustContext} from "../Settings";
 defineFunction({
     type: "html",
     names: ["\\htmlClass", "\\htmlId", "\\htmlStyle", "\\htmlData"],
-    props: {
-        numArgs: 2,
-        argTypes: ["raw", "original"],
-        allowedInText: true,
-    },
+    numArgs: 2,
+    argTypes: ["raw", "original"],
+    allowedInText: true,
+
     handler: ({parser, funcName, token}, args) => {
         const value = assertNodeType(args[0], "raw").string;
         const body = args[1];
@@ -83,6 +82,7 @@ defineFunction({
             body: ordargument(body),
         };
     },
+
     htmlBuilder: (group, options) => {
         const elements = html.buildExpression(group.body, options, false);
 

package/src/functions/htmlmathml.ts

@@ -7,11 +7,10 @@ import * as mml from "../buildMathML";
 defineFunction({
     type: "htmlmathml",
     names: ["\\html@mathml"],
-    props: {
-        numArgs: 2,
-        allowedInArgument: true,
-        allowedInText: true,
-    },
+    numArgs: 2,
+    allowedInArgument: true,
+    allowedInText: true,
+
     handler: ({parser}, args) => {
         return {
             type: "htmlmathml",
@@ -20,6 +19,7 @@ defineFunction({
             mathml: ordargument(args[1]),
         };
     },
+
     htmlBuilder: (group, options) => {
         const elements = html.buildExpression(
             group.html,

package/src/functions/includegraphics.ts

@@ -1,11 +1,11 @@
 import defineFunction from "../defineFunction";
-import type {Measurement} from "../units";
 import {calculateSize, validUnit, makeEm} from "../units";
 import ParseError from "../ParseError";
 import {Img} from "../domTree";
 import {MathNode} from "../mathMLTree";
 import {assertNodeType} from "../parseNode";
 import type {CssStyle} from "../domTree";
+import type {Measurement} from "../types";
 
 const sizeData = function(str: string): Measurement {
     if (/^[-+]? *(\d+(\.\d*)?|\.\d+)$/.test(str)) {
@@ -33,12 +33,11 @@ const sizeData = function(str: string): Measurement {
 defineFunction({
     type: "includegraphics",
     names: ["\\includegraphics"],
-    props: {
-        numArgs: 1,
-        numOptionalArgs: 1,
-        argTypes: ["raw", "url"],
-        allowedInText: false,
-    },
+    numArgs: 1,
+    numOptionalArgs: 1,
+    argTypes: ["raw", "url"],
+    allowedInText: false,
+
     handler: ({parser}, args, optArgs) => {
         let width = {number: 0, unit: "em"};
         let height = {number: 0.9, unit: "em"};    // sorta character sized.
@@ -101,6 +100,7 @@ defineFunction({
             src: src,
         };
     },
+
     htmlBuilder: (group, options) => {
         const height = calculateSize(group.height, options);
         let depth = 0;

package/src/functions/kern.ts

@@ -11,12 +11,11 @@ import {assertNodeType} from "../parseNode";
 defineFunction({
     type: "kern",
     names: ["\\kern", "\\mkern", "\\hskip", "\\mskip"],
-    props: {
-        numArgs: 1,
-        argTypes: ["size"],
-        primitive: true,
-        allowedInText: true,
-    },
+    numArgs: 1,
+    argTypes: ["size"],
+    primitive: true,
+    allowedInText: true,
+
     handler({parser, funcName}, args) {
         const size = assertNodeType(args[0], "size");
         if (parser.settings.strict) {
@@ -45,6 +44,7 @@ defineFunction({
             dimension: size.value,
         };
     },
+
     htmlBuilder(group, options) {
         return makeGlue(group.dimension, options);
     },

package/src/functions/lap.ts

@@ -10,10 +10,9 @@ import * as mml from "../buildMathML";
 defineFunction({
     type: "lap",
     names: ["\\mathllap", "\\mathrlap", "\\mathclap"],
-    props: {
-        numArgs: 1,
-        allowedInText: true,
-    },
+    numArgs: 1,
+    allowedInText: true,
+
     handler: ({parser, funcName}, args) => {
         const body = args[0];
         return {
@@ -23,6 +22,7 @@ defineFunction({
             body,
         };
     },
+
     htmlBuilder: (group, options) => {
         // mathllap, mathrlap, mathclap
         let inner;