@testsmith/api-spector 0.2.0 → 0.2.1

package/bin/cli.js

@@ -8,7 +8,7 @@ const [, , cmd = 'ui', ...rest] = process.argv
 
 function printHelp() {
   console.log('')
-  console.log('  api Spector — local-first API testing tool')
+  console.log('  API Spector — local-first API testing tool')
   console.log('')
   console.log('  Usage:')
   console.log('    api-spector ui                            Launch the app')
@@ -17,6 +17,9 @@ function printHelp() {
   console.log('    api-spector record --upstream <url>       Record API traffic as mock stubs')
   console.log('')
   console.log('  Options:')
+  console.log('    api-spector agents init <name>            Initialize AI agent files')
+  console.log('    api-spector agents list                   Show available agents')
+  console.log('')
   console.log('    api-spector run    --help                 Show run options')
   console.log('    api-spector mock   --help                 Show mock options')
   console.log('    api-spector record --help                 Show record options')
@@ -59,8 +62,15 @@ if (cmd === '--help' || cmd === '-h') {
     env: process.env,
   })
   proc.on('close', code => process.exit(code ?? 0))
+} else if (cmd === 'agents') {
+  const agentsPath = path.join(__dirname, '..', 'out', 'main', 'agents.js')
+  const proc = spawn(process.execPath, [agentsPath, ...rest], {
+    stdio: 'inherit',
+    env: process.env,
+  })
+  proc.on('close', code => process.exit(code ?? 0))
 } else {
-  console.error(`api Spector — unknown command: "${cmd}"`)
+  console.error(`API Spector — unknown command: "${cmd}"`)
   printHelp()
   process.exit(1)
 }

package/out/main/agents.js

@@ -0,0 +1,212 @@
+#!/usr/bin/env node
+"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 AGENTS = {
+  claude: {
+    name: "Claude Code",
+    description: "Skills for Claude Code (.claude/skills/)",
+    files: [
+      { src: "claude/skills/api-spector-functional-tests.md", dest: ".claude/skills/api-spector-functional-tests/SKILL.md" },
+      { src: "claude/skills/api-spector-security-tests.md", dest: ".claude/skills/api-spector-security-tests/SKILL.md" },
+      { src: "claude/skills/api-spector-generate-mocks.md", dest: ".claude/skills/api-spector-generate-mocks/SKILL.md" },
+      { src: "claude/skills/api-spector-api-audit.md", dest: ".claude/skills/api-spector-api-audit/SKILL.md" }
+    ]
+  },
+  copilot: {
+    name: "GitHub Copilot",
+    description: "Instructions for Copilot (.github/copilot-instructions.md)",
+    files: [
+      { src: "copilot/copilot-instructions.md", dest: ".github/copilot-instructions.md" }
+    ]
+  },
+  cursor: {
+    name: "Cursor",
+    description: "Rules for Cursor (.cursor/rules/api-spector.mdc)",
+    files: [
+      { src: "cursor/rules/api-spector.mdc", dest: ".cursor/rules/api-spector.mdc" }
+    ]
+  },
+  windsurf: {
+    name: "Windsurf",
+    description: "Rules for Windsurf (.windsurfrules)",
+    files: [
+      { src: "windsurf/windsurfrules", dest: ".windsurfrules" }
+    ]
+  },
+  aider: {
+    name: "Aider",
+    description: "Conventions for Aider (conventions.md)",
+    files: [
+      { src: "aider/conventions.md", dest: "conventions.md" }
+    ]
+  }
+};
+function sharedDocsForAgent(agentName) {
+  const destDir = {
+    claude: ".claude/docs",
+    copilot: ".github/docs",
+    cursor: ".cursor/docs",
+    windsurf: ".windsurf/docs",
+    aider: ".aider/docs"
+  };
+  const dir = destDir[agentName] ?? ".api-spector/docs";
+  return [
+    { src: "api-spector-scripting-reference.md", dest: `${dir}/api-spector-scripting-reference.md` },
+    { src: "collection-file-format.md", dest: `${dir}/collection-file-format.md` },
+    { src: "functional-testing-guide.md", dest: `${dir}/functional-testing-guide.md` },
+    { src: "security-testing-guide.md", dest: `${dir}/security-testing-guide.md` }
+  ];
+}
+function getPackageRoot() {
+  let dir = __dirname;
+  for (let i = 0; i < 5; i++) {
+    try {
+      require.resolve(path.join(dir, "package.json"));
+      return dir;
+    } catch {
+      dir = path.dirname(dir);
+    }
+  }
+  return path.join(__dirname, "..", "..");
+}
+function getTemplatesDir() {
+  return path.join(getPackageRoot(), "src", "cli", "agent-templates");
+}
+function getDocsDir() {
+  return path.join(getPackageRoot(), "docs", "ai");
+}
+async function fileExists(path2) {
+  try {
+    await promises.stat(path2);
+    return true;
+  } catch {
+    return false;
+  }
+}
+async function copyFile(src, dest, cwd) {
+  const destPath = path.join(cwd, dest);
+  const existed = await fileExists(destPath);
+  await promises.mkdir(path.dirname(destPath), { recursive: true });
+  const content = await promises.readFile(src, "utf8");
+  if (existed) {
+    const existing = await promises.readFile(destPath, "utf8");
+    if (existing === content) return "exists";
+  }
+  await promises.writeFile(destPath, content, "utf8");
+  return existed ? "updated" : "created";
+}
+async function initAgent(agentName, cwd) {
+  const names = agentName === "all" ? Object.keys(AGENTS) : [agentName];
+  for (const name of names) {
+    const agent = AGENTS[name];
+    if (!agent) {
+      console.error(color(`  Unknown agent: "${name}"`, C.red));
+      console.error(`  Available: ${Object.keys(AGENTS).join(", ")}, all`);
+      process.exit(1);
+    }
+    console.log(color(`
+  ${agent.name}`, C.bold, 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));
+        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 label = result === "exists" ? "unchanged" : result;
+      console.log(`    ${icon} ${file.dest} ${color(`(${label})`, C.gray)}`);
+    }
+  }
+  console.log(color(`
+  Shared documentation`, C.bold, C.cyan));
+  const docsDir = getDocsDir();
+  const allDocDests = /* @__PURE__ */ new Set();
+  for (const name of names) {
+    for (const doc of sharedDocsForAgent(name)) {
+      if (allDocDests.has(doc.dest)) continue;
+      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));
+        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 label = result === "exists" ? "unchanged" : result;
+      console.log(`    ${icon} ${doc.dest} ${color(`(${label})`, C.gray)}`);
+    }
+  }
+  console.log(color("\n  Done. Your AI agent can now generate API Spector tests.\n", C.green));
+}
+function listAgents() {
+  console.log(color("\n  Available agents:\n", C.bold));
+  for (const [key, agent] of Object.entries(AGENTS)) {
+    console.log(`    ${color(key.padEnd(12), 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));
+}
+function printHelp() {
+  console.log(`
+  ${color("api-spector agents", C.bold)} — manage AI agent configurations
+
+  ${color("Commands:", 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)}
+    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)}
+    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.
+`);
+}
+async function main() {
+  const args = process.argv.slice(2);
+  const subCmd = args[0];
+  if (!subCmd || subCmd === "--help" || subCmd === "-h") {
+    printHelp();
+    process.exit(0);
+  }
+  if (subCmd === "list") {
+    listAgents();
+    process.exit(0);
+  }
+  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(`  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));
+  printHelp();
+  process.exit(1);
+}
+main().catch((err) => {
+  console.error(color(`  Error: ${err.message}`, C.red));
+  process.exit(2);
+});

package/out/main/chunks/{request-handler-AFBOd__c.js → request-collection-Dx0ZqB54.js}

@@ -192,7 +192,7 @@ function buildUrl(baseUrl, params, vars) {
     templateTokens.add(String(name).trim());
     return "";
   });
-  const enabled = params.filter((p) => p.enabled && p.key);
+  const enabled = (params ?? []).filter((p) => p.enabled && p.key);
   const pathRows = [];
   const queryRows = [];
   for (const p of enabled) {
@@ -965,6 +965,10 @@ function registerRequestHandler(ipc) {
       tls,
       piiMaskPatterns = []
     } = payload;
+    if (!req.headers) req.headers = [];
+    if (!req.params) req.params = [];
+    if (!req.body) req.body = { mode: "none" };
+    if (!req.auth) req.auth = { type: "none" };
     const start = Date.now();
     const liveGlobals = getGlobals();
     const mergedGlobals = { ...payloadGlobals, ...liveGlobals };
@@ -1190,7 +1194,7 @@ function registerRequestHandler(ipc) {
       await persistGlobals();
     }
     const combinedTestResults = [...schemaTestResults, ...postTestResults];
-    if (!response.error && response.status >= 400 && !combinedTestResults.some((t) => !t.passed)) {
+    if (!response.error && response.status >= 400 && combinedTestResults.length === 0) {
       combinedTestResults.push({
         name: `HTTP status ${response.status} ${response.statusText}`.trim(),
         passed: false,
@@ -1224,13 +1228,78 @@ function registerRequestHandler(ipc) {
     };
   });
 }
+function collectTagged(folder, requests, collectionVars, filterTags, parentPath = [], isRoot = true) {
+  const results = [];
+  const scopePath = isRoot ? parentPath : [...parentPath, folder.name];
+  for (const reqId of folder.requestIds) {
+    const req = requests[reqId];
+    if (!req || req.hookType || req.disabled) continue;
+    const tags = req.meta?.tags ?? [];
+    if (filterTags.length > 0 && !filterTags.some((t) => tags.includes(t))) continue;
+    results.push({ request: req, collectionVars, scopePath });
+  }
+  for (const sub of folder.folders) {
+    const folderTags = sub.tags ?? [];
+    const effectiveTags = filterTags.length === 0 ? filterTags : folderTags.some((t) => filterTags.includes(t)) ? [] : filterTags;
+    results.push(...collectTagged(sub, requests, collectionVars, effectiveTags, scopePath, false));
+  }
+  return results;
+}
+function folderPathTo(root, requestId) {
+  if (root.requestIds.includes(requestId)) return [root];
+  for (const sub of root.folders) {
+    const path2 = folderPathTo(sub, requestId);
+    if (path2.length > 0) return [root, ...path2];
+  }
+  return [];
+}
+function getAllApplicableHooks(folderId, collection) {
+  function chainToFolder(root, targetId) {
+    if (root.id === targetId) return [root];
+    for (const sub of root.folders) {
+      const chain2 = chainToFolder(sub, targetId);
+      if (chain2.length) return [root, ...chain2];
+    }
+    return [];
+  }
+  const chain = chainToFolder(collection.rootFolder, folderId);
+  const beforeAll = [];
+  const before = [];
+  const after = [];
+  const afterAll = [];
+  for (const folder of chain) {
+    const reqs = folder.requestIds.map((id) => collection.requests[id]).filter((r) => r && !r.disabled);
+    beforeAll.push(...reqs.filter((r) => r.hookType === "beforeAll"));
+    before.push(...reqs.filter((r) => r.hookType === "before"));
+  }
+  for (const folder of [...chain].reverse()) {
+    const reqs = folder.requestIds.map((id) => collection.requests[id]).filter((r) => r && !r.disabled);
+    after.push(...reqs.filter((r) => r.hookType === "after"));
+    afterAll.push(...reqs.filter((r) => r.hookType === "afterAll"));
+  }
+  return { beforeAll, before, after, afterAll };
+}
+function resolveInheritedAuthAndHeaders(requestId, collection) {
+  let inheritedAuth = collection.auth && collection.auth.type !== "none" ? collection.auth : null;
+  let inheritedHeaders = collection.headers?.filter((h) => h.enabled && h.key) ?? [];
+  const path2 = folderPathTo(collection.rootFolder, requestId);
+  for (const folder of path2) {
+    if (folder.auth && folder.auth.type !== "none") inheritedAuth = folder.auth;
+    if (folder.headers?.length) {
+      inheritedHeaders = [...inheritedHeaders, ...folder.headers.filter((h) => h.enabled && h.key)];
+    }
+  }
+  return { auth: inheritedAuth, headers: inheritedHeaders };
+}
 exports.buildAuthHeaders = buildAuthHeaders;
 exports.buildDispatcher = buildDispatcher;
 exports.buildDynamicVars = buildDynamicVars;
 exports.buildEnvVars = buildEnvVars;
 exports.buildSchemaTestResults = buildSchemaTestResults;
 exports.buildUrl = buildUrl;
+exports.collectTagged = collectTagged;
 exports.fetchOAuth2Token = fetchOAuth2Token;
+exports.getAllApplicableHooks = getAllApplicableHooks;
 exports.getGlobals = getGlobals;
 exports.getSecret = getSecret;
 exports.initSecretStore = initSecretStore;
@@ -1245,5 +1314,6 @@ exports.performNtlmRequest = performNtlmRequest;
 exports.persistGlobals = persistGlobals;
 exports.registerRequestHandler = registerRequestHandler;
 exports.registerSecretHandlers = registerSecretHandlers;
+exports.resolveInheritedAuthAndHeaders = resolveInheritedAuthAndHeaders;
 exports.runScript = runScript;
 exports.setGlobals = setGlobals;