@jokerized/decksmith 0.3.2 → 0.4.0

package/dist/types/deck/runtime.d.ts

@@ -1,3 +1,4 @@
+import { type Narration } from "./subtitles.js";
 /** One entry of the slideshow island's `slides` array. */
 export interface SlideSpec {
     sceneId: string;
@@ -49,6 +50,32 @@ export interface TransitionPlan {
 export declare function planTransition(fromT: number, toT: number, opts?: {
     reducedMotion?: boolean;
 }): TransitionPlan;
+/**
+ * How long autoplay waits on the stop it is on, or `null` for "do not set a
+ * timer". Pure, for the same reason `planTransition` and `refused` are: the
+ * decision has two callers and lives inside `start`, which no test in this
+ * project can reach.
+ *
+ * `heard` is the whole point of the split. A narrated stop is timed by its own
+ * audio — speech drives the deck, which is this project's entire timing model —
+ * so it waits for `ended` and wants no timer. But `voice.at` answers
+ * synchronously about whether a segment EXISTS, while `play()` rejects a beat
+ * later, so at arrival a stop whose file is missing is indistinguishable from a
+ * working one. Ask again when `play()` settles and the answer can flip either
+ * way: to `false`, and the stop needs the clock after all or autoplay waits
+ * forever for an `ended` that a source which never loaded cannot fire; or back
+ * to `true`, when a gesture retried the segment and it is speaking now, and the
+ * timer armed while it was silent would cut the sentence it just started.
+ *
+ * `gapMs` is the gap the author left before the next stop, the same number the
+ * linear render used, clamped so neither a back-to-back pair nor a long hold
+ * turns into a bad wait.
+ */
+export declare function dwellMs(opts: {
+    playing: boolean;
+    heard: boolean;
+    gapMs: number;
+}): number | null;
 /** `#3` is slide 3; `#3.2` is slide 3, second fragment. Both 1-based. */
 export declare function formatHash(pos: Pos): string;
 export declare function parseHash(hash: string): Pos | null;
@@ -78,6 +105,106 @@ interface Frame {
  * cannot drive it. `present()` says so out loud rather than rendering blank.
  */
 export declare function frameOf(player: Player): Frame | null;
+export interface Voice {
+    /**
+     * Arrive at a stop: cut whatever was speaking, start this stop from zero.
+     * Returns whether this stop has anything to say — autoplay needs to know,
+     * because a silent stop has no `ended` event to wait for and would otherwise
+     * be where playback quietly stops forever.
+     */
+    at: (stop: Stop) => boolean;
+    /**
+     * Stop talking without arriving anywhere. The deck has ONE audio track and
+     * `claim-figure` already spends it on narration — see its `muted` note — so
+     * anything else that wants to make a sound has to take it first.
+     */
+    hush: () => void;
+    toggleMute: () => void;
+    toggleSubtitles: () => void;
+    /** Called when the segment for the CURRENT stop finishes of its own accord. */
+    onEnded: (fn: () => void) => void;
+    /**
+     * Called when the CURRENT stop's `play()` settles, with whether there is going
+     * to be a sound. Autoplay needs it because `at` answers one beat too early:
+     * `at` says a segment EXISTS, and `play()` says whether it can be heard.
+     *
+     * BOTH answers matter. False means no `ended` will ever fire, so a deck
+     * playing itself must fall back to its own clock or sit on that slide forever
+     * with the button lit. True is how it gives that clock back — a segment
+     * retried after a dropped connection is speaking now, and a timer armed while
+     * it was silent would cut the sentence it just started.
+     */
+    onSettled: (fn: (heard: boolean) => void) => void;
+    /**
+     * A real gesture: retry the segment for the stop we are on. Covers the
+     * autoplay policy, which is what it was written for, and a file that failed to
+     * load — see `refused` for why the second one is never retried unasked.
+     */
+    unlock: () => void;
+}
+/**
+ * Was that `play()` rejection the autoplay policy, or an audio file we will
+ * never be able to play? Pure, so the classification is testable without a
+ * browser; the element that produces the rejection is not.
+ *
+ * The two need telling apart because they are not the same failure and must not
+ * be reported as one. The policy is recoverable by construction: the first
+ * gesture retries the segment and it speaks, so "press any key for sound" is
+ * simply true. A file that did not load MIGHT be — a two-second wifi drop and a
+ * one-off 503 look exactly like this from here — but it is just as likely a deck
+ * whose audio directory never got copied, and telling THAT viewer to press a key
+ * names the wrong culprit and goes on being wrong every time they try.
+ *
+ * So this split decides what the strip says, and whether anything retries
+ * unasked. It does NOT decide whether a person may retry: a gesture re-arms
+ * either failure (see `unlock`), because someone asking is not the same as us
+ * guessing. And no gate here can see any of it — nothing in the suite opens
+ * deck.html or plays a sound.
+ *
+ * `NotSupportedError` is the unplayable one — observed rather than taken from
+ * the spec: a source that cannot be fetched at all rejects `play()` with
+ * `NotSupportedError` and leaves `audio.error.code` at 4
+ * (`MEDIA_ERR_SRC_NOT_SUPPORTED`), and so does one that is fetched but is not
+ * media.
+ *
+ * Be honest about what that is worth. It is ONE run, on this machine, in a
+ * headless browser whose engine and version nobody wrote down, and that run
+ * could not show the other side of the split at all: the build played an
+ * ungestured sound even under
+ * `--autoplay-policy=document-user-activation-required`, so no `NotAllowedError`
+ * ever arrived to compare against. Nothing here has watched the two failures
+ * come out of the same browser. Treat "a missing segment reads as missing on the
+ * first attempt" as what that one run did, not as a cross-engine guarantee.
+ *
+ * Everything else FAILS SAFE to the policy, `NotAllowedError` included, and that
+ * is exactly what makes such thin evidence affordable: rejection names are
+ * per-engine, and an unknown one degrading to what ships today is the smaller
+ * mistake — "press any key" over a file we could have played still recovers on
+ * the first gesture, whereas the other way round leaves a recoverable deck
+ * permanently silent.
+ */
+export declare function refused(err: unknown): boolean;
+/**
+ * Speech and subtitles for one presented deck.
+ *
+ * Two rules earn their own object. First, leaving a stop must silence it
+ * immediately by every route — arrow, click, Home/End, hashchange — so all of
+ * them funnel through `at`, which stops before it starts; two sentences talking
+ * over each other is worse than no narration at all.
+ *
+ * Second, cues are timed against `audio.currentTime` and nothing else. A timer
+ * started alongside `play()` agrees with the audio right up until the first
+ * stall, and then never again — and a stall is exactly when a viewer is looking
+ * at the subtitle to find out what they missed.
+ *
+ * Exported, with `Voice`, only so a test can drive its failure paths: everything
+ * that matters below happens after `play()` rejects, and nothing else in this
+ * module can hand it that promise. `start` is the only caller.
+ */
+export declare function mountVoice(doc: Document, narration: Narration, ui: {
+    subs: HTMLElement;
+    flags: HTMLElement;
+}): Voice;
 /** One player-page video, keyed in the island by the scene that draws its still. */
 export interface ClipSpec {
     /** Already in embeddable form — `embedUrl` in src/pack/media.ts did that at build time. */

package/dist/types/emit/camera.d.ts

@@ -13,12 +13,20 @@
  *
  * Three things here are load-bearing and each of them cost a render to learn:
  *
- * 1. THE MOVE IS TWO `fromTo`s AND NOTHING ELSE. `seek()` passes
- *    `suppressEvents`, so a GSAP `onUpdate` never fires under capture. The first
- *    camera in experiment 008 drove `viewBox` from an `onUpdate`, played
- *    perfectly in a browser, and rendered 900 frames of a frozen `0 0 1920 1080`
- *    with every gate green (invariant 11). State must be applied by the thing
- *    being seeked.
+ * 1. THE MOVE IS TWO `fromTo`s AND NOTHING ELSE. The first camera in experiment
+ *    008 drove `viewBox` from an `onUpdate`, played perfectly in a browser, and
+ *    rendered 900 frames of a frozen `0 0 1920 1080` with every gate green.
+ *
+ *    THAT RECORD STANDS; THE MECHANISM IT WAS ATTRIBUTED TO DOES NOT. `seek()`
+ *    passing `suppressEvents` is why `decksmith frames` sees nothing, but the
+ *    render does not seek — capture runs off Chrome's `beginFrame`, and both
+ *    constructions were re-rendered on 2026-09-04 and both ramped smoothly. What
+ *    a callback actually costs is reproducibility: 11 differing frames of 3,120
+ *    on the demo as built, 260 with one `onUpdate` tween added. Whatever froze
+ *    experiment 008's camera, it was not measured, and this file should not keep
+ *    asserting it. The rule is unchanged and so is the reason for it — state must
+ *    be applied by the thing being seeked. See invariant 11 in AGENTS.md and
+ *    `.planning/2026-09-04-invariant-11-under-beginframe.md`.
  *
  * 2. THE EASES ARE CLOSED FORM AND THEY ARE NOT DECORATION. `zoomEase` travels
  *    scale in log space — a linear scale tween reads as a lurch, and every

package/dist/types/emit/composition.d.ts

@@ -67,6 +67,19 @@ export interface DeckOptions {
      * failure shape.
      */
     onBeatError?: (beatId: string, err: Error) => void;
+    /**
+     * What to do when a beat IS drawn but not as it was authored.
+     *
+     * The other half of `onBeatError`, and the reason it is a second hook rather
+     * than a second call to that one: this beat is IN the deck. An emitter that
+     * drops an ornament to fit its beat — see `Scene.warnings` — says so here, and
+     * absent this hook it says it to nobody, which is the silence the whole
+     * mechanism exists to avoid.
+     *
+     * Called once per built scene, from `layout`. `planCut` emits every beat as
+     * well and stays quiet: its scenes are thrown away.
+     */
+    onBeatWarning?: (beatId: string, warning: string) => void;
     /**
      * The subsetted bundle's `@font-face` CSS, INLINED rather than linked.
      *

package/dist/types/emit/kit.d.ts

@@ -311,20 +311,45 @@ export interface Scene {
      * off, against 7 frames of antialiasing once deferred. Both failures are
      * invisible to every gate. `cameraMeasure` carries the numbers and the controls.
      *
-     * INVARIANT 11 IS THE TRAP HERE. This is not a callback on a tween. `seek()`
-     * passes `suppressEvents`, so measuring from an `onUpdate` — the obvious way to
-     * "measure late" — renders a frozen video with every gate green. Measurement
-     * happens before the timeline exists, and what it produces is ordinary tween
-     * values.
+     * INVARIANT 11 IS THE TRAP HERE. This is not a callback on a tween. Measuring
+     * from an `onUpdate` — the obvious way to "measure late" — is what the
+     * invariant forbids, and the reason is reproducibility rather than the frozen
+     * video an older version of this comment claimed: measured 2026-09-04, one
+     * `onUpdate` tween took the demo from 11 non-reproducible frames of 3,120 to
+     * 260. See AGENTS.md invariant 11. Measurement here happens before the
+     * timeline exists, and what it produces is ordinary tween values.
      */
     measure?: string[];
     /**
      * Vendored runtimes this scene's tweens need registered before its script
-     * runs — `"dsMorph"` for the equation morph. The shell loads a runtime only
-     * when some scene names it, so a deck that names none is byte-for-byte what
-     * it was.
+     * runs — `"dsMorph"` for the equation morph, `"morphSVG"` for a reshape. The
+     * shell loads a runtime only when some scene names it, so a deck that names
+     * none is byte-for-byte what it was.
+     *
+     * `PLUGINS` in `composition.ts` is the ONE place a name resolves, and it is
+     * the list to read before returning this field: the type is
+     * `readonly string[]`, so a name that table does not know is a typo no
+     * compiler can see, and the shell refuses it there rather than emitting a
+     * scene whose plugin tween animates nothing.
      */
     plugins?: readonly string[];
+    /**
+     * WHAT THE ARCHETYPE HAD TO GIVE UP TO DRAW THIS BEAT, one sentence each.
+     *
+     * The middle answer between drawing the beat as asked and refusing it. An
+     * emitter that cannot fit everything it was given has three moves: draw it
+     * anyway and let it collide or truncate, which is the failure this project
+     * keeps finding by eye; throw, which reaches `onBeatError` and costs the whole
+     * SLIDE; or draw less and say so, which is this. Reach for it when the thing
+     * dropped is an ORNAMENT — line-chart's reshape against a baseline, say —
+     * and for the throw when what is left would misrepresent the source.
+     *
+     * Surfaced by `layout` through `DeckOptions.onBeatWarning`, once per built
+     * scene. `planCut`'s measuring pass emits every beat too and deliberately does
+     * not report these: it throws its scenes away, and the same sentence twice per
+     * beat trains people to stop reading it.
+     */
+    warnings?: readonly string[];
     /**
      * Hold points in seconds from the scene's start — where a presenter should
      * pause. The shell converts these to absolute island fragment times.

package/dist/types/emit/svg.d.ts

@@ -69,6 +69,33 @@ export declare function nv(v: number): number;
  */
 export declare const DRAW_FROM: Vars;
 export declare const DRAW_TO: Vars;
+/**
+ * ONE SHAPE BECOMES ANOTHER — a baseline curve lifting off its own position and
+ * settling into the result, leaving whatever was drawn under it behind.
+ *
+ * The from-vars are SELF-REFERENTIAL: `{ morphSVG: { shape: target } }` means
+ * "start from the `d` you were authored with". That is the construction
+ * `experiments/013-vocabulary/gaps/spike/index.html:147` measured, and it is the
+ * only one that keeps invariant 2 checkable by `tsc` — MorphSVG's natural
+ * spelling is a bare `to`, which is a `from()` wearing different clothes.
+ * `_parseShape` reads `data-original` when the shape names the target itself
+ * (MorphSVGPlugin.js), so the start is the authored path however many times the
+ * tween is re-initialised under a seek.
+ *
+ * `to` NAMES A SELECTOR, so the end shape lives in the document as a hidden
+ * sibling rather than as a path string in the timeline. Two copies of the same
+ * geometry — one in the `d` attribute, one in the tween — is the duplication
+ * `drawFrom` was retired for.
+ *
+ * Safe under capture for the reason DrawSVG is: a plugin's `render()` is part of
+ * being seeked where a callback is not. Measured for THIS plugin in a deck, not
+ * inherited from that one — `.planning/2026-09-08-reshape-seam.md`.
+ *
+ * ONE CALL PER (ELEMENT, MORPH). `first` is false for any reshape that is not
+ * the element's first on `morphSVG`; a second immediate render on one property
+ * would establish its start state at build time and undo the first.
+ */
+export declare function reshape(target: string, to: string, at: number, seconds: number, first: boolean): Tween;
 /**
  * Something travels a polyline — a pulse along an arrow, a marker ring along a
  * curve, a highlight down a divider: one `x`/`y` `fromTo` per leg, each leg's

package/dist/types/index.d.ts

@@ -166,6 +166,19 @@ export type { AssetRequest, Fetcher, Media, MediaPlan } from "./pack/media.js";
  */
 export { CONFIG_FILE, loadPrefs } from "./prefs.js";
 export type { Prefs, PrefsPatch } from "./prefs.js";
+/**
+ * The `TMPDIR` guard, exported because `src/server/main.ts` has no other way to
+ * reach it: `build:server` transpiles without bundling, so a deep import there
+ * would survive into `dist/server/` and resolve to nothing. It fails the house
+ * rule for this file — nobody outside asked for it — and it is here anyway,
+ * because the alternative is a second copy of the guard living under `server/`.
+ *
+ * A CONSUMER SHOULD NEVER NEED TO CALL IT. It is a no-op in a published install
+ * (see src/tmpdir.ts for why), and importing this module does not run it: an
+ * absent `TMPDIR` is inherited by every child process, which is not something a
+ * library import may decide for its host.
+ */
+export { guardTmpdir } from "./tmpdir.js";
 /**
  * Every schema and type. Unusually broad for this file, and justified: `types.ts`
  * is nothing but the wire format — what `source.json`, `storyboard.json`,
@@ -197,6 +210,12 @@ export interface BuildDeckOptions {
      * Absent, the emitter's error propagates — see `DeckOptions.onBeatError`.
      */
     onBeatError?: (beatId: string, err: Error) => void;
+    /**
+     * Called when a beat is drawn but not as it was authored — an emitter dropped
+     * an ornament to fit the beat's length. The beat is IN the deck; nothing is
+     * missing but the ornament. See `DeckOptions.onBeatWarning`.
+     */
+    onBeatWarning?: (beatId: string, warning: string) => void;
     /** Any name in `THEME_NAMES`. Overrides `storyboard.theme`. */
     theme?: string;
     /** Multiplies every duration and hold. 1 leaves the bytes untouched. */

package/dist/types/tmpdir.d.ts

@@ -0,0 +1,33 @@
+/**
+ * The directory holding our own `package.json`, found by RESOLVING it rather
+ * than by counting `..` segments off `import.meta.url`.
+ *
+ * The positional form gives the same answer everywhere this module can land
+ * today — `src/` under vitest, and the depth-one bundles `dist/cli.js`,
+ * `dist/mcp.js` and `dist/index.js`, which is the convention `src/version.ts`
+ * relies on and explains at length. The problem is how it FAILS: at any other
+ * depth the root silently becomes `dist/`, nothing is ever inside it, and the
+ * guard turns into a no-op that prints nothing and throws nothing. Nobody would
+ * notice until the directories came back. `require.resolve` throws
+ * MODULE_NOT_FOUND there instead, which is the whole reason for the detour.
+ *
+ * One consequence, stated rather than left to be discovered: in a published
+ * install this resolves to `node_modules/@jokerized/decksmith`, and nobody's
+ * TMPDIR is inside that, so the guard is a deliberate no-op for consumers. It
+ * protects this checkout — the mess is ours. Do NOT "fix" the asymmetry by
+ * testing `process.cwd()`: a user who legitimately works inside their temp
+ * directory would have their `TMPDIR` deleted for it.
+ *
+ * Exported for the test that asserts the depth is still right.
+ */
+export declare function packageRoot(): string;
+/** True when `dir` is the package root or sits inside it, symlinks resolved. */
+export declare function insideRoot(dir: string): boolean;
+/**
+ * Unset a `TMPDIR` that resolves inside the package root, and say so.
+ *
+ * Idempotent by construction rather than by a flag: once the variable is gone
+ * `os.tmpdir()` answers from the platform default, so a second call finds
+ * nothing to do and stays silent.
+ */
+export declare function guardTmpdir(): void;

package/dist/types/types.d.ts

@@ -205,6 +205,13 @@ export declare const lineChartParamsSchema: z.ZodObject<{
     }, z.core.$strip>>;
     deltas: z.ZodOptional<z.ZodArray<z.ZodString>>;
     readout: z.ZodOptional<z.ZodString>;
+    compare: z.ZodOptional<z.ZodObject<{
+        label: z.ZodString;
+        points: z.ZodArray<z.ZodObject<{
+            x: z.ZodString;
+            y: z.ZodNumber;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
 }, z.core.$strip>;
 export declare const calloutParamsSchema: z.ZodObject<{
     eyebrow: z.ZodOptional<z.ZodString>;
@@ -609,6 +616,13 @@ export declare const beatSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
         }, z.core.$strip>>;
         deltas: z.ZodOptional<z.ZodArray<z.ZodString>>;
         readout: z.ZodOptional<z.ZodString>;
+        compare: z.ZodOptional<z.ZodObject<{
+            label: z.ZodString;
+            points: z.ZodArray<z.ZodObject<{
+                x: z.ZodString;
+                y: z.ZodNumber;
+            }, z.core.$strip>>;
+        }, z.core.$strip>>;
     }, z.core.$strip>;
     id: z.ZodString;
     intent: z.ZodString;
@@ -1208,6 +1222,13 @@ export declare const storyboardSchema: z.ZodObject<{
             }, z.core.$strip>>;
             deltas: z.ZodOptional<z.ZodArray<z.ZodString>>;
             readout: z.ZodOptional<z.ZodString>;
+            compare: z.ZodOptional<z.ZodObject<{
+                label: z.ZodString;
+                points: z.ZodArray<z.ZodObject<{
+                    x: z.ZodString;
+                    y: z.ZodNumber;
+                }, z.core.$strip>>;
+            }, z.core.$strip>>;
         }, z.core.$strip>;
         id: z.ZodString;
         intent: z.ZodString;
@@ -1981,6 +2002,13 @@ export declare const packSchema: z.ZodObject<{
                 }, z.core.$strip>>;
                 deltas: z.ZodOptional<z.ZodArray<z.ZodString>>;
                 readout: z.ZodOptional<z.ZodString>;
+                compare: z.ZodOptional<z.ZodObject<{
+                    label: z.ZodString;
+                    points: z.ZodArray<z.ZodObject<{
+                        x: z.ZodString;
+                        y: z.ZodNumber;
+                    }, z.core.$strip>>;
+                }, z.core.$strip>>;
             }, z.core.$strip>;
             id: z.ZodString;
             intent: z.ZodString;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jokerized/decksmith",
-  "version": "0.3.2",
+  "version": "0.4.0",
   "description": "Turn a source document into an animated explanation deck.",
   "type": "module",
   "license": "MIT",
@@ -63,7 +63,7 @@
     "commander": "^14.0.1",
     "fflate": "^0.8.3",
     "gsap": "^3.14.2",
-    "hyperframes": "0.8.27",
+    "hyperframes": "0.8.33",
     "katex": "^0.16.11",
     "puppeteer-core": "^25.3.0",
     "remark-gfm": "^4.0.1",