dsh-hyperframes 0.2.0 → 0.3.1

package/skills/media-use/scripts/lib/recipe-store.test.mjs

@@ -0,0 +1,367 @@
+import { strict as assert } from "node:assert";
+import { test } from "node:test";
+import { existsSync, mkdirSync, mkdtempSync, readFileSync, rmSync, writeFileSync } from "node:fs";
+import { tmpdir } from "node:os";
+import { join } from "node:path";
+import {
+  freezeRecipe,
+  listRecipes,
+  skeletonizeBrief,
+  skeletonizeStoryboard,
+  slugifyRecipeName,
+  useRecipe,
+} from "./recipe-store.mjs";
+import { recordPreference } from "./prefs-store.mjs";
+
+const STORYBOARD = `---
+format: 1080x1080
+message: "Ship a launch video in an afternoon"
+arc: Hook → Problem → Solution
+audience: indie devs on X
+mode: collaborative
+music: upbeat tech
+---
+
+## Frame 1 — Hook
+
+- scene: Big type punches in
+- duration: 3s
+- transition_in: cut
+- status: animated
+- voiceover: "Ship a launch video in an afternoon."
+- src: compositions/frames/01-hook.html
+
+Open cold on the promise. This is the thesis.
+
+## Frame 2 — Proof
+
+- duration: 4s
+- transition_in: crossfade
+- status: animated
+- asset_candidates: dashboard.png
+- src: compositions/frames/02-proof.html
+
+Real dashboard, real numbers.
+Second prose line to collapse.
+
+## Video direction
+
+Punchy, one accent color, hard cuts on the beat.
+`;
+
+const BRIEF = `---
+workflow: product-launch-video
+flow: automation
+storyboard: yes
+message: "Ship a launch video in an afternoon"
+audience: indie devs on X
+destination: x-feed
+aspect: 1080x1080
+language: en
+length: 60s
+angle: feature-reveal
+---
+
+## Intent
+
+Sell the afternoon-launch promise to indie devs.
+
+## Assets
+
+- public/dashboard.png — the real dashboard, proof beat.
+
+## Notes
+
+- No stock-photo aesthetics.
+`;
+
+function sandbox() {
+  const root = mkdtempSync(join(tmpdir(), "mu-recipes-"));
+  const home = join(root, "home");
+  const project = join(root, "my-launch");
+  mkdirSync(home, { recursive: true });
+  mkdirSync(project, { recursive: true });
+  writeFileSync(join(project, "frame.md"), "# Frame spec\nbackground: #101014\n");
+  writeFileSync(join(project, "STORYBOARD.md"), STORYBOARD);
+  process.env.HOME = home;
+  return { root, home, project };
+}
+
+function restoreEnv(saved) {
+  for (const k of Object.keys(process.env)) if (!(k in saved)) delete process.env[k];
+  Object.assign(process.env, saved);
+}
+
+function withSandbox(fn) {
+  const savedEnv = { ...process.env };
+  const box = sandbox();
+  try {
+    fn(box);
+  } finally {
+    restoreEnv(savedEnv);
+    rmSync(box.root, { recursive: true, force: true });
+  }
+}
+
+test("slugifyRecipeName normalizes and rejects empty", () => {
+  assert.equal(slugifyRecipeName("Weekly Changelog!"), "weekly-changelog");
+  assert.equal(slugifyRecipeName("  pr_reveal  "), "pr-reveal");
+  assert.throws(() => slugifyRecipeName("!!!"));
+});
+
+test("skeletonize keeps structure, resets status, blanks content", () => {
+  const skeleton = skeletonizeStoryboard(STORYBOARD);
+  // Structure kept.
+  assert.match(skeleton, /format: 1080x1080/);
+  assert.match(skeleton, /arc: Hook → Problem → Solution/);
+  assert.match(skeleton, /music: upbeat tech/);
+  assert.match(skeleton, /- duration: 3s/);
+  assert.match(skeleton, /- src: compositions\/frames\/01-hook\.html/);
+  assert.match(skeleton, /## Video direction/);
+  assert.match(skeleton, /hard cuts on the beat/);
+  // Statuses reset.
+  assert.equal((skeleton.match(/- status: outline/g) ?? []).length, 2);
+  assert.doesNotMatch(skeleton, /animated/);
+  // Content blanked.
+  assert.doesNotMatch(skeleton, /message:/);
+  assert.doesNotMatch(skeleton, /audience:/);
+  assert.doesNotMatch(skeleton, /mode:/);
+  assert.doesNotMatch(skeleton, /voiceover/);
+  assert.doesNotMatch(skeleton, /asset_candidates/);
+  assert.doesNotMatch(skeleton, /thesis/);
+  assert.doesNotMatch(skeleton, /Real dashboard/);
+  assert.match(skeleton, /<fill in: this video's content for the "Hook" beat/);
+  assert.match(skeleton, /<fill in: this video's content for the "Proof" beat/);
+});
+
+test("skeletonizeBrief keeps reusable keys, drops run-shape, blanks body sections", () => {
+  const skeleton = skeletonizeBrief(BRIEF);
+  // Reusable frontmatter kept.
+  assert.match(skeleton, /workflow: product-launch-video/);
+  assert.match(skeleton, /destination: x-feed/);
+  assert.match(skeleton, /aspect: 1080x1080/);
+  assert.match(skeleton, /length: 60s/);
+  assert.match(skeleton, /angle: feature-reveal/);
+  // Run-shape and content keys dropped.
+  assert.doesNotMatch(skeleton, /^flow:/m);
+  assert.doesNotMatch(skeleton, /^storyboard:/m);
+  assert.doesNotMatch(skeleton, /^message:/m);
+  assert.doesNotMatch(skeleton, /^audience:/m);
+  // Body sections kept as headings, prose blanked to placeholders.
+  assert.match(skeleton, /## Intent/);
+  assert.match(skeleton, /## Assets/);
+  assert.match(skeleton, /<fill in: this video's intent/);
+  assert.match(skeleton, /<fill in: this video's assets/);
+  assert.doesNotMatch(skeleton, /afternoon-launch promise/);
+  assert.doesNotMatch(skeleton, /dashboard\.png/);
+});
+
+test("freeze writes the folder, manifest record, and user-tier copy", () => {
+  withSandbox(({ project, home }) => {
+    recordPreference({ projectDir: project, key: "destination", value: "x-feed" });
+    recordPreference({
+      projectDir: project,
+      key: "style_preset",
+      value: "pin-and-paper",
+      workflow: "product-launch-video",
+    });
+    const frozen = freezeRecipe({
+      projectDir: project,
+      name: "Weekly Launch",
+      workflow: "product-launch-video",
+      blocks: ["data-chart"],
+    });
+    assert.equal(frozen.slug, "weekly-launch");
+    assert.equal(frozen.version, 1);
+
+    const dir = join(project, ".media/recipes/weekly-launch");
+    const recipe = JSON.parse(readFileSync(join(dir, "recipe.json"), "utf8"));
+    assert.equal(recipe.workflow, "product-launch-video");
+    assert.equal(recipe.destination, "x-feed");
+    assert.equal(recipe.style_preset, "pin-and-paper");
+    assert.deepEqual(recipe.blocks, ["data-chart"]);
+    assert.ok(existsSync(join(dir, "frame.md")));
+    assert.match(readFileSync(join(dir, "storyboard-skeleton.md"), "utf8"), /- status: outline/);
+
+    const manifest = readFileSync(join(project, ".media/manifest.jsonl"), "utf8");
+    assert.match(manifest, /"type":"recipe"/);
+    assert.match(manifest, /"entity":"weekly-launch"/);
+
+    assert.ok(existsSync(join(home, ".media/recipes/weekly-launch/recipe.json")));
+  });
+});
+
+test("freeze with a BRIEF.md carries the brief skeleton; use hands its path back", () => {
+  withSandbox(({ project, root }) => {
+    writeFileSync(join(project, "BRIEF.md"), BRIEF);
+    const frozen = freezeRecipe({
+      projectDir: project,
+      name: "promo",
+      workflow: "product-launch-video",
+    });
+    assert.equal(frozen.briefSkeleton, true);
+    const skeleton = readFileSync(join(project, ".media/recipes/promo/brief-skeleton.md"), "utf8");
+    assert.match(skeleton, /destination: x-feed/);
+    assert.doesNotMatch(skeleton, /^flow:/m);
+
+    const fresh = join(root, "fresh-project");
+    mkdirSync(fresh, { recursive: true });
+    const used = useRecipe({ projectDir: fresh, name: "promo" });
+    assert.equal(used.briefSkeletonPath, ".media/recipes/promo/brief-skeleton.md");
+    assert.ok(existsSync(join(fresh, ".media/recipes/promo/brief-skeleton.md")));
+  });
+});
+
+test("freeze without a BRIEF.md degrades: no skeleton, use returns no path", () => {
+  withSandbox(({ project, root }) => {
+    const frozen = freezeRecipe({
+      projectDir: project,
+      name: "promo",
+      workflow: "product-launch-video",
+    });
+    assert.equal(frozen.briefSkeleton, false);
+    assert.ok(!existsSync(join(project, ".media/recipes/promo/brief-skeleton.md")));
+
+    const fresh = join(root, "fresh-project");
+    mkdirSync(fresh, { recursive: true });
+    const used = useRecipe({ projectDir: fresh, name: "promo" });
+    assert.equal(used.briefSkeletonPath, undefined);
+  });
+});
+
+test("freeze takes the workflow from BRIEF.md over a contradicting flag", () => {
+  withSandbox(({ project }) => {
+    writeFileSync(
+      join(project, "BRIEF.md"),
+      BRIEF.replace("workflow: product-launch-video", "workflow: general-video"),
+    );
+    const frozen = freezeRecipe({
+      projectDir: project,
+      name: "promo",
+      workflow: "faceless-explainer",
+    });
+    assert.equal(frozen.workflow, "general-video");
+    assert.equal(frozen.workflowOverridden, true);
+    const recipe = JSON.parse(
+      readFileSync(join(project, ".media/recipes/promo/recipe.json"), "utf8"),
+    );
+    assert.equal(recipe.workflow, "general-video");
+  });
+});
+
+test("freeze without BRIEF.md falls back to --workflow; with neither it refuses", () => {
+  withSandbox(({ project }) => {
+    const frozen = freezeRecipe({
+      projectDir: project,
+      name: "promo",
+      workflow: "product-launch-video",
+    });
+    assert.equal(frozen.workflow, "product-launch-video");
+    assert.equal(frozen.workflowOverridden, false);
+    assert.throws(() => freezeRecipe({ projectDir: project, name: "other" }), /no workflow found/);
+  });
+});
+
+test("freeze finds a legacy bare style_preset record; the scoped key wins over it", () => {
+  withSandbox(({ project }) => {
+    writeFileSync(join(project, "BRIEF.md"), BRIEF);
+    // A record made before the store required workflow scoping.
+    mkdirSync(join(project, ".media"), { recursive: true });
+    writeFileSync(
+      join(project, ".media/preferences.json"),
+      JSON.stringify({
+        version: 1,
+        preferences: {
+          style_preset: {
+            value: "source-paper-flowchart",
+            confirmed_in: ["my-launch"],
+            updated_at: "2026-07-15T00:00:00.000Z",
+          },
+        },
+        sightings: {},
+      }),
+    );
+    freezeRecipe({ projectDir: project, name: "promo" });
+    const legacy = JSON.parse(
+      readFileSync(join(project, ".media/recipes/promo/recipe.json"), "utf8"),
+    );
+    assert.equal(legacy.style_preset, "source-paper-flowchart");
+
+    recordPreference({
+      projectDir: project,
+      key: "style_preset",
+      value: "pin-and-paper",
+      workflow: "product-launch-video",
+    });
+    freezeRecipe({ projectDir: project, name: "promo" });
+    const scoped = JSON.parse(
+      readFileSync(join(project, ".media/recipes/promo/recipe.json"), "utf8"),
+    );
+    assert.equal(scoped.style_preset, "pin-and-paper");
+  });
+});
+
+test("re-freezing bumps the version and archives the old folder", () => {
+  withSandbox(({ project }) => {
+    freezeRecipe({ projectDir: project, name: "promo", workflow: "product-launch-video" });
+    const again = freezeRecipe({
+      projectDir: project,
+      name: "promo",
+      workflow: "product-launch-video",
+    });
+    assert.equal(again.version, 2);
+    assert.ok(existsSync(join(project, ".media/recipes/promo@v1/recipe.json")));
+    const current = JSON.parse(
+      readFileSync(join(project, ".media/recipes/promo/recipe.json"), "utf8"),
+    );
+    assert.equal(current.version, 2);
+  });
+});
+
+test("list merges tiers (project wins), filters by workflow, skips archives", () => {
+  withSandbox(({ project, root }) => {
+    freezeRecipe({ projectDir: project, name: "promo", workflow: "product-launch-video" });
+    freezeRecipe({ projectDir: project, name: "promo", workflow: "product-launch-video" });
+    freezeRecipe({ projectDir: project, name: "explainer", workflow: "faceless-explainer" });
+
+    const fresh = join(root, "fresh-project");
+    mkdirSync(fresh, { recursive: true });
+    const all = listRecipes({ projectDir: fresh });
+    assert.deepEqual(all.map((r) => r.source).sort(), ["user", "user"]);
+    assert.equal(all.find((r) => r.name === "promo").version, 2);
+
+    const filtered = listRecipes({ projectDir: fresh, workflow: "faceless-explainer" });
+    assert.deepEqual(
+      filtered.map((r) => r.name),
+      ["explainer"],
+    );
+  });
+});
+
+test("use imports from the user tier into a fresh project and copies frame.md", () => {
+  withSandbox(({ project, root }) => {
+    freezeRecipe({ projectDir: project, name: "promo", workflow: "product-launch-video" });
+
+    const fresh = join(root, "fresh-project");
+    mkdirSync(fresh, { recursive: true });
+    const used = useRecipe({ projectDir: fresh, name: "Promo" });
+    assert.equal(used.recipe.name, "promo");
+    assert.equal(used.skeletonPath, ".media/recipes/promo/storyboard-skeleton.md");
+    assert.ok(existsSync(join(fresh, "frame.md")));
+    assert.ok(existsSync(join(fresh, ".media/recipes/promo/storyboard-skeleton.md")));
+    assert.match(
+      readFileSync(join(fresh, ".media/manifest.jsonl"), "utf8"),
+      /"imported_from":"user-tier"/,
+    );
+  });
+});
+
+test("use with an unknown name lists what exists", () => {
+  withSandbox(({ project }) => {
+    freezeRecipe({ projectDir: project, name: "promo", workflow: "product-launch-video" });
+    assert.throws(
+      () => useRecipe({ projectDir: project, name: "nope" }),
+      /no recipe named "nope" \(known: promo\)/,
+    );
+  });
+});

package/skills/media-use/scripts/lib/registry.mjs

@@ -0,0 +1,218 @@
+// Provider registry — the v2 contract.
+//
+// Each media type maps to an ORDERED list of provider entries. Providers are
+// tried in order; the first to return a non-null result wins, which keeps
+// resolution deterministic (same request -> same provider -> same file ->
+// reproducible renders). heygen-CLI is always first for the types it serves.
+//
+// An entry exposes any of three capability methods — search / generate /
+// process — plus { name }. media-use holds no keys; each external tool owns its
+// own auth. Providers, by type:
+//   - heygen CLI: catalog + TTS, first for every type it serves (OAuth free
+//     allowance first, then the user's HeyGen billing path)
+//   - mflux: local FLUX-class image gen, spec-selected to the machine's RAM
+//     (free, private, offline once cached)
+//   - codex CLI: image gen on the user's ChatGPT sub — the better-quality upsell
+//     and the fallback when no local model fits
+//   - Kokoro (via the hyperframes CLI): local voiceover, free/private fallback
+//     when HeyGen credentials are absent or --local-only is requested
+//
+// Generation is local-first, cloud-upsell. `ctx.provider` forces one provider
+// (e.g. "make an image with codex").
+
+import { bgmProvider } from "./bgm-provider.mjs";
+import { sfxProvider } from "./sfx-provider.mjs";
+import { bundledSfxProvider } from "./bundled-sfx-provider.mjs";
+import { imageProvider, iconProvider } from "./image-provider.mjs";
+import { brandProvider } from "./brand-provider.mjs";
+import {
+  svglSearch,
+  simpleIconsSearch,
+  githubAvatarSearch,
+  faviconSearch,
+} from "./logo-provider.mjs";
+import { heygenTtsGenerate } from "./voice-provider.mjs";
+import { heygenVideoGenerate } from "./heygen-video-provider.mjs";
+import { ltxVideoGenerate } from "./ltx-video-provider.mjs";
+import { localTtsGenerate } from "./tts-local-provider.mjs";
+import { codexImageGenerate } from "./codex-provider.mjs";
+import { mfluxImageGenerate } from "./mflux-provider.mjs";
+
+// Provider markers: `network` = hits a remote service (skipped by --local-only).
+// `paid` = may cost wallet credits after any OAuth/web-plan free allowance
+// (documentation for the agent's cost judgment, X4: agent-initiated paid should
+// confirm). HeyGen catalog SEARCH is free; HeyGen TTS is free for eligible
+// OAuth CLI users up to the monthly allowance, then follows the user's billing.
+const A = (name, caps) => ({ name, ...caps }); // local, free
+const N = (name, caps) => ({ name, network: true, ...caps }); // remote, free
+const P = (name, caps) => ({ name, network: true, paid: true, ...caps }); // remote, paid
+
+// heygen-CLI first. All remote providers are skipped by --local-only.
+const REGISTRY = {
+  bgm: [N("heygen.audio.sounds", { search: bgmProvider.search })],
+  sfx: [
+    N("heygen.audio.sounds", { search: sfxProvider.search }),
+    A("bundled.sfx", { search: bundledSfxProvider.search }),
+  ],
+  image: [
+    N("heygen.asset.search", { search: imageProvider.search }),
+    // Catalog miss -> generate. Local first (best FLUX-class model the machine's
+    // RAM can run, spec-selected; free, private, kept under --local-only), then
+    // the codex CLI on the user's ChatGPT sub as the better-quality upsell and
+    // the fallback when no local model fits.
+    A("mflux.local", { generate: mfluxImageGenerate }),
+    N("codex.image_gen", { generate: codexImageGenerate }),
+  ],
+  icon: [N("heygen.asset.search", { search: iconProvider.search })],
+  logo: [
+    // Official brand marks. Tiers verified by a 54-brand stress test (100%
+    // cascade hit); HeyGen asset search is deliberately absent — it returns
+    // generic look-alike icons for brand queries. All free, all network →
+    // --local-only leaves only the cache rungs.
+    N("svgl", { search: svglSearch }),
+    N("simple-icons", { search: simpleIconsSearch }),
+    N("github.avatar", { search: githubAvatarSearch }),
+    N("favicon.ddg", { search: faviconSearch }),
+  ],
+  voice: [
+    // HeyGen TTS first when credentialed so CLI/OAuth users consume the free
+    // web-plan allowance (10 min/month) before any paid path. --local-only skips
+    // it and keeps Kokoro as the private/offline fallback.
+    // Deliberately kept `paid` (X4 confirm-before-call) even though the first
+    // 10 min/month are free: the client can't know the remaining allowance, so
+    // confirming is safer than risking a silent charge once it's spent. (A
+    // tri-state "quota-first, paid after" would need backend quota state.)
+    P("heygen.tts", { generate: heygenTtsGenerate }),
+    A("kokoro.local", { generate: localTtsGenerate }),
+  ],
+  video: [
+    // HeyGen avatar video first when credentialed; --local-only skips it and
+    // keeps LTX as the local fallback.
+    P("heygen.video", { generate: heygenVideoGenerate }),
+    A("ltx.local", { generate: ltxVideoGenerate }),
+  ],
+  brand: [
+    // Local design spec, not heygen — reads frame.md / design.md tokens.
+    A("design_spec", { search: brandProvider.search }),
+  ],
+  grade: [
+    // Local deterministic cascade handled by resolve.mjs so grade records can
+    // carry an inline block as well as an optional frozen .cube file.
+    A("color_grade.local", { search: async () => null, generate: async () => null }),
+  ],
+  lut: [
+    // Lower-level local LUT generation/freezing path handled by resolve.mjs.
+    A("cube_lut.local", { search: async () => null, generate: async () => null }),
+  ],
+};
+
+function listFor(type) {
+  const list = REGISTRY[type];
+  if (!list) throw new Error(`unknown media type: ${type}`);
+  return list;
+}
+
+/** Ordered providers for a type. */
+export function getProviders(type) {
+  return listFor(type);
+}
+
+/** All declared media types. */
+export function listTypes() {
+  return Object.keys(REGISTRY);
+}
+
+/** Provider names available for a type, in cascade order (for --provider validation). */
+export function providerNamesFor(type) {
+  return listFor(type).map((p) => p.name);
+}
+
+/**
+ * name -> cost tier ("local" | "network_free" | "network_paid") over a collection
+ * of ordered provider lists, i.e. the A / N / P distinction the constructors above
+ * already declare. Exported so the conflict rule below is testable against a
+ * fixture; production reads the REGISTRY-wide index built from it.
+ *
+ * A name declared under two media types must carry the same tier in both. If it
+ * didn't, "did this resolve cost credit" would depend on which type happened to
+ * serve it, and the telemetry property would mean nothing — so this throws at
+ * import rather than silently picking one.
+ */
+export function buildProviderTierIndex(providerLists) {
+  const tiers = new Map();
+  for (const list of providerLists) {
+    for (const p of list) {
+      const tier = p.paid ? "network_paid" : p.network ? "network_free" : "local";
+      const prior = tiers.get(p.name);
+      if (prior && prior !== tier)
+        throw new Error(
+          `provider "${p.name}" is declared ${prior} under one media type and ${tier} under another`,
+        );
+      tiers.set(p.name, tier);
+    }
+  }
+  return tiers;
+}
+
+const PROVIDER_TIERS = buildProviderTierIndex(Object.values(REGISTRY));
+
+/**
+ * Cost tier of a provider by name, or undefined for a name the registry doesn't
+ * declare. The registry stays the single owner of "does this cost credit", so
+ * dashboards and callers never re-derive it from provider-name string matching.
+ */
+export function providerTierFor(name) {
+  return PROVIDER_TIERS.get(name);
+}
+
+/**
+ * Does an override token (full name like "codex.image_gen" or a prefix like
+ * "codex") match any provider declared for the type? Same match rule as
+ * runProviders, so validation and dispatch never disagree.
+ */
+export function providerMatches(type, want) {
+  return providerNamesFor(type).some((n) => n === want || n.startsWith(`${want}.`));
+}
+
+/**
+ * Back-compat shim for the v1 single-provider API. Returns the first declared
+ * provider for the type (tagged with `type`); throws for an unknown type.
+ * Kept for v1 callers only — new code should use getProviders/runCapability.
+ */
+export function getProvider(type) {
+  const first = listFor(type)[0] || {};
+  return { ...first, type };
+}
+
+/**
+ * Run a capability across an explicit ordered provider list. Tries each in
+ * order, returns the first non-null result, skips providers that don't expose
+ * the capability. Pure over its input — the unit-testable core of the cascade.
+ *
+ * Offline guard: a `network` provider is skipped when `ctx.localOnly` is set —
+ * unconditionally, even under a `ctx.provider` override. --local-only is a hard
+ * safety flag: it must never make a network call. Forcing a network provider
+ * while offline yields a clean miss (the caller explains the conflict), never a
+ * silent network request.
+ * Provider override: `ctx.provider` (a full name like "codex.image_gen" or a
+ * prefix like "codex") pins resolution to matching providers only — this is how
+ * a user "make an image WITH codex" forces the upsell instead of taking the
+ * free-first default.
+ */
+export async function runProviders(providers, capability, intent, ctx) {
+  const want = ctx?.provider;
+  for (const p of providers) {
+    if (want && p.name !== want && !p.name.startsWith(`${want}.`)) continue;
+    if (p.network && ctx?.localOnly) continue; // --local-only wins, even over --provider
+    const fn = p[capability];
+    if (typeof fn !== "function") continue;
+    const res = await fn(intent, ctx);
+    if (res) return res;
+  }
+  return null;
+}
+
+/** Run a capability over the providers for a type (deterministic, heygen-first). */
+export async function runCapability(type, capability, intent, ctx) {
+  return runProviders(getProviders(type), capability, intent, ctx);
+}