@testsmith/api-spector 0.2.5 → 0.2.7

package/LICENSE

@@ -1,26 +1,21 @@
-Copyright (c) 2024-2026 Testsmith.io
-
-All rights reserved.
-
-Permission is granted to view, copy, and run this software for private,
-internal, and non-commercial purposes only.
+MIT License
 
-You may not, without prior written permission from the copyright holder:
+Copyright (c) 2024-2026 Testsmith.io
 
-* use this software or derivative works for any commercial purpose;
-* sell, sublicense, rent, lease, or monetize this software;
-* host, publish, distribute, or make available any public copy of this
-  software or derivative works;
-* use this software to provide services to third parties;
-* remove or alter this copyright notice or license text.
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-Except as expressly permitted above, no rights are granted.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
-IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-For commercial licensing or other permissions, contact: info@testsmith.io
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/bin/cli.js

@@ -63,7 +63,48 @@ if (!command) {
 
 // ui: spawn electron with the app dir
 if (command.runner === 'electron') {
-  const electron = require('electron')
+  // `require('electron')` throws if electron's postinstall didn't download
+  // the platform binary (common behind corporate proxies on Windows: the
+  // npm install completes but the GitHub Releases download is blocked).
+  // The raw stack trace is intimidating; turn it into actionable steps.
+  let electron
+  try {
+    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)
+    console.error('')
+    console.error('  API Spector — failed to launch the UI.')
+    console.error('')
+    if (looksLikeBinaryMissing) {
+      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')
+      console.error('  firewall blocking github.com / electronjs.org).')
+      console.error('')
+      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('')
+      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('')
+      console.error('    3. Re-run electron\'s postinstall manually:')
+      console.error(`         cd "${path.join(installDir, 'node_modules', 'electron')}"`)
+      console.error('         node install.js')
+      console.error('')
+      console.error('  CLI subcommands (run / mock / record / contract / wsdl) do not')
+      console.error('  need the UI binary and should work even while this is broken.')
+    } else {
+      console.error(`  ${msg}`)
+    }
+    console.error('')
+    process.exit(1)
+  }
   const appDir = path.join(__dirname, '..')
   // Forward the user's cwd so the main process can decide whether to open a
   // workspace in this folder, or fall through to the welcome screen. Without

package/out/main/index.js

@@ -1494,7 +1494,7 @@ function buildTestSuite(collection, environment, nameMap) {
   processFolder(collection.rootFolder);
   return lines.join("\n");
 }
-function renderTree$5(paths) {
+function renderTree$6(paths) {
   const root = {};
   for (const p of [...paths].sort()) {
     let cur = root;
@@ -1513,8 +1513,8 @@ function renderTree$5(paths) {
   }
   return [".", ...render(root)].join("\n");
 }
-function buildReadme$5(collectionName, filePaths) {
-  const tree = renderTree$5(filePaths);
+function buildReadme$6(collectionName, filePaths) {
+  const tree = renderTree$6(filePaths);
   return `# ${collectionName} — API Tests (Robot Framework)
 
 ## Project structure
@@ -1553,7 +1553,7 @@ function generateRobotFramework(collection, environment) {
   ];
   const allPaths = ["requirements.txt", ...contentFiles.map((f) => f.path)];
   return [
-    { path: "README.md", content: buildReadme$5(collection.name, allPaths) },
+    { path: "README.md", content: buildReadme$6(collection.name, allPaths) },
     { path: "requirements.txt", content: "robotframework\nrobotframework-requests\n" },
     ...contentFiles
   ];
@@ -1859,7 +1859,7 @@ function buildPackageJson$3(collectionName) {
     }
   }, null, 2) + "\n";
 }
-function renderTree$4(paths) {
+function renderTree$5(paths) {
   const root = {};
   for (const p of [...paths].sort()) {
     let cur = root;
@@ -1878,8 +1878,8 @@ function renderTree$4(paths) {
   }
   return [".", ...render(root)].join("\n");
 }
-function buildReadme$4(collectionName, filePaths) {
-  const tree = renderTree$4([...filePaths, ".env.local"]);
+function buildReadme$5(collectionName, filePaths) {
+  const tree = renderTree$5([...filePaths, ".env.local"]);
   return `# ${collectionName} — API Tests (Playwright TypeScript)
 
 ## Project structure
@@ -1914,7 +1914,7 @@ function generatePlaywright(collection, environment) {
   files.unshift(
     { path: "package.json", content: buildPackageJson$3(collection.name) },
     { path: "playwright.config.ts", content: buildPlaywrightConfig$1(environment) },
-    { path: "README.md", content: buildReadme$4(collection.name, scaffoldPaths) }
+    { path: "README.md", content: buildReadme$5(collection.name, scaffoldPaths) }
   );
   return files;
 }
@@ -2203,7 +2203,7 @@ function buildPackageJson$2(collectionName) {
     }
   }, null, 2) + "\n";
 }
-function renderTree$3(paths) {
+function renderTree$4(paths) {
   const root = {};
   for (const p of [...paths].sort()) {
     let cur = root;
@@ -2222,8 +2222,8 @@ function renderTree$3(paths) {
   }
   return [".", ...render(root)].join("\n");
 }
-function buildReadme$3(collectionName, filePaths) {
-  const tree = renderTree$3([...filePaths, ".env.local"]);
+function buildReadme$4(collectionName, filePaths) {
+  const tree = renderTree$4([...filePaths, ".env.local"]);
   return `# ${collectionName} — API Tests (Playwright JavaScript)
 
 ## Project structure
@@ -2258,7 +2258,7 @@ function generatePlaywrightJs(collection, environment) {
   files.unshift(
     { path: "package.json", content: buildPackageJson$2(collection.name) },
     { path: "playwright.config.js", content: buildPlaywrightConfig(environment) },
-    { path: "README.md", content: buildReadme$3(collection.name, scaffoldPaths) }
+    { path: "README.md", content: buildReadme$4(collection.name, scaffoldPaths) }
   );
   return files;
 }
@@ -2486,7 +2486,7 @@ function buildTsConfig() {
     exclude: ["node_modules", "dist"]
   }, null, 2) + "\n";
 }
-function renderTree$2(paths) {
+function renderTree$3(paths) {
   const root = {};
   for (const p of [...paths].sort()) {
     let cur = root;
@@ -2505,8 +2505,8 @@ function renderTree$2(paths) {
   }
   return [".", ...render(root)].join("\n");
 }
-function buildReadme$2(collectionName, filePaths) {
-  const tree = renderTree$2([...filePaths, ".env.local"]);
+function buildReadme$3(collectionName, filePaths) {
+  const tree = renderTree$3([...filePaths, ".env.local"]);
   return `# ${collectionName} — API Tests (Supertest + Jest TypeScript)
 
 ## Project structure
@@ -2551,7 +2551,7 @@ function generateSupertestTs(collection, environment) {
   files.unshift(
     { path: "package.json", content: buildPackageJson$1(collection.name) },
     { path: "tsconfig.json", content: buildTsConfig() },
-    { path: "README.md", content: buildReadme$2(collection.name, scaffoldPaths) }
+    { path: "README.md", content: buildReadme$3(collection.name, scaffoldPaths) }
   );
   return files;
 }
@@ -2755,7 +2755,7 @@ function buildPackageJson(collectionName) {
     }
   }, null, 2) + "\n";
 }
-function renderTree$1(paths) {
+function renderTree$2(paths) {
   const root = {};
   for (const p of [...paths].sort()) {
     let cur = root;
@@ -2774,8 +2774,8 @@ function renderTree$1(paths) {
   }
   return [".", ...render(root)].join("\n");
 }
-function buildReadme$1(collectionName, filePaths) {
-  const tree = renderTree$1([...filePaths, ".env.local"]);
+function buildReadme$2(collectionName, filePaths) {
+  const tree = renderTree$2([...filePaths, ".env.local"]);
   return `# ${collectionName} — API Tests (Supertest + Jest JavaScript)
 
 ## Project structure
@@ -2819,11 +2819,11 @@ function generateSupertestJs(collection, environment) {
   const scaffoldPaths = ["package.json", ...files.map((f) => f.path)];
   files.unshift(
     { path: "package.json", content: buildPackageJson(collection.name) },
-    { path: "README.md", content: buildReadme$1(collection.name, scaffoldPaths) }
+    { path: "README.md", content: buildReadme$2(collection.name, scaffoldPaths) }
   );
   return files;
 }
-function javaClass(name) {
+function javaClass$1(name) {
   return name.replace(/[^\w\s]/g, " ").split(/\s+/).filter(Boolean).map((w) => w.charAt(0).toUpperCase() + w.slice(1)).join("");
 }
 function javaMethod(name) {
@@ -2854,7 +2854,7 @@ function interpolateJava(value, sharedVars = /* @__PURE__ */ new Set()) {
     return `" + System.getenv("${envKey}") + "`;
   }) + '"';
 }
-function buildPom(collectionName) {
+function buildPom$1(collectionName) {
   const artifact = collectionName.replace(/\W+/g, "-").toLowerCase();
   return `<?xml version="1.0" encoding="UTF-8"?>
 <project xmlns="http://maven.apache.org/POM/4.0.0"
@@ -2966,7 +2966,7 @@ public class BaseTest {
 }
 function buildTestClass(folderName, folder, collection) {
   const requests = collection.requests;
-  const className = javaClass(folderName) + "Test";
+  const className = javaClass$1(folderName) + "Test";
   const methods = [];
   const hooks = requestCollection.getAllApplicableHooks(folder.id, collection);
   const beforeAllH = hooks.beforeAll;
@@ -3122,7 +3122,7 @@ ${methods.join("\n\n")}
 }
 `;
 }
-function renderTree(paths) {
+function renderTree$1(paths) {
   const root = {};
   for (const p of [...paths].sort()) {
     let cur = root;
@@ -3141,8 +3141,8 @@ function renderTree(paths) {
   }
   return [".", ...render(root)].join("\n");
 }
-function buildReadme(collectionName, filePaths) {
-  const tree = renderTree(filePaths);
+function buildReadme$1(collectionName, filePaths) {
+  const tree = renderTree$1(filePaths);
   return `# ${collectionName} — API Tests (REST Assured + JUnit 5)
 
 ## Project structure
@@ -3166,12 +3166,12 @@ BASE_URL=https://api.example.com mvn test
 }
 function generateRestAssured(collection, environment) {
   const files = [
-    { path: "pom.xml", content: buildPom(collection.name) },
+    { path: "pom.xml", content: buildPom$1(collection.name) },
     { path: "src/test/java/com/example/api/BaseTest.java", content: buildBaseTest(environment) }
   ];
   function processFolder(folder, name) {
     if (folder.requestIds.length > 0) {
-      const className = javaClass(name) + "Test";
+      const className = javaClass$1(name) + "Test";
       files.push({
         path: `src/test/java/com/example/api/${className}.java`,
         content: buildTestClass(name, folder, collection)
@@ -3187,6 +3187,442 @@ function generateRestAssured(collection, environment) {
   for (const sub of collection.rootFolder.folders) {
     processFolder(sub, sub.name);
   }
+  files.unshift({ path: "README.md", content: buildReadme$1(collection.name, files.map((f) => f.path)) });
+  return files;
+}
+function javaClass(name) {
+  return name.replace(/[^\w\s]/g, " ").split(/\s+/).filter(Boolean).map((w) => w.charAt(0).toUpperCase() + w.slice(1)).join("");
+}
+function jsVar(name) {
+  const parts = name.replace(/[^a-zA-Z0-9]+/g, " ").split(/\s+/).filter(Boolean).map((p) => p.toLowerCase());
+  if (parts.length === 0) return "_";
+  return parts[0] + parts.slice(1).map((w) => w.charAt(0).toUpperCase() + w.slice(1)).join("");
+}
+function featureFileName(name) {
+  const slug2 = name.replace(/[^\w\s-]/g, "").trim().replace(/\s+/g, "-").toLowerCase();
+  return slug2 || "tests";
+}
+function configKey(envKey) {
+  return jsVar(envKey);
+}
+function escSingle(s) {
+  return s.replace(/\\/g, "\\\\").replace(/'/g, "\\'");
+}
+function interpolateKarate(value) {
+  if (!value.includes("{{")) return `'${escSingle(value)}'`;
+  const parts = [];
+  let last = 0;
+  const re = /\{\{([^}]+)\}\}/g;
+  let m;
+  while (m = re.exec(value)) {
+    if (m.index > last) parts.push(`'${escSingle(value.slice(last, m.index))}'`);
+    parts.push(configKey(m[1].trim()));
+    last = m.index + m[0].length;
+  }
+  if (last < value.length) parts.push(`'${escSingle(value.slice(last))}'`);
+  return parts.length === 1 ? parts[0] : parts.join(" + ");
+}
+function urlSteps(url) {
+  const leadingVar = url.match(/^\{\{([^}]+)\}\}(.*)$/);
+  if (leadingVar) {
+    const baseVar = configKey(leadingVar[1].trim());
+    const rest2 = leadingVar[2].replace(/^\//, "");
+    const steps2 = [[`url ${baseVar}`]];
+    if (rest2) steps2.push([`path ${interpolateKarate(rest2)}`]);
+    return steps2;
+  }
+  if (/^https?:\/\//i.test(url)) {
+    return [[`url ${interpolateKarate(url)}`]];
+  }
+  const rest = url.replace(/^\//, "");
+  const steps = [[`url baseUrl`]];
+  if (rest) steps.push([`path ${interpolateKarate(rest)}`]);
+  return steps;
+}
+function buildPom(collectionName) {
+  const artifact = collectionName.replace(/\W+/g, "-").toLowerCase();
+  return `<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
+             http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+
+  <groupId>com.example.api</groupId>
+  <artifactId>${artifact}-karate</artifactId>
+  <version>1.0.0-SNAPSHOT</version>
+  <packaging>jar</packaging>
+
+  <properties>
+    <java.version>17</java.version>
+    <maven.compiler.source>\${java.version}</maven.compiler.source>
+    <maven.compiler.target>\${java.version}</maven.compiler.target>
+    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    <karate.version>1.5.0</karate.version>
+    <junit.version>5.10.2</junit.version>
+  </properties>
+
+  <dependencies>
+    <dependency>
+      <groupId>io.karatelabs</groupId>
+      <artifactId>karate-junit5</artifactId>
+      <version>\${karate.version}</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter</artifactId>
+      <version>\${junit.version}</version>
+      <scope>test</scope>
+    </dependency>
+  </dependencies>
+
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-surefire-plugin</artifactId>
+        <version>3.2.5</version>
+      </plugin>
+    </plugins>
+  </build>
+</project>
+`;
+}
+function buildKarateConfig(environment) {
+  const baseUrl = environment?.variables.find(
+    (v) => ["base_url", "baseurl", "base-url"].includes(v.key.toLowerCase()) && !v.secret
+  )?.value ?? "http://localhost:8080";
+  const lines = [];
+  lines.push(`function fn() {`);
+  lines.push(`  var env = karate.env || 'dev';`);
+  lines.push(`  karate.log('karate env:', env);`);
+  lines.push(``);
+  lines.push(`  var config = {`);
+  lines.push(`    baseUrl: '${escSingle(baseUrl)}'`);
+  const otherVars = (environment?.variables ?? []).filter((v) => {
+    const k = v.key.toLowerCase();
+    return v.enabled && !["base_url", "baseurl", "base-url"].includes(k);
+  });
+  for (const v of otherVars) {
+    const key = configKey(v.key);
+    const def = v.secret ? "''" : `'${escSingle(v.value ?? "")}'`;
+    lines.push(`,`);
+    lines.push(`    ${key}: ${def}`);
+  }
+  lines.push(`  };`);
+  lines.push(``);
+  lines.push(`  // Allow each variable to be overridden via a process env var of the same`);
+  lines.push(`  // SHOUTY_SNAKE_CASE name (e.g. AUTH_TOKEN populates config.authToken).`);
+  lines.push(`  function envOverride(name, key) {`);
+  lines.push(`    var v = java.lang.System.getenv(name);`);
+  lines.push(`    if (v) config[key] = v;`);
+  lines.push(`  }`);
+  lines.push(`  envOverride('BASE_URL', 'baseUrl');`);
+  for (const v of otherVars) {
+    lines.push(`  envOverride('${v.key}', '${configKey(v.key)}');`);
+  }
+  lines.push(``);
+  lines.push(`  return config;`);
+  lines.push(`}`);
+  return lines.join("\n") + "\n";
+}
+function buildRunner(collectionName) {
+  const className = javaClass(collectionName) + "Runner";
+  return `package karate;
+
+import com.intuit.karate.junit5.Karate;
+
+/**
+ * JUnit 5 entry point — runs every .feature in the \`karate\` package
+ * (this folder). Override the active env at run time with:
+ *
+ *   mvn test -Dkarate.env=staging
+ */
+public class ${className} {
+
+    @Karate.Test
+    Karate all() {
+        return Karate.run().relativeTo(getClass());
+    }
+}
+`;
+}
+function buildBackground(folderId, collection) {
+  const hooks = requestCollection.getAllApplicableHooks(folderId, collection);
+  const lines = [];
+  const defined = /* @__PURE__ */ new Set();
+  for (const h of [...hooks.beforeAll, ...hooks.before]) {
+    const method = h.method.toLowerCase();
+    const declared = new Set((h.headers ?? []).filter((x) => x.enabled && x.key).map((x) => x.key.toLowerCase()));
+    const has = (n) => declared.has(n.toLowerCase());
+    lines.push(`  # ${h.name}`);
+    for (const block of urlSteps(h.url)) {
+      lines.push(`  * ${block[0]}`);
+      for (let i = 1; i < block.length; i++) lines.push(block[i]);
+    }
+    for (const x of (h.headers ?? []).filter((x2) => x2.enabled && x2.key)) {
+      lines.push(`  * header ${x.key} = ${interpolateKarate(x.value)}`);
+    }
+    if (h.body.mode !== "none" && !["get", "head"].includes(method)) {
+      for (const block of bodySteps(h.body, has)) {
+        lines.push(`  * ${block[0]}`);
+        for (let i = 1; i < block.length; i++) lines.push(block[i]);
+      }
+    }
+    lines.push(`  * method ${method}`);
+    const parsed = parsePostScript(h.postRequestScript);
+    for (const e of parsed.extractions) {
+      const jp = accessorToJsonPath(e.accessor).replace(/^json\.?/, "");
+      const expr = jp ? `response.${jp}` : "response";
+      const name = configKey(e.varName);
+      defined.add(name);
+      lines.push(`  * def ${name} = ${expr}`);
+    }
+  }
+  return { lines, defined };
+}
+function bodyDocstring(json) {
+  const expanded = json.replace(/\{\{([^}]+)\}\}/g, (_, k) => `#(${configKey(k.trim())})`);
+  let pretty = expanded.trim();
+  try {
+    pretty = JSON.stringify(JSON.parse(expanded), null, 2);
+  } catch {
+  }
+  const out = ['    """'];
+  for (const l of pretty.split("\n")) out.push(`    ${l}`);
+  out.push('    """');
+  return out;
+}
+function rawDocstring(text) {
+  const expanded = text.replace(/\{\{([^}]+)\}\}/g, (_, k) => `#(${configKey(k.trim())})`);
+  const out = ['    """'];
+  for (const l of expanded.replace(/\r\n/g, "\n").split("\n")) out.push(`    ${l}`);
+  out.push('    """');
+  return out;
+}
+function bodySteps(body, alreadyHasHeader) {
+  if (body.mode === "json" && body.json) {
+    return [[`request`, ...bodyDocstring(body.json)]];
+  }
+  if (body.mode === "soap" && body.soap?.envelope) {
+    const out = [];
+    if (body.soap.soapAction && !alreadyHasHeader("soapaction")) {
+      out.push([`header SOAPAction = '"${escSingle(body.soap.soapAction)}"'`]);
+    }
+    if (!alreadyHasHeader("content-type")) {
+      out.push([`header Content-Type = 'text/xml; charset=utf-8'`]);
+    }
+    out.push([`request`, ...rawDocstring(body.soap.envelope)]);
+    return out;
+  }
+  if (body.mode === "raw" && body.raw) {
+    const out = [];
+    if (body.rawContentType && !alreadyHasHeader("content-type")) {
+      out.push([`header Content-Type = '${escSingle(body.rawContentType)}'`]);
+    }
+    out.push([`request`, ...rawDocstring(body.raw)]);
+    return out;
+  }
+  if (body.mode === "graphql" && body.graphql) {
+    const env = { query: body.graphql.query };
+    if (body.graphql.variables?.trim()) {
+      try {
+        env.variables = JSON.parse(body.graphql.variables);
+      } catch {
+      }
+    }
+    if (body.graphql.operationName?.trim()) env.operationName = body.graphql.operationName.trim();
+    return [[`request`, ...bodyDocstring(JSON.stringify(env))]];
+  }
+  return [];
+}
+function buildFeature(folderName, folder, collection) {
+  const requests = collection.requests;
+  const bg = buildBackground(folder.id, collection);
+  const scenarios = [];
+  const usedTags = /* @__PURE__ */ new Set();
+  for (const reqId of folder.requestIds) {
+    const req = requests[reqId];
+    if (!req || req.disabled || req.hookType) continue;
+    let tag = featureFileName(req.name);
+    if (usedTags.has(tag)) {
+      let i = 2;
+      while (usedTags.has(`${tag}-${i}`)) i++;
+      tag = `${tag}-${i}`;
+    }
+    usedTags.add(tag);
+    const inherited = requestCollection.resolveInheritedAuthAndHeaders(reqId, collection);
+    const effectiveAuth = req.auth.type !== "none" ? req.auth : inherited.auth ?? req.auth;
+    const allHeaders = [...inherited.headers.filter((h) => h.enabled && h.key), ...req.headers.filter((h) => h.enabled && h.key)];
+    const enabledParams = req.params.filter((p) => p.enabled && p.key);
+    const method = req.method.toLowerCase();
+    const hasBody = req.body.mode !== "none" && !["get", "head"].includes(method);
+    const lines = [];
+    lines.push(`@${tag}`);
+    lines.push(`Scenario: ${req.name}`);
+    const setup = [...urlSteps(req.url)];
+    if (effectiveAuth.type === "bearer") {
+      const token = effectiveAuth.token ?? "";
+      if (token.includes("{{")) {
+        const single = token.match(/^\{\{([^}]+)\}\}$/);
+        if (single) {
+          setup.push([`header Authorization = 'Bearer ' + ${configKey(single[1].trim())}`]);
+        } else {
+          setup.push([`header Authorization = 'Bearer ' + ${interpolateKarate(token)}`]);
+        }
+      } else if (effectiveAuth.tokenSecretRef) {
+        setup.push([`header Authorization = 'Bearer ' + ${configKey(effectiveAuth.tokenSecretRef)}`]);
+      } else if (token) {
+        setup.push([`header Authorization = 'Bearer ${escSingle(token)}'`]);
+      }
+    } else if (effectiveAuth.type === "basic") {
+      const user = effectiveAuth.username ?? "";
+      const pass = effectiveAuth.password ?? "";
+      setup.push([`configure headers = ({ Authorization: 'Basic ' + java.util.Base64.getEncoder().encodeToString((${interpolateKarate(user)} + ':' + ${interpolateKarate(pass)}).getBytes()) })`]);
+    }
+    for (const h of allHeaders) {
+      setup.push([`header ${h.key} = ${interpolateKarate(h.value)}`]);
+    }
+    for (const p of enabledParams) {
+      setup.push([`param ${p.key} = ${interpolateKarate(p.value)}`]);
+    }
+    if (hasBody) {
+      const declared = new Set(allHeaders.map((h) => h.key.toLowerCase()));
+      const has = (n) => declared.has(n.toLowerCase());
+      for (const block of bodySteps(req.body, has)) setup.push(block);
+    }
+    setup.forEach((step, i) => {
+      const kw = i === 0 ? "Given" : "And";
+      lines.push(`  ${kw} ${step[0]}`);
+      for (let j = 1; j < step.length; j++) lines.push(step[j]);
+    });
+    lines.push(`  When method ${method}`);
+    const asserts = [];
+    const parsed = parsePostScript(req.postRequestScript);
+    let statusEmitted = false;
+    if (parsed.assertions.length > 0) {
+      for (const a of parsed.assertions) {
+        const jp = accessorToJsonPath(a.accessor).replace(/^json\.?/, "");
+        const target = jp ? `response.${jp}` : "response";
+        switch (a.kind) {
+          case "status":
+            asserts.push(`status ${a.expected ?? 200}`);
+            statusEmitted = true;
+            break;
+          case "equals":
+            asserts.push(`match ${target} == ${a.expected}`);
+            break;
+          case "contains":
+            asserts.push(`match ${target} contains ${a.expected}`);
+            break;
+          case "exists":
+            asserts.push(`match ${target} != null`);
+            break;
+          case "type": {
+            const t = (a.expected ?? "").replace(/"/g, "");
+            const fuzzy = ["string", "number", "boolean", "array", "object"].includes(t) ? `'#${t}'` : `'#notnull'`;
+            asserts.push(`match ${target} == ${fuzzy}`);
+            break;
+          }
+          case "above":
+            asserts.push(`match ${target} > ${a.expected ?? 0}`);
+            break;
+        }
+      }
+    }
+    if (!statusEmitted) asserts.unshift(`status 200`);
+    asserts.forEach((step, i) => {
+      const kw = i === 0 ? "Then" : "And";
+      lines.push(`  ${kw} ${step}`);
+    });
+    scenarios.push(lines.join("\n"));
+  }
+  const bgBlock = bg.lines.length > 0 ? `
+Background:
+${bg.lines.join("\n")}
+` : "";
+  return `Feature: ${folderName}
+${bgBlock}
+${scenarios.join("\n\n")}
+`;
+}
+function renderTree(paths) {
+  const root = {};
+  for (const p of [...paths].sort()) {
+    let cur = root;
+    for (const part of p.split("/")) {
+      cur = cur[part] ??= {};
+    }
+  }
+  function render(node, prefix = "") {
+    const entries = Object.entries(node);
+    return entries.flatMap(([name, children], i) => {
+      const last = i === entries.length - 1;
+      const lines = [`${prefix}${last ? "└── " : "├── "}${name}`];
+      if (Object.keys(children).length) lines.push(...render(children, prefix + (last ? "    " : "│   ")));
+      return lines;
+    });
+  }
+  return [".", ...render(root)].join("\n");
+}
+function buildReadme(collectionName, filePaths) {
+  const tree = renderTree(filePaths);
+  return `# ${collectionName} — API Tests (Karate + JUnit 5)
+
+Karate is a BDD-flavoured API test framework that uses Gherkin feature files
+(no glue code) — see https://docs.karatelabs.io for the full reference.
+
+## Project structure
+
+\`\`\`
+${tree}
+\`\`\`
+
+## Setup
+
+Requires Java 17+ and Maven 3.8+.
+
+\`\`\`sh
+# Run all features
+mvn test
+
+# Switch environment (read by karate-config.js)
+mvn test -Dkarate.env=staging
+
+# Override individual values
+BASE_URL=https://api.example.com AUTH_TOKEN=eyJ... mvn test
+
+# Filter by tag
+mvn test "-Dkarate.options=--tags @get-users"
+\`\`\`
+`;
+}
+function generateKarate(collection, environment) {
+  const files = [
+    { path: "pom.xml", content: buildPom(collection.name) },
+    { path: "src/test/resources/karate-config.js", content: buildKarateConfig(environment) },
+    {
+      path: `src/test/java/karate/${javaClass(collection.name)}Runner.java`,
+      content: buildRunner(collection.name)
+    }
+  ];
+  function processFolder(folder, name) {
+    if (folder.requestIds.some((id) => {
+      const r = collection.requests[id];
+      return r && !r.disabled && !r.hookType;
+    })) {
+      files.push({
+        path: `src/test/resources/karate/${featureFileName(name)}.feature`,
+        content: buildFeature(name, folder, collection)
+      });
+    }
+    for (const sub of folder.folders) processFolder(sub, sub.name);
+  }
+  if (collection.rootFolder.requestIds.length > 0) {
+    processFolder(collection.rootFolder, collection.name);
+  }
+  for (const sub of collection.rootFolder.folders) processFolder(sub, sub.name);
   files.unshift({ path: "README.md", content: buildReadme(collection.name, files.map((f) => f.path)) });
   return files;
 }
@@ -3206,6 +3642,8 @@ function registerGenerateHandlers(ipc) {
         return generateSupertestJs(collection, environment);
       case "rest_assured":
         return generateRestAssured(collection, environment);
+      case "karate":
+        return generateKarate(collection, environment);
       default:
         throw new Error(`Unknown target: ${target}`);
     }
@@ -4158,10 +4596,20 @@ function registerContractHandlers(ipc) {
     await snapshots.deleteSnapshot(dir, relPath);
   });
 }
+const GIT_BLOCK_TIMEOUT_MS = 6e4;
 function git() {
   const dir = getWorkspaceDir();
   if (!dir) throw new Error("No workspace open");
-  return simpleGit.simpleGit(dir);
+  return simpleGit.simpleGit(dir, {
+    timeout: { block: GIT_BLOCK_TIMEOUT_MS },
+    unsafe: { allowUnsafeAskPass: true }
+  }).env({
+    ...process.env,
+    GIT_TERMINAL_PROMPT: "0",
+    GIT_ASKPASS: "echo",
+    SSH_ASKPASS: "echo",
+    GCM_INTERACTIVE: "Never"
+  });
 }
 function registerGitHandlers(ipc) {
   ipc.handle("git:isRepo", async () => {

package/out/main/runner.js

@@ -632,7 +632,7 @@ async function main() {
   if (envName && !env) {
     console.warn(color(`Warning: environment "${envName}" not found. Running without environment.`, C.yellow));
   }
-  const version = `v${"0.2.5"}`;
+  const version = `v${"0.2.7"}`;
   console.log("");
   console.log(color("  API Test Runner" + (version ? ` ${version}` : ""), C.bold, C.white));
   console.log(color(`  Workspace:   ${wsPath}`, C.gray));

package/out/renderer/assets/{index-Cp3zkfSB.js → index-WH-P4X-L.js}

@@ -64976,7 +64976,8 @@ const TARGETS = [
   { id: "playwright_js", label: "Playwright JS", description: "JavaScript page-object API classes + spec files" },
   { id: "supertest_ts", label: "Supertest TS", description: "Jest + Supertest TypeScript tests" },
   { id: "supertest_js", label: "Supertest JS", description: "Jest + Supertest JavaScript tests" },
-  { id: "rest_assured", label: "REST Assured", description: "Java + JUnit 5 + Maven pom.xml" }
+  { id: "rest_assured", label: "REST Assured", description: "Java + JUnit 5 + Maven pom.xml" },
+  { id: "karate", label: "Karate", description: "Karate feature files + JUnit 5 runner + Maven" }
 ];
 function GeneratorPanel() {
   const setShowGeneratorPanel = useStore((s) => s.setShowGeneratorPanel);
@@ -70981,7 +70982,7 @@ function App() {
       /* @__PURE__ */ jsxRuntimeExports.jsx("span", { style: { color: "#6aa3c8" }, children: "Spector" }),
       /* @__PURE__ */ jsxRuntimeExports.jsxs("span", { className: "ml-2 text-[10px] font-normal opacity-50", children: [
         "v",
-        "0.2.5"
+        "0.2.7"
       ] }),
       /* @__PURE__ */ jsxRuntimeExports.jsx("span", { className: "mx-2 opacity-30", children: "·" }),
       /* @__PURE__ */ jsxRuntimeExports.jsx(

package/out/renderer/index.html

@@ -5,7 +5,7 @@
   <meta charset="UTF-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <title>API Spector</title>
-  <script type="module" crossorigin src="./assets/index-Cp3zkfSB.js"></script>
+  <script type="module" crossorigin src="./assets/index-WH-P4X-L.js"></script>
   <link rel="stylesheet" crossorigin href="./assets/index-DfkLUeA1.css">
 </head>
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@testsmith/api-spector",
   "productName": "API Spector",
-  "version": "0.2.5",
+  "version": "0.2.7",
   "description": "Local-first API testing tool to inspect, test and mock APIs",
   "repository": {
     "type": "git",
@@ -11,7 +11,7 @@
     "url": "https://github.com/testsmith-io/api-spector/issues"
   },
   "homepage": "https://github.com/testsmith-io/api-spector",
-  "license": "GPL-3.0-only",
+  "license": "MIT",
   "main": "out/main/index.js",
   "bin": {
     "api-spector": "bin/cli.js"

package/readme.md

@@ -118,8 +118,6 @@ npm run package
 
 ## License
 
-Copyright (c) 2024-2026 Testsmith.io. All rights reserved.
+API Spector is released under the [MIT License](LICENSE) — free to use, modify, and distribute, including for commercial purposes.
 
-This repository is publicly viewable for reference purposes only.
-
-Commercial use, public hosting, redistribution, and use for third-party services are not permitted without prior written permission. See [LICENSE](LICENSE) for full terms.
+Copyright (c) 2024-2026 Testsmith.io