@vfrey/vfrey 0.0.1 → 1.0.0-beta.0

package/src/desk/cli.ts

@@ -0,0 +1,216 @@
+import type { Store } from "../queue/store.js";
+import type { SecretOwnerKind } from "./secrets.js";
+import * as verbs from "./verbs.js";
+
+export interface DeskIo {
+  env: Record<string, string | undefined>;
+  stdout: (text: string) => void;
+  stderr: (text: string) => void;
+  readStdin: () => Promise<string>;
+}
+
+type FlagMap = Record<string, string | undefined>;
+
+class UsageError extends Error {
+  constructor(
+    message: string,
+    readonly fix: string,
+  ) {
+    super(message);
+  }
+}
+
+function flags(argv: string[]): FlagMap {
+  const out: FlagMap = {};
+  for (let i = 0; i < argv.length; i += 1) {
+    const token = argv[i];
+    if (!token?.startsWith("--")) continue;
+    const name = token.slice(2);
+    const next = argv[i + 1];
+    if (next && !next.startsWith("--")) {
+      out[name] = next;
+      i += 1;
+    } else {
+      out[name] = "true";
+    }
+  }
+  return out;
+}
+
+function need(map: FlagMap, name: string): string {
+  const value = map[name];
+  if (!value) throw new UsageError(`Missing --${name}.`, `Pass --${name} <value>.`);
+  return value;
+}
+
+function refusal(io: DeskIo, message: string, fix: string): number {
+  io.stderr(`✗ ${message}\n`);
+  io.stderr(`Fix: ${fix}\n`);
+  io.stdout(`${JSON.stringify({ ok: false, refusal: message, fix })}\n`);
+  return 1;
+}
+
+function secretTarget(map: FlagMap): { ownerKind: SecretOwnerKind; ownerId: string } {
+  if (map.series) return { ownerKind: "series", ownerId: map.series };
+  if (map.account) return { ownerKind: "account", ownerId: map.account };
+  if (map.owner && map.id) {
+    return { ownerKind: map.owner === "account" ? "account" : "series", ownerId: map.id };
+  }
+  throw new UsageError("Missing --series or --account.", "Pass --series <id> or --account <id>.");
+}
+
+function flagBool(value: string | undefined): boolean | undefined {
+  if (value === undefined) return undefined;
+  return value !== "false";
+}
+
+const list = (value: string | undefined): string[] => (value ? value.split(",").filter(Boolean) : []);
+
+/** Prints a verb result in the CLI's style and returns the exit code. */
+function print(io: DeskIo, result: verbs.VerbResult): number {
+  if (!result.ok) return refusal(io, result.refusal, result.fix);
+  io.stdout(`${JSON.stringify(result.data ?? { ok: true })}\n`);
+  return 0;
+}
+
+export async function runDesk(argv: string[], io: DeskIo, store: Store): Promise<number> {
+  const userId = io.env.VFREY_USER ?? "local";
+  const [group, action] = argv;
+  const map = flags(argv.slice(2));
+  const run = (result: verbs.VerbResult) => print(io, result);
+  try {
+    if (group === "snapshot") return run(verbs.snapshotRead(store, { userId }));
+    if (group === "account" && action === "create") {
+      return run(verbs.accountCreate(store, { id: need(map, "id"), name: need(map, "name"), ownerId: userId }));
+    }
+    if (group === "account" && action === "rename") {
+      return run(verbs.accountRename(store, { id: need(map, "id"), name: need(map, "name") }));
+    }
+    if (group === "account" && action === "delete") return run(verbs.accountDelete(store, { id: need(map, "id") }));
+    if (group === "secret" && action === "set") {
+      const value = await io.readStdin();
+      return run(
+        verbs.secretSet(store, { ...secretTarget(map), field: need(map, "field"), value, key: io.env.CREDENTIALS_KEY }),
+      );
+    }
+    if (group === "secret" && action === "clear") {
+      return run(verbs.secretClear(store, { ...secretTarget(map), field: need(map, "field") }));
+    }
+    if (group === "series" && action === "create") {
+      return run(
+        verbs.seriesCreate(store, {
+          id: need(map, "id"),
+          accountId: need(map, "account"),
+          niche: need(map, "niche"),
+          language: map.language,
+          timezone: map.timezone,
+          engine: map.engine,
+        }),
+      );
+    }
+    if (group === "series" && action === "update") {
+      return run(
+        verbs.seriesUpdate(store, {
+          id: need(map, "id"),
+          patch: {
+            niche: map.niche,
+            language: map.language,
+            timezone: map.timezone,
+            voices: map.voice ? [map.voice] : undefined,
+            autopilot: flagBool(map.autopilot),
+            hashtagPool: map.hashtags ? list(map.hashtags) : undefined,
+            engageEnabled: flagBool(map.engage),
+            publishEnabled: flagBool(map.publish),
+            reviewEnabled: flagBool(map.review),
+            allowSpicy: flagBool(map.spicy),
+            stylePath: map.style,
+            engine: map.engine,
+          },
+        }),
+      );
+    }
+    if (group === "series" && action === "delete") return run(verbs.seriesDelete(store, { id: need(map, "id") }));
+    if (group === "series" && action === "live") {
+      if (map.off) return run(verbs.seriesOff(store, { id: need(map, "id") }));
+      return run(verbs.seriesLive(store, { id: need(map, "id"), confirm: map.confirm, key: io.env.CREDENTIALS_KEY }));
+    }
+    if (group === "series" && action === "pause") return run(verbs.seriesPause(store, { id: need(map, "id") }));
+    if (group === "series" && action === "resume") return run(verbs.seriesResume(store, { id: need(map, "id") }));
+    if (group === "platform" && action === "set") {
+      const config: Record<string, unknown> = {};
+      for (const [key, value] of Object.entries(map)) {
+        if (key === "series" || key === "platform" || key === "enabled" || value === undefined) continue;
+        config[key] = value;
+      }
+      return run(
+        verbs.platformSet(store, {
+          seriesId: need(map, "series"),
+          platform: need(map, "platform"),
+          enabled: map.enabled !== "false",
+          config,
+        }),
+      );
+    }
+    if (group === "platform" && action === "remove") {
+      return run(verbs.platformRemove(store, { seriesId: need(map, "series"), platform: need(map, "platform") }));
+    }
+    if (group === "platform" && action === "disable") {
+      return run(verbs.platformDisable(store, { seriesId: need(map, "series"), platform: need(map, "platform") }));
+    }
+    if (group === "source" && action === "add") {
+      return run(verbs.sourceAdd(store, { seriesId: need(map, "series"), kind: need(map, "kind"), value: need(map, "value") }));
+    }
+    if (group === "source" && action === "update") {
+      return run(verbs.sourceUpdate(store, { id: need(map, "id"), value: need(map, "value") }));
+    }
+    if (group === "source" && action === "remove") return run(verbs.sourceRemove(store, { id: need(map, "id") }));
+    if (group === "mode" && action === "set") {
+      const mode = argv[2] === "api" ? "api" : argv[2] === "agent" ? "agent" : "";
+      return run(verbs.modeSet(store, { userId, mode, llmKeyPresent: Boolean(io.env.LLM_API_KEY) }));
+    }
+    if (group === "mode" && action === "clear") return run(verbs.modeClear(store, { userId }));
+    if (group === "job" && action === "retry") return run(verbs.jobRetry(store, { id: need(map, "id") }));
+    if (group === "job" && action === "approve") return run(verbs.jobApprove(store, { id: need(map, "id") }));
+    if (group === "job" && action === "reject") return run(verbs.jobReject(store, { id: need(map, "id"), reason: map.reason === "true" ? undefined : map.reason }));
+    if (group === "job" && action === "cancel") return run(verbs.jobCancel(store, { id: need(map, "id") }));
+    if (group === "job" && action === "delete") return run(verbs.jobDelete(store));
+    if (group === "publication" && action === "delete") return run(verbs.publicationDelete(store));
+    if (group === "metric" && action === "delete") return run(verbs.metricDelete(store));
+    if (group === "comment" && action === "delete") return run(verbs.commentDelete(store));
+    if (group === "cadence" && action === "set") {
+      return run(
+        verbs.cadenceSet(store, {
+          seriesId: need(map, "series"),
+          timezone: need(map, "timezone"),
+          minHoursBetweenPosts: Number(need(map, "min-hours")),
+          maxPostsPerDay: Number(need(map, "max-per-day")),
+          windows: list(map.windows),
+        }),
+      );
+    }
+    if (group === "cadence" && action === "clear") return run(verbs.cadenceClear(store));
+    if (group === "quota" && action === "set") {
+      return run(
+        verbs.quotaSet(store, {
+          seriesId: need(map, "series"),
+          youtubeDailyUploadCap: Number(need(map, "upload-cap")),
+          maxRepliesPerDay: Number(need(map, "replies")),
+          minSecondsBetween: Number(need(map, "seconds")),
+        }),
+      );
+    }
+    if (group === "quota" && action === "clear") return run(verbs.quotaClear(store));
+    if (group === "warning" && action === "ack") return run(verbs.warningAck(store, { id: need(map, "id") }));
+    if (group === "import") return run(verbs.deskImport(store, { from: need(flags(argv.slice(1)), "from") }));
+    if (group === "warning" && action === "delete") return run(verbs.warningDelete(store));
+    return refusal(
+      io,
+      `Unknown desk command ${group ?? ""} ${action ?? ""}.`.trim(),
+      "Use snapshot, account, secret, series, platform, source, mode, job, publication, metric, comment, cadence, quota, warning, tick, or import.",
+    );
+  } catch (error) {
+    if (error instanceof UsageError) return refusal(io, error.message, error.fix);
+    const message = error instanceof Error ? error.message : "desk command failed";
+    return refusal(io, message, "Check the command and try again.");
+  }
+}

package/src/desk/creators-route.ts

@@ -0,0 +1,129 @@
+// The dashboard's window onto vfrey Creators. The browser asks this server; this server asks the vfrey API with the stored token.
+// The token is read here, per request, and is never put in a response. "Study formats" writes <project>/research/<handle>.md.
+import { mkdirSync, writeFileSync } from "node:fs";
+import path from "node:path";
+import { ApiFailure, clean } from "../api/client.js";
+import { openSession } from "../api/topics.js";
+import { ApiConfigError } from "../api/config.js";
+import {
+  addToWatchlist,
+  buildSearchQuery,
+  fetchAlerts,
+  fetchProfile,
+  fetchWatchlistItems,
+  fetchWatchlists,
+  normalizeHandle,
+  removeFromWatchlist,
+  searchCreators,
+  studyFileName,
+  studyMarkdown,
+  CREATOR_PLATFORM_IDS,
+  DEFAULT_WATCHLIST,
+  type CreatorsDeps,
+} from "../api/creators.js";
+import type { CreatorProfileView } from "../api/types.js";
+import { redact } from "../queue/seal.js";
+
+export interface RouteReply {
+  status: number;
+  body: Record<string, unknown>;
+}
+
+export interface CreatorsRouteInput {
+  method: "GET" | "POST";
+  pathname: string;
+  params: URLSearchParams;
+  body: Record<string, unknown>;
+  /** The project folder "Study formats" writes into. Null on the machine desk. */
+  projectRoot: string | null;
+  now?: () => Date;
+}
+
+const bad = (refusal: string, fix: string): RouteReply => ({ status: 400, body: { ok: false, refusal, fix, code: "bad_request" } });
+
+function refusal(error: unknown): RouteReply {
+  if (error instanceof ApiFailure || error instanceof ApiConfigError) {
+    const status = error instanceof ApiFailure ? error.status : undefined;
+    const code = error instanceof ApiFailure ? (error.code ?? "api_error") : "api_config";
+    const http = code === "not_live" || code === "not_signed_in" ? 401 : status && status >= 400 && status < 600 ? status : 502;
+    return { status: http, body: { ok: false, refusal: redact(error.message), fix: redact(error.fix), code, loginCommand: code === "not_signed_in" || code === "unauthorized" || code === "not_live" ? "npx vfrey login" : undefined } };
+  }
+  return { status: 502, body: { ok: false, refusal: redact(error instanceof Error ? clean(error.message) : "Creators could not be read."), fix: "Try again in a moment.", code: "api_error" } };
+}
+
+// A profile the person just opened can be studied without paying for it twice.
+const recent = new Map<string, { at: number; profile: CreatorProfileView }>();
+const RECENT_MS = 10 * 60_000;
+
+const str = (v: unknown): string => (typeof v === "string" ? v.trim() : "");
+
+function target(source: { platform?: unknown; handle?: unknown }): { platform: string; handle: string } | RouteReply {
+  const platform = str(source.platform).toLowerCase();
+  const handle = normalizeHandle(str(source.handle));
+  if (!(CREATOR_PLATFORM_IDS as readonly string[]).includes(platform)) return bad("Pick a platform: tiktok, instagram or youtube.", "Choose one from the platform picker.");
+  if (!/^[a-z0-9._-]{1,80}$/i.test(handle)) return bad("That handle does not look right.", "Use letters, numbers, dots, dashes and underscores.");
+  return { platform, handle };
+}
+
+/** GET /api/creators/{search,profile,watchlists,watchlist,alerts}; POST /api/creators/{watch,study}. Null for any other path. */
+export async function creatorsRoute(deps: CreatorsDeps, input: CreatorsRouteInput): Promise<RouteReply | null> {
+  const { method, pathname, params, body } = input;
+  try {
+    if (method === "GET" && pathname === "/api/creators/search") {
+      const built = buildSearchQuery({ niche: params.get("niche") ?? undefined, platform: params.get("platform") || undefined, followers: params.get("followers") || undefined, postsPerWeek: params.get("postsPerWeek") || undefined, engagement: params.get("engagement") || undefined, sort: params.get("sort") || undefined, limit: params.get("limit") ?? "20" });
+      if ("error" in built) return bad(built.error.replace(/^--/, ""), "Fix the filter and search again.");
+      return { status: 200, body: { ok: true, creators: await searchCreators(deps, built.query) } };
+    }
+    if (method === "GET" && pathname === "/api/creators/profile") {
+      const t = target({ platform: params.get("platform"), handle: params.get("handle") });
+      if ("status" in t) return t;
+      const profile = await fetchProfile(deps, t.platform, t.handle);
+      recent.set(`${openSession(deps).host}/${t.platform}/${t.handle}`, { at: Date.now(), profile });
+      return { status: 200, body: { ok: true, profile } };
+    }
+    if (method === "GET" && pathname === "/api/creators/watchlists") {
+      return { status: 200, body: { ok: true, watchlists: await fetchWatchlists(deps) } };
+    }
+    if (method === "GET" && pathname === "/api/creators/watchlist") {
+      const id = params.get("id")?.trim() ?? "";
+      if (!id) return bad("Pick a watchlist.", "Choose one from the list.");
+      const answer = await fetchWatchlistItems(deps, id);
+      return { status: 200, body: { ok: true, watchlist: answer.watchlist, items: answer.items } };
+    }
+    if (method === "GET" && pathname === "/api/creators/alerts") {
+      const answer = await fetchAlerts(deps);
+      return { status: 200, body: { ok: true, rule: answer.rule, alerts: answer.alerts } };
+    }
+    if (method === "POST" && pathname === "/api/creators/watch") {
+      const t = target(body);
+      if ("status" in t) return t;
+      const action = str(body.action);
+      const list = str(body.watchlist) || DEFAULT_WATCHLIST;
+      if (action === "add") {
+        const done = await addToWatchlist(deps, list, t.platform, t.handle);
+        return { status: 200, body: { ok: true, watchlist: done.watchlist, created: done.created, madeList: done.madeList } };
+      }
+      if (action === "remove") return { status: 200, body: { ok: true, watchlist: await removeFromWatchlist(deps, list, t.platform, t.handle) } };
+      return bad("Say whether to add or remove.", "Send action add or remove.");
+    }
+    if (method === "POST" && pathname === "/api/creators/study") {
+      const t = target(body);
+      if ("status" in t) return t;
+      if (!input.projectRoot) return { status: 409, body: { ok: false, refusal: "This desk is not in a project, so there is no research folder to write to.", fix: "Run `npx @vfrey/vfrey init` in your video folder (or start a new one with `npm create vfrey@latest my-channel`), then open the dashboard from there.", code: "no_project" } };
+      const file = studyFileName(t.handle);
+      if (!file) return bad("That handle cannot be a file name.", "Use letters, numbers, dots, dashes and underscores.");
+      // Signed out is refused here, cached profile or not. The cache is per server, so another account's profile never leaks across.
+      const key = `${openSession(deps).host}/${t.platform}/${t.handle}`;
+      const hit = recent.get(key);
+      const profile = hit && Date.now() - hit.at < RECENT_MS ? hit.profile : await fetchProfile(deps, t.platform, t.handle);
+      const dir = path.join(input.projectRoot, "research");
+      mkdirSync(dir, { recursive: true });
+      const target_ = path.join(dir, file);
+      writeFileSync(target_, studyMarkdown(profile, input.now?.() ?? new Date()), { mode: 0o644 });
+      return { status: 200, body: { ok: true, file: `research/${file}`, formats: profile.formats?.length ?? 0, hooks: profile.hooks?.length ?? 0 } };
+    }
+    return null;
+  } catch (error) {
+    return refusal(error);
+  }
+}

package/src/desk/fonts/JetBrainsMono-OFL.txt

@@ -0,0 +1,93 @@
+Copyright 2020 The JetBrains Mono Project Authors (https://github.com/JetBrains/JetBrainsMono)
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+https://scripts.sil.org/OFL
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded, 
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.