vizmatic 0.6.0 → 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. package/README.md +18 -18
  2. package/assets/THIRD_PARTY_LICENSES.md +10 -1
  3. package/assets/licenses/satori-NOTICES.txt +688 -0
  4. package/dist/{chunk-RWF4VBUL.js → chunk-CJOXWJQA.js} +2 -1
  5. package/dist/chunk-MAHT32CE.js +79 -0
  6. package/dist/cli.js +4 -4
  7. package/dist/index.cjs +1044 -155
  8. package/dist/index.d.cts +440 -5
  9. package/dist/index.d.ts +440 -5
  10. package/dist/index.js +1003 -129
  11. package/dist/satori.cjs +27 -0
  12. package/dist/scene-browser-assets.js +1 -1
  13. package/dist/scene-browser.js +17 -17
  14. package/dist/scene-cli.js +1 -1
  15. package/dist/scene-layout.wasm +0 -0
  16. package/dist/stage-browser/dagre.esm-6F3RIGLP.js +6 -0
  17. package/dist/stage-browser/stage.js +1 -1
  18. package/dist/stage-export.cjs +10 -2
  19. package/dist/stage-export.d.cts +11 -1
  20. package/dist/stage-export.d.ts +11 -1
  21. package/dist/stage-export.js +8 -2
  22. package/examples/_teaching/categorical-tail-loss.ts +25 -0
  23. package/examples/_teaching/teaching-byte-diff.ts +48 -0
  24. package/examples/_teaching/teaching-routed-transfer.ts +35 -0
  25. package/examples/_teaching/teaching-token-history.ts +29 -0
  26. package/examples/_teaching/teaching-weighted-vector.ts +55 -0
  27. package/examples/films/attention.ts +2 -2
  28. package/examples/films/cache-miss.ts +3 -3
  29. package/examples/films/central-limit.ts +1 -1
  30. package/examples/films/complex-maps.ts +1 -1
  31. package/examples/films/deck-example.ts +5 -5
  32. package/examples/films/euler-circle.ts +2 -2
  33. package/examples/films/fourier-epicycles.ts +15 -3
  34. package/examples/films/gradient-descent.ts +1 -1
  35. package/examples/films/linear-maps.ts +1 -1
  36. package/examples/films/lorenz.ts +1 -1
  37. package/examples/films/pythagoras.ts +3 -3
  38. package/examples/films/taylor-series.ts +2 -2
  39. package/examples/films/vizmatic-title.ts +1 -1
  40. package/package.json +4 -4
  41. package/dist/chunk-JHHPLALU.js +0 -79
  42. package/dist/stage-browser/dagre.esm-N2NIVIAZ.js +0 -6
package/README.md CHANGED
@@ -93,6 +93,20 @@ npx vizmatic ./frame.tsx --out ./figures --theme dark,light --format both
93
93
 
94
94
  Read [Diagrams and density](https://bvolpato.github.io/vizmatic/docs/diagrams.html) and the [figures reference](https://bvolpato.github.io/vizmatic/docs/figures.html), or browse the [component catalog](https://bvolpato.github.io/vizmatic/components.html).
95
95
 
96
+ ## Teaching with a checked canvas
97
+
98
+ `createTeachingCanvas(painter)` composes animated explanations through your host's checked drawing methods. Its components return computed state so labels and geometry follow the same calculation. Bind progress and answer reveals separately to the narration.
99
+
100
+ | Component | A worked example |
101
+ |---|---|
102
+ | `vectorAccumulation` | [Retain momentum, add an opposing gradient, then reveal the resultant](examples/_teaching/teaching-weighted-vector.ts) |
103
+ | `categoricalSampling` | [Watch a rare category disappear from a supplied finite sample](examples/_teaching/categorical-tail-loss.ts) |
104
+ | `routedTransfer` | [Carry a value around visible obstacles](examples/_teaching/teaching-routed-transfer.ts) |
105
+ | `byteDifference` | [Locate a changed byte while retaining offsets and escaped control characters](examples/_teaching/teaching-byte-diff.ts) |
106
+ | `tokenHistory` | [Drop and rebuild KV while preserving accepted and emitted tokens](examples/_teaching/teaching-token-history.ts) |
107
+
108
+ Each example supplies its own data and timing. Inspect prediction frames, moving states, and settled results at the delivery resolution. The [canvas guide](https://bvolpato.github.io/vizmatic/docs/tsx-animation.html) describes the painter contract and component limits.
109
+
96
110
  ## For coding agents
97
111
 
98
112
  Install the skill. It teaches the engine, the object catalog, and the check workflow.
@@ -118,32 +132,18 @@ Agents can also read [`llms.txt`](https://bvolpato.github.io/vizmatic/llms.txt),
118
132
  | [Roadmap](ROADMAP.md) | What shipped and what comes next |
119
133
  | [Contributing](CONTRIBUTING.md) | Setup, checks, and the release process |
120
134
 
121
- ## Consumer security overrides
122
-
123
- Vizmatic 0.6.0's MathJax tree resolves `speech-rule-engine`, which uses `@xmldom/xmldom`. Its Satori tree resolves `fflate`. Pin these patched transitive versions in a consuming project before you install Vizmatic.
135
+ ## Package installation
124
136
 
125
- For npm, add these root-level entries to `package.json`:
126
-
127
- ```json
128
- {
129
- "overrides": {
130
- "@xmldom/xmldom": "0.9.12",
131
- "fflate": "0.7.5"
132
- }
133
- }
134
- ```
137
+ Vizmatic 0.7.0 bundles its tested Satori renderer and uses patched `fflate` 0.7.5. Consumer dependency overrides are no longer required.
135
138
 
136
- For pnpm 11, add these entries to the root `pnpm-workspace.yaml`. The CLI uses esbuild to compile films and frames, so allow its install script:
139
+ For pnpm 11, allow esbuild's install script in the root `pnpm-workspace.yaml`. The CLI uses esbuild to compile films and frames:
137
140
 
138
141
  ```yaml
139
- overrides:
140
- '@xmldom/xmldom': 0.9.12
141
- fflate: 0.7.5
142
142
  allowBuilds:
143
143
  esbuild: true
144
144
  ```
145
145
 
146
- Then add Vizmatic with your package manager. The install updates the lockfile with these transitive pins.
146
+ Then add Vizmatic with your package manager.
147
147
 
148
148
  ## License
149
149
 
@@ -39,6 +39,15 @@ The raster helpers use `fast-png` 8.0.0, `iobuffer` 6.0.1, and `fflate` 0.7.5,
39
39
  each under the MIT License. Their full notices are in
40
40
  [`licenses/raster-codecs-MIT.txt`](licenses/raster-codecs-MIT.txt).
41
41
 
42
+ ## Figure layout renderer
43
+
44
+ The package bundles Satori 0.41.0 and its layout WASM under MPL-2.0.
45
+ The unmodified source is available at
46
+ https://github.com/vercel/satori/tree/a7e9338e15fec771b7e2cfb90df737789104edeb.
47
+ Its bundled dependencies retain their MIT and ISC licenses. Full licenses and
48
+ upstream notices are in [`licenses/satori-NOTICES.txt`](licenses/satori-NOTICES.txt).
49
+ Satori uses the package's patched `fflate` 0.7.5 dependency.
50
+
42
51
  ## Fonts
43
52
 
44
53
  - Inter: SIL Open Font License 1.1.
@@ -63,7 +72,7 @@ each under the MIT License. Their full notices are in
63
72
 
64
73
  Full license: [`licenses/OFL-1.1.txt`](licenses/OFL-1.1.txt).
65
74
 
66
- The website uses WOFF2 copies of the same Inter, JetBrains Mono, and Instrument Serif font files.
75
+ The website uses WOFF2 copies of the same Inter, JetBrains Mono, and Source Serif 4 font files.
67
76
  Regenerate them with `pnpm site:fonts`; the original font licenses apply.
68
77
 
69
78
  ## Emoji