@elucim/dsl 0.1.1 → 0.1.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Seth Juarez
+
+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

@@ -1,245 +1,245 @@
-# @elucim/dsl
-
-> Declarative JSON DSL for animated visualizations — perfect for AI agents.
-
-[![npm version](https://img.shields.io/npm/v/@elucim/dsl)](https://www.npmjs.com/package/@elucim/dsl)
-[![license](https://img.shields.io/npm/l/@elucim/dsl)](https://github.com/sethjuarez/elucim/blob/main/LICENSE)
-
-`@elucim/dsl` lets you describe animated diagrams as JSON documents. An AI agent (or any code) produces a JSON object conforming to the schema, and the `<DslRenderer>` component renders it as a fully interactive [Elucim](https://www.npmjs.com/package/@elucim/core) visualization — no React knowledge required.
-
-## Install
-
-```bash
-npm install @elucim/dsl @elucim/core react react-dom
-# or
-pnpm add @elucim/dsl @elucim/core react react-dom
-```
-
-## Quick Start
-
-```tsx
-import { DslRenderer } from '@elucim/dsl';
-import type { ElucimDocument } from '@elucim/dsl';
-
-const myDiagram: ElucimDocument = {
-  version: '1.0',
-  root: {
-    type: 'player',
-    width: 800,
-    height: 600,
-    fps: 30,
-    durationInFrames: 90,
-    background: '#0d0d1a',
-    children: [
-      {
-        type: 'circle',
-        cx: 400,
-        cy: 300,
-        r: 100,
-        stroke: '#3b82f6',
-        strokeWidth: 3,
-        draw: 60,
-      },
-    ],
-  },
-};
-
-function App() {
-  return <DslRenderer dsl={myDiagram} />;
-}
-```
-
-## API
-
-### `<DslRenderer dsl={doc} />`
-
-Validates the DSL document and renders it as React components. If validation fails, displays error messages.
-
-**Props:**
-- `dsl: ElucimDocument` — The DSL document to render
-- `className?: string` — CSS class for the wrapper div
-- `style?: CSSProperties` — Inline styles for the wrapper div
-
-### `validate(doc: unknown): ValidationResult`
-
-Validates a DSL document without rendering it.
-
-```ts
-import { validate } from '@elucim/dsl';
-
-const result = validate(myDoc);
-if (!result.valid) {
-  console.log(result.errors);
-  // [{ path: 'root.children[0].cx', message: 'Required numeric field "cx"...', severity: 'error' }]
-}
-```
-
-### `compileExpression(expr: string)`
-
-Compile a math expression string into a callable function.
-
-```ts
-import { compileExpression } from '@elucim/dsl';
-
-const fn = compileExpression('sin(x) * 2');
-fn({ x: Math.PI / 2 }); // → 2
-```
-
-### `compileVectorExpression(expr: string)`
-
-Compile a vector field expression returning `[number, number]`.
-
-```ts
-import { compileVectorExpression } from '@elucim/dsl';
-
-const fn = compileVectorExpression('[-y, x]');
-fn({ x: 1, y: 2 }); // → [-2, 1]
-```
-
-## Document Schema
-
-Every document has this structure:
-
-```json
-{
-  "version": "1.0",
-  "root": { "type": "scene|player|presentation", ... }
-}
-```
-
-### Root Types
-
-| Type | Description |
-|------|-------------|
-| `scene` | Raw SVG scene (needs external frame control) |
-| `player` | Interactive player with controls, scrub bar, play/pause |
-| `presentation` | Slide-based presentation with transitions |
-
-### Element Types
-
-#### Primitives
-| Type | Required Props | Description |
-|------|---------------|-------------|
-| `circle` | `cx`, `cy`, `r` | SVG circle |
-| `line` | `x1`, `y1`, `x2`, `y2` | SVG line |
-| `arrow` | `x1`, `y1`, `x2`, `y2` | Line with arrowhead |
-| `rect` | `x`, `y`, `width`, `height` | Rectangle |
-| `polygon` | `points` (array of [x,y]) | Polygon/polyline |
-| `text` | `x`, `y`, `content` | Text element |
-
-#### Math Visualizations
-| Type | Required Props | Description |
-|------|---------------|-------------|
-| `axes` | — | Coordinate axes with grid/ticks |
-| `functionPlot` | `fn` (expression) | Plot a function like `"sin(x)"` |
-| `vector` | `to` ([x,y]) | Mathematical vector with label |
-| `vectorField` | `fn` (vector expr) | Grid of arrows like `"[-y, x]"` |
-| `matrix` | `values` (2D array) | Matrix with brackets |
-| `graph` | `nodes`, `edges` | Graph theory visualization |
-| `latex` | `expression`, `x`, `y` | LaTeX rendered via KaTeX |
-
-#### Animation Wrappers
-| Type | Key Props | Description |
-|------|----------|-------------|
-| `fadeIn` | `duration`, `easing` | Fade children in |
-| `fadeOut` | `duration`, `easing` | Fade children out |
-| `draw` | `duration`, `easing` | Progressive stroke drawing |
-| `write` | `duration`, `easing` | Stroke draw + fill fade |
-| `transform` | `translate`, `scale`, `rotate`, `opacity` | Animate position/scale/rotation |
-| `morph` | `fromColor`, `toColor`, `fromScale`, `toScale` | Color/scale morphing |
-| `stagger` | `staggerDelay` | Sequential delayed children |
-| `parallel` | — | Children animate simultaneously |
-
-#### Structural
-| Type | Key Props | Description |
-|------|----------|-------------|
-| `sequence` | `from`, `durationInFrames` | Time-offset wrapper |
-| `group` | `children` | Logical grouping |
-
-### Inline Animation Props
-
-All primitives support these optional animation props directly:
-- `fadeIn?: number` — Fade in over N frames
-- `fadeOut?: number` — Fade out over N frames
-- `draw?: number` — Progressive stroke draw over N frames
-- `easing?: string | { type, ... }` — Easing function
-
-### Easing
-
-**Named easings:** `linear`, `easeInQuad`, `easeOutQuad`, `easeInOutQuad`, `easeInCubic`, `easeOutCubic`, `easeInOutCubic`, `easeInQuart`, `easeOutQuart`, `easeInOutQuart`, `easeInSine`, `easeOutSine`, `easeInOutSine`, `easeInExpo`, `easeOutExpo`, `easeInOutExpo`, `easeInBack`, `easeOutBack`, `easeOutElastic`, `easeOutBounce`
-
-**Spring:** `{ "type": "spring", "stiffness": 100, "damping": 10, "mass": 1 }`
-
-**Cubic Bezier:** `{ "type": "cubicBezier", "x1": 0.25, "y1": 0.1, "x2": 0.25, "y2": 1 }`
-
-### Math Expressions
-
-Used in `functionPlot.fn` and `vectorField.fn`. Safe evaluation — no `eval()`.
-
-**Operators:** `+`, `-`, `*`, `/`, `^` (power), unary `-`
-
-**Functions:** `sin`, `cos`, `tan`, `asin`, `acos`, `atan`, `atan2`, `sqrt`, `abs`, `log`, `ln`, `exp`, `floor`, `ceil`, `round`, `min`, `max`, `sign`, `pow`
-
-**Constants:** `PI`, `E`, `TAU`
-
-**Variables:** `x` (FunctionPlot), `x` and `y` (VectorField)
-
-**Examples:**
-- `"sin(x)"` — Sine wave
-- `"x^2 - 1"` — Parabola
-- `"exp(-(x^2) / 2)"` — Gaussian
-- `"[-y, x]"` — Rotation vector field
-- `"[sin(y), cos(x)]"` — Wave vector field
-
-## Examples
-
-See the [`examples/`](./examples/) directory:
-- `hello-circle.json` — Minimal animated circle
-- `math-demo.json` — Axes, function plot, vector, LaTeX
-- `animated-scene.json` — FadeIn, Draw, Transform, Stagger, Morph
-- `presentation.json` — Multi-slide presentation
-- `full-showcase.json` — Every feature in one document
-
-## For AI Agents
-
-When instructing an LLM to create Elucim diagrams:
-
-1. **Ask it to produce JSON** matching the `ElucimDocument` schema
-2. **Set `version: "1.0"`** as the first field
-3. **Choose a root type**: `player` for interactive, `scene` for embedded, `presentation` for slides
-4. **Use `sequence` nodes** to control timing (offsets in frames)
-5. **Wrap elements in animation nodes** (`fadeIn`, `draw`, `stagger`) for entrance effects
-6. **Use math expression strings** for function plots and vector fields
-
-Example prompt:
-> "Create an Elucim DSL JSON document that shows a coordinate system with sin(x) and cos(x) plotted, 
-> with the sin curve drawing first, then the cos curve drawing 30 frames later, 
-> and a LaTeX label fading in at the end."
-
-## Fluent Builder API
-
-Build presentations programmatically with a chainable TypeScript API:
-
-```tsx
-import { presentation, darkTheme } from '@elucim/dsl';
-
-const doc = presentation(darkTheme)
-  .size(1920, 1080)
-  .transition('fade', 500)
-  .slide('Welcome', (s) => {
-    s.title('Hello World');
-  })
-  .slide('Math', (s) => {
-    s.latex('e^{i\\pi} + 1 = 0', { x: 960, y: 500, fontSize: 48, color: '#fdcb6e' });
-  })
-  .build();
-```
-
-## Related
-
-- **[@elucim/core](https://www.npmjs.com/package/@elucim/core)** — The React rendering engine (peer dependency)
-- **[Elucim on GitHub](https://github.com/sethjuarez/elucim)** — Full docs with live interactive examples
-
-## License
-
-[MIT](https://github.com/sethjuarez/elucim/blob/main/LICENSE)
+# @elucim/dsl
+
+> Declarative JSON DSL for animated visualizations — perfect for AI agents.
+
+[![npm version](https://img.shields.io/npm/v/@elucim/dsl)](https://www.npmjs.com/package/@elucim/dsl)
+[![license](https://img.shields.io/npm/l/@elucim/dsl)](https://github.com/sethjuarez/elucim/blob/main/LICENSE)
+
+`@elucim/dsl` lets you describe animated diagrams as JSON documents. An AI agent (or any code) produces a JSON object conforming to the schema, and the `<DslRenderer>` component renders it as a fully interactive [Elucim](https://www.npmjs.com/package/@elucim/core) visualization — no React knowledge required.
+
+## Install
+
+```bash
+npm install @elucim/dsl @elucim/core react react-dom
+# or
+pnpm add @elucim/dsl @elucim/core react react-dom
+```
+
+## Quick Start
+
+```tsx
+import { DslRenderer } from '@elucim/dsl';
+import type { ElucimDocument } from '@elucim/dsl';
+
+const myDiagram: ElucimDocument = {
+  version: '1.0',
+  root: {
+    type: 'player',
+    width: 800,
+    height: 600,
+    fps: 30,
+    durationInFrames: 90,
+    background: '#0d0d1a',
+    children: [
+      {
+        type: 'circle',
+        cx: 400,
+        cy: 300,
+        r: 100,
+        stroke: '#3b82f6',
+        strokeWidth: 3,
+        draw: 60,
+      },
+    ],
+  },
+};
+
+function App() {
+  return <DslRenderer dsl={myDiagram} />;
+}
+```
+
+## API
+
+### `<DslRenderer dsl={doc} />`
+
+Validates the DSL document and renders it as React components. If validation fails, displays error messages.
+
+**Props:**
+- `dsl: ElucimDocument` — The DSL document to render
+- `className?: string` — CSS class for the wrapper div
+- `style?: CSSProperties` — Inline styles for the wrapper div
+
+### `validate(doc: unknown): ValidationResult`
+
+Validates a DSL document without rendering it.
+
+```ts
+import { validate } from '@elucim/dsl';
+
+const result = validate(myDoc);
+if (!result.valid) {
+  console.log(result.errors);
+  // [{ path: 'root.children[0].cx', message: 'Required numeric field "cx"...', severity: 'error' }]
+}
+```
+
+### `compileExpression(expr: string)`
+
+Compile a math expression string into a callable function.
+
+```ts
+import { compileExpression } from '@elucim/dsl';
+
+const fn = compileExpression('sin(x) * 2');
+fn({ x: Math.PI / 2 }); // → 2
+```
+
+### `compileVectorExpression(expr: string)`
+
+Compile a vector field expression returning `[number, number]`.
+
+```ts
+import { compileVectorExpression } from '@elucim/dsl';
+
+const fn = compileVectorExpression('[-y, x]');
+fn({ x: 1, y: 2 }); // → [-2, 1]
+```
+
+## Document Schema
+
+Every document has this structure:
+
+```json
+{
+  "version": "1.0",
+  "root": { "type": "scene|player|presentation", ... }
+}
+```
+
+### Root Types
+
+| Type | Description |
+|------|-------------|
+| `scene` | Raw SVG scene (needs external frame control) |
+| `player` | Interactive player with controls, scrub bar, play/pause |
+| `presentation` | Slide-based presentation with transitions |
+
+### Element Types
+
+#### Primitives
+| Type | Required Props | Description |
+|------|---------------|-------------|
+| `circle` | `cx`, `cy`, `r` | SVG circle |
+| `line` | `x1`, `y1`, `x2`, `y2` | SVG line |
+| `arrow` | `x1`, `y1`, `x2`, `y2` | Line with arrowhead |
+| `rect` | `x`, `y`, `width`, `height` | Rectangle |
+| `polygon` | `points` (array of [x,y]) | Polygon/polyline |
+| `text` | `x`, `y`, `content` | Text element |
+
+#### Math Visualizations
+| Type | Required Props | Description |
+|------|---------------|-------------|
+| `axes` | — | Coordinate axes with grid/ticks |
+| `functionPlot` | `fn` (expression) | Plot a function like `"sin(x)"` |
+| `vector` | `to` ([x,y]) | Mathematical vector with label |
+| `vectorField` | `fn` (vector expr) | Grid of arrows like `"[-y, x]"` |
+| `matrix` | `values` (2D array) | Matrix with brackets |
+| `graph` | `nodes`, `edges` | Graph theory visualization |
+| `latex` | `expression`, `x`, `y` | LaTeX rendered via KaTeX |
+
+#### Animation Wrappers
+| Type | Key Props | Description |
+|------|----------|-------------|
+| `fadeIn` | `duration`, `easing` | Fade children in |
+| `fadeOut` | `duration`, `easing` | Fade children out |
+| `draw` | `duration`, `easing` | Progressive stroke drawing |
+| `write` | `duration`, `easing` | Stroke draw + fill fade |
+| `transform` | `translate`, `scale`, `rotate`, `opacity` | Animate position/scale/rotation |
+| `morph` | `fromColor`, `toColor`, `fromScale`, `toScale` | Color/scale morphing |
+| `stagger` | `staggerDelay` | Sequential delayed children |
+| `parallel` | — | Children animate simultaneously |
+
+#### Structural
+| Type | Key Props | Description |
+|------|----------|-------------|
+| `sequence` | `from`, `durationInFrames` | Time-offset wrapper |
+| `group` | `children` | Logical grouping |
+
+### Inline Animation Props
+
+All primitives support these optional animation props directly:
+- `fadeIn?: number` — Fade in over N frames
+- `fadeOut?: number` — Fade out over N frames
+- `draw?: number` — Progressive stroke draw over N frames
+- `easing?: string | { type, ... }` — Easing function
+
+### Easing
+
+**Named easings:** `linear`, `easeInQuad`, `easeOutQuad`, `easeInOutQuad`, `easeInCubic`, `easeOutCubic`, `easeInOutCubic`, `easeInQuart`, `easeOutQuart`, `easeInOutQuart`, `easeInSine`, `easeOutSine`, `easeInOutSine`, `easeInExpo`, `easeOutExpo`, `easeInOutExpo`, `easeInBack`, `easeOutBack`, `easeOutElastic`, `easeOutBounce`
+
+**Spring:** `{ "type": "spring", "stiffness": 100, "damping": 10, "mass": 1 }`
+
+**Cubic Bezier:** `{ "type": "cubicBezier", "x1": 0.25, "y1": 0.1, "x2": 0.25, "y2": 1 }`
+
+### Math Expressions
+
+Used in `functionPlot.fn` and `vectorField.fn`. Safe evaluation — no `eval()`.
+
+**Operators:** `+`, `-`, `*`, `/`, `^` (power), unary `-`
+
+**Functions:** `sin`, `cos`, `tan`, `asin`, `acos`, `atan`, `atan2`, `sqrt`, `abs`, `log`, `ln`, `exp`, `floor`, `ceil`, `round`, `min`, `max`, `sign`, `pow`
+
+**Constants:** `PI`, `E`, `TAU`
+
+**Variables:** `x` (FunctionPlot), `x` and `y` (VectorField)
+
+**Examples:**
+- `"sin(x)"` — Sine wave
+- `"x^2 - 1"` — Parabola
+- `"exp(-(x^2) / 2)"` — Gaussian
+- `"[-y, x]"` — Rotation vector field
+- `"[sin(y), cos(x)]"` — Wave vector field
+
+## Examples
+
+See the [`examples/`](./examples/) directory:
+- `hello-circle.json` — Minimal animated circle
+- `math-demo.json` — Axes, function plot, vector, LaTeX
+- `animated-scene.json` — FadeIn, Draw, Transform, Stagger, Morph
+- `presentation.json` — Multi-slide presentation
+- `full-showcase.json` — Every feature in one document
+
+## For AI Agents
+
+When instructing an LLM to create Elucim diagrams:
+
+1. **Ask it to produce JSON** matching the `ElucimDocument` schema
+2. **Set `version: "1.0"`** as the first field
+3. **Choose a root type**: `player` for interactive, `scene` for embedded, `presentation` for slides
+4. **Use `sequence` nodes** to control timing (offsets in frames)
+5. **Wrap elements in animation nodes** (`fadeIn`, `draw`, `stagger`) for entrance effects
+6. **Use math expression strings** for function plots and vector fields
+
+Example prompt:
+> "Create an Elucim DSL JSON document that shows a coordinate system with sin(x) and cos(x) plotted, 
+> with the sin curve drawing first, then the cos curve drawing 30 frames later, 
+> and a LaTeX label fading in at the end."
+
+## Fluent Builder API
+
+Build presentations programmatically with a chainable TypeScript API:
+
+```tsx
+import { presentation, darkTheme } from '@elucim/dsl';
+
+const doc = presentation(darkTheme)
+  .size(1920, 1080)
+  .transition('fade', 500)
+  .slide('Welcome', (s) => {
+    s.title('Hello World');
+  })
+  .slide('Math', (s) => {
+    s.latex('e^{i\\pi} + 1 = 0', { x: 960, y: 500, fontSize: 48, color: '#fdcb6e' });
+  })
+  .build();
+```
+
+## Related
+
+- **[@elucim/core](https://www.npmjs.com/package/@elucim/core)** — The React rendering engine (peer dependency)
+- **[Elucim Docs](https://elucim.com)** — Full docs with live interactive examples
+
+## License
+
+[MIT](https://github.com/sethjuarez/elucim/blob/main/LICENSE)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elucim/dsl",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "JSON/YAML DSL for declarative Elucim animations — define visualizations without writing React code",
   "type": "module",
   "license": "MIT",
@@ -9,7 +9,7 @@
     "url": "https://github.com/sethjuarez/elucim.git",
     "directory": "packages/dsl"
   },
-  "homepage": "https://github.com/sethjuarez/elucim#readme",
+  "homepage": "https://elucim.com",
   "bugs": "https://github.com/sethjuarez/elucim/issues",
   "keywords": [
     "react",
@@ -37,19 +37,12 @@
     "dist",
     "elucim.schema.json"
   ],
-  "scripts": {
-    "dev": "vite build --watch",
-    "build": "tsc && vite build",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "lint": "tsc --noEmit"
-  },
   "peerDependencies": {
     "react": "^18.0.0 || ^19.0.0",
     "react-dom": "^18.0.0 || ^19.0.0"
   },
   "dependencies": {
-    "@elucim/core": "^0.1.1"
+    "@elucim/core": "0.1.3"
   },
   "devDependencies": {
     "@types/react": "^18.3.0",
@@ -62,5 +55,12 @@
     "vite": "^5.4.0",
     "vite-plugin-dts": "^4.0.0",
     "vitest": "^2.0.0"
+  },
+  "scripts": {
+    "dev": "vite build --watch",
+    "build": "tsc && vite build",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "lint": "tsc --noEmit"
   }
-}
+}