@temelj/mdx 0.13.0 → 0.14.0

package/dist/mod.d.mts

@@ -1,8 +1,9 @@
 import { HastElement as Element, HastNode as Node } from "./types.mjs";
 import { MdxArtifact, MdxCompileError, MdxCompileOptions, MdxCompiler, MdxMessage, MdxMessagePlace, MdxMessagePoint, MdxSource, remarkFrontmatterPlugin, remarkGfmPlugin } from "./compiler.mjs";
 import { HeadingIdPluginOptions, headingIdPlugin } from "./plugins/heading-id/plugin.mjs";
+import { InlineMathStyle, KatexPluginOptions, katexPlugin } from "./plugins/katex/plugin.mjs";
 import { removeImportsExportsPlugin } from "./plugins/remove-imports-exports.mjs";
 import { SyntaxHighlightPluginOptions, syntaxHighlightPlugin } from "./plugins/syntax-highlight/plugin.mjs";
 import { MdxTreeProcessor, treeProcessorPlugin } from "./plugins/tree-processor/plugin.mjs";
 import "./plugins/mod.mjs";
-export { type Element as HastElement, type Node as HastNode, HeadingIdPluginOptions, MdxArtifact, MdxCompileError, MdxCompileOptions, MdxCompiler, MdxMessage, MdxMessagePlace, MdxMessagePoint, MdxSource, MdxTreeProcessor, SyntaxHighlightPluginOptions, headingIdPlugin, remarkFrontmatterPlugin, remarkGfmPlugin, removeImportsExportsPlugin, syntaxHighlightPlugin, treeProcessorPlugin };
+export { type Element as HastElement, type Node as HastNode, HeadingIdPluginOptions, InlineMathStyle, KatexPluginOptions, MdxArtifact, MdxCompileError, MdxCompileOptions, MdxCompiler, MdxMessage, MdxMessagePlace, MdxMessagePoint, MdxSource, MdxTreeProcessor, SyntaxHighlightPluginOptions, headingIdPlugin, katexPlugin, remarkFrontmatterPlugin, remarkGfmPlugin, removeImportsExportsPlugin, syntaxHighlightPlugin, treeProcessorPlugin };

package/dist/mod.mjs

@@ -1,7 +1,8 @@
 import { MdxCompileError, MdxCompiler, remarkFrontmatterPlugin, remarkGfmPlugin } from "./compiler.mjs";
 import { headingIdPlugin } from "./plugins/heading-id/plugin.mjs";
+import { katexPlugin } from "./plugins/katex/plugin.mjs";
 import { removeImportsExportsPlugin } from "./plugins/remove-imports-exports.mjs";
 import { syntaxHighlightPlugin } from "./plugins/syntax-highlight/plugin.mjs";
 import { treeProcessorPlugin } from "./plugins/tree-processor/plugin.mjs";
 import "./plugins/mod.mjs";
-export { MdxCompileError, MdxCompiler, headingIdPlugin, remarkFrontmatterPlugin, remarkGfmPlugin, removeImportsExportsPlugin, syntaxHighlightPlugin, treeProcessorPlugin };
+export { MdxCompileError, MdxCompiler, headingIdPlugin, katexPlugin, remarkFrontmatterPlugin, remarkGfmPlugin, removeImportsExportsPlugin, syntaxHighlightPlugin, treeProcessorPlugin };

package/dist/plugins/katex/plugin.d.mts

@@ -0,0 +1,39 @@
+import { HastNode as Node } from "../../types.mjs";
+import { KatexOptions } from "katex";
+import { Plugin } from "unified";
+//#region src/plugins/katex/plugin.d.ts
+declare const inlineMathStyleCommands: {
+  readonly display: string;
+  readonly script: string;
+  readonly scriptscript: string;
+  readonly text: string;
+};
+type KatexRenderOptions = Omit<KatexOptions, "displayMode" | "throwOnError">;
+/**
+ * TeX math style applied to inline math.
+ *
+ * `"auto"` preserves the source and KaTeX's default style.
+ */
+type InlineMathStyle = "auto" | keyof typeof inlineMathStyleCommands;
+/**
+ * KaTeX options controlled by callers. Rendering mode and error handling are
+ * inferred and enforced by the plugin.
+ */
+type KatexPluginOptions = KatexRenderOptions & {
+  /**
+   * TeX math style applied to inline-math nodes.
+   *
+   * Display and fenced math are not affected.
+   *
+   * @default "auto"
+   */
+  inlineMathStyle?: InlineMathStyle;
+};
+/**
+ * Renders HAST elements marked as inline, display, or fenced-code math with
+ * KaTeX.
+ */
+declare const katexPlugin: Plugin<[Readonly<KatexPluginOptions>?], Node, Node>;
+//#endregion
+export { InlineMathStyle, KatexPluginOptions, katexPlugin };
+//# sourceMappingURL=plugin.d.mts.map

package/dist/plugins/katex/plugin.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.d.mts","names":[],"sources":["../../../src/plugins/katex/plugin.ts"],"mappings":";;;;cAgBM;WACJ;WACA;WACA;WACA;;KAGG,qBAAqB,KAAK;;;;;;KAOnB,wCAAwC;;;;;KAMxC,qBAAqB;;;;;;;;EAQ/B,kBAAkB;;;;;;cAOP,aAAa,QAAQ,SAAS,uBAAuB,MAAU"}

package/dist/plugins/katex/plugin.mjs

@@ -0,0 +1,107 @@
+import { fromHtmlIsomorphic } from "hast-util-from-html-isomorphic";
+import { toText } from "hast-util-to-text";
+import katex from "katex";
+import { SKIP, visitParents } from "unist-util-visit-parents";
+//#region src/plugins/katex/plugin.ts
+const mathClasses = {
+	display: "math-display",
+	inline: "math-inline",
+	language: "language-math"
+};
+const inlineMathStyleCommands = {
+	display: String.raw`\displaystyle`,
+	script: String.raw`\scriptstyle`,
+	scriptscript: String.raw`\scriptscriptstyle`,
+	text: String.raw`\textstyle`
+};
+/**
+* Renders HAST elements marked as inline, display, or fenced-code math with
+* KaTeX.
+*/
+const katexPlugin = (options = {}) => {
+	const { inlineMathStyle = "auto", ...katexOptions } = options;
+	return (tree, file) => {
+		visitParents(tree, "element", (element, ancestors) => {
+			const classes = Array.isArray(element.properties.className) ? element.properties.className : [];
+			const isLanguageMath = classes.includes(mathClasses.language);
+			const isDisplayMath = classes.includes(mathClasses.display);
+			const isInlineMath = classes.includes(mathClasses.inline);
+			if (!isLanguageMath && !isDisplayMath && !isInlineMath) return;
+			let scope = element;
+			let parent = ancestors.at(-1);
+			let displayMode = isDisplayMath;
+			if (element.tagName === "code" && isLanguageMath && parent?.type === "element" && parent.tagName === "pre") {
+				scope = parent;
+				parent = ancestors.at(-2);
+				displayMode = true;
+			}
+			if (parent === void 0 || parent.type !== "element" && parent.type !== "root") return;
+			const value = toText(scope, { whitespace: "pre" });
+			const renderedValue = isInlineMath && !displayMode ? applyInlineMathStyle(value, inlineMathStyle) : value;
+			let result;
+			try {
+				result = renderMath(renderedValue, katexOptions, displayMode);
+			} catch (error) {
+				const cause = getOriginalRenderError(value, katexOptions, displayMode, error);
+				file.message("Could not render math with KaTeX", {
+					ancestors: [...ancestors, element],
+					cause,
+					place: element.position,
+					ruleId: cause.name.toLowerCase(),
+					source: "rehype-katex"
+				});
+				try {
+					result = renderMath(value, {
+						...katexOptions,
+						strict: "ignore"
+					}, displayMode, false);
+				} catch {
+					result = [{
+						type: "element",
+						tagName: "span",
+						properties: {
+							className: ["katex-error"],
+							style: `color:${katexOptions.errorColor ?? "#cc0000"}`,
+							title: String(cause)
+						},
+						children: [{
+							type: "text",
+							value
+						}]
+					}];
+				}
+			}
+			const index = parent.children.indexOf(scope);
+			if (index !== -1) parent.children.splice(index, 1, ...result);
+			return SKIP;
+		});
+		return tree;
+	};
+};
+function getOriginalRenderError(value, options, displayMode, styledError) {
+	try {
+		katex.renderToString(value, {
+			...options,
+			displayMode,
+			throwOnError: true
+		});
+	} catch (error) {
+		return error instanceof Error ? error : new Error(String(error));
+	}
+	return styledError instanceof Error ? styledError : new Error(String(styledError));
+}
+function applyInlineMathStyle(value, style) {
+	if (style === "auto") return value;
+	return `{${inlineMathStyleCommands[style]} ${value}}`;
+}
+function renderMath(value, options, displayMode, throwOnError = true) {
+	return fromHtmlIsomorphic(katex.renderToString(value, {
+		...options,
+		displayMode,
+		throwOnError
+	}), { fragment: true }).children;
+}
+//#endregion
+export { katexPlugin };
+
+//# sourceMappingURL=plugin.mjs.map

package/dist/plugins/katex/plugin.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.mjs","names":[],"sources":["../../../src/plugins/katex/plugin.ts"],"sourcesContent":["import type { Element, ElementContent, Root } from \"hast\";\nimport type { Plugin } from \"unified\";\n\nimport { fromHtmlIsomorphic } from \"hast-util-from-html-isomorphic\";\nimport { toText } from \"hast-util-to-text\";\nimport katex, { type KatexOptions } from \"katex\";\nimport { SKIP, visitParents } from \"unist-util-visit-parents\";\n\nimport type { HastNode } from \"../../types\";\n\nconst mathClasses = {\n  display: \"math-display\",\n  inline: \"math-inline\",\n  language: \"language-math\",\n} as const;\n\nconst inlineMathStyleCommands = {\n  display: String.raw`\\displaystyle`,\n  script: String.raw`\\scriptstyle`,\n  scriptscript: String.raw`\\scriptscriptstyle`,\n  text: String.raw`\\textstyle`,\n} as const;\n\ntype KatexRenderOptions = Omit<KatexOptions, \"displayMode\" | \"throwOnError\">;\n\n/**\n * TeX math style applied to inline math.\n *\n * `\"auto\"` preserves the source and KaTeX's default style.\n */\nexport type InlineMathStyle = \"auto\" | keyof typeof inlineMathStyleCommands;\n\n/**\n * KaTeX options controlled by callers. Rendering mode and error handling are\n * inferred and enforced by the plugin.\n */\nexport type KatexPluginOptions = KatexRenderOptions & {\n  /**\n   * TeX math style applied to inline-math nodes.\n   *\n   * Display and fenced math are not affected.\n   *\n   * @default \"auto\"\n   */\n  inlineMathStyle?: InlineMathStyle;\n};\n\n/**\n * Renders HAST elements marked as inline, display, or fenced-code math with\n * KaTeX.\n */\nexport const katexPlugin: Plugin<[Readonly<KatexPluginOptions>?], HastNode, HastNode> = (\n  options = {},\n) => {\n  const { inlineMathStyle = \"auto\", ...katexOptions } = options;\n\n  return (tree, file) => {\n    visitParents(tree as Root, \"element\", (element, ancestors) => {\n      const classes = Array.isArray(element.properties.className)\n        ? element.properties.className\n        : [];\n      const isLanguageMath = classes.includes(mathClasses.language);\n      const isDisplayMath = classes.includes(mathClasses.display);\n      const isInlineMath = classes.includes(mathClasses.inline);\n\n      if (!isLanguageMath && !isDisplayMath && !isInlineMath) {\n        return;\n      }\n\n      let scope: Element = element;\n      let parent = ancestors.at(-1);\n      let displayMode = isDisplayMath;\n\n      if (\n        element.tagName === \"code\" &&\n        isLanguageMath &&\n        parent?.type === \"element\" &&\n        parent.tagName === \"pre\"\n      ) {\n        scope = parent;\n        parent = ancestors.at(-2);\n        displayMode = true;\n      }\n\n      if (parent === undefined || (parent.type !== \"element\" && parent.type !== \"root\")) {\n        return;\n      }\n\n      const value = toText(scope, { whitespace: \"pre\" });\n      const renderedValue =\n        isInlineMath && !displayMode ? applyInlineMathStyle(value, inlineMathStyle) : value;\n      let result: ElementContent[];\n\n      try {\n        result = renderMath(renderedValue, katexOptions, displayMode);\n      } catch (error) {\n        const cause = getOriginalRenderError(value, katexOptions, displayMode, error);\n\n        file.message(\"Could not render math with KaTeX\", {\n          ancestors: [...ancestors, element],\n          cause,\n          place: element.position,\n          ruleId: cause.name.toLowerCase(),\n          source: \"rehype-katex\",\n        });\n\n        try {\n          result = renderMath(value, { ...katexOptions, strict: \"ignore\" }, displayMode, false);\n        } catch {\n          result = [\n            {\n              type: \"element\",\n              tagName: \"span\",\n              properties: {\n                className: [\"katex-error\"],\n                style: `color:${katexOptions.errorColor ?? \"#cc0000\"}`,\n                title: String(cause),\n              },\n              children: [{ type: \"text\", value }],\n            },\n          ];\n        }\n      }\n\n      const index = parent.children.indexOf(scope);\n      if (index !== -1) {\n        parent.children.splice(index, 1, ...result);\n      }\n\n      return SKIP;\n    });\n\n    return tree;\n  };\n};\n\nfunction getOriginalRenderError(\n  value: string,\n  options: Readonly<KatexRenderOptions>,\n  displayMode: boolean,\n  styledError: unknown,\n): Error {\n  try {\n    katex.renderToString(value, {\n      ...options,\n      displayMode,\n      throwOnError: true,\n    });\n  } catch (error) {\n    return error instanceof Error ? error : new Error(String(error));\n  }\n\n  return styledError instanceof Error ? styledError : new Error(String(styledError));\n}\n\nfunction applyInlineMathStyle(value: string, style: InlineMathStyle): string {\n  if (style === \"auto\") {\n    return value;\n  }\n\n  return `{${inlineMathStyleCommands[style]} ${value}}`;\n}\n\nfunction renderMath(\n  value: string,\n  options: Readonly<KatexRenderOptions>,\n  displayMode: boolean,\n  throwOnError = true,\n): ElementContent[] {\n  const html = katex.renderToString(value, {\n    ...options,\n    displayMode,\n    throwOnError,\n  });\n  const root = fromHtmlIsomorphic(html, { fragment: true });\n\n  // KaTeX emits an HTML fragment and therefore cannot produce doctypes.\n  return root.children as ElementContent[];\n}\n"],"mappings":";;;;;AAUA,MAAM,cAAc;CAClB,SAAS;CACT,QAAQ;CACR,UAAU;AACZ;AAEA,MAAM,0BAA0B;CAC9B,SAAS,OAAO,GAAG;CACnB,QAAQ,OAAO,GAAG;CAClB,cAAc,OAAO,GAAG;CACxB,MAAM,OAAO,GAAG;AAClB;;;;;AA8BA,MAAa,eACX,UAAU,CAAC,MACR;CACH,MAAM,EAAE,kBAAkB,QAAQ,GAAG,iBAAiB;CAEtD,QAAQ,MAAM,SAAS;EACrB,aAAa,MAAc,YAAY,SAAS,cAAc;GAC5D,MAAM,UAAU,MAAM,QAAQ,QAAQ,WAAW,SAAS,IACtD,QAAQ,WAAW,YACnB,CAAC;GACL,MAAM,iBAAiB,QAAQ,SAAS,YAAY,QAAQ;GAC5D,MAAM,gBAAgB,QAAQ,SAAS,YAAY,OAAO;GAC1D,MAAM,eAAe,QAAQ,SAAS,YAAY,MAAM;GAExD,IAAI,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,cACxC;GAGF,IAAI,QAAiB;GACrB,IAAI,SAAS,UAAU,GAAG,EAAE;GAC5B,IAAI,cAAc;GAElB,IACE,QAAQ,YAAY,UACpB,kBACA,QAAQ,SAAS,aACjB,OAAO,YAAY,OACnB;IACA,QAAQ;IACR,SAAS,UAAU,GAAG,EAAE;IACxB,cAAc;GAChB;GAEA,IAAI,WAAW,KAAA,KAAc,OAAO,SAAS,aAAa,OAAO,SAAS,QACxE;GAGF,MAAM,QAAQ,OAAO,OAAO,EAAE,YAAY,MAAM,CAAC;GACjD,MAAM,gBACJ,gBAAgB,CAAC,cAAc,qBAAqB,OAAO,eAAe,IAAI;GAChF,IAAI;GAEJ,IAAI;IACF,SAAS,WAAW,eAAe,cAAc,WAAW;GAC9D,SAAS,OAAO;IACd,MAAM,QAAQ,uBAAuB,OAAO,cAAc,aAAa,KAAK;IAE5E,KAAK,QAAQ,oCAAoC;KAC/C,WAAW,CAAC,GAAG,WAAW,OAAO;KACjC;KACA,OAAO,QAAQ;KACf,QAAQ,MAAM,KAAK,YAAY;KAC/B,QAAQ;IACV,CAAC;IAED,IAAI;KACF,SAAS,WAAW,OAAO;MAAE,GAAG;MAAc,QAAQ;KAAS,GAAG,aAAa,KAAK;IACtF,QAAQ;KACN,SAAS,CACP;MACE,MAAM;MACN,SAAS;MACT,YAAY;OACV,WAAW,CAAC,aAAa;OACzB,OAAO,SAAS,aAAa,cAAc;OAC3C,OAAO,OAAO,KAAK;MACrB;MACA,UAAU,CAAC;OAAE,MAAM;OAAQ;MAAM,CAAC;KACpC,CACF;IACF;GACF;GAEA,MAAM,QAAQ,OAAO,SAAS,QAAQ,KAAK;GAC3C,IAAI,UAAU,IACZ,OAAO,SAAS,OAAO,OAAO,GAAG,GAAG,MAAM;GAG5C,OAAO;EACT,CAAC;EAED,OAAO;CACT;AACF;AAEA,SAAS,uBACP,OACA,SACA,aACA,aACO;CACP,IAAI;EACF,MAAM,eAAe,OAAO;GAC1B,GAAG;GACH;GACA,cAAc;EAChB,CAAC;CACH,SAAS,OAAO;EACd,OAAO,iBAAiB,QAAQ,QAAQ,IAAI,MAAM,OAAO,KAAK,CAAC;CACjE;CAEA,OAAO,uBAAuB,QAAQ,cAAc,IAAI,MAAM,OAAO,WAAW,CAAC;AACnF;AAEA,SAAS,qBAAqB,OAAe,OAAgC;CAC3E,IAAI,UAAU,QACZ,OAAO;CAGT,OAAO,IAAI,wBAAwB,OAAO,GAAG,MAAM;AACrD;AAEA,SAAS,WACP,OACA,SACA,aACA,eAAe,MACG;CASlB,OAHa,mBALA,MAAM,eAAe,OAAO;EACvC,GAAG;EACH;EACA;CACF,CACmC,GAAG,EAAE,UAAU,KAAK,CAG7C,CAAC,CAAC;AACd"}

package/dist/plugins/mod.d.mts

@@ -1,5 +1,6 @@
 import { HeadingIdPluginOptions, headingIdPlugin } from "./heading-id/plugin.mjs";
+import { InlineMathStyle, KatexPluginOptions, katexPlugin } from "./katex/plugin.mjs";
 import { removeImportsExportsPlugin } from "./remove-imports-exports.mjs";
 import { SyntaxHighlightPluginOptions, syntaxHighlightPlugin } from "./syntax-highlight/plugin.mjs";
 import { MdxTreeProcessor, treeProcessorPlugin } from "./tree-processor/plugin.mjs";
-export { HeadingIdPluginOptions, MdxTreeProcessor, SyntaxHighlightPluginOptions, headingIdPlugin, removeImportsExportsPlugin, syntaxHighlightPlugin, treeProcessorPlugin };
+export { HeadingIdPluginOptions, InlineMathStyle, KatexPluginOptions, MdxTreeProcessor, SyntaxHighlightPluginOptions, headingIdPlugin, katexPlugin, removeImportsExportsPlugin, syntaxHighlightPlugin, treeProcessorPlugin };

package/dist/plugins/mod.mjs

@@ -1,5 +1,6 @@
 import { headingIdPlugin } from "./heading-id/plugin.mjs";
+import { katexPlugin } from "./katex/plugin.mjs";
 import { removeImportsExportsPlugin } from "./remove-imports-exports.mjs";
 import { syntaxHighlightPlugin } from "./syntax-highlight/plugin.mjs";
 import { treeProcessorPlugin } from "./tree-processor/plugin.mjs";
-export { headingIdPlugin, removeImportsExportsPlugin, syntaxHighlightPlugin, treeProcessorPlugin };
+export { headingIdPlugin, katexPlugin, removeImportsExportsPlugin, syntaxHighlightPlugin, treeProcessorPlugin };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@temelj/mdx",
-  "version": "0.13.0",
+  "version": "0.14.0",
   "description": "MDX processing utilities.",
   "license": "MIT",
   "repository": {
@@ -25,8 +25,10 @@
     "@types/hast": "^3.0.5",
     "github-slugger": "^2.0.0",
     "hast": "^1.0.0",
+    "hast-util-from-html-isomorphic": "^2.0.0",
     "hast-util-to-string": "^3.0.1",
-    "rehype-katex": "^7.0.1",
+    "hast-util-to-text": "^4.0.2",
+    "katex": "^0.18.1",
     "remark-frontmatter": "^5.0.0",
     "remark-gfm": "^4.0.1",
     "remark-math": "^6.0.0",
@@ -35,6 +37,7 @@
     "unified": "^11.0.5",
     "unist-util-remove": "^4.0.0",
     "unist-util-visit": "^5.1.0",
+    "unist-util-visit-parents": "^6.0.2",
     "vfile": "^6.0.3",
     "vfile-matter": "^5.0.1",
     "@temelj/iterator": "0.13.0",