@koda-sl/baker-cli 0.553.0 → 0.555.0

package/dist/chunk-KDAINT54.js

@@ -0,0 +1,131 @@
+import {
+  holdUnbilledSpend
+} from "./chunk-Y5PNLB24.js";
+import {
+  askAboutText
+} from "./chunk-DLM5OSHM.js";
+
+// src/engine/brand/brand-doc.ts
+import { createHash } from "crypto";
+import { mkdir, readdir, readFile, writeFile } from "fs/promises";
+import path from "path";
+import { z } from "zod";
+var BRAND_DOC_MODEL = "google/gemini-3.5-flash-lite";
+var REQUEST = {
+  provider: { order: ["google-vertex"], allow_fallbacks: false },
+  seed: 0,
+  response_format: { type: "json_object" }
+};
+var PROMPT_VERSION = 3;
+var TIMEOUT_MS = 3e4;
+var BRAND_MD_CHARS = 32e3;
+var NOTE_CHARS = 600;
+var COMPANY_MD_CHARS = 4e3;
+var Font = z.object({
+  family: z.string().trim().min(1).max(60),
+  role: z.enum(["heading", "body", "any"]).catch("any"),
+  use: z.boolean()
+});
+var Color = z.object({
+  hex: z.string().trim().regex(/^#?[0-9a-fA-F]{6}$/).transform((h) => `#${h.replace(/^#/, "").toLowerCase()}`),
+  use: z.boolean()
+});
+var note = z.string().trim().min(1).max(NOTE_CHARS).nullable().optional().catch(null);
+var Reading = z.object({
+  name: z.string().trim().min(1).max(80).nullable().catch(null),
+  wordmark: z.array(z.string().trim().min(1).max(40)).catch([]),
+  logoNames: z.array(z.string().trim().min(1).max(40)).catch([]),
+  fonts: z.array(z.unknown()).catch([]),
+  colors: z.array(z.unknown()).catch([]),
+  voice: note,
+  imagery: note,
+  logoUsage: note
+});
+function brandDocPrompt(docs) {
+  return [
+    "You read a company's brand guidelines (BRAND.md), the start of its company profile (COMPANY.md) and the file names of its logos. They may be written in any language, or several. Extract only what they state; never invent a value.",
+    "",
+    "Return JSON only, in this shape:",
+    '{"name": string | null, "wordmark": string[], "logoNames": string[], "fonts": [{"family": string, "role": "heading" | "body" | "any", "use": boolean}], "colors": [{"hex": "#rrggbb", "use": boolean}], "voice": string | null, "imagery": string | null, "logoUsage": string | null}',
+    "",
+    `- name: the brand's name exactly as written ("# Zernio Brand Guidelines" names Zernio). null when neither document states one, as in an unfilled template ("# Brand Guidelines", "# Company", TODO).`,
+    `- wordmark: every word the documents say the logo prints, as they quote it ("Wordmark: \\"permut\\"" gives "permut"; 'symbol plus "Cubbo" wordmark' gives "Cubbo"), even when it is also the name. [] when they quote none.`,
+    '- logoNames: a product or brand name a logo file name carries ("logo-engage-blue.png" gives "Engage"). Colours, variants, sizes and formats (dark, white, icon, isotype, png) are not names. [] when none.',
+    `- fonts: every typeface the guidelines name, by its family name exactly, the banned ones included. role is heading, body, or any when they do not say. use is false when the guidelines ban it, forbid it or say to avoid it or never use it, in any wording or language; true when the brand uses it. Only a named typeface counts: a generic family (sans-serif, serif, monospace, system-ui) or the operating system's own fonts ("system stack", "system fonts") is not one, so leave it out.`,
+    "- colors: every hex colour the guidelines give. use is false when they ban it or say to avoid it, true when it is a brand colour.",
+    "- voice: how the brand speaks, as the guidelines put it, at most two sentences in their language. null when they do not say.",
+    "- imagery: what the brand's pictures look like and never look like (photography, illustration, people; a ```generation-style block says it too), at most two sentences in their language. null when they do not say.",
+    "- logoUsage: which logo file an ad uses and how it must appear (which file for which product, line or background, what never to do to it), at most two sentences in their language. null when they do not say.",
+    "",
+    "<brand_md>",
+    (docs.brandMd ?? "").slice(0, BRAND_MD_CHARS),
+    "</brand_md>",
+    "<company_md>",
+    (docs.companyMd ?? "").slice(0, COMPANY_MD_CHARS),
+    "</company_md>",
+    "<logo_files>",
+    (docs.logoFiles ?? []).join("\n"),
+    "</logo_files>"
+  ].join("\n");
+}
+function parseBrandDoc(answer) {
+  const parsed = Reading.safeParse(answer);
+  if (!parsed.success) return null;
+  const fonts = parsed.data.fonts.flatMap((f) => {
+    const font = Font.safeParse(f);
+    return font.success ? [font.data] : [];
+  });
+  const colors = parsed.data.colors.flatMap((c) => {
+    const color = Color.safeParse(c);
+    return color.success ? [color.data] : [];
+  });
+  const { voice, imagery, logoUsage } = parsed.data;
+  return {
+    ...parsed.data.name ? { name: parsed.data.name } : {},
+    wordmark: [.../* @__PURE__ */ new Set([...parsed.data.wordmark, ...parsed.data.logoNames])],
+    fonts,
+    colors,
+    ...voice ? { voice } : {},
+    ...imagery ? { imagery } : {},
+    ...logoUsage ? { logoUsage } : {}
+  };
+}
+function brandDocReader(cacheDir, onSpend) {
+  return async (docs) => {
+    const prompt = brandDocPrompt(docs);
+    const key = createHash("sha256").update(JSON.stringify([PROMPT_VERSION, BRAND_DOC_MODEL, prompt])).digest("hex");
+    const file = path.join(cacheDir, "brand-doc", `${key}.json`);
+    const cached = parseBrandDoc(await readFile(file, "utf8").then(JSON.parse, () => null));
+    if (cached) return cached;
+    const spent = [];
+    const answer = await askAboutText(BRAND_DOC_MODEL, prompt, (u) => onSpend ? onSpend(u) : spent.push(u), {
+      timeoutMs: TIMEOUT_MS,
+      request: REQUEST
+    }).catch(() => null);
+    await holdUnbilledSpend(cacheDir, spent).catch(() => void 0);
+    const reading = parseBrandDoc(answer);
+    if (reading) {
+      await mkdir(path.dirname(file), { recursive: true }).catch(() => void 0);
+      await writeFile(file, JSON.stringify(reading), "utf8").catch(() => void 0);
+    }
+    return reading;
+  };
+}
+var LOGO_FILE = /logo|lockup|wordmark|isotype|isologo/i;
+async function workspaceBrandDocs(root) {
+  const read = (rel) => readFile(path.join(root, rel), "utf8").catch(() => null);
+  const logoFiles = (await readdir(path.join(root, "src", "brand", "logos")).catch(() => [])).filter((f) => /\.(png|jpe?g|webp|svg)$/i.test(f) && LOGO_FILE.test(f)).sort();
+  return { brandMd: await read("src/brand/BRAND.md"), companyMd: await read("COMPANY.md"), logoFiles };
+}
+async function readWorkspaceBrandDoc(root, opts = {}) {
+  const docs = await workspaceBrandDocs(root);
+  if (!docs.brandMd?.trim() && !docs.companyMd?.trim()) return null;
+  const read = opts.read ?? brandDocReader(path.join(root, "canvas", ".cache"), opts.onSpend);
+  return await read(docs).catch(() => null);
+}
+
+export {
+  LOGO_FILE,
+  readWorkspaceBrandDoc
+};
+//# sourceMappingURL=chunk-KDAINT54.js.map

package/dist/chunk-KKKZRQFY.js

@@ -0,0 +1,297 @@
+import {
+  REDDIT_LINK_REJECTED,
+  redditSearchHints,
+  redditSubredditsHints,
+  redditThreadHints
+} from "./chunk-UCJAPB5Y.js";
+import {
+  handleResearchError,
+  writeResearchJson
+} from "./chunk-CXYX6G3I.js";
+import {
+  repeatedValues
+} from "./chunk-ERSX3MKH.js";
+import {
+  RESEARCH_REDDIT_THREAD_DEFAULT_COMMENTS
+} from "./chunk-MKLAZD23.js";
+import {
+  apiPost
+} from "./chunk-GFWWHCBF.js";
+import {
+  registerSchema
+} from "./chunk-CCYZJMZ7.js";
+
+// src/commands/research/reddit.ts
+import { defineCommand } from "citty";
+var TIMEOUT_MS = 18e4;
+var TEXT_PREVIEW_CHARS = 1500;
+var ITEM_FIELDS = {
+  kind: "post or comment",
+  subreddit: "Where it was said",
+  title: "The post's title (on a comment: the post it answers)",
+  text: "Verbatim \u2014 quote this, exactly",
+  text_truncated: "The text was cut; re-run with --full before quoting the end of it",
+  author: "Reddit username, or null once the account is deleted",
+  score: "Points",
+  comment_count: "Posts only",
+  created: "Date written (UTC)",
+  permalink: "Cite THIS link \u2014 it is built from where the words actually are",
+  depth: "Thread comments: 0 answers the post, 1 answers a comment",
+  source: "reddit_api / reddit_web = live Reddit; archive = the Arctic Shift archive of Reddit"
+};
+registerSchema({
+  command: "research.reddit.search",
+  description: "Search Reddit posts or comments for the audience's own words. Returns verbatim text with a real permalink for each hit. Start here for voice-of-customer work on Reddit.",
+  args: {
+    query: {
+      type: "string",
+      description: "Words to match \u2014 the audience's phrasing, not a description of it",
+      required: true
+    },
+    subreddit: {
+      type: "string",
+      description: "Subreddits to search (up to 10): comma-separated (couriersofreddit,AmazonFlexUK) or the flag repeated. Needed for --kind comments",
+      required: false
+    },
+    kind: {
+      type: "string",
+      description: "posts (default) or comments \u2014 the replies are where most of the voice is",
+      required: false,
+      enum: ["posts", "comments"]
+    },
+    since: { type: "string", description: "Only things written on or after this day, YYYY-MM-DD", required: false },
+    limit: { type: "number", description: "Results to return (1-50, default 25)", required: false },
+    full: {
+      type: "boolean",
+      description: "Return every text whole instead of a preview",
+      required: false,
+      default: false
+    }
+  }
+});
+registerSchema({
+  command: "research.reddit.thread",
+  description: "Read one Reddit thread verbatim: the post and its best comments, each with its own permalink. Use it on any Reddit link before quoting it \u2014 it also exposes links that point somewhere other than they claim.",
+  args: {
+    target: {
+      type: "string",
+      description: "The thread's link (any Reddit form, including share links) or post id",
+      required: true
+    },
+    comments: { type: "number", description: "Comments to return, best first (0-200, default 40)", required: false },
+    full: {
+      type: "boolean",
+      description: "Return every text whole instead of a preview",
+      required: false,
+      default: false
+    }
+  }
+});
+registerSchema({
+  command: "research.reddit.subreddits",
+  description: "Find the subreddits where an audience talks about a topic, with member counts and whether they can be read. Run it before searching, instead of guessing subreddit names.",
+  args: {
+    query: { type: "string", description: 'The audience or topic, e.g. "amazon flex uk", "deliveroo"', required: true },
+    limit: { type: "number", description: "Subreddits to return (1-25, default 10)", required: false }
+  }
+});
+function searchReddit(body) {
+  return apiPost("/api/research/reddit/search", body, { timeoutMs: TIMEOUT_MS });
+}
+function findSubreddits(body) {
+  return apiPost("/api/research/reddit/subreddits", body, { timeoutMs: TIMEOUT_MS });
+}
+function row(item, full) {
+  const cut = !full && item.text.length > TEXT_PREVIEW_CHARS;
+  return {
+    kind: item.kind,
+    subreddit: item.subreddit,
+    title: item.title,
+    text: cut ? `${item.text.slice(0, TEXT_PREVIEW_CHARS)}\u2026` : item.text,
+    ...cut ? { text_truncated: true } : {},
+    author: item.author,
+    score: item.score,
+    ...item.kind === "post" ? { comment_count: item.commentCount } : {},
+    created: item.createdAt.slice(0, 10),
+    permalink: item.permalink,
+    ...item.depth !== null ? { depth: item.depth } : {}
+  };
+}
+function redditFix(code) {
+  if (code === "NOT_FOUND") return REDDIT_LINK_REJECTED;
+  if (code === "BAD_REQUEST" || code === "VALIDATION_ERROR") {
+    return { action: "retry_with_changes", explanation: "Follow the message above and run the command again." };
+  }
+  return {
+    action: "continue_without",
+    explanation: "Don't loop on it. Finish the job with the other sources, say plainly that Reddit is a gap in this research, and never stand in a summary's paraphrase for a Reddit quote."
+  };
+}
+function failValidation(message) {
+  writeResearchJson({ ok: false, error: { code: "VALIDATION_ERROR", message, fix: redditFix("VALIDATION_ERROR") } });
+  process.exit(1);
+}
+function subredditsFromArgs(rawArgs, parsed) {
+  return repeatedValues(rawArgs, "subreddit", parsed).flatMap((value) => value.split(",")).map((name) => name.trim()).filter(Boolean);
+}
+var searchCommand = defineCommand({
+  meta: {
+    name: "search",
+    description: `Search Reddit for the audience's own words, verbatim, each with a permalink you can cite.
+
+Start here for Reddit voice-of-customer. Matches words, not meaning \u2014 search the way the audience writes, and quote a phrase to keep it together ('"right to work"').
+
+Examples:
+  baker research reddit search "agency never paid" --subreddit couriersofreddit,AmazonFlexUK
+  baker research reddit search '"right to work"' --subreddit UKJobs,AmazonFlexUK
+  baker research reddit search "visa" --subreddit UberEATS --kind comments --since 2025-01-01
+  baker research reddit search "side hustle student deliveries"`
+  },
+  args: {
+    query: { type: "positional", description: "Words to match", required: false },
+    subreddit: {
+      type: "string",
+      description: "Subreddits (up to 10): comma-separated, or repeat the flag",
+      required: false
+    },
+    kind: { type: "string", description: "posts (default) or comments", required: false },
+    since: { type: "string", description: "YYYY-MM-DD", required: false },
+    limit: { type: "string", description: "1-50, default 25", required: false },
+    full: { type: "boolean", description: "Whole texts, not previews", required: false }
+  },
+  run: async ({ args, rawArgs }) => {
+    const query = args.query?.trim();
+    if (!query) failValidation('Say what to search for: baker research reddit search "<words>"');
+    const kind = args.kind ?? "posts";
+    if (kind !== "posts" && kind !== "comments") failValidation("--kind must be posts or comments");
+    const body = {
+      query,
+      kind,
+      subreddits: subredditsFromArgs(rawArgs, args.subreddit)
+    };
+    if (args.since) body.since = args.since;
+    if (args.limit) body.limit = Number(args.limit);
+    try {
+      const data = await searchReddit(body);
+      writeResearchJson({
+        ok: true,
+        data: data.results.map((item) => row(item, Boolean(args.full))),
+        source: data.source,
+        fields: ITEM_FIELDS,
+        hints: redditSearchHints({ resultCount: data.results.length, kind, source: data.source })
+      });
+    } catch (err) {
+      handleResearchError(err, redditFix);
+    }
+  }
+});
+var threadCommand = defineCommand({
+  meta: {
+    name: "thread",
+    description: `Read one Reddit thread verbatim \u2014 the post and its best comments, each with its own permalink.
+
+Run it on every Reddit link before you quote from it, including links a research summary gave you: it refuses a link whose post is somewhere other than the link claims.
+
+Examples:
+  baker research reddit thread "https://www.reddit.com/r/AmazonFlexUK/comments/1abc2de/agency_still_hasnt_paid_me/"
+  baker research reddit thread "https://www.reddit.com/r/UberEATS/s/3TzXiyxaMD" --comments 100
+  baker research reddit thread 1abc2de --full`
+  },
+  args: {
+    target: { type: "positional", description: "Thread link or post id", required: false },
+    comments: { type: "string", description: "0-200, default 40", required: false },
+    full: { type: "boolean", description: "Whole texts, not previews", required: false }
+  },
+  run: async ({ args }) => {
+    const target = args.target?.trim();
+    if (!target) failValidation("Pass the thread's link or post id: baker research reddit thread <url>");
+    const commentsAsked = args.comments ? Number(args.comments) : RESEARCH_REDDIT_THREAD_DEFAULT_COMMENTS;
+    const body = { target, comments: commentsAsked };
+    try {
+      const data = await apiPost("/api/research/reddit/thread", body, {
+        timeoutMs: TIMEOUT_MS
+      });
+      const full = Boolean(args.full);
+      writeResearchJson({
+        ok: true,
+        data: { post: row(data.post, full), comments: data.comments.map((item) => row(item, full)) },
+        source: data.source,
+        fields: ITEM_FIELDS,
+        hints: redditThreadHints({
+          commentsShown: data.comments.length,
+          commentsAsked,
+          commentCount: data.post.commentCount,
+          source: data.source
+        })
+      });
+    } catch (err) {
+      handleResearchError(err, redditFix);
+    }
+  }
+});
+var subredditsCommand = defineCommand({
+  meta: {
+    name: "subreddits",
+    description: `Find the subreddits where an audience talks \u2014 name, members, and whether it can be read.
+
+Run it before \`reddit search\` instead of guessing names: a plausible-sounding subreddit can be dead (r/CouriersUK has one post), while the conversation sits in r/AmazonFlexUK or r/deliveroos.
+
+Examples:
+  baker research reddit subreddits "amazon flex uk"
+  baker research reddit subreddits "deliveroo" --limit 5`
+  },
+  args: {
+    query: { type: "positional", description: "Audience or topic", required: false },
+    limit: { type: "string", description: "1-25, default 10", required: false }
+  },
+  run: async ({ args }) => {
+    const query = args.query?.trim();
+    if (!query) failValidation('Say what to look for: baker research reddit subreddits "<audience or topic>"');
+    const body = { query };
+    if (args.limit) body.limit = Number(args.limit);
+    try {
+      const data = await findSubreddits(body);
+      writeResearchJson({
+        ok: true,
+        data: data.results,
+        source: data.source,
+        fields: {
+          name: "Pass this to --subreddit",
+          subscribers: "Members \u2014 size, not activity",
+          access: "public / restricted (readable, members post) / private (unreadable) / null when the source doesn't say",
+          description: "The subreddit's own summary",
+          url: "The subreddit"
+        },
+        hints: redditSubredditsHints({ resultCount: data.results.length })
+      });
+    } catch (err) {
+      handleResearchError(err, redditFix);
+    }
+  }
+});
+var redditCommand = defineCommand({
+  meta: {
+    name: "reddit",
+    description: `Read Reddit verbatim \u2014 the one site no page reader will open for us.
+
+Commands:
+  subreddits \u2014 Find where the audience talks (start here)
+  search     \u2014 Find posts or comments in the audience's own words
+  thread     \u2014 Read one thread: the post and its best comments
+
+Examples:
+  baker research reddit subreddits "amazon flex uk"
+  baker research reddit search "agency never paid" --subreddit couriersofreddit,AmazonFlexUK --kind comments
+  baker research reddit thread "https://www.reddit.com/r/AmazonFlexUK/comments/1abc2de/"
+Full guide: __tooling__/docs/tools/baker/research.md`
+  },
+  subCommands: { subreddits: subredditsCommand, search: searchCommand, thread: threadCommand }
+});
+
+export {
+  searchReddit,
+  findSubreddits,
+  subredditsFromArgs,
+  redditCommand
+};
+//# sourceMappingURL=chunk-KKKZRQFY.js.map