mathjax-svg 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 karei
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,39 @@
+# mathjax-svg
+
+A small Node.js library that renders TeX to a raw SVG string with MathJax 4.
+
+## Install
+
+```sh
+npm install mathjax-svg
+```
+
+> [!NOTE]
+> Node.js 16.14.2 or later is required.
+
+## Usage
+
+```ts
+import { renderToSvg, warmup } from 'mathjax-svg';
+
+await warmup(); // optional
+
+const inlineSvg = await renderToSvg(String.raw`E=mc^2`);
+const displaySvg = await renderToSvg(String.raw`\frac{1}{2}`, { display: true });
+```
+
+## API
+
+**`warmup(): Promise<void>`**
+
+Loads and initializes MathJax without rendering a formula. Calling it is optional; the first render initializes MathJax automatically.
+
+**`renderToSvg(tex, options?): Promise<string>`**
+
+Renders `tex`. `options.display` defaults to `false`.
+
+Initialization failures throw `MathJaxInitializationError`, whose `phase` is `module-import` or `mathjax-init`. Rendering failures throw `MathJaxRenderError`, whose `phase` is `tex2svg`, `serialize`, or `svg-validation`. Both error classes retain the original failure in `original`.
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,17 @@
+export interface RenderToSvgOptions {
+    display?: boolean;
+}
+export type MathJaxInitializationPhase = 'module-import' | 'mathjax-init';
+export type MathJaxRenderPhase = 'tex2svg' | 'serialize' | 'svg-validation';
+export declare class MathJaxInitializationError extends Error {
+    readonly phase: MathJaxInitializationPhase;
+    readonly original: unknown;
+    constructor(phase: MathJaxInitializationPhase, original: unknown);
+}
+export declare class MathJaxRenderError extends Error {
+    readonly phase: MathJaxRenderPhase;
+    readonly original: unknown;
+    constructor(phase: MathJaxRenderPhase, original: unknown);
+}
+export declare function warmup(): Promise<void>;
+export declare function renderToSvg(tex: string, options?: RenderToSvgOptions): Promise<string>;

package/dist/index.js

@@ -0,0 +1,106 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MathJaxRenderError = exports.MathJaxInitializationError = void 0;
+exports.warmup = warmup;
+exports.renderToSvg = renderToSvg;
+const node_path_1 = require("node:path");
+const node_url_1 = require("node:url");
+class MathJaxInitializationError extends Error {
+    phase;
+    original;
+    constructor(phase, original) {
+        super(`MathJax initialization failed during ${phase}: ${errorText(original)}`);
+        this.phase = phase;
+        this.original = original;
+        this.name = 'MathJaxInitializationError';
+    }
+}
+exports.MathJaxInitializationError = MathJaxInitializationError;
+class MathJaxRenderError extends Error {
+    phase;
+    original;
+    constructor(phase, original) {
+        super(`Math rendering failed during ${phase}: ${errorText(original)}`);
+        this.phase = phase;
+        this.original = original;
+        this.name = 'MathJaxRenderError';
+    }
+}
+exports.MathJaxRenderError = MathJaxRenderError;
+let mathJaxPromise;
+async function warmup() {
+    await mathJax();
+}
+async function renderToSvg(tex, options = {}) {
+    const mathJaxApi = await mathJax();
+    let node;
+    try {
+        node = await mathJaxApi.tex2svgPromise(tex, { display: options.display ?? false });
+    }
+    catch (error) {
+        throw new MathJaxRenderError('tex2svg', error);
+    }
+    let serialized;
+    try {
+        serialized = mathJaxApi.startup.adaptor.serializeXML(node);
+    }
+    catch (error) {
+        throw new MathJaxRenderError('serialize', error);
+    }
+    try {
+        if (serialized.includes('data-mml-node="merror"'))
+            throw new Error('MathJax returned an merror node.');
+        const matches = serialized.match(/<svg\b[\s\S]*?<\/svg>/g);
+        if (matches?.length !== 1)
+            throw new Error('MathJax did not produce exactly one SVG image.');
+        return matches[0];
+    }
+    catch (error) {
+        throw new MathJaxRenderError('svg-validation', error);
+    }
+}
+function mathJax() {
+    if (mathJaxPromise)
+        return mathJaxPromise;
+    let promise;
+    promise = initializeMathJax().catch((error) => {
+        if (mathJaxPromise === promise)
+            mathJaxPromise = undefined;
+        if (error instanceof MathJaxInitializationError)
+            throw error;
+        throw new MathJaxInitializationError('mathjax-init', error);
+    });
+    mathJaxPromise = promise;
+    return promise;
+}
+async function initializeMathJax() {
+    let module;
+    try {
+        module = await import('mathjax');
+    }
+    catch (error) {
+        throw new MathJaxInitializationError('module-import', error);
+    }
+    const mathJaxApi = module.default;
+    try {
+        await mathJaxApi.init({
+            loader: {
+                paths: { 'mathjax-tex': '@mathjax/mathjax-tex-font' },
+                load: ['input/tex', 'output/svg'],
+                require: (file) => import(process.platform === 'win32' && node_path_1.win32.isAbsolute(file) ? (0, node_url_1.pathToFileURL)(file).href : file),
+            },
+            output: { font: 'mathjax-tex', displayOverflow: 'overflow', linebreaks: { inline: false } },
+            tex: { packages: ['base', 'ams', 'newcommand'] },
+        });
+        if (typeof mathJaxApi.tex2svgPromise !== 'function')
+            throw new TypeError('MathJax initialized without a tex2svgPromise API.');
+        return mathJaxApi;
+    }
+    catch (error) {
+        throw new MathJaxInitializationError('mathjax-init', error);
+    }
+}
+function errorText(error) {
+    return error instanceof Error ? error.message : String(error);
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AA+BA,wBAEC;AACD,kCAsBC;AAxDD,yCAAkC;AAClC,uCAAyC;AASzC,MAAa,0BAA2B,SAAQ,KAAK;IAExC;IACA;IAFX,YACW,KAAiC,EACjC,QAAiB;QAE1B,KAAK,CAAC,wCAAwC,KAAK,KAAK,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QAHtE,UAAK,GAAL,KAAK,CAA4B;QACjC,aAAQ,GAAR,QAAQ,CAAS;QAG1B,IAAI,CAAC,IAAI,GAAG,4BAA4B,CAAC;IAC3C,CAAC;CACF;AARD,gEAQC;AACD,MAAa,kBAAmB,SAAQ,KAAK;IAEhC;IACA;IAFX,YACW,KAAyB,EACzB,QAAiB;QAE1B,KAAK,CAAC,gCAAgC,KAAK,KAAK,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QAH9D,UAAK,GAAL,KAAK,CAAoB;QACzB,aAAQ,GAAR,QAAQ,CAAS;QAG1B,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC;IACnC,CAAC;CACF;AARD,gDAQC;AAED,IAAI,cAA+C,CAAC;AAE7C,KAAK,UAAU,MAAM;IAC1B,MAAM,OAAO,EAAE,CAAC;AAClB,CAAC;AACM,KAAK,UAAU,WAAW,CAAC,GAAW,EAAE,UAA8B,EAAE;IAC7E,MAAM,UAAU,GAAG,MAAM,OAAO,EAAE,CAAC;IACnC,IAAI,IAAuD,CAAC;IAC5D,IAAI,CAAC;QACH,IAAI,GAAG,MAAM,UAAU,CAAC,cAAc,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,KAAK,EAAE,CAAC,CAAC;IACrF,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,kBAAkB,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;IACjD,CAAC;IACD,IAAI,UAAkB,CAAC;IACvB,IAAI,CAAC;QACH,UAAU,GAAG,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IAC7D,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,kBAAkB,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IACnD,CAAC;IACD,IAAI,CAAC;QACH,IAAI,UAAU,CAAC,QAAQ,CAAC,wBAAwB,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;QACvG,MAAM,OAAO,GAAG,UAAU,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAC3D,IAAI,OAAO,EAAE,MAAM,KAAK,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;QAC7F,OAAO,OAAO,CAAC,CAAC,CAAC,CAAC;IACpB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,kBAAkB,CAAC,gBAAgB,EAAE,KAAK,CAAC,CAAC;IACxD,CAAC;AACH,CAAC;AAED,SAAS,OAAO;IACd,IAAI,cAAc;QAAE,OAAO,cAAc,CAAC;IAC1C,IAAI,OAA6B,CAAC;IAClC,OAAO,GAAG,iBAAiB,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;QAC5C,IAAI,cAAc,KAAK,OAAO;YAAE,cAAc,GAAG,SAAS,CAAC;QAC3D,IAAI,KAAK,YAAY,0BAA0B;YAAE,MAAM,KAAK,CAAC;QAC7D,MAAM,IAAI,0BAA0B,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;IAC9D,CAAC,CAAC,CAAC;IACH,cAAc,GAAG,OAAO,CAAC;IACzB,OAAO,OAAO,CAAC;AACjB,CAAC;AACD,KAAK,UAAU,iBAAiB;IAC9B,IAAI,MAAgC,CAAC;IACrC,IAAI,CAAC;QACH,MAAM,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,CAAC;IACnC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,0BAA0B,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC;IAC/D,CAAC;IACD,MAAM,UAAU,GAAG,MAAM,CAAC,OAAgC,CAAC;IAC3D,IAAI,CAAC;QACH,MAAM,UAAU,CAAC,IAAI,CAAC;YACpB,MAAM,EAAE;gBACN,KAAK,EAAE,EAAE,aAAa,EAAE,2BAA2B,EAAE;gBACrD,IAAI,EAAE,CAAC,WAAW,EAAE,YAAY,CAAC;gBACjC,OAAO,EAAE,CAAC,IAAY,EAAE,EAAE,CACxB,MAAM,CAAC,OAAO,CAAC,QAAQ,KAAK,OAAO,IAAI,iBAAK,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAA,wBAAa,EAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;aACnG;YACD,MAAM,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE,eAAe,EAAE,UAAU,EAAE,UAAU,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE;YAC3F,GAAG,EAAE,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,KAAK,EAAE,YAAY,CAAC,EAAE;SACjD,CAAC,CAAC;QACH,IAAI,OAAO,UAAU,CAAC,cAAc,KAAK,UAAU;YACjD,MAAM,IAAI,SAAS,CAAC,mDAAmD,CAAC,CAAC;QAC3E,OAAO,UAAU,CAAC;IACpB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,0BAA0B,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;IAC9D,CAAC;AACH,CAAC;AACD,SAAS,SAAS,CAAC,KAAc;IAC/B,OAAO,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAChE,CAAC"}

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "mathjax-svg",
+  "version": "0.1.0",
+  "description": "Render TeX to a raw SVG string with MathJax in Node.js.",
+  "keywords": [
+    "mathjax",
+    "svg",
+    "tex",
+    "latex"
+  ],
+  "license": "MIT",
+  "author": {
+    "name": "karei"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/abcdvvvv/mathjax-svg.git"
+  },
+  "bugs": {
+    "url": "https://github.com/abcdvvvv/mathjax-svg/issues"
+  },
+  "homepage": "https://github.com/abcdvvvv/mathjax-svg#readme",
+  "type": "commonjs",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.js",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "sideEffects": false,
+  "engines": {
+    "node": ">=16.14.2"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "clean": "node -e \"require('node:fs').rmSync('dist',{recursive:true,force:true})\"",
+    "build": "tsc -p tsconfig.json",
+    "test": "npm run clean && npm run build && node test/index.test.cjs",
+    "benchmark": "npm run build && node benchmark/render.mjs",
+    "prepack": "npm run clean && npm run build",
+    "prepublishOnly": "npm test"
+  },
+  "dependencies": {
+    "@mathjax/mathjax-tex-font": "4.1.3",
+    "mathjax": "4.1.3"
+  },
+  "devDependencies": {
+    "@types/node": "^18.19.0",
+    "typescript": "^5.9.3"
+  }
+}