opencrater 0.2.5 → 1.0.0

package/package.json

@@ -1,33 +1,55 @@
 {
   "name": "opencrater",
-  "version": "0.2.5",
-  "description": "OpenCrater — sponsor cards in Claude Code and Codex. Free, one command, opt out anytime.",
+  "version": "1.0.0",
+  "description": "OpenCrater — sponsor cards for AI coding terminals (Claude Code, Codex, Gemini CLI, Copilot CLI). One command, auto-wires every host, opt out anytime.",
   "keywords": [
     "opencrater",
-    "claude-code",
-    "codex",
+    "sponsorship",
+    "cli",
+    "mcp",
     "terminal",
-    "sponsor"
+    "ads"
   ],
   "homepage": "https://opencrater.to",
-  "license": "Apache-2.0",
+  "license": "SEE LICENSE IN LICENSE",
   "type": "commonjs",
   "engines": {
     "node": ">=18.17"
   },
   "bin": {
-    "opencrater": "cli.js"
+    "opencrater": "dist/cli.js",
+    "opencrater-hook": "dist/hook.js",
+    "opencrater-paint": "dist/paint.js",
+    "opencrater-dismiss": "dist/dismiss.js"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
   },
   "files": [
-    "cli.js",
+    "dist",
     "README.md",
     "LICENSE"
   ],
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/open-crater/ads.git"
+  "scripts": {
+    "build": "tsup",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "version": "node scripts/sync-version.mjs && git add src/version.ts",
+    "prepublishOnly": "npm run typecheck && npm run build && npm test"
   },
-  "bugs": {
-    "url": "https://github.com/open-crater/ads/issues"
+  "devDependencies": {
+    "@types/node": "^18.19.0",
+    "tsup": "^8.0.0",
+    "typescript": "^5.4.0",
+    "vitest": "^3.0.0"
   }
 }

package/cli.js

@@ -1,416 +0,0 @@
-#!/usr/bin/env node
-/**
- * opencrater — the DIRECT channel: any Claude Code / Codex user can opt
- * in to OpenCrater sponsor cards with one command, no publisher needed.
- *
- *   npx opencrater on       enable (Claude Code + Codex hooks)
- *   npx opencrater off      disable (removes only our entries)
- *   npx opencrater status   show what is installed
- *
- * Coexistence with publisher packages that embed OpenCrater:
- *   - hook entries are marker-isolated ("--package opencrater" identifies
- *     ours), so installs/uninstalls never touch a publisher's hooks;
- *   - the SDK's machine-wide frequency cap (~/.config/opencrater/state.json)
- *     means at most ONE card per interval across ALL sources, and the
- *     painter's lock file guarantees only one card is ever on screen.
- *
- * Rendering runs through @opencrater/sdk (opencrater-hook), the same engine
- * publishers use. Opt out anytime: `npx opencrater off` or
- * OPENCRATER_DISABLE=1.
- */
-"use strict";
-const fs = require("node:fs");
-const path = require("node:path");
-const os = require("node:os");
-
-// Default = the house channel. Publishers integrating OpenCrater into
-// their OWN package pass their credentials instead:
-//   npx opencrater on  --key ock_… --package my-tool
-//   npx opencrater off --package my-tool
-// so revenue attributes to them and `off` removes only their entries.
-// Flags are parsed up front; everything below reads KEY/PKG.
-let KEY = "ock_MUFntM66VEbx7e7fKoQr2a43VBx762rHkKw1G8vj";
-let PKG = "opencrater";
-{
-  const argv = process.argv;
-  for (let i = 2; i < argv.length; i++) {
-    if (argv[i] === "--key" && argv[i + 1]) KEY = argv[++i];
-    else if (argv[i] === "--package" && argv[i + 1]) PKG = argv[++i];
-  }
-  if (!/^ock_[A-Za-z0-9]{8,64}$/.test(KEY)) {
-    console.error("opencrater: --key must look like ock_…");
-    process.exit(1);
-  }
-  if (!/^[A-Za-z0-9@/_.-]{1,128}$/.test(PKG)) {
-    console.error("opencrater: --package must be 1-128 chars of [a-zA-Z0-9@/_.-]");
-    process.exit(1);
-  }
-}
-// EVERY host hook is registered as a trigger; the SDK + platform decide
-// which ones actually render (recommended session-edge hooks by default,
-// remotely tunable). Registering everything also feeds the recommendation
-// engine's anonymized topic signal so cards match what you're working on.
-const CLAUDE_EVENTS = [
-  "SessionStart", "SessionEnd", "Stop", "StopFailure", "SubagentStart", "SubagentStop",
-  "Notification", "PreToolUse", "PostToolUse", "PostToolUseFailure", "PostToolBatch",
-  "PermissionRequest", "PermissionDenied", "UserPromptSubmit", "UserPromptExpansion",
-  "PreCompact", "PostCompact", "TaskCreated", "TaskCompleted", "Setup", "TeammateIdle",
-  "Elicitation", "ElicitationResult", "ConfigChange", "InstructionsLoaded",
-  "WorktreeCreate", "WorktreeRemove", "CwdChanged", "FileChanged", "MessageDisplay",
-];
-// Gemini CLI hooks (verified HookEventName set, GA since v0.26.0):
-// ~/.gemini/settings.json takes the same rule shape as Claude Code.
-const GEMINI_EVENTS = [
-  "SessionStart", "SessionEnd", "BeforeAgent", "AfterAgent", "BeforeModel",
-  "AfterModel", "BeforeToolSelection", "BeforeTool", "AfterTool",
-  "PreCompress", "Notification",
-];
-const CODEX_EVENTS = [
-  "SessionStart", "Stop", "UserPromptSubmit", "PreToolUse", "PostToolUse",
-  "PermissionRequest", "PreCompact", "PostCompact",
-];
-const MARKER = "--package " + PKG + " "; // identifies OUR hook entries only
-
-// Resilient hook command: prefer the pre-installed local runtime (no npx on
-// the hot path — concurrent fires racing a cold npx cache caused
-// "opencrater-hook: command not found" noise in the host); fall back to npx;
-// ALWAYS exit 0 with stderr silenced — a sponsor hook must never surface an
-// error inside someone's session.
-const cmdFor = (event, host) => {
-  const args = "--placement " + event + " --key " + KEY +
-    " --package " + PKG + " --host " + host;
-  const runtime = '"$HOME/.config/opencrater/runtime/node_modules/@opencrater/sdk/dist/hook.js"';
-  return (
-    "{ if [ -f " + runtime + " ]; then node " + runtime + " " + args +
-    "; else npx -y -p @opencrater/sdk opencrater-hook " + args +
-    "; fi; } 2>/dev/null || true"
-  );
-};
-
-const CLAUDE_SETTINGS = path.join(os.homedir(), ".claude", "settings.json");
-const CODEX_HOOKS = path.join(
-  process.env.CODEX_HOME || path.join(os.homedir(), ".codex"),
-  "hooks.json",
-);
-const GEMINI_SETTINGS = path.join(os.homedir(), ".gemini", "settings.json");
-
-function readJson(p) {
-  try {
-    const raw = fs.readFileSync(p, "utf8");
-    if (!raw.trim()) return {};
-    const v = JSON.parse(raw);
-    return v && typeof v === "object" && !Array.isArray(v) ? v : {};
-  } catch (e) {
-    if (e.code === "ENOENT") return {};
-    throw new Error("Could not parse " + p + " — fix it by hand and retry.");
-  }
-}
-
-function writeJson(p, v) {
-  fs.mkdirSync(path.dirname(p), { recursive: true });
-  const tmp = p + ".opencrater-tmp";
-  fs.writeFileSync(tmp, JSON.stringify(v, null, 2) + "\n");
-  fs.renameSync(tmp, p); // atomic — never leave a half-written settings file
-}
-
-const isOurs = (rule) =>
-  Array.isArray(rule.hooks) &&
-  rule.hooks.some(
-    (h) => typeof h.command === "string" &&
-      h.command.includes("opencrater-hook") && h.command.includes(MARKER),
-  );
-
-function enableIn(file, host) {
-  const events =
-    host === "codex" ? CODEX_EVENTS :
-    host === "gemini_cli" ? GEMINI_EVENTS : CLAUDE_EVENTS;
-  const settings = readJson(file);
-  if (!settings.hooks) settings.hooks = {};
-  let changed = false;
-  for (const event of events) {
-    const list = Array.isArray(settings.hooks[event]) ? settings.hooks[event] : [];
-    const desired = {
-      matcher: "",
-      hooks: [{ type: "command", command: cmdFor(event, host) }],
-    };
-    // Remove EVERY entry of ours, then add exactly one. findIndex+replace only
-    // fixed the first match, so repeated installs / older command shapes left
-    // duplicate opencrater-hook entries piling up. Filtering collapses them.
-    const others = list.filter((r) => !isOurs(r));
-    const mine = list.filter(isOurs);
-    const alreadyCorrect =
-      mine.length === 1 && JSON.stringify(mine[0]) === JSON.stringify(desired);
-    if (!alreadyCorrect) {
-      settings.hooks[event] = [...others, desired];
-      changed = true;
-    }
-  }
-  if (changed) writeJson(file, settings);
-  return changed;
-}
-
-function disableIn(file) {
-  const settings = readJson(file);
-  if (!settings.hooks) return false;
-  let changed = false;
-  for (const event of Object.keys(settings.hooks)) {
-    const list = settings.hooks[event];
-    if (!Array.isArray(list)) continue;
-    const kept = list.filter((r) => !isOurs(r));
-    if (kept.length !== list.length) {
-      changed = true;
-      if (kept.length === 0) delete settings.hooks[event];
-      else settings.hooks[event] = kept;
-    }
-  }
-  if (Object.keys(settings.hooks).length === 0) delete settings.hooks;
-  if (changed) writeJson(file, settings);
-  return changed;
-}
-
-function statusIn(file) {
-  const settings = readJson(file);
-  if (!settings.hooks) return [];
-  return Object.keys(settings.hooks).filter(
-    (ev) => Array.isArray(settings.hooks[ev]) && settings.hooks[ev].some(isOurs),
-  );
-}
-
-/* Dismiss the sponsor card currently on screen — no browser needed.
-   Writes the painter's local dismiss signal, records the dismissal against
-   the API (idempotent), and SIGTERMs the painter so the card clears NOW. */
-async function dismissNow() {
-  const dir = path.join(os.homedir(), ".config", "opencrater");
-  let lock = null;
-  try {
-    lock = JSON.parse(fs.readFileSync(path.join(dir, "painter.lock"), "utf8"));
-  } catch {
-    console.log("opencrater: no sponsor card is on screen.");
-    return;
-  }
-  try {
-    fs.mkdirSync(dir, { recursive: true });
-    fs.writeFileSync(
-      path.join(dir, "dismiss.signal"),
-      JSON.stringify({ impressionId: lock.impressionId, at: Date.now() }),
-    );
-  } catch {}
-  if (lock.dismissUrl) {
-    try { await fetch(lock.dismissUrl, { signal: AbortSignal.timeout(1000) }); } catch {}
-  }
-  if (lock.impressionId) {
-    const origin = process.env.OPENCRATER_API_ORIGIN || "https://api.opencrater.to";
-    try {
-      await fetch(origin + "/x/" + lock.impressionId, { signal: AbortSignal.timeout(2500) });
-    } catch {}
-  }
-  if (lock.pid && lock.pid > 1) {
-    try { process.kill(lock.pid, "SIGTERM"); } catch {}
-  }
-  console.log("opencrater: ad dismissed — feedback recorded.");
-  console.log("           changed your mind? npx opencrater show");
-}
-
-/* Report the sponsor card currently on screen (or the last one shown).
-   Blocks the campaign on this machine permanently (reported-ads.json — the
-   SDK skips reported campaigns forever), clears the card, and opens the
-   hosted report screen so the user can pick a reason. */
-async function reportAd() {
-  const dir = path.join(os.homedir(), ".config", "opencrater");
-  let lock = null;
-  let saved = null;
-  try { lock = JSON.parse(fs.readFileSync(path.join(dir, "painter.lock"), "utf8")); } catch {}
-  try { saved = JSON.parse(fs.readFileSync(path.join(dir, "last-ad.json"), "utf8")); } catch {}
-  const impressionId = (lock && lock.impressionId) || (saved && saved.payload && saved.payload.impressionId);
-  const campaignId = saved && saved.payload && saved.payload.campaignId;
-  if (!impressionId && !campaignId) {
-    console.log("opencrater: no sponsor card to report.");
-    return;
-  }
-  // permanent local block — never render this campaign here again
-  if (campaignId) {
-    const file = path.join(dir, "reported-ads.json");
-    let reported = {};
-    try { reported = JSON.parse(fs.readFileSync(file, "utf8")) || {}; } catch {}
-    reported[campaignId] = Date.now();
-    try {
-      fs.mkdirSync(dir, { recursive: true });
-      fs.writeFileSync(file, JSON.stringify(reported));
-    } catch {}
-  }
-  // clear the live card, if any
-  if (lock) {
-    try {
-      fs.writeFileSync(
-        path.join(dir, "dismiss.signal"),
-        JSON.stringify({ impressionId: lock.impressionId, at: Date.now() }),
-      );
-    } catch {}
-    if (lock.pid && lock.pid > 1) {
-      try { process.kill(lock.pid, "SIGTERM"); } catch {}
-    }
-  }
-  console.log("opencrater: reported — you won't see this ad on this machine again.");
-  if (impressionId) {
-    const origin = process.env.OPENCRATER_API_ORIGIN || "https://api.opencrater.to";
-    const url = origin + "/r/" + impressionId;
-    const { spawnSync } = require("node:child_process");
-    const opener = process.platform === "darwin" ? "open" : "xdg-open";
-    const res = spawnSync(opener, [url], { stdio: "ignore" });
-    if (res.status === 0) {
-      console.log("           tell us why in the tab that just opened (10 seconds).");
-    } else {
-      console.log("           tell us why (optional): " + url);
-    }
-  }
-}
-
-/* Repaint the last sponsor card ("show ad again"). Reads the payload the
-   painter saved, resolves THIS terminal's tty, and spawns the local-runtime
-   painter detached — exactly how the hook does it. */
-function showAgain() {
-  const dir = path.join(os.homedir(), ".config", "opencrater");
-  let saved = null;
-  try {
-    saved = JSON.parse(fs.readFileSync(path.join(dir, "last-ad.json"), "utf8"));
-  } catch {
-    console.log("opencrater: no recent ad to show.");
-    return;
-  }
-  const painter = path.join(dir, "runtime", "node_modules", "@opencrater", "sdk", "dist", "paint.js");
-  if (!fs.existsSync(painter)) {
-    console.log("opencrater: hook runtime not installed yet — run: npx opencrater on");
-    return;
-  }
-  const { spawnSync, spawn } = require("node:child_process");
-  const isWin = process.platform === "win32";
-  // Replay: live ✕ (local), but never re-poll or re-record the original
-  // impression — it was already dismissed once.
-  const payload = { ...saved.payload, replay: true };
-  delete payload.impressionId;
-  const env = { ...process.env, OPENCRATER_PAINT: JSON.stringify(payload) };
-  // Unix: resolve our terminal device so the detached painter can open it.
-  // Windows: no `tty` command and no device path — the painter opens CONOUT$
-  // of the console it inherits, so we must NOT detach (detach = new/hidden
-  // console = nothing visible). Mirror the SDK's painterSpawnOptions.
-  if (!isWin) {
-    const tty = spawnSync("tty", { stdio: ["inherit", "pipe", "ignore"], encoding: "utf8" })
-      .stdout?.trim();
-    if (tty && tty.startsWith("/dev/")) env.OPENCRATER_TTY = tty;
-  }
-  const child = spawn(process.execPath, [painter], {
-    detached: !isWin,
-    stdio: "ignore",
-    env,
-    ...(isWin ? { windowsHide: true } : {}),
-  });
-  child.on("error", () => {});
-  child.unref();
-  console.log("opencrater: showing the last ad again.");
-}
-
-/* Auto-detect which AI CLIs exist on this machine — `on` connects every
-   detected host's config automatically, and new hosts picked up here flow
-   into detection as we add them. */
-function hasBin(name) {
-  try {
-    const { spawnSync } = require("node:child_process");
-    return spawnSync("which", [name], { stdio: "ignore" }).status === 0;
-  } catch { return false; }
-}
-function detectHosts() {
-  return {
-    claude_code: fs.existsSync(path.join(os.homedir(), ".claude")) || hasBin("claude"),
-    codex: fs.existsSync(path.join(process.env.CODEX_HOME || path.join(os.homedir(), ".codex"))) || hasBin("codex"),
-    openclaw: fs.existsSync(path.join(os.homedir(), ".openclaw")) || hasBin("openclaw"),
-    gemini_cli: fs.existsSync(path.join(os.homedir(), ".gemini")) || hasBin("gemini"),
-  };
-}
-
-const cmd = process.argv[2] || "status";
-if (cmd === "on" || cmd === "enable") {
-  const hosts = detectHosts();
-  if (!hosts.claude_code && !hosts.codex) {
-    console.log("No supported AI CLI found (looked for Claude Code and Codex).");
-    console.log("Install one, then run: npx opencrater on");
-    process.exit(1);
-  }
-  if (hosts.claude_code) {
-    enableIn(CLAUDE_SETTINGS, "claude_code");
-    console.log("✓ Claude Code detected — connected (" + CLAUDE_SETTINGS + ")");
-  } else {
-    console.log("· Claude Code not found — skipped");
-  }
-  if (hosts.codex) {
-    enableIn(CODEX_HOOKS, "codex");
-    console.log("✓ Codex detected — connected (" + CODEX_HOOKS + ")");
-    console.log("  Codex will ask once to trust the new hooks on its next launch — approve to enable.");
-  } else {
-    console.log("· Codex not found — skipped");
-  }
-  if (hosts.gemini_cli) {
-    enableIn(GEMINI_SETTINGS, "gemini_cli");
-    console.log("✓ Gemini CLI detected — connected (" + GEMINI_SETTINGS + ")");
-  } else {
-    console.log("· Gemini CLI not found — skipped");
-  }
-  if (hosts.openclaw) {
-    console.log("· OpenClaw detected — its hooks run inside the gateway (no terminal");
-    console.log("  overlay surface); message-level sponsorship is on the roadmap.");
-  }
-  // Pre-install the local hook runtime (background): hooks then run via
-  // plain node — no npx resolution latency, no cold-cache races. Best-effort
-  // and non-fatal — hooks fall back to `npx -y` when the runtime is absent.
-  try {
-    const { spawn } = require("node:child_process");
-    // Windows: `npm` is `npm.cmd`, spawnable only through a shell — without
-    // shell:true this throws ENOENT as an async 'error' event that escapes
-    // try/catch and crashes the process. shell:true + an error handler keep
-    // it silent on every platform.
-    const isWin = process.platform === "win32";
-    const child = spawn("npm", ["install", "--prefix",
-      path.join(os.homedir(), ".config", "opencrater", "runtime"),
-      "@opencrater/sdk@latest", "--silent", "--no-audit", "--no-fund"],
-      { detached: true, stdio: "ignore", shell: isWin, windowsHide: true });
-    child.on("error", () => {});
-    child.unref();
-  } catch {}
-  console.log("OpenCrater ads enabled for Claude Code + Codex.");
-  console.log("All hooks registered as triggers; cards render only at session edges");
-  console.log("(SessionStart, Stop, SessionEnd, Notification) with a machine-wide frequency cap.");
-  console.log("Ads are personalized to what you're working on via anonymized keywords");
-  console.log("(never raw prompts, paths, or secrets).");
-  console.log("Turn off anytime: npx opencrater off  (or OPENCRATER_DISABLE=1)");
-  console.log("");
-  console.log("VS Code tip: the first time you ⌘-click a sponsor link, choose");
-  console.log("'Configure Trusted Domains' → trust api.opencrater.to and the");
-  console.log("confirmation dialog never appears again.");
-} else if (cmd === "off" || cmd === "disable") {
-  const a = disableIn(CLAUDE_SETTINGS);
-  const b = disableIn(CODEX_HOOKS);
-  const c = disableIn(GEMINI_SETTINGS);
-  void c;
-  console.log(a || b ? "OpenCrater ads disabled. Publisher hooks (if any) were not touched." : "Nothing to remove — OpenCrater ads were not enabled.");
-} else if (cmd === "x" || cmd === "dismiss") {
-  dismissNow();
-} else if (cmd === "report" || cmd === "flag") {
-  reportAd();
-} else if (cmd === "show" || cmd === "again") {
-  showAgain();
-} else if (cmd === "status") {
-  const hosts = detectHosts();
-  const cc = statusIn(CLAUDE_SETTINGS);
-  const cx = statusIn(CODEX_HOOKS);
-  const gm = statusIn(GEMINI_SETTINGS);
-  console.log("Claude Code:", !hosts.claude_code ? "not installed" : cc.length ? "enabled (" + cc.length + " hooks)" : "detected — run: npx opencrater on");
-  console.log("Codex:     ", !hosts.codex ? "not installed" : cx.length ? "enabled (" + cx.length + " hooks)" : "detected — run: npx opencrater on");
-  console.log("Gemini CLI:", !hosts.gemini_cli ? "not installed" : gm.length ? "enabled (" + gm.length + " hooks)" : "detected — run: npx opencrater on");
-  if (hosts.openclaw) console.log("OpenClaw:   detected — message-level sponsorship on the roadmap");
-} else {
-  console.log("Usage: npx opencrater <on|off|status|x|report|show> [--key ock_… --package name]");
-  console.log("  --key/--package  publisher attribution (defaults to the OpenCrater house channel)");
-  console.log("  x       dismiss the sponsor card currently on screen");
-  console.log("  report  report the ad (never shows on this machine again)");
-  console.log("  show    bring the last dismissed ad back");
-  process.exitCode = 1;
-}