katex 0.16.32 → 0.16.34

package/src/{tree.js → tree.ts}

@@ -1,5 +1,3 @@
-// @flow
-
 import type {CssStyle, HtmlDomNode} from "./domTree";
 import type {MathDomNode} from "./mathMLTree";
 
@@ -16,16 +14,16 @@ export interface VirtualNode {
  * placed into the DOM doesn't have any representation itself. It only contains
  * children and doesn't have any DOM node properties.
  */
-export class DocumentFragment<ChildType: VirtualNode>
+export class DocumentFragment<ChildType extends VirtualNode>
     implements HtmlDomNode, MathDomNode {
-    children: $ReadOnlyArray<ChildType>;
+    children: ReadonlyArray<ChildType>;
     classes: string[];
     height: number;
     depth: number;
     maxFontSize: number;
     style: CssStyle;          // Never used; needed for satisfying interface.
 
-    constructor(children: $ReadOnlyArray<ChildType>) {
+    constructor(children: ReadonlyArray<ChildType>) {
         this.children = children;
         this.classes = [];
         this.height = 0;
@@ -68,8 +66,8 @@ export class DocumentFragment<ChildType: VirtualNode>
     toText(): string {
         // To avoid this, we would subclass documentFragment separately for
         // MathML, but polyfills for subclassing is expensive per PR 1469.
-        // $FlowFixMe: Only works for ChildType = MathDomNode.
-        const toText = (child: ChildType): string => child.toText();
+        // TODO(ts): Only works for ChildType = MathDomNode.
+        const toText = (child: ChildType): string => (child as unknown as MathDomNode).toText();
         return this.children.map(toText).join("");
     }
 }

package/src/{types.js → types.ts}

@@ -1,7 +1,6 @@
-// @flow
 
 /**
- * This file consists only of basic flow types used in multiple places.
+ * This file consists only of basic types used in multiple places.
  * For types with javascript, create separate files by themselves.
  */
 

package/src/unicodeAccents.js

@@ -2,7 +2,8 @@
 // math mode (when they exist).
 // This exports a CommonJS module, allowing to be required in unicodeSymbols
 // without transpiling.
-module.exports = {
+/** @type {Record<string, {text: string, math?: string}>} */
+const unicodeAccents = {
     '\u0301': {text: "\\'", math: '\\acute'},
     '\u0300': {text: '\\`', math: '\\grave'},
     '\u0308': {text: '\\"', math: '\\ddot'},
@@ -16,3 +17,5 @@ module.exports = {
     '\u030b': {text: '\\H'},
     '\u0327': {text: '\\c'},
 };
+
+module.exports = unicodeAccents;

package/src/{unicodeScripts.js → unicodeScripts.ts}

@@ -1,5 +1,3 @@
-// @flow
-
 /*
  * This file defines the Unicode scripts and script families that we
  * support. To add new scripts or families, just add a new entry to the
@@ -88,7 +86,7 @@ const scriptData: Array<Script> = [
  * Given a codepoint, return the name of the script or script family
  * it is from, or null if it is not part of a known block
  */
-export function scriptFromCodepoint(codepoint: number): ?string {
+export function scriptFromCodepoint(codepoint: number): string | null | undefined {
     for (let i = 0; i < scriptData.length; i++) {
         const script = scriptData[i];
         for (let i = 0; i < script.blocks.length; i++) {

package/src/{unicodeSupOrSub.js → unicodeSupOrSub.ts}

@@ -2,7 +2,7 @@
 
 export const unicodeSubRegEx = /^[₊₋₌₍₎₀₁₂₃₄₅₆₇₈₉ₐₑₕᵢⱼₖₗₘₙₒₚᵣₛₜᵤᵥₓᵦᵧᵨᵩᵪ]/;
 
-export const uSubsAndSups = Object.freeze({
+export const uSubsAndSups: Readonly<Record<string, string>> = Object.freeze({
     '₊': '+',
     '₋': '-',
     '₌': '=',

package/src/unicodeSymbols.js

@@ -1,12 +1,13 @@
-// @flow
+// @ts-check
 // This is an internal module, not part of the KaTeX distribution,
 // whose purpose is to generate `unicodeSymbols` in Parser.js
 // In this way, only this module, and not the distribution/browser,
 // needs String's normalize function. As this file is not transpiled,
-// Flow comment types syntax is used.
+// JSDoc type syntax is used.
 const accents = require('./unicodeAccents');
 
-const result /*: {[string]: string}*/ = {};
+/** @type {Record<string, string>} */
+const result = {};
 const letters = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ" +
     "αβγδεϵζηθϑικλμνξοπϖρϱςστυφϕχψωΓΔΘΛΞΠΣΥΦΨΩ";
 for (const letter of letters) {

package/src/{units.js → units.ts}

@@ -1,5 +1,3 @@
-// @flow
-
 /**
  * This file does conversion between units.  In particular, it provides
  * calculateSize to convert other units into ems.
@@ -12,7 +10,7 @@ import Options from "./Options";
 // Thus, multiplying a length by this number converts the length from units
 // into pts.  Dividing the result by ptPerEm gives the number of ems
 // *assuming* a font size of ptPerEm (normal size, normal style).
-const ptPerUnit = {
+const ptPerUnit: Record<string, number> = {
     // https://en.wikibooks.org/wiki/LaTeX/Lengths and
     // https://tex.stackexchange.com/a/8263
     "pt": 1,            // TeX point
@@ -37,7 +35,7 @@ const relativeUnit = {
     "mu": true,
 };
 
-export type Measurement = {| number: number, unit: string |};
+export type Measurement = { number: number, unit: string };
 
 /**
  * Determine whether the specified unit (either a string defining the unit

package/src/{utils.js → utils.ts}

@@ -1,4 +1,3 @@
-// @flow
 /**
  * This file contains a list of utility functions which are useful in other
  * files.
@@ -11,7 +10,7 @@ const uppercase = /([A-Z])/g;
 export const hyphenate = (str: string): string =>
     str.replace(uppercase, "-$1").toLowerCase();
 
-const ESCAPE_LOOKUP = {
+const ESCAPE_LOOKUP: Record<string, string> = {
     "&": "&amp;",
     ">": "&gt;",
     "<": "&lt;",
@@ -24,7 +23,7 @@ const ESCAPE_REGEX = /[&><"']/g;
 /**
  * Escapes text to prevent scripting attacks.
  */
-export const escape = (text: mixed): string =>
+export const escape = (text: unknown): string =>
     String(text).replace(ESCAPE_REGEX, match => ESCAPE_LOOKUP[match]);
 
 /**

package/src/{wide-character.js → wide-character.ts}

@@ -1,5 +1,3 @@
-// @flow
-
 /**
  * This file provides support for Unicode range U+1D400 to U+1D7FF,
  * Mathematical Alphanumeric Symbols.
@@ -21,7 +19,7 @@ import ParseError from "./ParseError";
  *      * The font name, so that KaTeX can get font metrics.
  */
 
-const wideLatinLetterData: Array<[string, string, string]> = [
+const wideLatinLetterData = [
     ["mathbf", "textbf", "Main-Bold"],                // A-Z bold upright
     ["mathbf", "textbf", "Main-Bold"],                // a-z bold upright
 
@@ -63,20 +61,20 @@ const wideLatinLetterData: Array<[string, string, string]> = [
 
     ["mathtt", "texttt", "Typewriter-Regular"],     // A-Z monospace
     ["mathtt", "texttt", "Typewriter-Regular"],     // a-z monospace
-];
+] as const satisfies readonly (readonly [string, string, string])[];
 
-const wideNumeralData: Array<[string, string, string]> = [
+const wideNumeralData = [
     ["mathbf", "textbf", "Main-Bold"],                // 0-9 bold
     ["", "", ""],                         // 0-9 double-struck. No KaTeX font.
     ["mathsf", "textsf", "SansSerif-Regular"],        // 0-9 sans-serif
     ["mathboldsf", "textboldsf", "SansSerif-Bold"],   // 0-9 bold sans-serif
     ["mathtt", "texttt", "Typewriter-Regular"],       // 0-9 monospace
-];
+] as const satisfies readonly (readonly [string, string, string])[];
 
-export const wideCharacterFont = function(
+export const wideCharacterFont = (
     wideChar: string,
     mode: Mode,
-): [string, string] {
+): [string, string] => {
 
     // IE doesn't support codePointAt(). So work with the surrogate pair.
     const H = wideChar.charCodeAt(0);    // high surrogate
@@ -89,12 +87,12 @@ export const wideCharacterFont = function(
         // wideLatinLetterData contains exactly 26 chars on each row.
         // So we can calculate the relevant row. No traverse necessary.
         const i = Math.floor((codePoint - 0x1D400) / 26);
-        return [wideLatinLetterData[i][2], wideLatinLetterData[i][j]];
+        return [wideLatinLetterData[i]![2], wideLatinLetterData[i]![j]];
 
     } else if (0x1D7CE <= codePoint && codePoint <= 0x1D7FF) {
         // Numerals, ten per row.
         const i = Math.floor((codePoint - 0x1D7CE) / 10);
-        return [wideNumeralData[i][2], wideNumeralData[i][j]];
+        return [wideNumeralData[i]![2], wideNumeralData[i]![j]];
 
     } else if (codePoint === 0x1D6A5 || codePoint === 0x1D6A6) {
         // dotless i or j

package/types/katex.d.ts

@@ -66,7 +66,7 @@ export interface KatexOptions {
      * If `true` the math will be rendered in display mode.
      * If `false` the math will be rendered in inline mode.
      * @see https://katex.org/docs/options
-     * 
+     *
      * @default false
      */
     displayMode?: boolean;
@@ -76,21 +76,21 @@ export interface KatexOptions {
      * - `mathml`: Outputs KaTeX in MathML only.
      * - `htmlAndMathml`: Outputs HTML for visual rendering and includes MathML
      * for accessibility.
-     * 
+     *
      * @default "htmlAndMathml"
      */
     output?: "html" | "mathml" | "htmlAndMathml";
     /**
      * If `true`, display math has `\tag`s rendered on the left instead of the
      * right, like `\usepackage[leqno]{amsmath}` in LaTeX.
-     * 
+     *
      * @default false
      */
     leqno?: boolean;
     /**
      * If `true`, display math renders flush left with a `2em` left margin,
      * like `\documentclass[fleqn]` in LaTeX with the `amsmath` package.
-     * 
+     *
      * @default false
      */
     fleqn?: boolean;
@@ -100,7 +100,7 @@ export interface KatexOptions {
      * If `false`, KaTeX will render unsupported commands as text, and render
      * invalid LaTeX as its source code with hover text giving the error, in
      * the color given by `errorColor`.
-     * 
+     *
      * @default true
      */
     throwOnError?: boolean;
@@ -108,7 +108,7 @@ export interface KatexOptions {
      * A color string given in the format `"#XXX"` or `"#XXXXXX"`. This option
      * determines the color that unsupported commands and invalid LaTeX are
      * rendered in when `throwOnError` is set to `false`.
-     * 
+     *
      * @default "#cc0000"
      */
     errorColor?: string;
@@ -116,7 +116,8 @@ export interface KatexOptions {
      * A collection of custom macros.
      * @see https://katex.org/docs/options
      */
-    macros?: Record<string, string | object | ((macroExpander:object) => string | object)>;
+    macros?: Record<string, string | object | ((macroExpander:object)
+        => string | object)>;
     /**
      * Specifies a minimum thickness, in ems, for fraction lines, `\sqrt` top
      * lines, `{array}` vertical lines, `\hline`, `\hdashline`, `\underline`,
@@ -138,7 +139,7 @@ export interface KatexOptions {
      * All user-specified sizes, e.g. in `\rule{500em}{500em}`, will be capped
      * to `maxSize` ems. If set to `Infinity` (the default), users can make
      * elements and spaces arbitrarily large.
-     * 
+     *
      * @default Infinity
      */
     maxSize?: number;
@@ -147,7 +148,7 @@ export interface KatexOptions {
      * e.g. infinite macro loops. `\edef` expansion counts all expanded tokens.
      * If set to `Infinity`, the macro expander will try to fully expand as in
      * LaTeX.
-     * 
+     *
      * @default 1000
      */
     maxExpand?: number;
@@ -164,7 +165,7 @@ export interface KatexOptions {
      * can also return `"ignore"`, `"error"`, or `"warn"` to use a built-in
      * behavior.
      * @see https://katex.org/docs/options
-     * 
+     *
      * @default "warn"
      */
     strict?:
@@ -179,7 +180,7 @@ export interface KatexOptions {
      * Provide a custom function `handler(context)` to customize behavior
      * depending on the context (command, arguments e.g. a URL, etc.).
      * @see https://katex.org/docs/options
-     * 
+     *
      * @default false
     */
     trust?: boolean | ((context: TrustContext) => boolean);
@@ -190,7 +191,7 @@ export interface KatexOptions {
      * constructs such as `\begin{equation}` and `$$` create a local group and
      * prevent definitions other than `\gdef` from becoming visible outside of
      * those blocks, so this is KaTeX's default behavior.
-     * 
+     *
      * @default false
      */
     globalGroup?: boolean;