chore(ckeditor5-math): integrate source code

2025-10-31 18:36:30 +01:00 · 2025-05-04 22:16:32 +03:00
parent ee6e111a85
commit 5d42b942ba
19 changed files with 67 additions and 168 deletions
--- a/packages/ckeditor5-math/src/typings-external.ts
+++ b/packages/ckeditor5-math/src/typings-external.ts
@@ -0,0 +1,156 @@
+/**
+ * Basic typings for third party, external libraries (KaTeX, MathJax).
+ */
+export interface MathJax3 {
+	version: string;
+	tex2chtmlPromise?: ( input: string, options: { display: boolean } ) => Promise<HTMLElement>;
+	tex2svgPromise?: ( input: string, options: { display: boolean } ) => Promise<HTMLElement>;
+}
+
+export interface MathJax2 {
+	Hub: { Queue: ( callback: [string, MathJax2['Hub'], string | HTMLElement] | ( () => void ) ) => void };
+}
+
+export interface Katex {
+	render( equation: string, el: HTMLElement, options: KatexOptions ): void;
+}
+
+declare global {
+	// eslint-disable-next-line no-var
+	var CKEDITOR_MATH_LAZY_LOAD: undefined | Promise<void>;
+	// eslint-disable-next-line no-var
+	var MathJax: undefined | MathJax2 | MathJax3;
+	// eslint-disable-next-line no-var
+	var katex: undefined | Katex;
+}
+
+export interface KatexOptions {
+
+    /**
+     * If `true`, math will be rendered in display mode
+     * (math in display style and center math on page)
+     *
+     * If `false`, math will be rendered in inline mode
+     * @default false
+     */
+    displayMode?: boolean | undefined;
+
+    /**
+     * Determines the markup language of the output. The valid choices are:
+     * - `html`: Outputs KaTeX in HTML only.
+     * - `mathml`: Outputs KaTeX in MathML only.
+     * - `htmlAndMathml`: Outputs HTML for visual rendering
+     *   and includes MathML for accessibility.
+     *
+     * @default 'htmlAndMathml'
+     */
+    output?: 'html' | 'mathml' | 'htmlAndMathml' | undefined;
+
+    /**
+     * If `true`, display math has \tags rendered on the left
+     * instead of the right, like \usepackage[leqno]{amsmath} in LaTeX.
+     *
+     * @default false
+     */
+    leqno?: boolean | undefined;
+
+    /**
+     * 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 | undefined;
+
+    /**
+     * If `true`, KaTeX will throw a `ParseError` when
+     * it encounters an unsupported command or invalid LaTex
+     *
+     * If `false`, KaTeX will render unsupported commands as
+     * text, and render invalid LaTeX as its source code with
+     * hover text giving the error, in color given by errorColor
+     * @default true
+     */
+    throwOnError?: boolean | undefined;
+
+    /**
+     * A Color string given in format `#XXX` or `#XXXXXX`
+     */
+    errorColor?: string | undefined;
+
+    /**
+     * A collection of custom macros.
+     *
+     * See `src/macros.js` for its usage
+     */
+    macros?: unknown;
+
+    /**
+     * Specifies a minimum thickness, in ems, for fraction lines,
+     * \sqrt top lines, {array} vertical lines, \hline, \hdashline,
+     * \underline, \overline, and the borders of \fbox, \boxed, and
+     * \fcolorbox.
+     */
+    minRuleThickness?: number | undefined;
+
+    /**
+     * If `true`, `\color` will work like LaTeX's `\textcolor`
+     * and takes 2 arguments
+     *
+     * If `false`, `\color` will work like LaTeX's `\color`
+     * and takes 1 argument
+     *
+     * In both cases, `\textcolor` works as in LaTeX
+     *
+     * @default false
+     */
+    colorIsTextColor?: boolean | undefined;
+
+    /**
+     * All user-specified sizes will be caped to `maxSize` ems
+     *
+     * If set to Infinity, users can make elements and space
+     * arbitrarily large
+     *
+     * @default Infinity
+     */
+    maxSize?: number | undefined;
+
+    /**
+     * Limit the number of macro expansions to specified number
+     *
+     * If set to `Infinity`, marco expander will try to fully expand
+     * as in LaTex
+     *
+     * @default 1000
+     */
+    maxExpand?: number | undefined;
+
+    /**
+     * If `false` or `"ignore"`, allow features that make
+     * writing in LaTex convenient but not supported by LaTex
+     *
+     * If `true` or `"error"`, throw an error for such transgressions
+     *
+     * If `"warn"`, warn about behavior via `console.warn`
+     *
+     * @default "warn"
+     */
+    strict?: boolean | string | Function | undefined;
+
+    /**
+     * If `false` (do not trust input), prevent any commands that could enable adverse behavior, rendering them instead in errorColor.
+     *
+     * If `true` (trust input), allow all such commands.
+     *
+     * @default false
+     */
+    trust?: boolean | ( ( context: object ) => boolean ) | undefined;
+
+    /**
+     * Place KaTeX code in the global group.
+     *
+     * @default false
+     */
+    globalGroup?: boolean | undefined;
+}