katex 0.16.28 → 0.16.30

package/src/functions/underline.js

@@ -1,7 +1,7 @@
 // @flow
 import defineFunction from "../defineFunction";
-import buildCommon from "../buildCommon";
-import mathMLTree from "../mathMLTree";
+import {makeLineSpan, makeSpan, makeVList} from "../buildCommon";
+import {MathNode, TextNode} from "../mathMLTree";
 
 import * as html from "../buildHTML";
 import * as mml from "../buildMathML";
@@ -26,11 +26,11 @@ defineFunction({
         const innerGroup = html.buildGroup(group.body, options);
 
         // Create the line to go below the body
-        const line = buildCommon.makeLineSpan("underline-line", options);
+        const line = makeLineSpan("underline-line", options);
 
         // Generate the vlist, with the appropriate kerns
         const defaultRuleThickness = options.fontMetrics().defaultRuleThickness;
-        const vlist = buildCommon.makeVList({
+        const vlist = makeVList({
             positionType: "top",
             positionData: innerGroup.height,
             children: [
@@ -41,14 +41,14 @@ defineFunction({
             ],
         }, options);
 
-        return buildCommon.makeSpan(["mord", "underline"], [vlist], options);
+        return makeSpan(["mord", "underline"], [vlist], options);
     },
     mathmlBuilder(group, options) {
-        const operator = new mathMLTree.MathNode(
-            "mo", [new mathMLTree.TextNode("\u203e")]);
+        const operator = new MathNode(
+            "mo", [new TextNode("\u203e")]);
         operator.setAttribute("stretchy", "true");
 
-        const node = new mathMLTree.MathNode(
+        const node = new MathNode(
             "munder",
             [mml.buildGroup(group.body, options), operator]);
         node.setAttribute("accentunder", "true");

package/src/functions/utils/assembleSupSub.js

@@ -1,7 +1,7 @@
 // @flow
-import buildCommon from "../../buildCommon";
+import {makeSpan, makeVList} from "../../buildCommon";
 import * as html from "../../buildHTML";
-import utils from "../../utils";
+import {isCharacterBox} from "../../utils";
 import type {StyleInterface} from "../../Style";
 import type Options from "../../Options";
 import type {DomSpan, SymbolNode} from "../../domTree";
@@ -19,8 +19,8 @@ export const assembleSupSub = (
     slant: number,
     baseShift: number,
 ): DomSpan => {
-    base = buildCommon.makeSpan([], [base]);
-    const subIsSingleCharacter = subGroup &&  utils.isCharacterBox(subGroup);
+    base = makeSpan([], [base]);
+    const subIsSingleCharacter = subGroup &&  isCharacterBox(subGroup);
     let sub;
     let sup;
     // We manually have to handle the superscripts and subscripts. This,
@@ -58,7 +58,7 @@ export const assembleSupSub = (
             sub.kern +
             base.depth + baseShift;
 
-        finalGroup = buildCommon.makeVList({
+        finalGroup = makeVList({
             positionType: "bottom",
             positionData: bottom,
             children: [
@@ -78,7 +78,7 @@ export const assembleSupSub = (
         // that we are supposed to shift the limits by 1/2 of the slant,
         // but since we are centering the limits adding a full slant of
         // margin will shift by 1/2 that.
-        finalGroup = buildCommon.makeVList({
+        finalGroup = makeVList({
             positionType: "top",
             positionData: top,
             children: [
@@ -91,7 +91,7 @@ export const assembleSupSub = (
     } else if (sup) {
         const bottom = base.depth + baseShift;
 
-        finalGroup = buildCommon.makeVList({
+        finalGroup = makeVList({
             positionType: "bottom",
             positionData: bottom,
             children: [
@@ -112,9 +112,9 @@ export const assembleSupSub = (
     if (sub && slant !== 0 && !subIsSingleCharacter) {
         // A negative margin-left was applied to the lower limit.
         // Avoid an overlap by placing a spacer on the left on the group.
-        const spacer = buildCommon.makeSpan(["mspace"], [], options);
+        const spacer = makeSpan(["mspace"], [], options);
         spacer.style.marginRight = makeEm(slant);
         parts.unshift(spacer);
     }
-    return buildCommon.makeSpan(["mop", "op-limits"], parts, options);
+    return makeSpan(["mop", "op-limits"], parts, options);
 };

package/src/functions/vcenter.js

@@ -1,7 +1,7 @@
 // @flow
 import defineFunction from "../defineFunction";
-import buildCommon from "../buildCommon";
-import mathMLTree from "../mathMLTree";
+import {makeVList} from "../buildCommon";
+import {MathNode} from "../mathMLTree";
 
 import * as html from "../buildHTML";
 import * as mml from "../buildMathML";
@@ -27,7 +27,7 @@ defineFunction({
         const body = html.buildGroup(group.body, options);
         const axisHeight = options.fontMetrics().axisHeight;
         const dy = 0.5 * ((body.height - axisHeight) - (body.depth + axisHeight));
-        return buildCommon.makeVList({
+        return makeVList({
             positionType: "shift",
             positionData: dy,
             children: [{type: "elem", elem: body}],
@@ -37,7 +37,7 @@ defineFunction({
         // There is no way to do this in MathML.
         // Write a class as a breadcrumb in case some post-processor wants
         // to perform a vcenter adjustment.
-        return new mathMLTree.MathNode(
+        return new MathNode(
             "mpadded", [mml.buildGroup(group.body, options)], ["vcenter"]);
     },
 });

package/src/functions/verb.js

@@ -1,7 +1,7 @@
 // @flow
 import defineFunction from "../defineFunction";
-import buildCommon from "../buildCommon";
-import mathMLTree from "../mathMLTree";
+import {makeSpan, makeSymbol, tryCombineChars} from "../buildCommon";
+import {MathNode, TextNode} from "../mathMLTree";
 import ParseError from "../ParseError";
 
 import type {ParseNode} from "../parseNode";
@@ -31,18 +31,18 @@ defineFunction({
             if (c === '~') {
                 c = '\\textasciitilde';
             }
-            body.push(buildCommon.makeSymbol(c, "Typewriter-Regular",
+            body.push(makeSymbol(c, "Typewriter-Regular",
                 group.mode, newOptions, ["mord", "texttt"]));
         }
-        return buildCommon.makeSpan(
+        return makeSpan(
             ["mord", "text"].concat(newOptions.sizingClasses(options)),
-            buildCommon.tryCombineChars(body),
+            tryCombineChars(body),
             newOptions,
         );
     },
     mathmlBuilder(group, options) {
-        const text = new mathMLTree.TextNode(makeVerb(group));
-        const node = new mathMLTree.MathNode("mtext", [text]);
+        const text = new TextNode(makeVerb(group));
+        const node = new MathNode("mtext", [text]);
         node.setAttribute("mathvariant", "monospace");
         return node;
     },

package/src/macros.js

@@ -287,7 +287,8 @@ defineMacro("\\underbar", "\\underline{\\text{#1}}");
 // It's thus treated like a \mathrel, but defined by a symbol that has zero
 // width but extends to the right.  We use \rlap to get that spacing.
 // For MathML we write U+0338 here. buildMathML.js will then do the overlay.
-defineMacro("\\not", '\\html@mathml{\\mathrel{\\mathrlap\\@not}}{\\char"338}');
+defineMacro("\\not", "\\html@mathml{\\mathrel{\\mathrlap\\@not}\\nobreak}" +
+    "{\\char\"338}");
 
 // Negated symbols from base/fontmath.ltx:
 // \def\neq{\not=} \let\ne=\neq
@@ -449,6 +450,8 @@ const dotsByToken = {
     '\\DOTSX': '\\dotsx',
 };
 
+const dotsbGroups = new Set(['bin', 'rel']);
+
 defineMacro("\\dots", function(context) {
     // TODO: If used in text mode, should expand to \textellipsis.
     // However, in KaTeX, \textellipsis and \ldots behave the same
@@ -462,7 +465,7 @@ defineMacro("\\dots", function(context) {
     } else if (next.slice(0, 4) === '\\not') {
         thedots = '\\dotsb';
     } else if (next in symbols.math) {
-        if (['bin', 'rel'].includes(symbols.math[next].group)) {
+        if (dotsbGroups.has(symbols.math[next].group)) {
             thedots = '\\dotsb';
         }
     }

package/src/mathMLTree.js

@@ -9,7 +9,7 @@
  * domTree.js, creating namespaced DOM nodes and HTML text markup respectively.
  */
 
-import utils from "./utils";
+import {escape} from "./utils";
 import {DocumentFragment} from "./tree";
 import {createClass} from "./domTree";
 import {makeEm} from "./units";
@@ -122,13 +122,13 @@ export class MathNode implements MathDomNode {
         for (const attr in this.attributes) {
             if (Object.prototype.hasOwnProperty.call(this.attributes, attr)) {
                 markup += " " + attr + "=\"";
-                markup += utils.escape(this.attributes[attr]);
+                markup += escape(this.attributes[attr]);
                 markup += "\"";
             }
         }
 
         if (this.classes.length > 0) {
-            markup += ` class ="${utils.escape(createClass(this.classes))}"`;
+            markup += ` class ="${escape(createClass(this.classes))}"`;
         }
 
         markup += ">";
@@ -172,7 +172,7 @@ export class TextNode implements MathDomNode {
      * (representing the text itself).
      */
     toMarkup(): string {
-        return utils.escape(this.toText());
+        return escape(this.toText());
     }
 
     /**
@@ -188,7 +188,7 @@ export class TextNode implements MathDomNode {
  * This node represents a space, but may render as <mspace.../> or as text,
  * depending on the width.
  */
-class SpaceNode implements MathDomNode {
+export class SpaceNode implements MathDomNode {
     width: number;
     character: ?string;
 
@@ -258,10 +258,3 @@ class SpaceNode implements MathDomNode {
         }
     }
 }
-
-export default {
-    MathNode,
-    TextNode,
-    SpaceNode,
-    newDocumentFragment,
-};

package/src/stretchy.js

@@ -6,12 +6,12 @@
  */
 
 import {LineNode, PathNode, SvgNode} from "./domTree";
-import buildCommon from "./buildCommon";
-import mathMLTree from "./mathMLTree";
+import {makeSpan, makeSvgSpan} from "./buildCommon";
+import {MathNode, TextNode} from "./mathMLTree";
 import {makeEm} from "./units";
 
 import type Options from "./Options";
-import type {ParseNode, AnyParseNode} from "./parseNode";
+import type {ParseNode} from "./parseNode";
 import type {DomSpan, HtmlDomNode, SvgSpan} from "./domTree";
 
 const stretchyCodePoint: {[string]: string} = {
@@ -59,10 +59,10 @@ const stretchyCodePoint: {[string]: string} = {
     "\\cdlongequal": "=",
 };
 
-const mathMLnode = function(label: string): mathMLTree.MathNode {
-    const node = new mathMLTree.MathNode(
+export const stretchyMathML = function(label: string): MathNode {
+    const node = new MathNode(
         "mo",
-        [new mathMLTree.TextNode(stretchyCodePoint[label.replace(/^\\/, '')])],
+        [new TextNode(stretchyCodePoint[label.replace(/^\\/, '')])],
     );
     node.setAttribute("stretchy", "true");
     return node;
@@ -170,15 +170,10 @@ const katexImagesData: {
         "shortrightharpoonabovebar"], 1.75, 716],
 };
 
-const groupLength = function(arg: AnyParseNode): number {
-    if (arg.type === "ordgroup") {
-        return arg.body.length;
-    } else {
-        return 1;
-    }
-};
+const wideAccentLabels =
+    new Set(["widehat", "widecheck", "widetilde", "utilde"]);
 
-const svgSpan = function(
+export const stretchySvg = function(
     group: ParseNode<"accent"> | ParseNode<"accentUnder"> | ParseNode<"xArrow">
          | ParseNode<"horizBrace">,
     options: Options,
@@ -191,14 +186,15 @@ const svgSpan = function(
     } {
         let viewBoxWidth = 400000;  // default
         const label = group.label.slice(1);
-        if (["widehat", "widecheck", "widetilde", "utilde"].includes(label)) {
+        if (wideAccentLabels.has(label)) {
             // Each type in the `if` statement corresponds to one of the ParseNode
             // types below. This narrowing is required to access `grp.base`.
             // $FlowFixMe
             const grp: ParseNode<"accent"> | ParseNode<"accentUnder"> = group;
             // There are four SVG images available for each function.
             // Choose a taller image when there are more characters.
-            const numChars = groupLength(grp.base);
+            const numChars = grp.base.type === "ordgroup" ?
+                grp.base.body.length : 1;
             let viewBoxHeight;
             let pathName;
             let height;
@@ -237,7 +233,7 @@ const svgSpan = function(
                 "preserveAspectRatio": "none",
             });
             return {
-                span: buildCommon.makeSvgSpan([], [svgNode], options),
+                span: makeSvgSpan([], [svgNode], options),
                 minWidth: 0,
                 height,
             };
@@ -278,7 +274,7 @@ const svgSpan = function(
                     "preserveAspectRatio": aligns[i] + " slice",
                 });
 
-                const span = buildCommon.makeSvgSpan(
+                const span = makeSvgSpan(
                     [widthClasses[i]], [svgNode], options);
                 if (numSvgChildren === 1) {
                     return {span, minWidth, height};
@@ -289,7 +285,7 @@ const svgSpan = function(
             }
 
             return {
-                span: buildCommon.makeSpan(["stretchy"], spans, options),
+                span: makeSpan(["stretchy"], spans, options),
                 minWidth,
                 height,
             };
@@ -308,7 +304,7 @@ const svgSpan = function(
     return span;
 };
 
-const encloseSpan = function(
+export const stretchyEnclose = function(
     inner: HtmlDomNode,
     label: string,
     topPad: number,
@@ -320,7 +316,7 @@ const encloseSpan = function(
     const totalHeight = inner.height + inner.depth + topPad + bottomPad;
 
     if (/fbox|color|angl/.test(label)) {
-        img = buildCommon.makeSpan(["stretchy", label], [], options);
+        img = makeSpan(["stretchy", label], [], options);
 
         if (label === "fbox") {
             const color = options.color && options.getColor();
@@ -360,7 +356,7 @@ const encloseSpan = function(
             "height": makeEm(totalHeight),
         });
 
-        img = buildCommon.makeSvgSpan([], [svgNode], options);
+        img = makeSvgSpan([], [svgNode], options);
     }
 
     img.height = totalHeight;
@@ -368,9 +364,3 @@ const encloseSpan = function(
 
     return img;
 };
-
-export default {
-    encloseSpan,
-    mathMLnode,
-    svgSpan,
-};

package/src/styles/fonts.scss

@@ -1,3 +1,5 @@
+@use "sass:list";
+
 $font-folder: "../../fonts" !default;
 $use-woff2: true !default;
 $use-woff: true !default;
@@ -7,13 +9,13 @@ $font-display: block !default;
 @function generate-src($family, $family-suffix) {
     $src: null;
     @if $use-woff2 {
-        $src: append($src, url('#{$font-folder}/KaTeX_#{$family}-#{$family-suffix}.woff2') format('woff2'), comma);
+        $src: list.append($src, url('#{$font-folder}/KaTeX_#{$family}-#{$family-suffix}.woff2') format('woff2'), comma);
     }
     @if $use-woff {
-        $src: append($src, url('#{$font-folder}/KaTeX_#{$family}-#{$family-suffix}.woff') format('woff'), comma);
+        $src: list.append($src, url('#{$font-folder}/KaTeX_#{$family}-#{$family-suffix}.woff') format('woff'), comma);
     }
     @if $use-ttf {
-        $src: append($src, url('#{$font-folder}/KaTeX_#{$family}-#{$family-suffix}.ttf') format('truetype'), comma);
+        $src: list.append($src, url('#{$font-folder}/KaTeX_#{$family}-#{$family-suffix}.ttf') format('truetype'), comma);
     }
 
     @return $src;

package/src/styles/katex-swap.scss

@@ -1,4 +1,7 @@
-@use 'katex' with (
+@use 'fonts.scss' with (
   $font-display: swap,
+);
+
+@use 'katex' with (
   $version: $version,
 );

package/src/styles/katex.scss

@@ -1,5 +1,7 @@
 /* stylelint-disable font-family-no-missing-generic-family-keyword */
-@import "./fonts.scss";
+@use "sass:list";
+@use "sass:math";
+@use "fonts.scss";
 
 // The mu unit is defined as 1/18 em
 $mu: calc(1em / 18);
@@ -341,11 +343,11 @@ $display-margin: 1em 0 !default;
     .fontsize-ensurer {
         $sizes: 0.5, 0.6, 0.7, 0.8, 0.9, 1, 1.2, 1.44, 1.728, 2.074, 2.488;
 
-        @for $from from 1 through length($sizes) {
-            @for $to from 1 through length($sizes) {
+        @for $from from 1 through list.length($sizes) {
+            @for $to from 1 through list.length($sizes) {
                 &.reset-size#{$from}.size#{$to} {
                     /* stylelint-disable-next-line */
-                    font-size: calc((nth($sizes, $to) / nth($sizes, $from)) * 1em);
+                    font-size: calc(math.div(list.nth($sizes, $to), list.nth($sizes, $from)) * 1em);
                 }
             }
         }

package/src/utils.js

@@ -6,20 +6,10 @@
 
 import type {AnyParseNode} from "./parseNode";
 
-/**
- * Provide a default value if a setting is undefined
- * NOTE: Couldn't use `T` as the output type due to facebook/flow#5022.
- */
-const deflt = function<T>(setting: T | void, defaultIfUndefined: T): * {
-    return setting === undefined ? defaultIfUndefined : setting;
-};
-
 // hyphenate and escape adapted from Facebook's React under Apache 2 license
-
 const uppercase = /([A-Z])/g;
-const hyphenate = function(str: string): string {
-    return str.replace(uppercase, "-$1").toLowerCase();
-};
+export const hyphenate = (str: string): string =>
+    str.replace(uppercase, "-$1").toLowerCase();
 
 const ESCAPE_LOOKUP = {
     "&": "&amp;",
@@ -34,16 +24,15 @@ const ESCAPE_REGEX = /[&><"']/g;
 /**
  * Escapes text to prevent scripting attacks.
  */
-function escape(text: mixed): string {
-    return String(text).replace(ESCAPE_REGEX, match => ESCAPE_LOOKUP[match]);
-}
+export const escape = (text: mixed): string =>
+    String(text).replace(ESCAPE_REGEX, match => ESCAPE_LOOKUP[match]);
 
 /**
  * Sometimes we want to pull out the innermost element of a group. In most
  * cases, this will just be the group itself, but when ordgroups and colors have
  * a single element, we want to pull that out.
  */
-const getBaseElem = function(group: AnyParseNode): AnyParseNode {
+export const getBaseElem = (group: AnyParseNode): AnyParseNode => {
     if (group.type === "ordgroup") {
         if (group.body.length === 1) {
             return getBaseElem(group.body[0]);
@@ -63,33 +52,22 @@ const getBaseElem = function(group: AnyParseNode): AnyParseNode {
     }
 };
 
+const characterNodesTypes = new Set(["mathord", "textord", "atom"]);
+
 /**
  * TeXbook algorithms often reference "character boxes", which are simply groups
  * with a single character in them. To decide if something is a character box,
  * we find its innermost group, and see if it is a single character.
  */
-const isCharacterBox = function(group: AnyParseNode): boolean {
-    const baseElem = getBaseElem(group);
-
-    // These are all they types of groups which hold single characters
-    return baseElem.type === "mathord" ||
-        baseElem.type === "textord" ||
-        baseElem.type === "atom";
-};
-
-export const assert = function<T>(value: ?T): T {
-    if (!value) {
-        throw new Error('Expected non-null, but got ' + String(value));
-    }
-    return value;
-};
+export const isCharacterBox = (group: AnyParseNode): boolean =>
+    characterNodesTypes.has(getBaseElem(group).type);
 
 /**
  * Return the protocol of a URL, or "_relative" if the URL does not specify a
  * protocol (and thus is relative), or `null` if URL has invalid protocol
  * (so should be outright rejected).
  */
-export const protocolFromUrl = function(url: string): string | null {
+export const protocolFromUrl = (url: string): string | null => {
     // Check for possible leading protocol.
     // https://url.spec.whatwg.org/#url-parsing strips leading whitespace
     // (U+20) or C0 control (U+00-U+1F) characters.
@@ -111,12 +89,3 @@ export const protocolFromUrl = function(url: string): string | null {
     // Lowercase the protocol
     return protocol[1].toLowerCase();
 };
-
-export default {
-    deflt,
-    escape,
-    hyphenate,
-    getBaseElem,
-    isCharacterBox,
-    protocolFromUrl,
-};