@motionscript/latex 0.1.0-alpha.0 → 0.1.0-alpha.3

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @motionscript/latex
 
+## 0.1.0-alpha.3
+
+### Patch Changes
+
+- f945a01: `\mathbb`, `\mathcal`, `\mathfrak`, `\mathscr`, `\mathsf` and `\mathtt` typeset.
+
+  Their glyphs live in font files MathJax loads asynchronously the first time a formula needs one, which the synchronous typesetter cannot wait for, so `buildLatexPath`, the `Latex` constructor and a morph to such a formula threw `MathJax retry`, in a browser and in Node. Those six files are now bundled and set up on the font before anything is typeset. The package depends on `@mathjax/mathjax-newcm-font` directly (it was already installed through `@mathjax/src`), and its browser build grows by about 525 KB minified, 219 KB gzipped. Characters in MathJax's other on-demand ranges, such as accented Latin in `\text{é}`, still throw.
+
+## 0.1.0-alpha.2
+
+## 0.1.0-alpha.1
+
+### Minor Changes
+
+- 59cecba: Build on `@motionscript/sdk` instead of `@motionscript/core`. The peer dependency is now `@motionscript/sdk`, every import goes through it (and `@motionscript/sdk/component` for the component machinery), and the browser build leaves `@motionscript/sdk` an import, so an import map names it once. A component copied with `ms add` imports the SDK too, and its registry item depends on `@motionscript/sdk` rather than `@motionscript/core`. `@motionscript/charts/kit` re-exports `@motionscript/sdk/component` where it re-exported `@motionscript/core/component`.
+
 ## 0.1.0-alpha.0
 
 Initial release.

package/README.md

@@ -5,24 +5,30 @@ node renders a formula to glyph paths with [MathJax](https://www.mathjax.org)
 and animates between formulas token by token, so equations morph into one another
 instead of cutting.
 
-```tsx
-import { createScene, createRef } from '@motionscript/core';
+Hand `Latex` to the engine through your project entry's `nodes`, and any
+document that engine opens can name it as `latex`:
+
+```ts
+// src/project.ts
 import { Latex } from '@motionscript/latex';
 
-export default createScene(function* (stage) {
-  const eq = createRef<Latex>();
+export const nodes = [Latex];
+```
 
-  stage.add(
-    <Latex
-      ref={eq}
-      fontSize={64}
-      fill="white"
-      latex="a^2 + b^2 = c^2"
-    />,
-  );
+```ts
+import type { CompositionDocument } from '@motionscript/sdk';
 
-  yield* eq().to({ latex: 'c = \\sqrt{a^2 + b^2}' }, 1.2);
-});
+export default {
+  kind: 'composition',
+  nodes: [
+    { id: 'eq', type: 'latex', parentId: null, layerOrder: 0,
+      props: { latex: 'a^2 + b^2 = c^2', fontSize: 64, fill: 'white' } },
+  ],
+  commands: [
+    { id: 'solve', type: 'to', targetId: 'eq', at: 0, duration: 1.2,
+      args: { latex: 'c = \\sqrt{a^2 + b^2}' } },
+  ],
+} satisfies CompositionDocument;
 ```
 
 ## What's in here
@@ -30,7 +36,7 @@ export default createScene(function* (stage) {
 - **`Latex`** node, a `ShapeNode` that draws a formula as fillable, strokable
   glyph paths. Set `latex` to the TeX source and `fontSize` to scale it; `fill`,
   `stroke`, `shadow`, and `padding` work like any other shape.
-- **Formula morphing**, `to({ latex, fontSize }, duration)` interpolates each
+- **Formula morphing**: a `to` command on `latex` (or `fontSize`) interpolates each
   glyph between the current and target formula, matching tokens that persist,
   fading out tokens that leave, and fading in tokens that arrive. A persisting
   glyph is carried by its geometry, so one that changes size on the way — the
@@ -45,17 +51,18 @@ TeX is parsed through MathJax with the `base`, `ams`, `boldsymbol`,
 `newcommand`, `cancel`, `color`, `mhchem`, `physics`, `bbox`, and `mathtools`
 packages enabled. Rendering is synchronous and browser-only.
 
-This package builds on [`@motionscript/core`](../../core) (the scene graph and
-animation runtime) and renders through whatever backend draws the scene, such as
-[`@motionscript/browser`](../../browser).
+This package is written against [`@motionscript/sdk`](../../sdk), which it
+takes as a peer dependency, and renders through whatever backend draws the
+scene, such as [`@motionscript/browser`](../../browser).
 
 ## Usage
 
 ```bash
-npm install @motionscript/latex
+npm install @motionscript/latex @motionscript/sdk
 ```
 
-See the [docs](https://motionscript.dev/docs) for the full feature set and API
+Or copy the node's source into your project with `ms add latex`
+(see [`@motionscript/cli`](../../cli)). See the [docs](https://motionscript.dev/docs) for the full feature set and API
 reference.
 
 ## Development