@navipartner/demo-video 0.4.0 → 0.5.1

package/bin/pick.d.mts

@@ -1,18 +1,23 @@
-import type { StoryEntry } from "./args.mjs";
-
-export interface AppMenu {
-  dir: string;
-  name: string;
-  stories: StoryEntry[];
-  brands: string[];
-}
-export type Pick =
-  | { app: string; story: string; brand: string | null; menu?: undefined }
-  | { menu: true; reason: string; apps?: AppMenu[] };
-export function appMenu(appDir: string): AppMenu;
-export function pick(request: string, apps: AppMenu[]): Pick;
-export function menuMarkdown(apps: AppMenu[], reason: string): string;
-export function pickExact(
-  apps: AppMenu[],
-  names: { app?: string; story?: string; brand?: string },
-): Pick;
+import type { StoryEntry } from "./args.mjs";
+
+export interface AppMenu {
+  dir: string;
+  name: string;
+  stories: StoryEntry[];
+  brands: string[];
+}
+export type Pick =
+  | {
+      app: string;
+      story: string;
+      brand: string | null;
+      menu?: undefined;
+    }
+  | { menu: true; reason: string; apps?: AppMenu[] };
+export function appMenu(appDir: string): AppMenu;
+export function pick(request: string, apps: AppMenu[]): Pick;
+export function menuMarkdown(apps: AppMenu[], reason: string): string;
+export function pickExact(
+  apps: AppMenu[],
+  names: { app?: string; story?: string; brand?: string },
+): Pick;

package/bin/pick.mjs

@@ -1,252 +1,265 @@
-import fs from "node:fs";
-import path from "node:path";
-import { fileURLToPath } from "node:url";
-
-import { listStories } from "./args.mjs";
-
-// `demo-video pick`: turns a `/demo-video …` request into one of the
-// already-made stories and a brand. No AI and nothing written: stories are a
-// developer's to make (locally, with the skill); a request only chooses.
-//
-//   /demo-video                                  → the primary story (one app)
-//   /demo-video checkout in acme branding   → story "checkout", brand "acme"
-//   /demo-video retail checkout                  → the app whose folder says retail
-//
-// Anything it can't settle on one story is answered with the menu.
-
-const engineDir = path.resolve(
-  path.dirname(fileURLToPath(import.meta.url)),
-  "..",
-);
-
-const STOP = new Set(
-  "a an and as at by for from in into make me of on or our please show story the this to video with branding brand marketing demo film render".split(
-    " ",
-  ),
-);
-
-const words = (text) =>
-  (text.toLowerCase().match(/[a-z0-9æøå]+(?:-[a-z0-9æøå]+)*/g) ?? []).flatMap(
-    (w) => [w, ...(w.includes("-") ? w.split("-") : [])],
-  );
-
-const brandNames = (dir) =>
-  fs.existsSync(dir)
-    ? fs
-        .readdirSync(dir)
-        .filter((f) => f.endsWith(".json"))
-        .map((f) => f.slice(0, -".json".length))
-    : [];
-
-// The adapter may keep its brands elsewhere (`brands: "../brands"`). Read
-// from demo.config.ts's text: a literal path, as the field is documented.
-const adapterBrandsDir = (appDir) => {
-  const config = path.join(appDir, "demo", "demo.config.ts");
-  const text = fs.existsSync(config) ? fs.readFileSync(config, "utf8") : "";
-  const dir = /\bbrands:\s*["'`]([^"'`]+)["'`]/.exec(text)?.[1] ?? "./brands";
-  return path.resolve(appDir, "demo", dir);
-};
-
-/** What an app offers: its stories, and its brands plus the engine's. */
-export const appMenu = (appDir) => ({
-  dir: appDir,
-  name: path.basename(appDir),
-  stories: listStories(path.join(appDir, "demo")),
-  brands: [
-    ...new Set([
-      ...brandNames(adapterBrandsDir(appDir)),
-      ...brandNames(path.join(engineDir, "brands")),
-    ]),
-  ],
-});
-
-/**
- * Picks from `apps` (appMenu results). Returns { app, story, brand } (brand
- * null = the adapter's default) or { menu: true, reason }.
- */
-export const pick = (request, apps) => {
-  const said = words(request);
-  const has = (word) => said.includes(word.toLowerCase());
-
-  // The brand: any offered brand named in the request.
-  const allBrands = [...new Set(apps.flatMap((a) => a.brands))];
-  const brands = allBrands.filter(has);
-  if (brands.length > 1) {
-    return {
-      menu: true,
-      reason: `Name one brand, not ${brands.join(" and ")}.`,
-    };
-  }
-  const brand = brands[0] ?? null;
-
-  // What's left of the request once the brand and filler are gone.
-  const content = said.filter(
-    (w) => !STOP.has(w) && !brands.includes(w) && !/^\d+$/.test(w),
-  );
-
-  // The app: named by its folder, else by a part of it no other app's
-  // folder has ("retail", not "self"), else the only one.
-  let candidates = apps;
-  if (apps.length > 1) {
-    const exact = apps.filter((a) => has(a.name));
-    const partCount = (part) =>
-      apps.filter((a) => a.name.split("-").includes(part)).length;
-    const named = exact.length
-      ? exact
-      : apps.filter((a) =>
-          a.name
-            .split("-")
-            .some(
-              (part) => part.length > 3 && partCount(part) === 1 && has(part),
-            ),
-        );
-    if (named.length === 1) {
-      candidates = named;
-    }
-  }
-
-  // Score every story: its name (or a part of it) said outright counts most,
-  // then words shared with its description.
-  // Variants aren't scored: the base story plus the brand finds them.
-  const scored = candidates.flatMap((app) =>
-    app.stories
-      .filter((story) => !story.extends)
-      .map((story) => {
-        const nameParts = story.name.split("-");
-        // "checkout express" says the story checkout-express in full.
-        let score = has(story.name) || nameParts.every((p) => has(p)) ? 10 : 0;
-        score += nameParts.filter((p) => p.length > 2 && has(p)).length * 3;
-        const description = new Set(words(story.description ?? ""));
-        score += content.filter(
-          (w) => w.length > 2 && description.has(w),
-        ).length;
-        return { app, story, score };
-      }),
-  );
-  const best = Math.max(0, ...scored.map((s) => s.score));
-  const top = scored.filter((s) => s.score === best);
-
-  if (best === 0) {
-    // Nothing named a story: a request with no feature gets the primary
-    // story ("a marketing video of the retail app"), if that's one app.
-    const noFeature = content.every((w) =>
-      candidates.some(
-        (a) => a.name.includes(w) || a.name.split("-").includes(w),
-      ),
-    );
-    const primaries = candidates
-      .map((app) => ({ app, story: app.stories.find((s) => s.primary) }))
-      .filter((p) => p.story);
-    if (noFeature && candidates.length === 1 && primaries.length === 1) {
-      return withBrand(primaries[0].app, primaries[0].story.name, brand);
-    }
-    return {
-      menu: true,
-      reason:
-        candidates.length > 1 && noFeature
-          ? "Which app?"
-          : "No story matches that. Pick one by name:",
-    };
-  }
-  if (top.length > 1) {
-    return {
-      menu: true,
-      reason: `That matches ${top.map((t) => `\`${t.story.name}\``).join(", ")}. Pick one by name:`,
-    };
-  }
-  return withBrand(top[0].app, top[0].story.name, brand);
-};
-
-// The brand must be one the chosen app has: another app's brand would fail
-// at render time with a worse message. A story with a variant for that brand
-// (checkout + acme → checkout.acme) films the variant: its words are the
-// customer's.
-const withBrand = (app, story, brand) => {
-  if (brand && !app.brands.includes(brand)) {
-    return {
-      menu: true,
-      reason: `No brand \`${brand}\` in ${app.name}. Pick one:`,
-      apps: [app],
-    };
-  }
-  const variant =
-    brand && app.stories.find((s) => s.extends === story && s.brand === brand);
-  return { app: app.dir, story: variant ? variant.name : story, brand };
-};
-
-/** The menu as Markdown, for the PR reply. */
-export const menuMarkdown = (apps, reason) => {
-  const lines = [reason, ""];
-  for (const app of apps) {
-    lines.push(`**${app.name}**`);
-    if (app.stories.length === 0) {
-      lines.push("- no stories yet");
-    }
-    for (const s of app.stories.filter((x) => !x.extends)) {
-      lines.push(
-        `- \`${s.name}\`${s.primary ? " (primary)" : ""}${s.description ? `: ${s.description}` : ""}`,
-      );
-      for (const v of app.stories.filter((x) => x.extends === s.name)) {
-        lines.push(`  - in \`${v.brand}\` branding: \`${v.name}\``);
-      }
-    }
-    lines.push(`- brands: ${app.brands.map((b) => `\`${b}\``).join(", ")}`, "");
-  }
-  const example = apps.find((a) => a.stories.some((s) => !s.extends));
-  if (example) {
-    lines.push(
-      `For example: \`/demo-video ${example.stories.find((s) => !s.extends).name}${example.brands.length > 1 ? ` in ${example.brands.find((b) => b !== "navipartner") ?? example.brands[0]} branding` : ""}\``,
-    );
-  }
-  return lines.join("\n");
-};
-
-/**
- * The form's version (Actions → Run workflow): app, story and brand by name,
- * no guessing. Empty story = the primary story, empty brand = the adapter's
- * default, empty app = the only app. A name that doesn't exist gets the menu,
- * so a typo never films something else. `apps` in a menu result narrows it.
- */
-export const pickExact = (apps, { app = "", story = "", brand = "" }) => {
-  const slashes = (p) => p.split("\\").join("/");
-  const wanted = slashes(app).replace(/\/+$/, "");
-  const candidates = wanted
-    ? apps.filter((a) => {
-        const dir = slashes(a.dir);
-        return (
-          a.name === wanted || dir === wanted || dir.endsWith(`/${wanted}`)
-        );
-      })
-    : apps;
-  if (candidates.length === 0) {
-    return { menu: true, reason: `No app \`${wanted}\`. The apps:` };
-  }
-  if (candidates.length > 1) {
-    return { menu: true, reason: "Which app? Fill in App with one of:" };
-  }
-  const chosen = candidates[0];
-  const found = story
-    ? chosen.stories.find((s) => s.name === story)
-    : chosen.stories.find((s) => s.primary);
-  if (!found) {
-    return {
-      menu: true,
-      reason: story
-        ? `No story \`${story}\` in ${chosen.name}. Pick one:`
-        : `${chosen.name} has no primary story. Pick one:`,
-      apps: [chosen],
-    };
-  }
-  if (found.extends) {
-    // A variant is made for one brand.
-    if (brand && brand !== found.brand) {
-      return {
-        menu: true,
-        reason: `\`${found.name}\` is made for \`${found.brand}\`. Leave Brand empty, or pick \`${found.extends}\`:`,
-        apps: [chosen],
-      };
-    }
-    return { app: chosen.dir, story: found.name, brand: found.brand };
-  }
-  return withBrand(chosen, found.name, brand || null);
-};
+import fs from "node:fs";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+
+import { listStories } from "./args.mjs";
+
+// `demo-video pick`: turns a `/demo-video …` request into one of the
+// already-made stories and a brand. No AI and nothing written: stories are a
+// developer's to make (locally, with the skill); a request only chooses.
+//
+//   /demo-video                                  → the primary story (one app)
+//   /demo-video help                             → the menu
+//   /demo-video checkout in acme branding   → story "checkout", brand "acme"
+//   /demo-video retail checkout                  → the app whose folder says retail
+//
+// Anything it can't settle on one story is answered with the menu.
+
+const engineDir = path.resolve(
+  path.dirname(fileURLToPath(import.meta.url)),
+  "..",
+);
+
+const STOP = new Set(
+  "a an and as at by for from in into make me of on or our please show story the this to video with branding brand marketing demo film render".split(
+    " ",
+  ),
+);
+
+const words = (text) =>
+  (text.toLowerCase().match(/[a-z0-9æøå]+(?:-[a-z0-9æøå]+)*/g) ?? []).flatMap(
+    (w) => [w, ...(w.includes("-") ? w.split("-") : [])],
+  );
+
+const brandNames = (dir) =>
+  fs.existsSync(dir)
+    ? fs
+        .readdirSync(dir)
+        .filter((f) => f.endsWith(".json"))
+        .map((f) => f.slice(0, -".json".length))
+    : [];
+
+// The adapter may keep its brands elsewhere (`brands: "../brands"`). Read
+// from demo.config.ts's text: a literal path, as the field is documented.
+const adapterBrandsDir = (appDir) => {
+  const config = path.join(appDir, "demo", "demo.config.ts");
+  const text = fs.existsSync(config) ? fs.readFileSync(config, "utf8") : "";
+  const dir = /\bbrands:\s*["'`]([^"'`]+)["'`]/.exec(text)?.[1] ?? "./brands";
+  return path.resolve(appDir, "demo", dir);
+};
+
+/** What an app offers: its stories, and its brands plus the engine's. */
+export const appMenu = (appDir) => ({
+  dir: appDir,
+  name: path.basename(appDir),
+  stories: listStories(path.join(appDir, "demo")),
+  brands: [
+    ...new Set([
+      ...brandNames(adapterBrandsDir(appDir)),
+      ...brandNames(path.join(engineDir, "brands")),
+    ]),
+  ],
+});
+
+/**
+ * Picks from `apps` (appMenu results). Returns { app, story, brand } (brand
+ * null = the adapter's default) or { menu: true, reason }.
+ */
+export const pick = (request, apps) => {
+  // A bare /demo-video films the primary story; this asks what there is.
+  if (/^\s*(help|menu|list)\s*$/i.test(request)) {
+    return { menu: true, reason: "The stories and brands:" };
+  }
+  return pickStory(request, apps);
+};
+
+const pickStory = (request, apps) => {
+  const said = words(request);
+  const has = (word) => said.includes(word.toLowerCase());
+
+  // The brand: any offered brand named in the request.
+  const allBrands = [...new Set(apps.flatMap((a) => a.brands))];
+  const brands = allBrands.filter(has);
+  if (brands.length > 1) {
+    return {
+      menu: true,
+      reason: `Name one brand, not ${brands.join(" and ")}.`,
+    };
+  }
+  const brand = brands[0] ?? null;
+
+  // What's left of the request once the brand and filler are gone.
+  const content = said.filter(
+    (w) => !STOP.has(w) && !brands.includes(w) && !/^\d+$/.test(w),
+  );
+
+  // The app: named by its folder, else by a part of it no other app's
+  // folder has ("retail", not "self"), else the only one.
+  let candidates = apps;
+  if (apps.length > 1) {
+    const exact = apps.filter((a) => has(a.name));
+    const partCount = (part) =>
+      apps.filter((a) => a.name.split("-").includes(part)).length;
+    const named = exact.length
+      ? exact
+      : apps.filter((a) =>
+          a.name
+            .split("-")
+            .some(
+              (part) => part.length > 3 && partCount(part) === 1 && has(part),
+            ),
+        );
+    if (named.length === 1) {
+      candidates = named;
+    }
+  }
+
+  // Score every story: its name (or a part of it) said outright counts most,
+  // then words shared with its description.
+  // Variants aren't scored: the base story plus the brand finds them.
+  const scored = candidates.flatMap((app) =>
+    app.stories
+      .filter((story) => !story.extends)
+      .map((story) => {
+        const nameParts = story.name.split("-");
+        // "checkout express" says the story checkout-express in full.
+        let score = has(story.name) || nameParts.every((p) => has(p)) ? 10 : 0;
+        score += nameParts.filter((p) => p.length > 2 && has(p)).length * 3;
+        const description = new Set(words(story.description ?? ""));
+        score += content.filter(
+          (w) => w.length > 2 && description.has(w),
+        ).length;
+        return { app, story, score };
+      }),
+  );
+  const best = Math.max(0, ...scored.map((s) => s.score));
+  const top = scored.filter((s) => s.score === best);
+
+  if (best === 0) {
+    // Nothing named a story: a request with no feature gets the primary
+    // story ("a marketing video of the retail app"), if that's one app.
+    const noFeature = content.every((w) =>
+      candidates.some(
+        (a) => a.name.includes(w) || a.name.split("-").includes(w),
+      ),
+    );
+    const primaries = candidates
+      .map((app) => ({ app, story: app.stories.find((s) => s.primary) }))
+      .filter((p) => p.story);
+    if (noFeature && candidates.length === 1 && primaries.length === 1) {
+      return withBrand(primaries[0].app, primaries[0].story.name, brand);
+    }
+    return {
+      menu: true,
+      reason:
+        candidates.length > 1 && noFeature
+          ? "Which app?"
+          : "No story matches that. Pick one by name:",
+    };
+  }
+  if (top.length > 1) {
+    return {
+      menu: true,
+      reason: `That matches ${top.map((t) => `\`${t.story.name}\``).join(", ")}. Pick one by name:`,
+    };
+  }
+  return withBrand(top[0].app, top[0].story.name, brand);
+};
+
+// The brand must be one the chosen app has: another app's brand would fail
+// at render time with a worse message. A story with a variant for that brand
+// (checkout + acme → checkout.acme) films the variant: its words are the
+// customer's.
+const withBrand = (app, story, brand) => {
+  if (brand && !app.brands.includes(brand)) {
+    return {
+      menu: true,
+      reason: `No brand \`${brand}\` in ${app.name}. Pick one:`,
+      apps: [app],
+    };
+  }
+  const variant =
+    brand && app.stories.find((s) => s.extends === story && s.brand === brand);
+  return { app: app.dir, story: variant ? variant.name : story, brand };
+};
+
+/** The menu as Markdown, for the PR reply. */
+export const menuMarkdown = (apps, reason) => {
+  const lines = [reason, ""];
+  for (const app of apps) {
+    lines.push(`**${app.name}**`);
+    if (app.stories.length === 0) {
+      lines.push("- no stories yet");
+    }
+    for (const s of app.stories.filter((x) => !x.extends)) {
+      lines.push(
+        `- \`${s.name}\`${s.primary ? " (primary)" : ""}${s.description ? `: ${s.description}` : ""}`,
+      );
+      for (const v of app.stories.filter((x) => x.extends === s.name)) {
+        lines.push(`  - in \`${v.brand}\` branding: \`${v.name}\``);
+      }
+    }
+    lines.push(`- brands: ${app.brands.map((b) => `\`${b}\``).join(", ")}`, "");
+  }
+  const example = apps.find((a) => a.stories.some((s) => !s.extends));
+  if (example) {
+    lines.push(
+      `For example: \`/demo-video ${example.stories.find((s) => !s.extends).name}${example.brands.length > 1 ? ` in ${example.brands.find((b) => b !== "navipartner") ?? example.brands[0]} branding` : ""}\``,
+    );
+    lines.push(
+      "",
+      "In Linear, ask @Linear instead, also for a customer without a brand here (a pitch draft).",
+    );
+  }
+  return lines.join("\n");
+};
+
+/**
+ * The form's version (Actions → Run workflow): app, story and brand by name,
+ * no guessing. Empty story = the primary story, empty brand = the adapter's
+ * default, empty app = the only app. A name that doesn't exist gets the menu,
+ * so a typo never films something else. `apps` in a menu result narrows it.
+ */
+export const pickExact = (apps, { app = "", story = "", brand = "" }) => {
+  const slashes = (p) => p.split("\\").join("/");
+  const wanted = slashes(app).replace(/\/+$/, "");
+  const candidates = wanted
+    ? apps.filter((a) => {
+        const dir = slashes(a.dir);
+        return (
+          a.name === wanted || dir === wanted || dir.endsWith(`/${wanted}`)
+        );
+      })
+    : apps;
+  if (candidates.length === 0) {
+    return { menu: true, reason: `No app \`${wanted}\`. The apps:` };
+  }
+  if (candidates.length > 1) {
+    return { menu: true, reason: "Which app? Fill in App with one of:" };
+  }
+  const chosen = candidates[0];
+  const found = story
+    ? chosen.stories.find((s) => s.name === story)
+    : chosen.stories.find((s) => s.primary);
+  if (!found) {
+    return {
+      menu: true,
+      reason: story
+        ? `No story \`${story}\` in ${chosen.name}. Pick one:`
+        : `${chosen.name} has no primary story. Pick one:`,
+      apps: [chosen],
+    };
+  }
+  if (found.extends) {
+    // A variant is made for one brand.
+    if (brand && brand !== found.brand) {
+      return {
+        menu: true,
+        reason: `\`${found.name}\` is made for \`${found.brand}\`. Leave Brand empty, or pick \`${found.extends}\`:`,
+        apps: [chosen],
+      };
+    }
+    return { app: chosen.dir, story: found.name, brand: found.brand };
+  }
+  return withBrand(chosen, found.name, brand || null);
+};

package/bin/pitch.d.mts

@@ -0,0 +1,17 @@
+export function pitchName(customer: string): string;
+export function contrastOnWhite(colour: string): number;
+export function plainText(text: string): string;
+export function imageType(
+  bytes: Buffer,
+): ".png" | ".jpg" | ".webp" | ".svg" | null;
+export function buildPitchBrand(
+  proposal: unknown,
+  outDir: string,
+  options?: { fetch?: typeof fetch },
+): Promise<{
+  brand: string;
+  customer: string;
+  website: string;
+  sources: string[];
+  notes: string;
+}>;