@testsmith/api-spector 0.3.1 → 0.3.3

package/bin/cli.js

@@ -72,11 +72,27 @@ if (command.runner === 'electron') {
     electron = require('electron')
   } catch (err) {
     const msg = err && err.message ? err.message : String(err)
-    const looksLikeBinaryMissing = /Electron failed to install correctly|Cannot find module 'electron'/i.test(msg)
+    const notInstalled = /Cannot find module 'electron'/i.test(msg)
+    const binaryMissing = /Electron failed to install correctly/i.test(msg)
     console.error('')
     console.error('  API Spector — failed to launch the UI.')
     console.error('')
-    if (looksLikeBinaryMissing) {
+    if (notInstalled) {
+      console.error('  The electron package is not installed alongside API Spector.')
+      console.error('  Versions 0.3.1 and 0.3.2 shipped without it by mistake.')
+      console.error('')
+      console.error('  Fix options:')
+      console.error('')
+      console.error('    1. Update API Spector (0.3.3 or later includes electron):')
+      console.error('         npm install -D @testsmith/api-spector@latest')
+      console.error('       (use -g instead of -D if you installed globally)')
+      console.error('')
+      console.error('    2. Or keep this version and install electron yourself:')
+      console.error('         npm install -D electron@31')
+      console.error('')
+      console.error('  CLI subcommands (run / mock / record / contract / wsdl) do not')
+      console.error('  need electron and work even while this is broken.')
+    } else if (binaryMissing) {
       const installDir = path.dirname(__dirname)
       console.error('  Electron is installed, but its platform binary is missing — the')
       console.error('  download during `npm install` did not complete (often a proxy or')
@@ -85,13 +101,14 @@ if (command.runner === 'electron') {
       console.error('  Fix options (try in order):')
       console.error('')
       console.error('    1. Reinstall and force the postinstall script to run:')
-      console.error('         npm install -g @testsmith/api-spector --force')
+      console.error('         npm install -D @testsmith/api-spector --force')
+      console.error('       (use -g instead of -D if you installed globally)')
       console.error('')
       console.error('    2. Behind a proxy? Set npm + electron mirrors and reinstall:')
       console.error('         npm config set proxy http://your-proxy:port')
       console.error('         npm config set https-proxy http://your-proxy:port')
       console.error('         set ELECTRON_MIRROR=https://npmmirror.com/mirrors/electron/')
-      console.error('         npm install -g @testsmith/api-spector --force')
+      console.error('         npm install -D @testsmith/api-spector --force')
       console.error('')
       console.error('    3. Re-run electron\'s postinstall manually:')
       console.error(`         cd "${path.join(installDir, 'node_modules', 'electron')}"`)

package/out/main/agents.js

@@ -2,18 +2,7 @@
 "use strict";
 const promises = require("fs/promises");
 const path = require("path");
-const C = {
-  reset: "\x1B[0m",
-  bold: "\x1B[1m",
-  green: "\x1B[32m",
-  cyan: "\x1B[36m",
-  yellow: "\x1B[33m",
-  gray: "\x1B[90m",
-  red: "\x1B[31m"
-};
-function color(text, ...codes) {
-  return codes.join("") + text + C.reset;
-}
+const cliCommon = require("./chunks/cli-common-CDQY1erJ.js");
 const AGENTS = {
   claude: {
     name: "Claude Code",
@@ -113,27 +102,27 @@ async function initAgent(agentName, cwd) {
   for (const name of names) {
     const agent = AGENTS[name];
     if (!agent) {
-      console.error(color(`  Unknown agent: "${name}"`, C.red));
+      console.error(cliCommon.colorAlways(`  Unknown agent: "${name}"`, cliCommon.C.red));
       console.error(`  Available: ${Object.keys(AGENTS).join(", ")}, all`);
       process.exit(1);
     }
-    console.log(color(`
-  ${agent.name}`, C.bold, C.cyan));
+    console.log(cliCommon.colorAlways(`
+  ${agent.name}`, cliCommon.C.bold, cliCommon.C.cyan));
     const templatesDir = getTemplatesDir();
     for (const file of agent.files) {
       const srcPath = path.join(templatesDir, file.src);
       if (!await fileExists(srcPath)) {
-        console.log(color(`    skip ${file.dest} (template not found)`, C.yellow));
+        console.log(cliCommon.colorAlways(`    skip ${file.dest} (template not found)`, cliCommon.C.yellow));
         continue;
       }
       const result = await copyFile(srcPath, file.dest, cwd);
-      const icon = result === "created" ? color("+", C.green) : result === "updated" ? color("~", C.yellow) : color("=", C.gray);
+      const icon = result === "created" ? cliCommon.colorAlways("+", cliCommon.C.green) : result === "updated" ? cliCommon.colorAlways("~", cliCommon.C.yellow) : cliCommon.colorAlways("=", cliCommon.C.gray);
       const label = result === "exists" ? "unchanged" : result;
-      console.log(`    ${icon} ${file.dest} ${color(`(${label})`, C.gray)}`);
+      console.log(`    ${icon} ${file.dest} ${cliCommon.colorAlways(`(${label})`, cliCommon.C.gray)}`);
     }
   }
-  console.log(color(`
-  Shared documentation`, C.bold, C.cyan));
+  console.log(cliCommon.colorAlways(`
+  Shared documentation`, cliCommon.C.bold, cliCommon.C.cyan));
   const docsDir = getDocsDir();
   const allDocDests = /* @__PURE__ */ new Set();
   for (const name of names) {
@@ -142,40 +131,40 @@ async function initAgent(agentName, cwd) {
       allDocDests.add(doc.dest);
       const srcPath = path.join(docsDir, doc.src);
       if (!await fileExists(srcPath)) {
-        console.log(color(`    skip ${doc.dest} (not found)`, C.yellow));
+        console.log(cliCommon.colorAlways(`    skip ${doc.dest} (not found)`, cliCommon.C.yellow));
         continue;
       }
       const result = await copyFile(srcPath, doc.dest, cwd);
-      const icon = result === "created" ? color("+", C.green) : result === "updated" ? color("~", C.yellow) : color("=", C.gray);
+      const icon = result === "created" ? cliCommon.colorAlways("+", cliCommon.C.green) : result === "updated" ? cliCommon.colorAlways("~", cliCommon.C.yellow) : cliCommon.colorAlways("=", cliCommon.C.gray);
       const label = result === "exists" ? "unchanged" : result;
-      console.log(`    ${icon} ${doc.dest} ${color(`(${label})`, C.gray)}`);
+      console.log(`    ${icon} ${doc.dest} ${cliCommon.colorAlways(`(${label})`, cliCommon.C.gray)}`);
     }
   }
-  console.log(color("\n  Done. Your AI agent can now generate API Spector tests.\n", C.green));
+  console.log(cliCommon.colorAlways("\n  Done. Your AI agent can now generate API Spector tests.\n", cliCommon.C.green));
 }
 function listAgents() {
-  console.log(color("\n  Available agents:\n", C.bold));
+  console.log(cliCommon.colorAlways("\n  Available agents:\n", cliCommon.C.bold));
   for (const [key, agent] of Object.entries(AGENTS)) {
-    console.log(`    ${color(key.padEnd(12), C.cyan)} ${agent.description}`);
+    console.log(`    ${cliCommon.colorAlways(key.padEnd(12), cliCommon.C.cyan)} ${agent.description}`);
   }
-  console.log(`    ${color("all".padEnd(12), C.cyan)} Initialize all agents at once`);
-  console.log(color("\n  Usage: api-spector agents init <name>\n", C.gray));
+  console.log(`    ${cliCommon.colorAlways("all".padEnd(12), cliCommon.C.cyan)} Initialize all agents at once`);
+  console.log(cliCommon.colorAlways("\n  Usage: api-spector agents init <name>\n", cliCommon.C.gray));
 }
 function printHelp() {
   console.log(`
-  ${color("api-spector agents", C.bold)} — manage AI agent configurations
+  ${cliCommon.colorAlways("api-spector agents", cliCommon.C.bold)} — manage AI agent configurations
 
-  ${color("Commands:", C.bold)}
+  ${cliCommon.colorAlways("Commands:", cliCommon.C.bold)}
     agents init <name>    Scaffold agent instruction files in the current directory
     agents list           Show available agents
     agents --help         Show this message
 
-  ${color("Examples:", C.bold)}
+  ${cliCommon.colorAlways("Examples:", cliCommon.C.bold)}
     api-spector agents init claude     Set up Claude Code skills
     api-spector agents init copilot    Set up GitHub Copilot instructions
     api-spector agents init all        Set up all agents at once
 
-  ${color("What this does:", C.gray)}
+  ${cliCommon.colorAlways("What this does:", cliCommon.C.gray)}
     Copies AI instruction files into your project so your LLM coding tool
     understands the API Spector scripting API and can generate functional
     and security test plans.
@@ -195,18 +184,18 @@ async function main() {
   if (subCmd === "init") {
     const agentName = args[1]?.toLowerCase();
     if (!agentName) {
-      console.error(color("  Missing agent name. Use: api-spector agents init <name>", C.red));
+      console.error(cliCommon.colorAlways("  Missing agent name. Use: api-spector agents init <name>", cliCommon.C.red));
       console.error(`  Available: ${Object.keys(AGENTS).join(", ")}, all`);
       process.exit(1);
     }
     await initAgent(agentName, process.cwd());
     process.exit(0);
   }
-  console.error(color(`  Unknown sub-command: "${subCmd}"`, C.red));
+  console.error(cliCommon.colorAlways(`  Unknown sub-command: "${subCmd}"`, cliCommon.C.red));
   printHelp();
   process.exit(1);
 }
 main().catch((err) => {
-  console.error(color(`  Error: ${err.message}`, C.red));
+  console.error(cliCommon.colorAlways(`  Error: ${err.message}`, cliCommon.C.red));
   process.exit(2);
 });

package/out/main/chunks/{auth-builder-CRQayp8x.js → auth-builder-CUs9yzOF.js}

@@ -24,6 +24,7 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 const crypto = require("crypto");
 const http = require("http");
 const promises = require("fs/promises");
+const handle = require("./handle-C0IQL-Vl.js");
 const path = require("path");
 const dayjs = require("dayjs");
 const vm = require("vm");
@@ -70,13 +71,13 @@ function getSafeStorage() {
   }
 }
 function registerSecretHandlers(ipc) {
-  ipc.handle("secret:checkMasterKey", () => {
+  handle.handleIpc(ipc, handle.IPC.secret.checkMasterKey, () => {
     return { set: Boolean(process.env[MASTER_KEY_ENV]) };
   });
-  ipc.handle("secret:setMasterKey", (_e, value) => {
+  handle.handleIpc(ipc, handle.IPC.secret.setMasterKey, (_e, value) => {
     process.env[MASTER_KEY_ENV] = value;
   });
-  ipc.handle("secret:set", async (_e, ref, value) => {
+  handle.handleIpc(ipc, handle.IPC.secret.set, async (_e, ref, value) => {
     const ss = getSafeStorage();
     if (!ss || !ss.isEncryptionAvailable()) {
       throw new Error("OS encryption is not available — set the secret via environment variable instead");

package/out/main/chunks/cli-common-CDQY1erJ.js

@@ -0,0 +1,98 @@
+"use strict";
+const promises = require("fs/promises");
+const path = require("path");
+const C = {
+  reset: "\x1B[0m",
+  bold: "\x1B[1m",
+  dim: "\x1B[2m",
+  green: "\x1B[32m",
+  red: "\x1B[31m",
+  yellow: "\x1B[33m",
+  cyan: "\x1B[36m",
+  gray: "\x1B[90m",
+  white: "\x1B[97m"
+};
+function color(str, ...codes) {
+  return process.stdout.isTTY ? codes.join("") + str + C.reset : str;
+}
+function colorAlways(str, ...codes) {
+  return codes.join("") + str + C.reset;
+}
+function parseArgs(argv, repeatableKeys = []) {
+  const args = {};
+  for (let i = 0; i < argv.length; i++) {
+    const arg = argv[i];
+    if (!arg.startsWith("--")) continue;
+    const key = arg.slice(2);
+    const next = argv[i + 1];
+    if (!next || next.startsWith("--")) {
+      args[key] = true;
+    } else {
+      if (repeatableKeys.includes(key)) {
+        const prev = args[key];
+        args[key] = Array.isArray(prev) ? [...prev, next] : [next];
+      } else {
+        args[key] = next;
+      }
+      i++;
+    }
+  }
+  return args;
+}
+async function resolveWorkspacePath(wsPath) {
+  const s = await promises.stat(wsPath);
+  if (!s.isDirectory()) return wsPath;
+  const entries = await promises.readdir(wsPath);
+  const spector = entries.find((e) => e.endsWith(".spector"));
+  if (!spector) throw new Error(`No .spector workspace file found in directory: ${wsPath}`);
+  return path.join(wsPath, spector);
+}
+async function loadWorkspace(wsPath) {
+  const resolved = await resolveWorkspacePath(wsPath);
+  const raw = await promises.readFile(resolved, "utf8");
+  return { workspace: JSON.parse(raw), dir: path.dirname(path.resolve(resolved)), file: resolved };
+}
+async function loadCollections(workspace, dir, opts = {}) {
+  const cols = [];
+  for (const relPath of workspace.collections) {
+    try {
+      const raw = await promises.readFile(path.join(dir, relPath), "utf8");
+      const col = JSON.parse(raw);
+      if (!opts.filterName || col.name === opts.filterName) cols.push(col);
+    } catch {
+      opts.onError?.(relPath);
+    }
+  }
+  return cols;
+}
+async function loadEnvironments(workspace, dir) {
+  const envs = [];
+  for (const relPath of workspace.environments) {
+    try {
+      const raw = await promises.readFile(path.join(dir, relPath), "utf8");
+      envs.push(JSON.parse(raw));
+    } catch {
+    }
+  }
+  return envs;
+}
+async function loadMocks(workspace, dir, onError) {
+  const mocks = [];
+  for (const relPath of workspace.mocks ?? []) {
+    try {
+      const raw = await promises.readFile(path.join(dir, relPath), "utf8");
+      mocks.push(JSON.parse(raw));
+    } catch {
+      onError?.(relPath);
+    }
+  }
+  return mocks;
+}
+exports.C = C;
+exports.color = color;
+exports.colorAlways = colorAlways;
+exports.loadCollections = loadCollections;
+exports.loadEnvironments = loadEnvironments;
+exports.loadMocks = loadMocks;
+exports.loadWorkspace = loadWorkspace;
+exports.parseArgs = parseArgs;

package/out/main/chunks/handle-C0IQL-Vl.js

@@ -0,0 +1,164 @@
+"use strict";
+const IPC = {
+  // ─── Workspace / File ──────────────────────────────────────────────────────
+  file: {
+    openWorkspace: "file:openWorkspace",
+    getLastWorkspace: "file:getLastWorkspace",
+    saveWorkspace: "file:saveWorkspace",
+    newWorkspace: "file:newWorkspace",
+    closeWorkspace: "file:closeWorkspace",
+    loadCollection: "file:loadCollection",
+    saveCollection: "file:saveCollection",
+    loadEnvironment: "file:loadEnvironment",
+    saveEnvironment: "file:saveEnvironment",
+    deleteWorkspaceFile: "file:deleteWorkspaceFile",
+    saveMock: "file:saveMock",
+    loadMock: "file:loadMock"
+  },
+  // ─── Native dialogs ────────────────────────────────────────────────────────
+  dialog: {
+    pickDir: "dialog:pickDir"
+  },
+  // ─── HTTP execution ────────────────────────────────────────────────────────
+  request: {
+    send: "request:send"
+  },
+  // ─── Secrets ───────────────────────────────────────────────────────────────
+  secret: {
+    checkMasterKey: "secret:checkMasterKey",
+    setMasterKey: "secret:setMasterKey",
+    set: "secret:set"
+  },
+  // ─── Global variables ──────────────────────────────────────────────────────
+  globals: {
+    get: "globals:get",
+    set: "globals:set"
+  },
+  // ─── Collection runner ─────────────────────────────────────────────────────
+  runner: {
+    start: "runner:start",
+    /** Event: per-request progress pushed from main during a run. */
+    progress: "runner:progress"
+  },
+  // ─── Run results export ────────────────────────────────────────────────────
+  results: {
+    save: "results:save"
+  },
+  // ─── Import ────────────────────────────────────────────────────────────────
+  import: {
+    postman: "import:postman",
+    openapi: "import:openapi",
+    openapiUrl: "import:openapi-url",
+    insomnia: "import:insomnia",
+    bruno: "import:bruno",
+    http: "import:http",
+    openapiSchemas: "import:openapi-schemas",
+    openapiSchemasUrl: "import:openapi-schemas-url"
+  },
+  // ─── Code generation ───────────────────────────────────────────────────────
+  generate: {
+    code: "generate:code",
+    save: "generate:save",
+    saveZip: "generate:saveZip"
+  },
+  // ─── OAuth 2.0 ─────────────────────────────────────────────────────────────
+  oauth2: {
+    startFlow: "oauth2:startFlow",
+    refreshToken: "oauth2:refreshToken"
+  },
+  // ─── Mock servers ──────────────────────────────────────────────────────────
+  mock: {
+    start: "mock:start",
+    stop: "mock:stop",
+    isRunning: "mock:isRunning",
+    runningIds: "mock:runningIds",
+    updateRoutes: "mock:updateRoutes",
+    /** Event: a mock server route was hit. */
+    hit: "mock:hit"
+  },
+  // ─── WebSocket ─────────────────────────────────────────────────────────────
+  ws: {
+    connect: "ws:connect",
+    send: "ws:send",
+    disconnect: "ws:disconnect",
+    /** Event: inbound/outbound WS message. */
+    message: "ws:message",
+    /** Event: connection status change. */
+    status: "ws:status"
+  },
+  // ─── SOAP / WSDL ───────────────────────────────────────────────────────────
+  wsdl: {
+    fetch: "wsdl:fetch",
+    import: "wsdl:import"
+  },
+  // ─── Docs generation ───────────────────────────────────────────────────────
+  docs: {
+    generate: "docs:generate"
+  },
+  // ─── Contract testing ──────────────────────────────────────────────────────
+  contract: {
+    run: "contract:run",
+    inferSchema: "contract:inferSchema",
+    exportReportHtml: "contract:exportReportHtml",
+    captureSnapshot: "contract:captureSnapshot",
+    listSnapshots: "contract:listSnapshots",
+    loadSnapshot: "contract:loadSnapshot",
+    deleteSnapshot: "contract:deleteSnapshot"
+  },
+  // ─── Script hooks ──────────────────────────────────────────────────────────
+  script: {
+    runHook: "script:run-hook"
+  },
+  // ─── Git ───────────────────────────────────────────────────────────────────
+  git: {
+    isRepo: "git:isRepo",
+    init: "git:init",
+    status: "git:status",
+    diff: "git:diff",
+    diffStaged: "git:diffStaged",
+    stage: "git:stage",
+    unstage: "git:unstage",
+    stageAll: "git:stageAll",
+    commit: "git:commit",
+    log: "git:log",
+    branches: "git:branches",
+    checkout: "git:checkout",
+    deleteBranch: "git:deleteBranch",
+    pull: "git:pull",
+    push: "git:push",
+    remotes: "git:remotes",
+    addRemote: "git:addRemote",
+    setRemoteUrl: "git:setRemoteUrl",
+    removeRemote: "git:removeRemote",
+    writeCiFile: "git:writeCiFile",
+    resolveOurs: "git:resolveOurs",
+    resolveTheirs: "git:resolveTheirs",
+    markResolved: "git:markResolved"
+  },
+  // ─── Recorder ──────────────────────────────────────────────────────────────
+  record: {
+    start: "record:start",
+    stop: "record:stop",
+    isRunning: "record:isRunning",
+    entries: "record:entries",
+    toMock: "record:toMock",
+    /** Event: a recorded proxy entry was captured. */
+    hit: "record:hit"
+  },
+  // ─── Shell ─────────────────────────────────────────────────────────────────
+  shell: {
+    openExternal: "shell:openExternal"
+  }
+};
+function handleIpc(ipc, channel, fn) {
+  ipc.handle(channel, async (event, ...args) => {
+    try {
+      return await fn(event, ...args);
+    } catch (err) {
+      console.error(`[${channel}]`, err);
+      throw err;
+    }
+  });
+}
+exports.IPC = IPC;
+exports.handleIpc = handleIpc;

package/out/main/chunks/{import-C9qdkBCH.js → import-C5Ngq8hk.js}

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const uuid = require("uuid");
-const soapHandler = require("./soap-handler-Cpj-JwyA.js");
+const soapHandler = require("./soap-handler-B9x_YCtj.js");
+require("./handle-C0IQL-Vl.js");
 require("https");
 require("http");
 require("@xmldom/xmldom");

package/out/main/chunks/{ipc-validate-CscN4HfG.js → ipc-validate-k6KI8adf.js}

@@ -61,14 +61,16 @@ const validateSendRequestPayload = compile({
 const validateContractRunPayload = compile({
   type: "object",
   properties: {
-    mode: { type: "string", enum: ["consumer", "provider", "bidirectional"] },
+    mode: { type: "string", enum: ["consumer", "provider", "provider-live", "bidirectional"] },
     requests: { type: "array", items: apiRequestSchema },
     envVars: stringMap,
     collectionVars: stringMap,
     specUrl: { type: "string" },
     specPath: { type: "string" },
     specSnapshotRelPath: { type: "string" },
-    requestBaseUrl: { type: "string" }
+    requestBaseUrl: { type: "string" },
+    providerBaseUrl: { type: "string" },
+    stateHandlerUrl: { type: "string" }
   },
   required: ["mode", "requests"],
   additionalProperties: true