@liqweed/motion-kit 0.3.0 → 0.5.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 (46) hide show
  1. package/.claude-plugin/marketplace.json +1 -1
  2. package/.claude-plugin/plugin.json +1 -1
  3. package/README.md +63 -10
  4. package/adapters/astro/AnimatedDiagram.astro +150 -24
  5. package/adapters/element/README.md +6 -1
  6. package/adapters/element/motion-diagram.mjs +4 -3
  7. package/adapters/page/README.md +8 -2
  8. package/adapters/slidev/AnimatedDiagram.vue +24 -0
  9. package/cli/motion-kit.mjs +85 -81
  10. package/docs/spec/technique.md +166 -63
  11. package/examples/custom-pulse.scene.mjs +3 -0
  12. package/examples/incident.json +18 -0
  13. package/examples/web-stack.json +17 -0
  14. package/lib/build.mjs +26 -12
  15. package/lib/bundle.mjs +9 -2
  16. package/lib/check.mjs +219 -15
  17. package/lib/export.mjs +135 -16
  18. package/lib/gate.mjs +90 -0
  19. package/lib/load.mjs +49 -19
  20. package/package.json +6 -3
  21. package/runtime/bake.mjs +18 -4
  22. package/runtime/kit.mjs +59 -0
  23. package/runtime/links.mjs +314 -0
  24. package/runtime/page.mjs +52 -0
  25. package/runtime/parts.mjs +15 -0
  26. package/runtime/patch.mjs +297 -0
  27. package/runtime/player.mjs +334 -130
  28. package/runtime/scene.mjs +82 -5
  29. package/runtime/style.mjs +64 -16
  30. package/runtime/types/hub-spoke.mjs +7 -7
  31. package/runtime/types/index.mjs +4 -0
  32. package/runtime/types/sequence.mjs +5 -5
  33. package/runtime/types/stack.mjs +227 -0
  34. package/runtime/types/timeline.mjs +405 -0
  35. package/skills/animated-diagram/SKILL.md +30 -7
  36. package/skills/animated-diagram/references/custom-scenes.md +64 -9
  37. package/skills/animated-diagram/references/interactivity.md +150 -15
  38. package/skills/animated-diagram/references/qc.md +5 -2
  39. package/skills/animated-diagram/references/scene-types.md +45 -2
  40. package/skills/animated-diagram/references/styles.md +45 -5
  41. package/skills/animated-diagram/references/targets.md +7 -5
  42. package/skills/animated-diagram/references/technique.md +14 -4
  43. package/skills/motion-render/SKILL.md +31 -8
  44. package/skills/motion-render/references/formats.md +8 -8
  45. package/skills/project-logo/SKILL.md +15 -4
  46. package/styles/neutral.json +2 -2
@@ -0,0 +1,405 @@
1
+ // SPDX-License-Identifier: MIT
2
+ // Copyright (c) 2026 Ophir Radnitz
3
+ /**
4
+ * motion-kit · scene type "timeline".
5
+ *
6
+ * Helps the viewer understand: events in time, and where "now" falls among
7
+ * them. Storyboard: the axis draws on, then the milestones drop onto it in
8
+ * order; each event that has happened fills with the accent colour and the
9
+ * axis behind it turns accent, while planned events stay pending. Last, a
10
+ * "now" marker (the one emphasis element) settles on the axis after the last
11
+ * event that has happened.
12
+ *
13
+ * Spec:
14
+ * { type: "timeline", id, title, description,
15
+ * events: [{ when, label, detail?, id?, planned? }], // 2–8, in time order; id names the step
16
+ * now?: { label, detail?, id? }, // marker after the last event that is not planned
17
+ * fontSize?: number }
18
+ * `planned: true` marks an event still to come; planned events come after all
19
+ * the others. Strings may be localized objects: { en: "...", nl: "..." }.
20
+ *
21
+ * Layouts: a horizontal axis with labels below it, or alternating above and
22
+ * below when they need the width (wide aspects and square); a vertical axis
23
+ * with labels on the right (9:16, tall).
24
+ */
25
+ import { easeOut, easeStandard, lerp, progress, springSettleTime, springStep } from "../motion.mjs";
26
+ import { FONT_MIN, maxFontSize, stateLabel } from "../parts.mjs";
27
+ import { FORMATS, localize, withId } from "../scene.mjs";
28
+ import { tok } from "../style.mjs";
29
+ import { drawOn, el, fade, num, text, translate } from "../svg.mjs";
30
+ import { wrapLabel } from "../wrap.mjs";
31
+
32
+ /** @import { Scene } from "../scene.mjs" */
33
+
34
+ // Timeline (seconds). Each beat ends (step) before the next one starts.
35
+ const AXIS = 0.6; // the axis draws on
36
+ const EXTEND = 0.3; // the accent axis reaches an event
37
+ const DROP = 0.35; // a milestone drops onto the axis
38
+ const LABEL = 0.3; // its label fades in
39
+ const FILL = 0.25; // a past event turns accent
40
+ const BEAT = 0.6; // one event: EXTEND/DROP/LABEL/FILL all end by 0.55
41
+ const SETTLE_AT = 0.55;
42
+ const NOW_OMEGA = 14; // the "now" marker settles on a critically damped spring
43
+ const NOW_FADE = 0.2;
44
+ const NOW_DROP = 18;
45
+ const TAIL = 0.4;
46
+
47
+ const PAD = 24;
48
+ const CHAR = 0.56;
49
+ const GAP = 16; // horizontal room between two labels on the same side
50
+ const DOT = 7; // milestone dot radius
51
+ const MAX_EVENTS = 8;
52
+
53
+ /**
54
+ * One localized event; `lines` is its label wrapped to the layout's budget.
55
+ * @typedef {{ label: string, when: string, planned: boolean, detail: string, id?: string, lines?: string[] }} Item
56
+ */
57
+ /**
58
+ * The localized "now" marker; `index` is the number of events before it.
59
+ * @typedef {{ label: string, detail: string, id?: string, index: number }} Now
60
+ */
61
+
62
+ /** Size of the "now" pill for a label at font size `fs`. */
63
+ function pill(label, fs) {
64
+ const h = Math.round(fs * 1.25 + 10);
65
+ return { w: Math.round(label.length * fs * CHAR + 22), h, fs };
66
+ }
67
+
68
+ function overlaps(a, b, gap = 4) {
69
+ return a.x < b.x + b.w + gap && b.x < a.x + a.w + gap && a.y < b.y + b.h + gap && b.y < a.y + a.h + gap;
70
+ }
71
+
72
+ /**
73
+ * Horizontal axis. `mode` "below" puts every label under the axis; "alternate"
74
+ * puts even events below and odd ones above, which doubles each label's width.
75
+ */
76
+ function horizontal(f, items, now, fs, mode) {
77
+ const W = f.width;
78
+ const fixed = f.height > 0;
79
+ const n = items.length;
80
+ const whenFs = Math.max(FONT_MIN, fs - 3);
81
+ const lineH = fs * 1.25;
82
+ const whenH = whenFs * 1.25;
83
+ const nowU = now ? now.index - 0.5 : null; // between two events, or half a cell beyond an end
84
+ const uMin = Math.min(0, nowU ?? 0);
85
+ const uMax = Math.max(n - 1, nowU ?? 0);
86
+ const U = uMax - uMin;
87
+ const sides = mode === "alternate" ? 2 : 1;
88
+ // Same-side labels sit `sides` cells apart; the outermost labels end at the padding.
89
+ let cell = (W - 2 * PAD + GAP) / (U + sides);
90
+ cell = Math.min(cell, fs * (sides === 2 ? 9 : 13));
91
+ const labelW = sides * cell - GAP;
92
+ const span = U * cell + labelW;
93
+ const x0 = (W - span) / 2 + labelW / 2 - uMin * cell;
94
+ const xs = items.map((_, k) => x0 + k * cell);
95
+ const maxChars = Math.floor(labelW / (fs * CHAR));
96
+ const whenChars = Math.floor(labelW / (whenFs * CHAR));
97
+ const nowPill = now ? pill(now.label, whenFs) : null;
98
+ const stem = Math.max(28, (nowPill?.h ?? 0) / 2 + 14);
99
+ const blockH = whenH + 4 + 2 * lineH; // budget: one "when" line, two label lines
100
+ const reach = stem + 6 + blockH; // axis → far edge of a label block
101
+ const above = mode === "alternate" ? reach : Math.max(nowPill ? nowPill.h / 2 : 0, DOT + NOW_DROP);
102
+ const contentH = above + reach;
103
+ const H = fixed ? f.height : Math.ceil(contentH + 2 * PAD);
104
+ const axisY = (H - contentH) / 2 + above;
105
+ const axisX0 = Math.max(PAD, x0 + uMin * cell - cell / 2);
106
+ const axisX1 = Math.min(W - PAD, x0 + uMax * cell + cell / 2);
107
+ return {
108
+ dir: "h", W, H, fs, whenFs, lineH, whenH, maxChars, whenChars, maxLines: 2, labelW, cell, stem,
109
+ axis: { x0: axisX0, y0: axisY, x1: axisX1, y1: axisY },
110
+ at: (k) => ({ x: xs[k], y: axisY }),
111
+ nowAt: nowU == null ? null : { x: x0 + nowU * cell, y: axisY },
112
+ side: (k) => (mode === "alternate" && k % 2 === 1 ? -1 : 1),
113
+ nowPill,
114
+ };
115
+ }
116
+
117
+ /** Vertical axis near the left edge, labels on the right, "now" in its own slot. */
118
+ function vertical(f, items, now, fs) {
119
+ const W = f.width;
120
+ const fixed = f.height > 0;
121
+ const n = items.length;
122
+ const whenFs = Math.max(FONT_MIN, fs - 3);
123
+ const lineH = fs * 1.25;
124
+ const whenH = whenFs * 1.25;
125
+ const axisX = PAD + DOT + 4;
126
+ const labelX = axisX + DOT + 14;
127
+ const labelW = W - PAD - labelX;
128
+ const maxChars = Math.floor(labelW / (fs * CHAR));
129
+ const whenChars = Math.floor(labelW / (whenFs * CHAR));
130
+ const nowPill = now ? pill(now.label, whenFs) : null;
131
+ // A row is as tall as its label (two lines until the labels are wrapped).
132
+ const rowH = (it) => whenH + 4 + (it.lines?.length ?? 2) * lineH;
133
+ // Slots in order: events, with the "now" slot inserted at its place.
134
+ const slots = items.map((it, k) => ({ k, h: rowH(it) }));
135
+ if (now && nowPill) slots.splice(now.index, 0, { k: -1, h: nowPill.h });
136
+ const used = slots.reduce((s, x) => s + x.h, 0);
137
+ const gap = fixed ? Math.max(16, Math.min(fs * 2.4, (f.height - 2 * PAD - 2 * DOT - used) / Math.max(1, slots.length - 1))) : 18;
138
+ const contentH = used + gap * (slots.length - 1);
139
+ const H = fixed ? f.height : Math.ceil(contentH + 2 * PAD + 2 * DOT);
140
+ let y = (H - contentH) / 2;
141
+ const ys = new Array(n);
142
+ /** @type {number | null} */
143
+ let nowY = null;
144
+ for (const s of slots) {
145
+ // An event's dot sits on its "when" line; the pill is centred in its slot.
146
+ if (s.k < 0) nowY = y + s.h / 2;
147
+ else ys[s.k] = y + whenH / 2;
148
+ y += s.h + gap;
149
+ }
150
+ const first = Math.min(ys[0], nowY ?? Infinity);
151
+ const last = Math.max(ys[n - 1], nowY ?? -Infinity);
152
+ return {
153
+ dir: "v", W, H, fs, whenFs, lineH, whenH, maxChars, whenChars, maxLines: 2, labelW, labelX,
154
+ axis: { x0: axisX, y0: Math.max(PAD / 2, first - gap), x1: axisX, y1: Math.min(H - PAD / 2, last + rowH(items[n - 1]) + gap / 2) },
155
+ at: (k) => ({ x: axisX, y: ys[k] }),
156
+ nowAt: nowY == null ? null : { x: axisX, y: nowY },
157
+ side: () => 1,
158
+ nowPill,
159
+ };
160
+ }
161
+
162
+ /** Label blocks, dots and the pill as boxes, for the overlap check. */
163
+ function boxes(L, items) {
164
+ const out = [];
165
+ items.forEach((it, k) => {
166
+ const p = L.at(k);
167
+ const w = Math.max(it.when.length * L.whenFs, Math.max(...it.lines.map((l) => l.length)) * L.fs) * CHAR;
168
+ const h = L.whenH + 4 + it.lines.length * L.lineH;
169
+ out.push({ x: p.x - DOT, y: p.y - DOT, w: 2 * DOT, h: 2 * DOT, what: "dot" });
170
+ if (L.dir === "h") {
171
+ const top = L.side(k) > 0 ? p.y + L.stem + 6 : p.y - L.stem - 6 - h;
172
+ out.push({ x: p.x - w / 2, y: top, w, h, what: `label "${it.label}"` });
173
+ } else {
174
+ out.push({ x: L.labelX, y: p.y - L.whenH / 2, w, h, what: `label "${it.label}"` });
175
+ }
176
+ });
177
+ if (L.nowAt && L.nowPill) {
178
+ const { w, h } = L.nowPill;
179
+ const x = L.dir === "h" ? L.nowAt.x - w / 2 : L.nowAt.x - h / 2;
180
+ out.push({ x, y: L.nowAt.y - h / 2, w, h, what: "the now marker" });
181
+ }
182
+ return out;
183
+ }
184
+
185
+ function layoutProblem(L, items) {
186
+ const all = boxes(L, items);
187
+ for (let i = 0; i < all.length; i++) {
188
+ const b = all[i];
189
+ if (b.x < 0 || b.y < 0 || b.x + b.w > L.W + 0.01 || b.y + b.h > L.H + 0.01) return `${b.what} falls outside the canvas`;
190
+ for (let j = i + 1; j < all.length; j++) {
191
+ if (b.what === "dot" && all[j].what === "dot") continue;
192
+ if (overlaps(b, all[j])) return `${b.what} overlaps ${all[j].what}`;
193
+ }
194
+ }
195
+ return null;
196
+ }
197
+
198
+ /**
199
+ * The validated, localized events and "now" of a spec.
200
+ * @param {any} spec
201
+ * @param {string} locale
202
+ */
203
+ function readSpec(spec, locale) {
204
+ const name = `timeline "${spec.id}"`;
205
+ const events = spec.events;
206
+ if (!Array.isArray(events)) throw new Error(`${name}: needs "events", a list of { when, label }`);
207
+ if (events.length < 2 || events.length > MAX_EVENTS) throw new Error(`${name}: needs 2–${MAX_EVENTS} events, got ${events.length}`);
208
+ let seenPlanned = false;
209
+ const items = events.map((e, i) => {
210
+ const label = localize(e?.label, locale);
211
+ const when = localize(e?.when, locale);
212
+ if (!label) throw new Error(`${name}: event ${i + 1} needs a "label"`);
213
+ if (!when) throw new Error(`${name}: event ${i + 1} ("${label}") needs a "when", e.g. "09:02" or "Q3 2026"`);
214
+ if (e.planned !== undefined && typeof e.planned !== "boolean") throw new Error(`${name}: event ${i + 1} ("${label}"): "planned" must be true or false`);
215
+ const planned = e.planned === true;
216
+ if (seenPlanned && !planned) throw new Error(`${name}: event ${i + 1} ("${label}") has happened but comes after a planned event; planned events go last`);
217
+ seenPlanned ||= planned;
218
+ return { label, when, planned, detail: localize(e.detail, locale), id: e.id };
219
+ });
220
+ /** @type {Now | null} */
221
+ let now = null;
222
+ if (spec.now != null) {
223
+ const label = localize(spec.now.label, locale);
224
+ if (!label) throw new Error(`${name}: "now" needs a "label", e.g. "Now" or "Today"`);
225
+ const index = items.filter((it) => !it.planned).length;
226
+ now = { label, detail: localize(spec.now.detail, locale), id: spec.now.id, index };
227
+ } else if (seenPlanned) {
228
+ throw new Error(`${name}: planned events need a "now" marker to separate them from the past`);
229
+ }
230
+ return { items, now };
231
+ }
232
+
233
+ /**
234
+ * Largest font (≤ max) at which the layout fits and every label wraps. At one
235
+ * font size, labels below the axis win over alternating ones unless
236
+ * alternating needs fewer lines (no orphaned words).
237
+ */
238
+ function fit(f, items, now, maxFs, name) {
239
+ const narrow = f.name === "tall" || (f.height > 0 && f.width / f.height < 0.8);
240
+ let why = "";
241
+ for (let fs = maxFs; fs >= FONT_MIN; fs--) {
242
+ /** @type {{ L: any, items: Item[], lines: number } | null} */
243
+ let best = null;
244
+ for (const mode of narrow ? ["v"] : ["below", "alternate"]) {
245
+ let L = mode === "v" ? vertical(f, items, now, fs) : horizontal(f, items, now, fs, mode);
246
+ try {
247
+ const wrapped = items.map((it) => {
248
+ wrapLabel(it.when, L.whenChars, 1);
249
+ return { ...it, lines: wrapLabel(it.label, L.maxChars, L.maxLines) };
250
+ });
251
+ if (now) wrapLabel(now.label, L.dir === "h" ? Math.floor((L.cell - 2 * DOT - 12) / (L.whenFs * CHAR)) : L.maxChars, 1);
252
+ if (mode === "v") L = vertical(f, wrapped, now, fs);
253
+ const problem = layoutProblem(L, wrapped);
254
+ if (problem) {
255
+ why = problem;
256
+ continue;
257
+ }
258
+ const lines = wrapped.reduce((s, it) => s + it.lines.length, 0);
259
+ if (!best || lines < best.lines) best = { L, items: wrapped, lines };
260
+ } catch (e) {
261
+ why = e instanceof Error ? e.message : String(e);
262
+ }
263
+ }
264
+ if (best) return best;
265
+ }
266
+ throw new Error(`${name}: ${items.length} events do not fit format ${f.name} at ≥ ${FONT_MIN}px (${why}); use fewer events, shorter labels or a larger format`);
267
+ }
268
+
269
+ /**
270
+ * Build a timeline scene from its spec.
271
+ * @param {any} spec
272
+ * @param {{ format?: string | { name: string, width: number, height: number }, locale?: string }} [opts]
273
+ * @returns {Scene}
274
+ */
275
+ export function timeline(spec, { format = "16:9", locale = "en" } = {}) {
276
+ const f = typeof format === "string" ? { name: format, ...FORMATS[format] } : format;
277
+ if (!f.width) throw new Error(`unknown format "${format}"`);
278
+ const { items: raw, now } = readSpec(spec, locale);
279
+ const n = raw.length;
280
+ const maxFs = maxFontSize(spec, f.height > 0 ? 22 : 16, `timeline "${spec.id}"`);
281
+ const { L, items } = fit(f, raw, now, maxFs, `timeline "${spec.id}"`);
282
+
283
+ // Event k's beat; then the "now" beat.
284
+ const beat = (k) => AXIS + 0.1 + k * BEAT;
285
+ const stepAt = (k) => beat(k) + SETTLE_AT;
286
+ const nowStart = beat(n);
287
+ const nowAt = nowStart + springSettleTime(NOW_OMEGA) + 0.01;
288
+ const duration = (now ? nowAt : stepAt(n - 1)) + TAIL;
289
+
290
+ // The accent axis: from the axis start through every past event, then to "now".
291
+ const ax = L.axis;
292
+ const along = (p) => (L.dir === "h" ? p.x : p.y);
293
+ const start = L.dir === "h" ? ax.x0 : ax.y0;
294
+ const stops = items.flatMap((it, k) => (it.planned ? [] : [{ to: along(L.at(k)), at: beat(k) }]));
295
+ if (now && L.nowAt) stops.push({ to: along(L.nowAt), at: nowStart });
296
+ const axisLen = L.dir === "h" ? ax.x1 - ax.x0 : ax.y1 - ax.y0;
297
+
298
+ function accentEnd(t) {
299
+ let end = start;
300
+ let from = start;
301
+ for (const s of stops) {
302
+ const p = progress(t, s.at, EXTEND, easeStandard);
303
+ if (p <= 0) break;
304
+ end = lerp(from, s.to, p);
305
+ from = s.to;
306
+ }
307
+ return end;
308
+ }
309
+
310
+ const line = (a, b, attrs) =>
311
+ el("path", { d: L.dir === "h" ? `M${num(a)} ${num(ax.y0)} H${num(b)}` : `M${num(ax.x0)} ${num(a)} V${num(b)}`, fill: "none", "stroke-linecap": "round", ...attrs });
312
+
313
+ function milestone(t, it, k) {
314
+ const p = L.at(k);
315
+ const b = beat(k);
316
+ const drop = progress(t, b + 0.05, DROP, easeOut);
317
+ if (drop <= 0) return "";
318
+ const shown = progress(t, b + 0.15, LABEL, easeOut);
319
+ const active = it.planned ? 0 : progress(t, b + 0.3, FILL, easeStandard);
320
+ const out = [];
321
+ const s = L.side(k);
322
+ if (L.dir === "h") {
323
+ // Stem from the dot to the label block, drawn as the label arrives.
324
+ const y0 = p.y + s * (DOT + 3);
325
+ const y1 = p.y + s * L.stem;
326
+ const len = Math.abs(y1 - y0);
327
+ const dash = drawOn(len, progress(t, b + 0.15, LABEL, easeStandard));
328
+ if (dash) out.push(el("path", { d: `M${num(p.x)} ${num(y0)} V${num(y1)}`, stroke: tok("line"), "stroke-width": 1.5, fill: "none", ...dash }));
329
+ }
330
+ const dy = (1 - drop) * -14;
331
+ const dot = (fill, stroke) => el("circle", { cx: p.x, cy: p.y, r: DOT, fill, stroke, "stroke-width": 2 });
332
+ out.push(
333
+ fade(drop, { transform: Math.abs(dy) > 0.004 ? translate(0, dy) : undefined }, fade(1 - active, {}, dot(tok("surface"), tok("line"))), fade(active, {}, dot(tok("accent"), tok("accent")))),
334
+ );
335
+ // Label block: the "when" line (muted) and the wrapped label (muted → ink once it has happened).
336
+ const h = L.whenH + 4 + it.lines.length * L.lineH;
337
+ let x;
338
+ let top;
339
+ let anchor;
340
+ if (L.dir === "h") {
341
+ x = p.x;
342
+ top = s > 0 ? p.y + L.stem + 6 : p.y - L.stem - 6 - h;
343
+ anchor = "middle";
344
+ } else {
345
+ x = L.labelX;
346
+ top = p.y - L.whenH / 2;
347
+ anchor = "start";
348
+ }
349
+ if (shown > 0) {
350
+ out.push(fade(shown, {}, text({ x, y: top, "text-anchor": anchor, "dominant-baseline": "hanging", "font-size": L.whenFs, "font-weight": 600, fill: tok("muted") }, it.when)));
351
+ out.push(stateLabel({ x, y: top + L.whenH + 4, lines: it.lines, fontSize: L.fs, anchor, baseline: "hanging", enter: shown, active }));
352
+ }
353
+ return out.join("");
354
+ }
355
+
356
+ function nowMarker(t) {
357
+ if (!now || !L.nowAt || !L.nowPill) return "";
358
+ const shown = progress(t, nowStart, NOW_FADE, easeOut);
359
+ if (shown <= 0) return "";
360
+ const dy = -(1 - springStep(t - nowStart, NOW_OMEGA)) * NOW_DROP;
361
+ const { w, h, fs } = L.nowPill;
362
+ const x = L.dir === "h" ? L.nowAt.x - w / 2 : L.nowAt.x - h / 2;
363
+ const y = L.nowAt.y - h / 2;
364
+ return fade(
365
+ shown,
366
+ { transform: Math.abs(dy) > 0.004 ? translate(0, dy) : undefined },
367
+ el("rect", { x, y, width: w, height: h, rx: h / 2, fill: tok("bg"), stroke: tok("emphasis"), "stroke-width": 2.5 }),
368
+ text({ x: x + w / 2, y: L.nowAt.y, "text-anchor": "middle", "dominant-baseline": "central", "font-size": fs, "font-weight": 600, fill: tok("ink") }, now.label),
369
+ );
370
+ }
371
+
372
+ function frame(t) {
373
+ const out = [];
374
+ // Axis: pending line draws on; an arrowhead at its end shows the direction of time.
375
+ const axisDash = drawOn(axisLen, progress(t, 0, AXIS, easeStandard));
376
+ if (axisDash) out.push(line(start, L.dir === "h" ? ax.x1 : ax.y1, { stroke: tok("line"), "stroke-width": 2, ...axisDash }));
377
+ const head = progress(t, AXIS - 0.15, 0.2, easeOut);
378
+ if (head > 0) {
379
+ const d = L.dir === "h" ? `M${num(ax.x1 - 9)} ${num(ax.y1 - 6)} L${num(ax.x1)} ${num(ax.y1)} L${num(ax.x1 - 9)} ${num(ax.y1 + 6)}` : `M${num(ax.x1 - 6)} ${num(ax.y1 - 9)} L${num(ax.x1)} ${num(ax.y1)} L${num(ax.x1 + 6)} ${num(ax.y1 - 9)}`;
380
+ out.push(el("path", { d, fill: "none", stroke: tok("line"), "stroke-width": 2, "stroke-linecap": "round", "stroke-linejoin": "round", opacity: head }));
381
+ }
382
+ const end = accentEnd(t);
383
+ if (end - start > 0.5) out.push(line(start, end, { stroke: tok("accent"), "stroke-width": 3 }));
384
+ items.forEach((it, k) => out.push(milestone(t, it, k)));
385
+ out.push(nowMarker(t));
386
+ return out.join("");
387
+ }
388
+
389
+ const steps = items.map((it, k) => withId({ at: stepAt(k), label: it.label, detail: it.detail }, it.id));
390
+ if (now) steps.push(withId({ at: nowAt, label: now.label, detail: now.detail }, now.id));
391
+
392
+ return {
393
+ id: `${spec.id}-${f.name.replace(":", "x")}`,
394
+ type: "timeline",
395
+ format: f.name,
396
+ locale,
397
+ width: L.W,
398
+ height: L.H,
399
+ duration,
400
+ title: localize(spec.title, locale),
401
+ description: localize(spec.description, locale),
402
+ steps,
403
+ frame,
404
+ };
405
+ }
@@ -11,12 +11,32 @@ clock; exporters sample exact times; video samples `t = f / fps`. Read
11
11
 
12
12
  ## Locate the toolkit
13
13
 
14
+ `$MK` is where the toolkit's files are (examples, styles, `brand/`); `mk` runs
15
+ the CLI. Take the first that works:
16
+
17
+ 1. `MOTION_KIT_HOME`: a clone or install the user chose (run `npm install`
18
+ there for PNG and video).
19
+ 2. The npm package through `npx`, at the version of these skills. `npx`
20
+ installs the PNG renderer with it.
21
+ 3. The plugin copy, two levels above this skill: `check`, `build`, `bake` and
22
+ SVG `export` work; PNG and video do not.
23
+
14
24
  ```bash
15
- MK="$HOME/workspace/motion-kit" # canonical clone (has node_modules)
16
- [ -d "$MK" ] || MK="$(cd "<this skill's base directory>/../.." && pwd)" # plugin copy
17
- node "$MK/cli/motion-kit.mjs" --help
25
+ PLUGIN="$(cd -P "<this skill's base directory>" && cd ../.. && pwd -P)" # -P: the base may be a symlink to a clone
26
+ V="$(node -p "require(process.argv[1] + '/package.json').version" "$PLUGIN")"
27
+ if [ -n "${MOTION_KIT_HOME:-}" ]; then
28
+ MK="$MOTION_KIT_HOME"; mk() { node "$MK/cli/motion-kit.mjs" "$@"; }
29
+ elif npx -y "@liqweed/motion-kit@$V" --help >/dev/null 2>&1; then
30
+ MK="$PLUGIN"; mk() { npx -y "@liqweed/motion-kit@$V" "$@"; }
31
+ else
32
+ MK="$PLUGIN"; mk() { node "$MK/cli/motion-kit.mjs" "$@"; }
33
+ fi
34
+ mk --help
18
35
  ```
19
- Node ≥ 22. PNG/video need `@resvg/resvg-js` (`npm install` in `$MK`) and `ffmpeg`.
36
+ Node ≥ 22. PNG and video need `@resvg/resvg-js`; video also needs `ffmpeg`.
37
+ When one is missing, the CLI names it: install `@resvg/resvg-js` with
38
+ `npm install` in `$MOTION_KIT_HOME` (or use the `npx` route), and `ffmpeg`
39
+ from the system's package manager (`brew install ffmpeg`, `apt install ffmpeg`).
20
40
 
21
41
  ## Workflow
22
42
 
@@ -33,7 +53,7 @@ Node ≥ 22. PNG/video need `@resvg/resvg-js` (`npm install` in `$MK`) and `ffmp
33
53
  Write the spec, then render the step contact sheet and show it:
34
54
  `motion-kit export spec.json -o <scratch>/sb --png --qc` → open `index.html`
35
55
  or show the PNGs. Get a yes on the *story* before polishing.
36
- 3. **Build.** Spec-driven types first (`sequence`, `hub-spoke`). Only write a
56
+ 3. **Build.** Spec-driven types first (`sequence`, `hub-spoke`, `timeline`, `stack`). Only write a
37
57
  custom scene module when no type fits (`references/custom-scenes.md`).
38
58
  4. **Gate.** `motion-kit check spec.json` must pass in every format/locale
39
59
  shipped: deterministic, settled steps, rounded numbers, token-only colours,
@@ -52,7 +72,8 @@ Node ≥ 22. PNG/video need `@resvg/resvg-js` (`npm install` in `$MK`) and `ffmp
52
72
  - Every motion must answer "what does this help the viewer understand?".
53
73
  - Skeleton first, then fill: show the whole structure, then walk through it.
54
74
  - One emphasis colour, one emphasis element.
55
- - Step frames are settled: the next motion starts at or after the step's `at`.
75
+ - Step frames are settled: motion comes to rest by the step's `at`, and the
76
+ next motion starts no earlier than 50 ms after it.
56
77
  - Long text belongs in HTML captions (`detail`), not in the SVG.
57
78
  - Always a pause control (WCAG 2.2.2); reduced motion = final frame, no autoplay.
58
79
  - No `Date`, `Math.random`, `performance.now` inside a scene.
@@ -63,11 +84,13 @@ Node ≥ 22. PNG/video need `@resvg/resvg-js` (`npm install` in `$MK`) and `ffmp
63
84
  mk() { node "$MK/cli/motion-kit.mjs" "$@"; }
64
85
  mk types; mk formats
65
86
  mk check diagram.json # all formats × locales
87
+ mk check flow.scene.mjs -l en -l nl --options labels.mjs # a custom module, with its text from the caller
66
88
  mk build diagram.json -o diagram.html -f wide -l nl # Craft Page / standalone
67
89
  mk export diagram.json -o out/ --png --qc # slides + review sheet
68
90
  mk bake diagram.json -o diagram.svg -f wide # zero-JS animated SVG
69
91
  mk video diagram.json -f 9:16 -o reel.mp4 --sheet sheet.png
70
- mk vendor <repo>/components/motion-kit --adapter slidev # or astro / page
92
+ mk vendor <repo>/components/motion-kit --adapter slidev # or astro / page / element
93
+ node <repo>/components/motion-kit/check.mjs flow.scene.mjs -l en -l nl --style brand.json --options labels.mjs # the vendored gate, same checks
71
94
  ```
72
95
 
73
96
  Vendoring includes the full MIT `LICENSE`. Keep that file and the SPDX
@@ -18,8 +18,10 @@ export default function make({ format = "16:9", locale = "en" } = {}) {
18
18
  duration: 4.2,
19
19
  title: localize({ en: "…", nl: "…" }, locale),
20
20
  description: localize({ en: "…", nl: "…" }, locale),
21
- steps: [{ at: 1.2, label: "…", detail: "…" }, …],
22
- frame(t) { /* return inner SVG markup for time t */ },
21
+ steps: [{ at: 1.2, label: "…", detail: "…", id: "request" }, …],
22
+ frame(t, { idPrefix }) {
23
+ // inner SVG markup for time t; ids are `${idPrefix}-…`
24
+ },
23
25
  };
24
26
  }
25
27
  ```
@@ -28,8 +30,19 @@ Rules:
28
30
 
29
31
  - Pure: the frame depends only on `t` and constants. No clock, no randomness,
30
32
  no module-level mutable state.
31
- - Colours only via `tok()`; numbers in strings via `num()`.
33
+ - Colours only via `tok()`; numbers in strings via `num()`. Named colours
34
+ (`"red"`) are literals too.
35
+ - Drawing a token pair the scene types don't (accent on surface, emphasis on
36
+ onAccent)? Declare it so the gate checks the style against it:
37
+ `contrastPairs: [{ fg: "accent", bg: "surface", min: 3, use: "bar on its track" }]`
38
+ (4.5 for text, 3 for shapes; `references/styles.md`).
32
39
  - Use `fade()`/`el()` so invisible elements disappear; `drawOn()` for lines.
40
+ - Ids (clip paths, gradients, masks, markers, filters) MUST be built from
41
+ `idPrefix`, the second argument's field: `${idPrefix}-clip`, referenced as
42
+ `url(#${idPrefix}-clip)`. Every render gets a prefix unique to its instance,
43
+ so two copies on one page never share an id. The gate refuses fixed ids.
44
+ - Give steps an `id` when page scripts or links address them
45
+ (`controller.playToStep("request")`); ids are unique within the scene.
33
46
  - Lay out per format; throw if labels don't fit (`wrapLabel`).
34
47
  - Gate: `motion-kit check my-diagram.scene.mjs` (all formats you support; pass
35
48
  `--format` to limit).
@@ -38,11 +51,53 @@ Rules:
38
51
  - If the same shape is needed twice, promote it to a scene type in
39
52
  `runtime/types/` with a spec and tests.
40
53
 
54
+ ## Scene options: text and views from the caller
55
+
56
+ Every caller builds a module through `sceneFromModule` (`runtime/kit.mjs`):
57
+
58
+ ```js
59
+ make({ ...options, format, locale, kit })
60
+ ```
61
+
62
+ `options` are the caller's serializable scene options, passed unchanged: a
63
+ site's dictionary entry (`labels`), a `view` to draw. `format`, `locale` and
64
+ `kit` are reserved. The same module, options, format and locale give the same
65
+ scene in the gate, the exporters and the browser.
66
+
67
+ ```js
68
+ export default function make({ format = "16:9", labels, view = "full" }) {
69
+ // labels: { title, description, steps: [{ id, label, detail }] } from the caller
70
+ }
71
+ ```
72
+
73
+ - CLI: `--options` takes inline JSON, a `.json` file, or an `.mjs` whose
74
+ default export is the options or `({ format, locale }) => options`, so the
75
+ gate checks each locale with that locale's text:
76
+
77
+ ```js
78
+ // labels.mjs
79
+ import en from "../i18n/en.json" with { type: "json" };
80
+ import nl from "../i18n/nl.json" with { type: "json" };
81
+ export default ({ locale }) => ({ labels: { en, nl }[locale].flow });
82
+ ```
83
+
84
+ ```bash
85
+ motion-kit check flow.scene.mjs -l en -l nl --options labels.mjs --style brand.json
86
+ ```
87
+
88
+ A vendored copy runs the same gate: `node <vendored>/check.mjs` takes the
89
+ same files and flags.
90
+ - Astro adapter: `<AnimatedDiagram module="/src/diagrams/flow.scene.mjs"
91
+ options={{ labels: t.flow }} locale={lang} format="wide" />`. The module
92
+ lives under `src/` and ends in `.scene.mjs` or `.scene.js`; the adapter
93
+ renders it on the server and loads it in the browser on demand. Only the
94
+ page's locale's text ships.
95
+
41
96
  ## Scenes outside this repository: `kit`
42
97
 
43
- The CLI calls `make({ format, locale, kit })`, where `kit` is the whole
44
- runtime in one flat namespace (`lib/load.mjs` `KIT`). A scene file kept in
45
- another repository can destructure what it needs instead of importing:
98
+ `kit` is the whole runtime in one flat namespace (`runtime/kit.mjs` `KIT`). A
99
+ scene file kept in another repository can destructure what it needs instead of
100
+ importing:
46
101
 
47
102
  ```js
48
103
  export default function make({ format = "1:1", kit }) {
@@ -51,6 +106,6 @@ export default function make({ format = "1:1", kit }) {
51
106
  }
52
107
  ```
53
108
 
54
- Every Node-side command (check, export, bake, icon, video) supports this.
55
- `motion-kit build` bundles the module for the browser and needs relative
56
- imports; vendor the runtime for that.
109
+ Every command supports this, `motion-kit build` included (it bundles the whole
110
+ runtime and passes it as `kit`). A module that imports instead must use
111
+ relative imports to a vendored runtime.