katex 0.16.32 → 0.16.34

package/{katex.js → katex.ts}

@@ -1,4 +1,3 @@
-// @flow
 /* eslint no-console:0 */
 /**
  * This is the main entry point for KaTeX. Here, we expose functions for
@@ -32,13 +31,17 @@ import defineFunction from './src/defineFunction';
 import defineMacro from './src/defineMacro';
 import {setFontMetrics} from './src/fontMetrics';
 
-declare var __VERSION__: string;
+declare let __VERSION__: string;
 
 /**
  * Parse and build an expression, and place that expression in the DOM node
  * given.
  */
-let render: (string, Node, SettingsOptions) => void = function(
+let render: (
+    expression: string,
+    baseNode: Node,
+    options: SettingsOptions,
+) => void = function(
     expression: string,
     baseNode: Node,
     options: SettingsOptions,
@@ -78,7 +81,7 @@ const renderToString = function(
  */
 const generateParseTree = function(
     expression: string,
-    options: SettingsOptions,
+    options?: SettingsOptions,
 ): AnyParseNode[] {
     const settings = new Settings(options);
     return parseTree(expression, settings);
@@ -90,7 +93,7 @@ const generateParseTree = function(
  * error message.  Otherwise, simply throws the error.
  */
 const renderError = function(
-    error,
+    error: unknown,
     expression: string,
     options: Settings,
 ) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "katex",
-  "version": "0.16.32",
+  "version": "0.16.34",
   "description": "Fast math typesetting for the web.",
   "main": "dist/katex.js",
   "types": "types/katex.d.ts",
@@ -47,7 +47,7 @@
     "https://github.com/sponsors/katex"
   ],
   "files": [
-    "katex.js",
+    "katex.ts",
     "cli.js",
     "src/",
     "contrib/",
@@ -57,22 +57,25 @@
   "license": "MIT",
   "packageManager": "yarn@4.1.1",
   "devDependencies": {
-    "@babel/core": "^7.18.13",
-    "@babel/eslint-parser": "^7.18.9",
+    "@babel/core": "^7.29.0",
+    "@babel/eslint-parser": "^7.28.6",
     "@babel/plugin-proposal-class-properties": "^7.18.6",
-    "@babel/plugin-syntax-flow": "^7.18.6",
-    "@babel/plugin-transform-react-jsx": "^7.18.10",
-    "@babel/plugin-transform-runtime": "^7.18.10",
-    "@babel/preset-env": "^7.18.10",
-    "@babel/preset-flow": "^7.18.6",
-    "@babel/preset-react": "^7.18.6",
-    "@babel/register": "^7.18.9",
-    "@babel/runtime": "^7.18.9",
+    "@babel/plugin-transform-react-jsx": "^7.28.6",
+    "@babel/plugin-transform-runtime": "^7.29.0",
+    "@babel/preset-env": "^7.29.0",
+    "@babel/preset-react": "^7.28.5",
+    "@babel/preset-typescript": "^7.28.5",
+    "@babel/register": "^7.28.6",
+    "@babel/runtime": "^7.28.6",
     "@rollup/plugin-alias": "^3.1.9",
     "@rollup/plugin-babel": "^5.3.1",
+    "@rollup/plugin-commonjs": "^28.0.9",
+    "@rollup/plugin-typescript": "^12.3.0",
     "@semantic-release/changelog": "^6.0.1",
     "@semantic-release/git": "^10.0.1",
-    "babel-jest": "^29.0.1",
+    "@typescript-eslint/eslint-plugin": "^8.56.0",
+    "@typescript-eslint/parser": "^8.56.0",
+    "babel-jest": "^30.2.0",
     "babel-loader": "^8.2.5",
     "babel-plugin-istanbul": "^6.1.1",
     "babel-plugin-preval": "^5.1.0",
@@ -84,23 +87,21 @@
     "css-loader": "^6.7.1",
     "cssnano": "^5.1.13",
     "eslint": "^8.23.0",
-    "eslint-import-resolver-webpack": "^0.13.2",
+    "eslint-import-resolver-webpack": "^0.13.10",
     "eslint-plugin-actions": "^2.0.0",
-    "eslint-plugin-flowtype": "^8.0.3",
     "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-react": "^7.31.1",
-    "flow-bin": "^0.135.0",
     "fs-extra": "^10.1.0",
     "got": "^11.8.5",
     "husky": "^4.3.8",
     "istanbul-lib-coverage": "^3.2.0",
     "istanbul-lib-report": "^3.0.0",
     "istanbul-reports": "^3.1.5",
-    "jest": "^29.0.1",
-    "jest-diff": "^29.0.1",
-    "jest-environment-jsdom": "^29.0.1",
-    "jest-matcher-utils": "^29.0.1",
-    "jest-message-util": "^29.0.1",
+    "jest": "^30.2.0",
+    "jest-diff": "^30.2.0",
+    "jest-environment-jsdom": "^30.2.0",
+    "jest-matcher-utils": "^30.2.0",
+    "jest-message-util": "^30.2.0",
     "jest-serializer-html": "^7.1.0",
     "js-yaml": "^4.1.0",
     "json-stable-stringify": "^1.0.1",
@@ -126,6 +127,8 @@
     "stylelint-config-standard": "^28.0.0",
     "stylelint-scss": "^6.3.2",
     "terser-webpack-plugin": "^5.3.6",
+    "tslib": "^2.8.1",
+    "typescript": "^5.9.3",
     "webpack": "^5.74.0",
     "webpack-bundle-analyzer": "^4.6.1",
     "webpack-cli": "^4.10.0",
@@ -134,18 +137,18 @@
   },
   "bin": "cli.js",
   "scripts": {
-    "test": "yarn test:lint && yarn test:flow && yarn test:jest",
+    "test": "yarn test:lint && yarn test:ts && yarn test:jest",
     "test:lint": "yarn test:lint:js && yarn test:lint:css",
     "test:lint:js": "eslint .",
     "test:lint:css": "stylelint src/styles/katex.scss static/main.css website/static/**/*.css",
-    "test:flow": "flow",
     "test:jest": "jest",
     "test:jest:watch": "jest --watch",
     "test:jest:update": "jest --updateSnapshot",
     "test:jest:coverage": "jest --coverage",
     "test:screenshots": "yarn test:screenshots:update --verify",
     "test:screenshots:update": "dockers/screenshotter/screenshotter.sh",
-    "test:perf": "NODE_ENV=test node test/perf-test.js",
+    "test:perf": "NODE_ENV=test node -e \"require('@babel/register')({extensions:['.js','.ts']}); require('./test/perf-test.ts')\"",
+    "test:ts": "tsc --noEmit",
     "clean": "rm -rf dist/ node_modules/",
     "clean-install": "yarn clean && yarn",
     "start": "webpack serve --config webpack.dev.js",
@@ -169,28 +172,28 @@
   },
   "jest": {
     "collectCoverageFrom": [
-      "src/**/*.js",
-      "contrib/**/*.js",
-      "!src/unicodeSymbols.js",
+      "src/**/*.{js,ts}",
+      "contrib/**/*.{js,ts}",
+      "!src/unicodeSymbols.{js,ts}",
       "!contrib/mhchem/**"
     ],
     "setupFilesAfterEnv": [
-      "<rootDir>/test/setup.js"
+      "<rootDir>/test/setup.ts"
     ],
     "snapshotSerializers": [
       "jest-serializer-html"
     ],
     "testMatch": [
-      "**/test/*-spec.js"
+      "**/test/*-spec.ts"
     ],
     "testEnvironmentOptions": {
       "url": "http://localhost/"
     },
     "transform": {
-      "^.+\\.js$": "babel-jest"
+      "^.+\\.(js|ts)$": "babel-jest"
     },
     "moduleNameMapper": {
-      "^katex$": "<rootDir>/katex.js"
+      "^katex$": "<rootDir>/katex.ts"
     }
   }
 }

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

@@ -1,4 +1,3 @@
-// @flow
 /**
  * The Lexer class handles tokenizing the input in various ways. Since our
  * parser expects us to be able to backtrack, the lexer allows lexing from any
@@ -69,7 +68,7 @@ export default class Lexer implements LexerInterface {
     tokenRegex: RegExp;
     // Category codes. The lexer only supports comment characters (14) for now.
     // MacroExpander additionally distinguishes active (13).
-    catcodes: {[string]: number};
+    catcodes: Record<string, number>;
 
     constructor(input: string, settings: Settings) {
         // Separate accents from characters

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

@@ -1,4 +1,3 @@
-// @flow
 /**
  * This file contains the “gullet” where macros are expanded
  * until only non-macro tokens remain.
@@ -30,7 +29,7 @@ export const implicitCommands = {
 export default class MacroExpander implements MacroContextInterface {
     settings: Settings;
     expansionCount: number;
-    lexer: Lexer;
+    lexer!: Lexer;
     macros: Namespace<MacroDefinition>;
     stack: Token[];
     mode: Mode;
@@ -98,7 +97,7 @@ export default class MacroExpander implements MacroContextInterface {
      */
     popToken(): Token {
         this.future();  // ensure non-empty stack
-        return this.stack.pop();
+        return this.stack.pop()!;
     }
 
     /**
@@ -120,7 +119,7 @@ export default class MacroExpander implements MacroContextInterface {
      * Find an macro argument without expanding tokens and append the array of
      * tokens to the token stack. Uses Token as a container for the result.
      */
-    scanArgument(isOptional: boolean): ?Token {
+    scanArgument(isOptional: boolean): Token | null | undefined {
         let start;
         let end;
         let tokens;
@@ -160,7 +159,7 @@ export default class MacroExpander implements MacroContextInterface {
      * Consume an argument from the token stream, and return the resulting array
      * of tokens and start/end token.
      */
-    consumeArg(delims?: ?string[]): MacroArg {
+    consumeArg(delims?: string[] | null | undefined): MacroArg {
         // The argument for a delimited parameter is the shortest (possibly
         // empty) sequence of tokens with properly nested {...} groups that is
         // followed ... by this particular list of non-parameter tokens.
@@ -339,7 +338,7 @@ export default class MacroExpander implements MacroContextInterface {
     expandNextToken(): Token {
         for (;;) {
             if (this.expandOnce() === false) {  // fully expanded
-                const token = this.stack.pop();
+                const token = this.stack.pop()!;
                 // the token after \noexpand is interpreted as if its meaning
                 // were ‘\relax’
                 if (token.treatAsRelax) {
@@ -348,17 +347,13 @@ export default class MacroExpander implements MacroContextInterface {
                 return token;
             }
         }
-
-        // Flow unable to figure out that this pathway is impossible.
-        // https://github.com/facebook/flow/issues/4808
-        throw new Error(); // eslint-disable-line no-unreachable
     }
 
     /**
      * Fully expand the given macro name and return the resulting list of
      * tokens, or return `undefined` if no such macro is defined.
      */
-    expandMacro(name: string): Token[] | void {
+    expandMacro(name: string): Token[] | undefined {
         return this.macros.has(name)
             ? this.expandTokens([new Token(name)]) : undefined;
     }
@@ -369,13 +364,13 @@ export default class MacroExpander implements MacroContextInterface {
      * output tokens are in forward order.
      */
     expandTokens(tokens: Token[]): Token[] {
-        const output = [];
+        const output: Token[] = [];
         const oldStackLength = this.stack.length;
         this.pushTokens(tokens);
         while (this.stack.length > oldStackLength) {
             // Expand only expandable tokens
             if (this.expandOnce(true) === false) {  // fully expanded
-                const token = this.stack.pop();
+                const token = this.stack.pop()!;
                 if (token.treatAsRelax) {
                     // the expansion of \noexpand is the token itself
                     token.noexpand = false;
@@ -394,7 +389,7 @@ export default class MacroExpander implements MacroContextInterface {
      * Fully expand the given macro name and return the result as a string,
      * or return `undefined` if no such macro is defined.
      */
-    expandMacroAsText(name: string): string | void {
+    expandMacroAsText(name: string): string | undefined {
         const tokens = this.expandMacro(name);
         if (tokens) {
             return tokens.map((token) => token.text).join("");
@@ -407,8 +402,9 @@ export default class MacroExpander implements MacroContextInterface {
      * Returns the expanded macro as a reversed array of tokens and a macro
      * argument count.  Or returns `null` if no such macro.
      */
-    _getExpansion(name: string): ?MacroExpansion {
+    _getExpansion(name: string): MacroExpansion | null | undefined {
         const definition = this.macros.get(name);
+
         if (definition == null) { // mainly checking for undefined here
             return definition;
         }

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

@@ -1,4 +1,3 @@
-// @flow
 
 /**
  * A `Namespace` refers to a space of nameable things like macros or lengths,
@@ -9,13 +8,12 @@
  */
 
 import ParseError from "./ParseError";
-
-export type Mapping<Value> = {[string]: Value};
+export type Mapping<Value> = Record<string, Value>;
 
 export default class Namespace<Value> {
     current: Mapping<Value>;
     builtins: Mapping<Value>;
-    undefStack: Mapping<?Value>[];
+    undefStack: Mapping<Value | null | undefined>[];
 
     /**
      * Both arguments are optional.  The first argument is an object of
@@ -84,7 +82,7 @@ export default class Namespace<Value> {
      * to `false` in JavaScript.  Use `if (namespace.get(...) != null)` or
      * `if (namespace.has(...))`.
      */
-    get(name: string): ?Value {
+    get(name: string): Value | null | undefined {
         if (this.current.hasOwnProperty(name)) {
             return this.current[name];
         } else {
@@ -99,7 +97,7 @@ export default class Namespace<Value> {
      * operation at every level, so takes time linear in their number.
      * A value of undefined means to delete existing definitions.
      */
-    set(name: string, value: ?Value, global: boolean = false) {
+    set(name: string, value: Value | null | undefined, global: boolean = false) {
         if (global) {
             // Global set is equivalent to setting in all groups.  Simulate this
             // by destroying any undos currently scheduled for this name,

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

@@ -1,4 +1,3 @@
-// @flow
 /**
  * This file contains information about the options that the Parser carries
  * around with it while parsing. Data is held in an `Options` object, and when
@@ -42,7 +41,7 @@ export type FontShape = "textit" | "textup" | "";
 
 export type OptionsData = {
     style: StyleInterface;
-    color?: string | void;
+    color?: string | undefined;
     size?: number;
     textSize?: number;
     phantom?: boolean;
@@ -64,7 +63,7 @@ export type OptionsData = {
  */
 class Options {
     style: StyleInterface;
-    color: string | void;
+    color: string | undefined;
     size: number;
     textSize: number;
     phantom: boolean;
@@ -78,7 +77,7 @@ class Options {
     sizeMultiplier: number;
     maxSize: number;
     minRuleThickness: number;
-    _fontMetrics: FontMetrics | void;
+    _fontMetrics: FontMetrics | undefined;
 
     /**
      * The base size index.
@@ -105,8 +104,8 @@ class Options {
      * Returns a new options object with the same properties as "this".  Properties
      * from "extension" will be copied to the new options object.
      */
-    extend(extension: $Shape<OptionsData>): Options {
-        const data = {
+    extend(extension: Partial<OptionsData>): Options {
+        const data: OptionsData = {
             style: this.style,
             size: this.size,
             textSize: this.textSize,
@@ -120,11 +119,7 @@ class Options {
             minRuleThickness: this.minRuleThickness,
         };
 
-        for (const key in extension) {
-            if (extension.hasOwnProperty(key)) {
-                data[key] = extension[key];
-            }
-        }
+        Object.assign(data, extension);
 
         return new Options(data);
     }
@@ -307,7 +302,7 @@ class Options {
     /**
      * Gets the CSS color of the current options object
      */
-    getColor(): string | void {
+    getColor(): string | undefined {
         if (this.phantom) {
             return "transparent";
         } else {

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

@@ -1,4 +1,3 @@
-// @flow
 import {Token} from "./Token";
 
 import type {AnyParseNode} from "./parseNode";
@@ -11,19 +10,19 @@ import type {AnyParseNode} from "./parseNode";
  * If possible, a caller should provide a Token or ParseNode with information
  * about where in the source string the problem occurred.
  */
-class ParseError {
-    name: "ParseError";
-    position: number | void;
-        // Error start position based on passed-in Token or ParseNode.
-    length: number | void;
-        // Length of affected text based on passed-in Token or ParseNode.
-    rawMessage: string | void;
-        // The underlying error message without any context added.
+class ParseError extends Error {
+    override name = "ParseError" as const;
+    position: number | undefined;
+    // Error start position based on passed-in Token or ParseNode.
+    length: number | undefined;
+    // Length of affected text based on passed-in Token or ParseNode.
+    rawMessage: string;
+    // The underlying error message without any context added.
 
     constructor(
-        message: string,               // The error message
-        token?: ?Token | AnyParseNode, // An object providing position information
-    ): ParseError {
+        message: string, // The error message
+        token?: Token | null | undefined | AnyParseNode,
+    ) {
         let error = "KaTeX parse error: " + message;
         let start;
         let end;
@@ -64,23 +63,14 @@ class ParseError {
 
         }
 
-        // Some hackery to make ParseError a prototype of Error
-        // See http://stackoverflow.com/a/8460753
-        // $FlowFixMe
-        const self: ParseError = new Error(error);
-        self.name = "ParseError";
-        // $FlowFixMe
-        self.__proto__ = ParseError.prototype;
-        self.position = start;
+        super(error);
+        Object.setPrototypeOf(this, ParseError.prototype);
+        this.position = start;
         if (start != null && end != null) {
-            self.length = end - start;
+            this.length = end - start;
         }
-        self.rawMessage = message;
-        return self;
+        this.rawMessage = message;
     }
 }
 
-// $FlowFixMe More hackery
-ParseError.prototype.__proto__ = Error.prototype;
-
 export default ParseError;