@altpsyche/maths 0.5.0 → 0.6.0

package/README.md

@@ -20,11 +20,12 @@ svgMarkup(at(figure, 0.5), viewMatrix(figure.extent, 'contain', 640, 360), 640,
 
 ## Axes and a plotted function
 
-<img src="docs/tangent.svg" width="720" alt="A parabola on a labelled grid, the region under it shaded to a point on the curve, the tangent at that point drawn, and the slope written as a number.">
+<img src="docs/tangent.svg" width="720" alt="A parabola on a labelled grid, the region under it shaded to a point on the curve, the tangent at that point drawn, and the slope written as a number under the typeset rule it comes from.">
 
 The picture arrives rather than appearing. The grid fades, the axes draw on, their labels come in one
 after another, the curve draws, the dot grows out of the origin, and the dot is pointed at where the
-slope is nothing. Then it walks the curve at one speed and flashes at the top.
+slope is nothing. Then it walks the curve at one speed and flashes at the top. The number in the
+corner is a value of the typeset rule under it.
 
 ```ts
 import { axes, coordsOf, group, interval, numberPlane, plot, scaleOf, shape } from '@altpsyche/maths';
@@ -63,6 +64,40 @@ Four times of one figure, side by side: the picture arrived, the beat at the sta
 way up, and the top. A moving picture in a README needs a GIF and this package has no encoder, so the
 strip shows the motion in a still.
 
+## Equations
+
+`equationFromTex` typesets an expression with MathJax and reads the SVG the typesetter wrote back as
+marks, one per glyph. `equationNode` places those marks in a figure, fitted inside a box and centred
+on a point. It fits the width as well as the height, because an expression six times wider than it is
+tall runs off the sides of a figure the moment the height alone decides its size.
+
+```ts
+import { equationFromTex, equationNode, vec2 } from '@altpsyche/maths';
+
+const rule = await equationFromTex('\\frac{dy}{dx} = 2x');
+
+equationNode('rule', rule, {
+  at: vec2(-4.27, 1.74),
+  width: 1.2,
+  height: 0.6,
+  fill: { colour: '#1b1b1b' },
+});
+```
+
+An equation is paths on the page as well as in a recording, which is what stops one expression having
+two pictures free to disagree. A glyph is an outline rather than a letter, so no font has to be
+installed anywhere and the LaTeX is the label the picture carries for a reader.
+
+MathJax is the one runtime dependency and the typesetting call is what loads it. Importing the door
+reaches none of it, so a consumer who draws figures and typesets nothing pays nothing. What that
+costs is that typesetting answers with a promise.
+
+Three things stop a typeset expression rather than being drawn, and each names what it found. A TeX
+error carries the typesetter's own message. A character the font has no outline for arrives as text,
+which would draw with whatever font a browser had and draw nothing at all in a recording. An
+undefined macro is not an error at all, because MathJax draws the macro's own name in red, so a typo
+would otherwise ship as a red word inside the picture.
+
 ## The animations
 
 `fadeIn`, `fadeOut`, `fadeTo`, `draw`, `morph`, `moveBy`, `rotate`, `scale`, `growFrom`, `moveAlong`,

package/dist/figure/equation.d.ts

@@ -0,0 +1,40 @@
+import { type Vec2 } from '../values/vec2.js';
+import { type GroupNode } from './node.js';
+import { type EquationElement } from './typeset.js';
+import type { Fill, PathMark } from './mark.js';
+/** Where the typesetter put the expression, in the marks' own units and with y
+ * counted upward, so `y` is the bottom edge and `y + height` the top. */
+export interface EquationBox {
+    readonly x: number;
+    readonly y: number;
+    readonly width: number;
+    readonly height: number;
+}
+export interface Equation {
+    readonly marks: readonly PathMark[];
+    readonly box: EquationBox;
+}
+export declare function equationMarks(root: EquationElement): Equation;
+/** One expression typeset and read, which is the two halves above in the order
+ * they are always used in. */
+export declare function equationFromTex(tex: string): Promise<Equation>;
+export interface EquationOptions {
+    /** Where the middle of the expression sits, in the figure's own units. */
+    readonly at: Vec2;
+    /** The box the expression is fitted inside, in the figure's own units. */
+    readonly width: number;
+    readonly height: number;
+    readonly fill: Fill;
+}
+/**
+ * A typeset expression placed in a figure: one shape per glyph, fitted inside a
+ * box and centred on a point.
+ *
+ * It fits inside both measurements rather than being sized by the height alone.
+ * An expression two units wide for every one it is tall runs off the sides of a
+ * narrow figure the moment its height is what decides its size.
+ *
+ * The group carries the transform rather than the geometry, so the glyphs stay
+ * the typesetter's own numbers and moving the expression is one matrix.
+ */
+export declare function equationNode(name: string, equation: Equation, options: EquationOptions): GroupNode;

package/dist/figure/equation.js

@@ -0,0 +1,178 @@
+/**
+ * A typeset expression read out of the SVG a typesetter wrote.
+ *
+ * MathJax describes an expression as nested groups with a transform on each,
+ * every glyph as an outline and a fraction bar or a root's rule as a rectangle.
+ * A figure holds a flat list of marks with every transform already applied, so
+ * this walks the tree, carries the transform stack down it, and hands back the
+ * marks with the box the typesetter measured the expression into.
+ *
+ * The stack starts turned over, because SVG counts y downward and a figure
+ * counts it upward. Doing it here means the whole expression arrives in the
+ * figure's own space and nothing downstream has to know which way up the
+ * typesetter works.
+ *
+ * A mark comes back with no fill and its id is a leaf name, because both arrive
+ * when the equation is placed in a figure: a figure's node tree builds an id out
+ * of the names on the way down it, so a full path written here would be a second
+ * naming of the same mark. The colour arrives there too, since a figure is handed
+ * its palette as it is drawn rather than reading one.
+ *
+ * An id carries the glyph's own code point, which is what a match between two
+ * expressions has to be made on.
+ *
+ * Three things stop the walk instead of being drawn, and each names what it
+ * found. They are written up on `refuse` below.
+ */
+import { mat3 } from '../values/mat3.js';
+import { vec2 } from '../values/vec2.js';
+import { rect, transformPath } from './path.js';
+import { group, shape } from './node.js';
+import { pathFromData } from './path-data.js';
+import { typesetElement } from './typeset.js';
+/** Both transforms a typeset expression uses. Anything else refuses rather than
+ * being ignored, which would leave a glyph sitting at the origin. */
+function transformOf(text) {
+    let matrix = mat3.IDENTITY;
+    for (const match of text.matchAll(/([A-Za-z]+)\s*\(([^)]*)\)/g)) {
+        const name = match[1] ?? '';
+        const numbers = (match[2] ?? '')
+            .split(/[,\s]+/)
+            .filter(Boolean)
+            .map(Number);
+        if (numbers.length === 0 || numbers.some((value) => !Number.isFinite(value)))
+            throw new Error(`the transform "${text}" carries something that is not a number`);
+        const [first = 0, second] = numbers;
+        if (name === 'translate')
+            matrix = mat3.multiply(matrix, mat3.translation(vec2(first, second ?? 0)));
+        else if (name === 'scale')
+            matrix = mat3.multiply(matrix, mat3.scaling(vec2(first, second ?? first)));
+        else
+            throw new Error(`the transform "${text}" asks for "${name}", which this does not apply`);
+    }
+    return matrix;
+}
+function attribute(element, name) {
+    const value = element.attributes[name];
+    if (value === undefined)
+        throw new Error(`a "${element.tag}" element in the typeset expression has no ${name}`);
+    return value;
+}
+function numberAttribute(element, name, fallback) {
+    const written = element.attributes[name];
+    if (written === undefined && fallback !== undefined)
+        return fallback;
+    const value = Number(attribute(element, name));
+    if (!Number.isFinite(value))
+        throw new Error(`a "${element.tag}" element has ${name}="${written}", which is not a number`);
+    return value;
+}
+function svgIn(element) {
+    if (element.tag === 'svg')
+        return element;
+    for (const child of element.children) {
+        const found = svgIn(child);
+        if (found)
+            return found;
+    }
+    return undefined;
+}
+function svgOf(element) {
+    const found = svgIn(element);
+    if (!found)
+        throw new Error('the typesetter returned no svg element');
+    return found;
+}
+/** The colour the `noundefined` extension draws a macro the typesetter does not
+ * know, which is the only sign that it did not typeset one. */
+const UNKNOWN = 'red';
+/** The characters under an element, read off the code point each glyph carries.
+ * It is what names a run the typesetter drew instead of typesetting. */
+function charactersOf(element) {
+    const code = element.tag === 'path' ? Number.parseInt(element.attributes['data-c'] ?? '', 16) : NaN;
+    const own = Number.isInteger(code) ? String.fromCodePoint(code) : '';
+    return own + element.children.map(charactersOf).join('');
+}
+/**
+ * The three things that stop the walk rather than being drawn, each naming what
+ * it found.
+ *
+ * A TeX error carries its message on the group MathJax puts the error box in. A
+ * character the font has no outline for arrives as a text element, which draws
+ * in a browser with whatever font it found and draws nothing at all in a
+ * recording. And an undefined macro is not an error under `AllPackages`, since
+ * the `noundefined` extension in it draws the macro's own name in red, so a typo
+ * would otherwise ship as a red word inside the picture.
+ */
+function refuse(element) {
+    const error = element.attributes['data-mjx-error'];
+    if (error !== undefined)
+        throw new Error(`the typesetter refused the expression: ${error}`);
+    if (element.attributes.fill === UNKNOWN)
+        throw new Error(`the typesetter does not know "${charactersOf(element)}" and drew it in ${UNKNOWN}`);
+    if (element.tag === 'text')
+        throw new Error(`the typesetter has no outline for "${element.text ?? ''}" and wrote it as text`);
+}
+/** The four numbers of the `viewBox`, turned over the way the marks are. */
+function boxOf(svg) {
+    const numbers = attribute(svg, 'viewBox')
+        .split(/[,\s]+/)
+        .filter(Boolean)
+        .map(Number);
+    if (numbers.length !== 4 || numbers.some((value) => !Number.isFinite(value)))
+        throw new Error(`the svg has viewBox="${svg.attributes.viewBox}", which is not four numbers`);
+    const [x = 0, y = 0, width = 0, height = 0] = numbers;
+    return { x, y: -(y + height), width, height };
+}
+export function equationMarks(root) {
+    const svg = svgOf(root);
+    const marks = [];
+    const mark = (path, stack, suffix) => {
+        marks.push({ kind: 'path', id: `${marks.length}-${suffix}`, path: transformPath(path, stack) });
+    };
+    const walk = (element, stack) => {
+        for (const child of element.children) {
+            refuse(child);
+            const written = child.attributes.transform;
+            const own = written ? mat3.multiply(stack, transformOf(written)) : stack;
+            switch (child.tag) {
+                case 'g':
+                    walk(child, own);
+                    break;
+                case 'path':
+                    mark(pathFromData(attribute(child, 'd')), own, child.attributes['data-c'] ?? 'glyph');
+                    break;
+                case 'rect':
+                    mark(rect(vec2(numberAttribute(child, 'x', 0), numberAttribute(child, 'y', 0)), numberAttribute(child, 'width'), numberAttribute(child, 'height')), own, 'rule');
+                    break;
+                default:
+                    throw new Error(`the typeset expression holds a "${child.tag}" element, which this does not draw`);
+            }
+        }
+    };
+    walk(svg, mat3.scaling(vec2(1, -1)));
+    return { marks, box: boxOf(svg) };
+}
+/** One expression typeset and read, which is the two halves above in the order
+ * they are always used in. */
+export async function equationFromTex(tex) {
+    return equationMarks(await typesetElement(tex));
+}
+/**
+ * A typeset expression placed in a figure: one shape per glyph, fitted inside a
+ * box and centred on a point.
+ *
+ * It fits inside both measurements rather than being sized by the height alone.
+ * An expression two units wide for every one it is tall runs off the sides of a
+ * narrow figure the moment its height is what decides its size.
+ *
+ * The group carries the transform rather than the geometry, so the glyphs stay
+ * the typesetter's own numbers and moving the expression is one matrix.
+ */
+export function equationNode(name, equation, options) {
+    const { box } = equation;
+    const fit = Math.min(options.width / box.width, options.height / box.height);
+    const centre = vec2(box.x + box.width / 2, box.y + box.height / 2);
+    const transform = mat3.multiply(mat3.translation(options.at), mat3.multiply(mat3.scaling(vec2(fit, fit)), mat3.translation(vec2(-centre.x, -centre.y))));
+    return group(name, equation.marks.map((mark) => shape(mark.id, mark.path, { fill: options.fill })), { transform });
+}

package/dist/figure/typeset.d.ts

@@ -0,0 +1,18 @@
+/**
+ * One element of the tree a typesetter wrote, with its attributes as written.
+ *
+ * The walk that turns this into marks takes this shape rather than the
+ * typesetter's own, which is what lets the walk be tested by building a tree by
+ * hand with no typesetter behind it.
+ */
+export interface EquationElement {
+    readonly tag: string;
+    readonly attributes: Readonly<Record<string, string>>;
+    readonly children: readonly EquationElement[];
+    /** A text element's own characters, which is what names it when it is
+     * refused. Nothing else here carries any. */
+    readonly text?: string;
+}
+/** One expression typeset, as the tree the typesetter wrote it. `display: true`
+ * is the centred form rather than the one that sits inside a line of prose. */
+export declare function typesetElement(tex: string): Promise<EquationElement>;

package/dist/figure/typeset.js

@@ -0,0 +1,43 @@
+// Held as the promise rather than the value: two calls arriving together share
+// one load, and registering the handler twice leaves MathJax with two of them.
+let shared;
+async function load() {
+    const [{ mathjax }, { TeX }, { SVG }, { liteAdaptor }, { RegisterHTMLHandler }, { AllPackages }] = await Promise.all([
+        import('mathjax-full/js/mathjax.js'),
+        import('mathjax-full/js/input/tex.js'),
+        import('mathjax-full/js/output/svg.js'),
+        import('mathjax-full/js/adaptors/liteAdaptor.js'),
+        import('mathjax-full/js/handlers/html.js'),
+        import('mathjax-full/js/input/tex/AllPackages.js'),
+    ]);
+    const adaptor = liteAdaptor();
+    RegisterHTMLHandler(adaptor);
+    const document = mathjax.document('', {
+        InputJax: new TeX({ packages: AllPackages }),
+        OutputJax: new SVG({ fontCache: 'none' }),
+    });
+    return { adaptor, document };
+}
+/** MathJax's own tree read into the shape above, with a text node's characters
+ * gathered onto the element that holds them. */
+function elementOf(adaptor, node) {
+    const children = [];
+    let text = '';
+    for (const child of adaptor.childNodes(node)) {
+        if (adaptor.kind(child) === '#text')
+            text += adaptor.value(child);
+        else
+            children.push(elementOf(adaptor, child));
+    }
+    const attributes = {};
+    for (const { name, value } of adaptor.allAttributes(node))
+        attributes[name] = value;
+    return { tag: adaptor.kind(node), attributes, children, text };
+}
+/** One expression typeset, as the tree the typesetter wrote it. `display: true`
+ * is the centred form rather than the one that sits inside a line of prose. */
+export async function typesetElement(tex) {
+    shared ??= load();
+    const { adaptor, document } = await shared;
+    return elementOf(adaptor, document.convert(tex, { display: true }));
+}

package/dist/index.d.ts

@@ -53,3 +53,7 @@ export { paintCanvas } from './paint/canvas.js';
 export type { CanvasLike } from './paint/canvas.js';
 export { arrow, callout, dot } from './figure/annotate.js';
 export type { ArrowOptions, CalloutOptions } from './figure/annotate.js';
+export { typesetElement } from './figure/typeset.js';
+export type { EquationElement } from './figure/typeset.js';
+export { equationFromTex, equationMarks, equationNode } from './figure/equation.js';
+export type { Equation, EquationBox, EquationOptions } from './figure/equation.js';

package/dist/index.js

@@ -32,3 +32,5 @@ export { at, durationOf, loops, sameMarks } from './figure/figure.js';
 export { pathData, paintSvg, svgElements, svgMarkup } from './paint/svg.js';
 export { paintCanvas } from './paint/canvas.js';
 export { arrow, callout, dot } from './figure/annotate.js';
+export { typesetElement } from './figure/typeset.js';
+export { equationFromTex, equationMarks, equationNode } from './figure/equation.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@altpsyche/maths",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "The mathematics AltPsyche's figures are drawn from: vectors, matrices, curves, and a value walked over time.",
   "license": "MIT",
   "author": "Siva",
@@ -47,5 +47,8 @@
   },
   "engines": {
     "node": ">=20"
+  },
+  "dependencies": {
+    "mathjax-full": "^3.2.1"
   }
 }