spring-api-scanner 0.1.0

package/tests/ui.test.ts

@@ -0,0 +1,85 @@
+import { describe, expect, it } from "vitest";
+import { buildUiModel, renderUiHtml } from "../src/ui.js";
+import type { OpenApiDocument } from "../src/openapi.js";
+import type { ExtractedEndpoint } from "../src/scanner.js";
+
+describe("buildUiModel", () => {
+  it("builds endpoint cards with curl and schema sections", () => {
+    const endpoints: ExtractedEndpoint[] = [
+      {
+        sourceFile: "UserController.kt",
+        operationName: "getUser",
+        httpMethod: "GET",
+        fullPath: "/users/{id}",
+        returnType: "UserDto",
+        pathVariables: [{ name: "id", type: "Long", required: true }],
+        queryParams: [{ name: "verbose", type: "Boolean?", required: false }],
+        headers: [{ name: "X-Trace-Id", type: "String", required: true }]
+      }
+    ];
+
+    const openapi: OpenApiDocument = {
+      openapi: "3.0.3",
+      info: { title: "Demo", version: "1.0.0" },
+      paths: {
+        "/users/{id}": {
+          get: {
+            operationId: "getUser",
+            tags: ["UserController"],
+            parameters: [],
+            responses: {
+              "200": {
+                description: "OK",
+                content: {
+                  "application/json": {
+                    schema: { $ref: "#/components/schemas/UserDto" }
+                  }
+                }
+              }
+            }
+          }
+        }
+      },
+      components: {
+        schemas: {
+          UserDto: {
+            type: "object",
+            properties: { id: { type: "integer", format: "int64" } },
+            required: ["id"]
+          }
+        }
+      }
+    };
+
+    const model = buildUiModel({ endpoints, openapi });
+
+    expect(model.endpoints).toHaveLength(1);
+    expect(model.endpoints[0].controller).toBe("UserController");
+    expect(model.endpoints[0].curl).toContain("curl -X GET");
+    expect(model.endpoints[0].responseSchema).toEqual(openapi.components.schemas.UserDto);
+  });
+});
+
+describe("renderUiHtml", () => {
+  it("renders search/filter/copy/download UI affordances", () => {
+    const html = renderUiHtml("Demo Docs");
+
+    expect(html).toContain("id=\"search\"");
+    expect(html).toContain("id=\"method-filter\"");
+    expect(html).toContain("id=\"controller-filter\"");
+    expect(html).toContain("Copy curl");
+    expect(html).toContain("Download OpenAPI JSON");
+    expect(html).toContain("navigator.clipboard.writeText");
+  });
+
+  it("supports embedded ui-data for file:// usage with fetch fallback", () => {
+    const html = renderUiHtml("Demo Docs", {
+      generatedAt: "2026-01-01T00:00:00.000Z",
+      endpoints: []
+    });
+
+    expect(html).toContain("id=\"embedded-ui-data\"");
+    expect(html).toContain("JSON.parse(embedded.textContent)");
+    expect(html).toContain("fetch('ui-data.json')");
+  });
+});

package/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "strict": true,
+    "declaration": true,
+    "outDir": "dist",
+    "rootDir": "src",
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "skipLibCheck": true
+  },
+  "include": ["src/**/*.ts"]
+}