npm - @kirrosh/apitool - Versions diffs - 0.4.3 - Mend

@kirrosh/apitool 0.4.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (191) hide show

package/.github/workflows/ci.yml +27 -0
package/.github/workflows/release.yml +97 -0
package/.mcp.json +9 -0
package/APITOOL.md +195 -0
package/BACKLOG.md +62 -0
package/CHANGELOG.md +88 -0
package/LICENSE +21 -0
package/README.md +105 -0
package/bun.lock +291 -0
package/docs/GLOSSARY.md +182 -0
package/docs/INDEX.md +21 -0
package/docs/agent.md +135 -0
package/docs/archive/APITOOL-pre-M22.md +831 -0
package/docs/archive/BACKLOG-AI-NATIVE.md +56 -0
package/docs/archive/M1-M2-parser-runner.md +216 -0
package/docs/archive/M4-M7-reporter-cli.md +179 -0
package/docs/archive/M5-M7-storage-junit.md +300 -0
package/docs/archive/M6-webui.md +339 -0
package/docs/ci.md +274 -0
package/docs/generation-issues.md +67 -0
package/generated/.env.yaml +3 -0
package/install.ps1 +80 -0
package/install.sh +113 -0
package/package.json +46 -0
package/scripts/run-mocked-tests.ts +45 -0
package/seed-demo.ts +53 -0
package/self-tests/auth.yaml +18 -0
package/self-tests/collections-crud.yaml +46 -0
package/self-tests/environments-crud.yaml +48 -0
package/self-tests/export.yaml +32 -0
package/self-tests/runs.yaml +16 -0
package/src/bun-types.d.ts +5 -0
package/src/cli/commands/add-api.ts +51 -0
package/src/cli/commands/ai-generate.ts +106 -0
package/src/cli/commands/chat.ts +43 -0
package/src/cli/commands/ci-init.ts +126 -0
package/src/cli/commands/collections.ts +41 -0
package/src/cli/commands/coverage.ts +65 -0
package/src/cli/commands/doctor.ts +127 -0
package/src/cli/commands/envs.ts +218 -0
package/src/cli/commands/init.ts +84 -0
package/src/cli/commands/mcp.ts +16 -0
package/src/cli/commands/run.ts +137 -0
package/src/cli/commands/runs.ts +108 -0
package/src/cli/commands/serve.ts +22 -0
package/src/cli/commands/update.ts +142 -0
package/src/cli/commands/validate.ts +18 -0
package/src/cli/index.ts +500 -0
package/src/cli/output.ts +24 -0
package/src/cli/runtime.ts +7 -0
package/src/core/agent/agent-loop.ts +116 -0
package/src/core/agent/context-manager.ts +41 -0
package/src/core/agent/system-prompt.ts +33 -0
package/src/core/agent/tools/diagnose-failure.ts +51 -0
package/src/core/agent/tools/explore-api.ts +40 -0
package/src/core/agent/tools/index.ts +48 -0
package/src/core/agent/tools/manage-environment.ts +40 -0
package/src/core/agent/tools/query-results.ts +40 -0
package/src/core/agent/tools/run-tests.ts +38 -0
package/src/core/agent/tools/send-request.ts +44 -0
package/src/core/agent/tools/validate-tests.ts +23 -0
package/src/core/agent/types.ts +22 -0
package/src/core/generator/ai/ai-generator.ts +61 -0
package/src/core/generator/ai/llm-client.ts +159 -0
package/src/core/generator/ai/output-parser.ts +307 -0
package/src/core/generator/ai/prompt-builder.ts +153 -0
package/src/core/generator/ai/types.ts +56 -0
package/src/core/generator/coverage-scanner.ts +87 -0
package/src/core/generator/data-factory.ts +115 -0
package/src/core/generator/index.ts +10 -0
package/src/core/generator/openapi-reader.ts +142 -0
package/src/core/generator/schema-utils.ts +52 -0
package/src/core/generator/serializer.ts +189 -0
package/src/core/generator/types.ts +47 -0
package/src/core/parser/filter.ts +14 -0
package/src/core/parser/index.ts +21 -0
package/src/core/parser/schema.ts +175 -0
package/src/core/parser/types.ts +50 -0
package/src/core/parser/variables.ts +146 -0
package/src/core/parser/yaml-parser.ts +85 -0
package/src/core/reporter/console.ts +175 -0
package/src/core/reporter/index.ts +23 -0
package/src/core/reporter/json.ts +9 -0
package/src/core/reporter/junit.ts +78 -0
package/src/core/reporter/types.ts +12 -0
package/src/core/runner/assertions.ts +172 -0
package/src/core/runner/execute-run.ts +75 -0
package/src/core/runner/executor.ts +150 -0
package/src/core/runner/http-client.ts +69 -0
package/src/core/runner/index.ts +12 -0
package/src/core/runner/types.ts +48 -0
package/src/core/setup-api.ts +97 -0
package/src/core/utils.ts +9 -0
package/src/db/queries.ts +868 -0
package/src/db/schema.ts +215 -0
package/src/mcp/server.ts +47 -0
package/src/mcp/tools/ci-init.ts +57 -0
package/src/mcp/tools/coverage-analysis.ts +58 -0
package/src/mcp/tools/explore-api.ts +84 -0
package/src/mcp/tools/generate-missing-tests.ts +80 -0
package/src/mcp/tools/generate-tests-guide.ts +353 -0
package/src/mcp/tools/manage-environment.ts +123 -0
package/src/mcp/tools/manage-server.ts +87 -0
package/src/mcp/tools/query-db.ts +141 -0
package/src/mcp/tools/run-tests.ts +66 -0
package/src/mcp/tools/save-test-suite.ts +164 -0
package/src/mcp/tools/send-request.ts +53 -0
package/src/mcp/tools/setup-api.ts +49 -0
package/src/mcp/tools/validate-tests.ts +42 -0
package/src/tui/chat-ui.ts +150 -0
package/src/web/routes/api.ts +234 -0
package/src/web/routes/dashboard.ts +348 -0
package/src/web/routes/runs.ts +64 -0
package/src/web/schemas.ts +121 -0
package/src/web/server.ts +134 -0
package/src/web/static/htmx.min.js +1 -0
package/src/web/static/style.css +265 -0
package/src/web/views/layout.ts +46 -0
package/src/web/views/results.ts +209 -0
package/tests/agent/agent-loop.test.ts +61 -0
package/tests/agent/context-manager.test.ts +59 -0
package/tests/agent/system-prompt.test.ts +42 -0
package/tests/agent/tools/diagnose-failure.test.ts +85 -0
package/tests/agent/tools/explore-api.test.ts +59 -0
package/tests/agent/tools/manage-environment.test.ts +78 -0
package/tests/agent/tools/query-results.test.ts +77 -0
package/tests/agent/tools/run-tests.test.ts +89 -0
package/tests/agent/tools/send-request.test.ts +78 -0
package/tests/agent/tools/validate-tests.test.ts +59 -0
package/tests/ai/ai-generator.integration.test.ts +131 -0
package/tests/ai/llm-client.test.ts +145 -0
package/tests/ai/output-parser.test.ts +132 -0
package/tests/ai/prompt-builder.test.ts +67 -0
package/tests/ai/types.test.ts +55 -0
package/tests/cli/args.test.ts +63 -0
package/tests/cli/chat.test.ts +38 -0
package/tests/cli/ci-init.test.ts +112 -0
package/tests/cli/commands.test.ts +316 -0
package/tests/cli/coverage.test.ts +58 -0
package/tests/cli/doctor.test.ts +39 -0
package/tests/cli/envs.test.ts +181 -0
package/tests/cli/init.test.ts +80 -0
package/tests/cli/runs.test.ts +94 -0
package/tests/cli/safe-run.test.ts +103 -0
package/tests/cli/update.test.ts +32 -0
package/tests/core/generator/schema-utils.test.ts +108 -0
package/tests/core/parser/nested-assertions.test.ts +80 -0
package/tests/core/runner/root-body-assertions.test.ts +70 -0
package/tests/db/chat-queries.test.ts +88 -0
package/tests/db/chat-schema.test.ts +37 -0
package/tests/db/environments.test.ts +131 -0
package/tests/db/queries.test.ts +409 -0
package/tests/db/schema.test.ts +141 -0
package/tests/fixtures/.env.yaml +3 -0
package/tests/fixtures/auth-token-test.yaml +8 -0
package/tests/fixtures/bail/suite-a.yaml +6 -0
package/tests/fixtures/bail/suite-b.yaml +6 -0
package/tests/fixtures/crud.yaml +35 -0
package/tests/fixtures/invalid-missing-name.yaml +5 -0
package/tests/fixtures/invalid-no-method.yaml +6 -0
package/tests/fixtures/petstore-auth.json +295 -0
package/tests/fixtures/petstore-simple.json +151 -0
package/tests/fixtures/post-only.yaml +12 -0
package/tests/fixtures/simple.yaml +6 -0
package/tests/fixtures/valid/.env.yaml +1 -0
package/tests/fixtures/valid/a.yaml +5 -0
package/tests/fixtures/valid/b.yml +5 -0
package/tests/generator/coverage-scanner.test.ts +129 -0
package/tests/generator/data-factory.test.ts +133 -0
package/tests/generator/openapi-reader.test.ts +131 -0
package/tests/integration/auth-flow.test.ts +217 -0
package/tests/mcp/coverage-analysis.test.ts +64 -0
package/tests/mcp/explore-api-schemas.test.ts +105 -0
package/tests/mcp/explore-api.test.ts +49 -0
package/tests/mcp/generate-missing-tests.test.ts +69 -0
package/tests/mcp/manage-environment.test.ts +89 -0
package/tests/mcp/save-test-suite.test.ts +116 -0
package/tests/mcp/send-request.test.ts +79 -0
package/tests/mcp/setup-api.test.ts +106 -0
package/tests/mcp/tools.test.ts +248 -0
package/tests/parser/schema.test.ts +134 -0
package/tests/parser/variables.test.ts +227 -0
package/tests/parser/yaml-parser.test.ts +69 -0
package/tests/reporter/console.test.ts +256 -0
package/tests/reporter/json.test.ts +98 -0
package/tests/reporter/junit.test.ts +284 -0
package/tests/runner/assertions.test.ts +262 -0
package/tests/runner/executor.test.ts +310 -0
package/tests/runner/http-client.test.ts +138 -0
package/tests/web/routes.test.ts +160 -0
package/tsconfig.json +31 -0

package/tests/runner/http-client.test.ts ADDED Viewed

@@ -0,0 +1,138 @@
+import { describe, test, expect, mock, beforeEach, afterEach } from "bun:test";
+import { executeRequest } from "../../src/core/runner/http-client.ts";
+describe("executeRequest", () => {
+  const originalFetch = globalThis.fetch;
+  afterEach(() => {
+    globalThis.fetch = originalFetch;
+  });
+  test("sends GET request and returns structured response", async () => {
+    globalThis.fetch = mock(async () => {
+      return new Response(JSON.stringify({ id: 1, name: "John" }), {
+        status: 200,
+        headers: { "Content-Type": "application/json" },
+      });
+    }) as unknown as typeof fetch;
+    const response = await executeRequest({
+      method: "GET",
+      url: "http://example.com/users/1",
+      headers: {},
+    });
+    expect(response.status).toBe(200);
+    expect(response.body_parsed).toEqual({ id: 1, name: "John" });
+    expect(response.headers["content-type"]).toBe("application/json");
+    expect(response.duration_ms).toBeGreaterThanOrEqual(0);
+  });
+  test("sends POST with body", async () => {
+    let capturedInit: RequestInit | undefined;
+    globalThis.fetch = mock(async (_url: string | URL | Request, init?: RequestInit) => {
+      capturedInit = init;
+      return new Response("{}", { status: 201, headers: { "Content-Type": "application/json" } });
+    }) as unknown as typeof fetch;
+    await executeRequest({
+      method: "POST",
+      url: "http://example.com/users",
+      headers: { "Content-Type": "application/json" },
+      body: JSON.stringify({ name: "John" }),
+    });
+    expect(capturedInit!.method).toBe("POST");
+    expect(capturedInit!.body).toBe('{"name":"John"}');
+  });
+  test("parses JSON response when content-type is application/json", async () => {
+    globalThis.fetch = mock(async () => {
+      return new Response('{"key": "value"}', {
+        status: 200,
+        headers: { "Content-Type": "application/json; charset=utf-8" },
+      });
+    }) as unknown as typeof fetch;
+    const response = await executeRequest({ method: "GET", url: "http://example.com", headers: {} });
+    expect(response.body_parsed).toEqual({ key: "value" });
+  });
+  test("does not parse body when content-type is not JSON", async () => {
+    globalThis.fetch = mock(async () => {
+      return new Response("<html>Hello</html>", {
+        status: 200,
+        headers: { "Content-Type": "text/html" },
+      });
+    }) as unknown as typeof fetch;
+    const response = await executeRequest({ method: "GET", url: "http://example.com", headers: {} });
+    expect(response.body_parsed).toBeUndefined();
+    expect(response.body).toBe("<html>Hello</html>");
+  });
+  test("retries on network error and succeeds", async () => {
+    let callCount = 0;
+    globalThis.fetch = mock(async () => {
+      callCount++;
+      if (callCount === 1) throw new Error("Network error");
+      return new Response("{}", { status: 200, headers: { "Content-Type": "application/json" } });
+    }) as unknown as typeof fetch;
+    const response = await executeRequest(
+      { method: "GET", url: "http://example.com", headers: {} },
+      { retries: 1, retry_delay: 10 },
+    );
+    expect(response.status).toBe(200);
+    expect(callCount).toBe(2);
+  });
+  test("throws after all retries exhausted", async () => {
+    globalThis.fetch = mock(async () => {
+      throw new Error("Network error");
+    }) as unknown as typeof fetch;
+    await expect(
+      executeRequest(
+        { method: "GET", url: "http://example.com", headers: {} },
+        { retries: 1, retry_delay: 10 },
+      ),
+    ).rejects.toThrow("Network error");
+  });
+  test("does NOT retry on HTTP error status", async () => {
+    let callCount = 0;
+    globalThis.fetch = mock(async () => {
+      callCount++;
+      return new Response("Not Found", { status: 404, headers: {} });
+    }) as unknown as typeof fetch;
+    const response = await executeRequest(
+      { method: "GET", url: "http://example.com", headers: {} },
+      { retries: 2, retry_delay: 10 },
+    );
+    expect(response.status).toBe(404);
+    expect(callCount).toBe(1); // Only one call — no retry on HTTP errors
+  });
+  test("timeout aborts the request", async () => {
+    globalThis.fetch = mock(async (_url: string | URL | Request, init?: RequestInit) => {
+      // Simulate slow response
+      await new Promise((resolve, reject) => {
+        const timer = setTimeout(resolve, 5000);
+        init?.signal?.addEventListener("abort", () => {
+          clearTimeout(timer);
+          reject(new DOMException("The operation was aborted.", "AbortError"));
+        });
+      });
+      return new Response("{}", { status: 200, headers: {} });
+    }) as unknown as typeof fetch;
+    await expect(
+      executeRequest(
+        { method: "GET", url: "http://example.com", headers: {} },
+        { timeout: 50 },
+      ),
+    ).rejects.toThrow();
+  });
+});

package/tests/web/routes.test.ts ADDED Viewed

@@ -0,0 +1,160 @@
+import { describe, it, expect, beforeAll, afterAll } from "bun:test";
+import { createApp } from "../../src/web/server.ts";
+import { getDb, closeDb } from "../../src/db/schema.ts";
+import { createRun, finalizeRun, saveResults, createCollection } from "../../src/db/queries.ts";
+import type { TestRunResult } from "../../src/core/runner/types.ts";
+import { unlinkSync } from "fs";
+import { tmpdir } from "os";
+import { join } from "path";
+const TEST_DB = join(tmpdir(), `apitool-web-routes-${Date.now()}.db`);
+function seedData() {
+  // Create a collection first
+  const colId = createCollection({ name: "Test API", test_path: "./tests/pet" });
+  const results: TestRunResult[] = [
+    {
+      suite_name: "petstore",
+      started_at: "2025-01-01T00:00:00.000Z",
+      finished_at: "2025-01-01T00:00:01.500Z",
+      total: 3,
+      passed: 2,
+      failed: 1,
+      skipped: 0,
+      steps: [
+        {
+          name: "List pets",
+          status: "pass",
+          duration_ms: 120,
+          request: { method: "GET", url: "http://localhost/pets", headers: {} },
+          response: { status: 200, headers: {}, body: "[]", duration_ms: 120 },
+          assertions: [{ field: "status", rule: "equals 200", passed: true, actual: 200, expected: 200 }],
+          captures: {},
+        },
+        {
+          name: "Create pet",
+          status: "pass",
+          duration_ms: 200,
+          request: { method: "POST", url: "http://localhost/pets", headers: {}, body: '{"name":"Buddy"}' },
+          response: { status: 201, headers: {}, body: '{"id":1}', duration_ms: 200 },
+          assertions: [{ field: "status", rule: "equals 201", passed: true, actual: 201, expected: 201 }],
+          captures: { petId: 1 },
+        },
+        {
+          name: "Delete pet",
+          status: "fail",
+          duration_ms: 50,
+          request: { method: "DELETE", url: "http://localhost/pets/1", headers: {} },
+          response: { status: 500, headers: {}, body: "error", duration_ms: 50 },
+          assertions: [{ field: "status", rule: "equals 204", passed: false, actual: 500, expected: 204 }],
+          captures: {},
+        },
+      ],
+    },
+  ];
+  const runId = createRun({ started_at: "2025-01-01T00:00:00.000Z", environment: "test", collection_id: colId });
+  finalizeRun(runId, results);
+  saveResults(runId, results);
+  return { runId, colId };
+}
+describe("Web routes", () => {
+  let app: ReturnType<typeof createApp>;
+  let runId: number;
+  beforeAll(() => {
+    try { unlinkSync(TEST_DB); } catch {}
+    getDb(TEST_DB);
+    const seed = seedData();
+    runId = seed.runId;
+    app = createApp();
+  });
+  afterAll(() => {
+    closeDb();
+    try { unlinkSync(TEST_DB); } catch {}
+  });
+  it("GET / returns 200 with dashboard", async () => {
+    const res = await app.request("/");
+    expect(res.status).toBe(200);
+    const html = await res.text();
+    expect(html).toContain("apitool");
+    expect(html).toContain("Test API");
+  });
+  it("GET / auto-selects single collection", async () => {
+    const res = await app.request("/");
+    expect(res.status).toBe(200);
+    const html = await res.text();
+    // Should auto-select the only collection and show action bar
+    expect(html).toContain("Run Tests");
+  });
+  it("GET /runs/:id returns 200 for existing run", async () => {
+    const res = await app.request(`/runs/${runId}`);
+    expect(res.status).toBe(200);
+    const html = await res.text();
+    expect(html).toContain(`Run #${runId}`);
+    expect(html).toContain("petstore");
+    expect(html).toContain("List pets");
+    expect(html).toContain("Delete pet");
+  });
+  it("GET /runs/:id returns 404 for non-existent run", async () => {
+    const res = await app.request("/runs/99999");
+    expect(res.status).toBe(404);
+    const html = await res.text();
+    expect(html).toContain("Run not found");
+  });
+  it("GET /runs/:id returns 400 for invalid id", async () => {
+    const res = await app.request("/runs/abc");
+    expect(res.status).toBe(400);
+  });
+  it("GET /static/style.css returns 200 with CSS", async () => {
+    const res = await app.request("/static/style.css");
+    expect(res.status).toBe(200);
+    expect(res.headers.get("content-type")).toContain("text/css");
+    const css = await res.text();
+    expect(css).toContain(":root");
+  });
+  it("GET /static/nonexistent returns 404", async () => {
+    const res = await app.request("/static/nope.js");
+    expect(res.status).toBe(404);
+  });
+  it("HTMX requests return fragment without layout", async () => {
+    const res = await app.request("/", { headers: { "HX-Request": "true" } });
+    expect(res.status).toBe(200);
+    const html = await res.text();
+    // Should not have full HTML boilerplate
+    expect(html).not.toContain("<!DOCTYPE html>");
+  });
+  it("GET /panels/results returns results for collection", async () => {
+    const res = await app.request("/panels/results?collection_id=1");
+    expect(res.status).toBe(200);
+    const html = await res.text();
+    expect(html).toContain("Run #");
+  });
+  it("GET /panels/history returns run history", async () => {
+    const res = await app.request("/panels/history?collection_id=1");
+    expect(res.status).toBe(200);
+    const html = await res.text();
+    expect(html).toContain("Run History");
+  });
+  it("removed routes return 404", async () => {
+    const removed = ["/explorer", "/environments", "/collections/1"];
+    for (const path of removed) {
+      const res = await app.request(path);
+      expect(res.status).toBe(404);
+    }
+  });
+});

package/tsconfig.json ADDED Viewed

@@ -0,0 +1,31 @@
+{
+  "include": ["src/**/*.ts", "tests/**/*.ts"],
+  "exclude": ["node_modules"],
+  "compilerOptions": {
+    // Environment setup & latest features
+    "lib": ["ESNext"],
+    "target": "ESNext",
+    "module": "Preserve",
+    "moduleDetection": "force",
+    "jsx": "react-jsx",
+    "allowJs": true,
+    // Bundler mode
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "verbatimModuleSyntax": true,
+    "noEmit": true,
+    // Best practices
+    "strict": true,
+    "skipLibCheck": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUncheckedIndexedAccess": true,
+    "noImplicitOverride": true,
+    // Some stricter flags (disabled by default)
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
+    "noPropertyAccessFromIndexSignature": false
+  }
+}