@zuplo/cli 7.11.0 → 7.11.1

package/dist/open-api/merge/handler.spec.js

@@ -1,673 +0,0 @@
-import assert from "node:assert";
-import fs from "node:fs/promises";
-import path from "node:path";
-import { afterEach, beforeEach, describe, it } from "node:test";
-import { fileURLToPath } from "node:url";
-import { importOpenApi } from "./handler.js";
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-const testTmpPath = path.join(__dirname, "..", "..", "__tests__", "test-tmp", "merge-handler");
-describe("Merge Handler", () => {
-    beforeEach(async () => {
-        await fs.mkdir(testTmpPath, { recursive: true });
-    });
-    afterEach(async () => {
-        try {
-            await fs.rm(testTmpPath, { recursive: true, force: true });
-        }
-        catch {
-        }
-    });
-    describe("importOpenApi", () => {
-        it("should merge source into new destination file", async () => {
-            const sourcePath = path.join(testTmpPath, "source.oas.json");
-            const destPath = path.join(testTmpPath, "dest.oas.json");
-            const sourceDoc = {
-                openapi: "3.1.0",
-                info: {
-                    title: "Source API",
-                    version: "1.0.0",
-                },
-                paths: {
-                    "/users": {
-                        get: {
-                            summary: "Get users",
-                            operationId: "getUsers",
-                            responses: {
-                                "200": {
-                                    description: "Success",
-                                },
-                            },
-                        },
-                    },
-                },
-            };
-            await fs.writeFile(sourcePath, JSON.stringify(sourceDoc, null, 2));
-            await importOpenApi({
-                source: sourcePath,
-                destination: destPath,
-                prompt: false,
-            });
-            const result = JSON.parse(await fs.readFile(destPath, "utf-8"));
-            assert.strictEqual(result.openapi, "3.1.0");
-            assert.strictEqual(result.paths["/users"].get.summary, "Get users");
-            assert.strictEqual(result.paths["/users"].get.operationId, "getUsers");
-        });
-        it("should merge source into existing destination file", async () => {
-            const sourcePath = path.join(testTmpPath, "source.oas.json");
-            const destPath = path.join(testTmpPath, "dest.oas.json");
-            const existingDoc = {
-                openapi: "3.1.0",
-                info: {
-                    title: "Existing API",
-                    version: "1.0.0",
-                },
-                paths: {
-                    "/products": {
-                        get: {
-                            summary: "Get products",
-                            operationId: "getProducts",
-                            responses: {
-                                "200": {
-                                    description: "Success",
-                                },
-                            },
-                        },
-                    },
-                },
-            };
-            const sourceDoc = {
-                openapi: "3.1.0",
-                info: {
-                    title: "Source API",
-                    version: "1.0.0",
-                },
-                paths: {
-                    "/users": {
-                        get: {
-                            summary: "Get users",
-                            operationId: "getUsers",
-                            responses: {
-                                "200": {
-                                    description: "Success",
-                                },
-                            },
-                        },
-                    },
-                },
-            };
-            await fs.writeFile(destPath, JSON.stringify(existingDoc, null, 2));
-            await fs.writeFile(sourcePath, JSON.stringify(sourceDoc, null, 2));
-            await importOpenApi({
-                source: sourcePath,
-                destination: destPath,
-                prompt: false,
-            });
-            const result = JSON.parse(await fs.readFile(destPath, "utf-8"));
-            assert.strictEqual(result.paths["/products"].get.summary, "Get products");
-            assert.strictEqual(result.paths["/users"].get.summary, "Get users");
-        });
-        it("should support YAML source files", async () => {
-            const sourcePath = path.join(testTmpPath, "source.oas.yaml");
-            const destPath = path.join(testTmpPath, "dest.oas.json");
-            const sourceDoc = `openapi: 3.1.0
-info:
-  title: Source API
-  version: 1.0.0
-paths:
-  /users:
-    get:
-      summary: Get users
-      operationId: getUsers
-      responses:
-        '200':
-          description: Success`;
-            await fs.writeFile(sourcePath, sourceDoc);
-            await importOpenApi({
-                source: sourcePath,
-                destination: destPath,
-                prompt: false,
-            });
-            const result = JSON.parse(await fs.readFile(destPath, "utf-8"));
-            assert.strictEqual(result.paths["/users"].get.summary, "Get users");
-        });
-        it("should use path-method merge mode by default", async () => {
-            const sourcePath = path.join(testTmpPath, "source.oas.json");
-            const destPath = path.join(testTmpPath, "dest.oas.json");
-            const existingDoc = {
-                openapi: "3.1.0",
-                info: {
-                    title: "Existing API",
-                    version: "1.0.0",
-                },
-                paths: {
-                    "/users": {
-                        get: {
-                            summary: "Original summary",
-                            operationId: "getUsers",
-                            responses: {
-                                "200": {
-                                    description: "Success",
-                                },
-                            },
-                        },
-                    },
-                },
-            };
-            const sourceDoc = {
-                openapi: "3.1.0",
-                info: {
-                    title: "Source API",
-                    version: "1.0.0",
-                },
-                paths: {
-                    "/users": {
-                        get: {
-                            summary: "Updated summary",
-                            operationId: "getUsersUpdated",
-                            responses: {
-                                "200": {
-                                    description: "Updated Success",
-                                },
-                            },
-                        },
-                    },
-                },
-            };
-            await fs.writeFile(destPath, JSON.stringify(existingDoc, null, 2));
-            await fs.writeFile(sourcePath, JSON.stringify(sourceDoc, null, 2));
-            await importOpenApi({
-                source: sourcePath,
-                destination: destPath,
-                prompt: false,
-            });
-            const result = JSON.parse(await fs.readFile(destPath, "utf-8"));
-            assert.strictEqual(result.paths["/users"].get.summary, "Updated summary");
-        });
-        it("should support operation-id merge mode", async () => {
-            const sourcePath = path.join(testTmpPath, "source.oas.json");
-            const destPath = path.join(testTmpPath, "dest.oas.json");
-            const existingDoc = {
-                openapi: "3.1.0",
-                info: {
-                    title: "Existing API",
-                    version: "1.0.0",
-                },
-                paths: {
-                    "/users": {
-                        get: {
-                            summary: "Original summary",
-                            operationId: "getUsers",
-                            responses: {
-                                "200": {
-                                    description: "Success",
-                                },
-                            },
-                        },
-                    },
-                },
-            };
-            const sourceDoc = {
-                openapi: "3.1.0",
-                info: {
-                    title: "Source API",
-                    version: "1.0.0",
-                },
-                paths: {
-                    "/v2/users": {
-                        get: {
-                            summary: "Updated summary",
-                            operationId: "getUsers",
-                            responses: {
-                                "200": {
-                                    description: "Updated Success",
-                                },
-                            },
-                        },
-                    },
-                },
-            };
-            await fs.writeFile(destPath, JSON.stringify(existingDoc, null, 2));
-            await fs.writeFile(sourcePath, JSON.stringify(sourceDoc, null, 2));
-            await importOpenApi({
-                source: sourcePath,
-                destination: destPath,
-                prompt: false,
-                "merge-mode": "operation-id",
-            });
-            const result = JSON.parse(await fs.readFile(destPath, "utf-8"));
-            assert.strictEqual(result.paths["/users"], undefined);
-            assert.strictEqual(result.paths["/v2/users"].get.summary, "Updated summary");
-        });
-        it("should create output directory if it doesn't exist", async () => {
-            const sourcePath = path.join(testTmpPath, "source.oas.json");
-            const destPath = path.join(testTmpPath, "nested", "dir", "dest.oas.json");
-            const sourceDoc = {
-                openapi: "3.1.0",
-                info: {
-                    title: "Source API",
-                    version: "1.0.0",
-                },
-                paths: {
-                    "/users": {
-                        get: {
-                            summary: "Get users",
-                            operationId: "getUsers",
-                            responses: {
-                                "200": {
-                                    description: "Success",
-                                },
-                            },
-                        },
-                    },
-                },
-            };
-            await fs.writeFile(sourcePath, JSON.stringify(sourceDoc, null, 2));
-            await importOpenApi({
-                source: sourcePath,
-                destination: destPath,
-                prompt: false,
-            });
-            const result = JSON.parse(await fs.readFile(destPath, "utf-8"));
-            assert.strictEqual(result.paths["/users"].get.summary, "Get users");
-        });
-        it("should add operation IDs if missing", async () => {
-            const sourcePath = path.join(testTmpPath, "source.oas.json");
-            const destPath = path.join(testTmpPath, "dest.oas.json");
-            const sourceDoc = {
-                openapi: "3.1.0",
-                info: {
-                    title: "Source API",
-                    version: "1.0.0",
-                },
-                paths: {
-                    "/users": {
-                        get: {
-                            summary: "Get users",
-                            responses: {
-                                "200": {
-                                    description: "Success",
-                                },
-                            },
-                        },
-                    },
-                },
-            };
-            await fs.writeFile(sourcePath, JSON.stringify(sourceDoc, null, 2));
-            await importOpenApi({
-                source: sourcePath,
-                destination: destPath,
-                prompt: false,
-            });
-            const result = JSON.parse(await fs.readFile(destPath, "utf-8"));
-            assert.strictEqual(typeof result.paths["/users"].get.operationId, "string");
-            assert.strictEqual(result.paths["/users"].get.operationId.length > 0, true);
-        });
-        it("should throw error when source file does not exist", async () => {
-            const sourcePath = path.join(testTmpPath, "nonexistent.oas.json");
-            const destPath = path.join(testTmpPath, "dest.oas.json");
-            await assert.rejects(() => importOpenApi({
-                source: sourcePath,
-                destination: destPath,
-                prompt: false,
-            }), /does not exist/);
-        });
-        it("should throw error when destination doesn't end with .oas.json", async () => {
-            const sourcePath = path.join(testTmpPath, "source.oas.json");
-            const destPath = path.join(testTmpPath, "dest.json");
-            const sourceDoc = {
-                openapi: "3.1.0",
-                info: {
-                    title: "Source API",
-                    version: "1.0.0",
-                },
-                paths: {},
-            };
-            await fs.writeFile(sourcePath, JSON.stringify(sourceDoc, null, 2));
-            await assert.rejects(() => importOpenApi({
-                source: sourcePath,
-                destination: destPath,
-                prompt: false,
-            }), /must end with '.oas.json'/);
-        });
-    });
-    describe("server-paths flag", () => {
-        it("should apply server-paths transformation by default", async () => {
-            const sourcePath = path.join(testTmpPath, "source.oas.json");
-            const destPath = path.join(testTmpPath, "dest.oas.json");
-            const sourceDoc = {
-                openapi: "3.1.0",
-                info: {
-                    title: "Source API",
-                    version: "1.0.0",
-                },
-                servers: [
-                    {
-                        url: "https://api.example.com/v2",
-                        description: "Production server",
-                    },
-                ],
-                paths: {
-                    "/products": {
-                        get: {
-                            summary: "Get products",
-                            operationId: "getProducts",
-                            responses: {
-                                "200": {
-                                    description: "Success",
-                                },
-                            },
-                        },
-                    },
-                },
-            };
-            await fs.writeFile(sourcePath, JSON.stringify(sourceDoc, null, 2));
-            await importOpenApi({
-                source: sourcePath,
-                destination: destPath,
-                prompt: false,
-            });
-            const result = JSON.parse(await fs.readFile(destPath, "utf-8"));
-            assert.strictEqual(result.paths["/v2/products"].get.summary, "Get products");
-            assert.strictEqual(result.paths["/products"], undefined);
-        });
-        it("should apply server-paths transformation when explicitly enabled", async () => {
-            const sourcePath = path.join(testTmpPath, "source.oas.json");
-            const destPath = path.join(testTmpPath, "dest.oas.json");
-            const sourceDoc = {
-                openapi: "3.1.0",
-                info: {
-                    title: "Source API",
-                    version: "1.0.0",
-                },
-                servers: [
-                    {
-                        url: "https://api.example.com/v1",
-                        description: "Production server",
-                    },
-                ],
-                paths: {
-                    "/accounts": {
-                        get: {
-                            summary: "Get accounts",
-                            operationId: "getAccounts",
-                            responses: {
-                                "200": {
-                                    description: "Success",
-                                },
-                            },
-                        },
-                    },
-                },
-            };
-            await fs.writeFile(sourcePath, JSON.stringify(sourceDoc, null, 2));
-            await importOpenApi({
-                source: sourcePath,
-                destination: destPath,
-                prompt: false,
-                "server-paths": true,
-            });
-            const result = JSON.parse(await fs.readFile(destPath, "utf-8"));
-            assert.strictEqual(result.paths["/v1/accounts"].get.summary, "Get accounts");
-            assert.strictEqual(result.paths["/accounts"], undefined);
-        });
-        it("should not transform paths when server-paths is disabled", async () => {
-            const sourcePath = path.join(testTmpPath, "source.oas.json");
-            const destPath = path.join(testTmpPath, "dest.oas.json");
-            const sourceDoc = {
-                openapi: "3.1.0",
-                info: {
-                    title: "Source API",
-                    version: "1.0.0",
-                },
-                servers: [
-                    {
-                        url: "https://api.example.com/v1",
-                        description: "Production server",
-                    },
-                ],
-                paths: {
-                    "/accounts": {
-                        get: {
-                            summary: "Get accounts",
-                            operationId: "getAccounts",
-                            responses: {
-                                "200": {
-                                    description: "Success",
-                                },
-                            },
-                        },
-                    },
-                },
-            };
-            await fs.writeFile(sourcePath, JSON.stringify(sourceDoc, null, 2));
-            await importOpenApi({
-                source: sourcePath,
-                destination: destPath,
-                prompt: false,
-                "server-paths": false,
-            });
-            const result = JSON.parse(await fs.readFile(destPath, "utf-8"));
-            assert.strictEqual(result.paths["/accounts"].get.summary, "Get accounts");
-            assert.strictEqual(result.paths["/v1/accounts"], undefined);
-        });
-        it("should handle servers with no pathname gracefully", async () => {
-            const sourcePath = path.join(testTmpPath, "source.oas.json");
-            const destPath = path.join(testTmpPath, "dest.oas.json");
-            const sourceDoc = {
-                openapi: "3.1.0",
-                info: {
-                    title: "Source API",
-                    version: "1.0.0",
-                },
-                servers: [
-                    {
-                        url: "https://api.example.com",
-                        description: "Production server",
-                    },
-                ],
-                paths: {
-                    "/accounts": {
-                        get: {
-                            summary: "Get accounts",
-                            operationId: "getAccounts",
-                            responses: {
-                                "200": {
-                                    description: "Success",
-                                },
-                            },
-                        },
-                    },
-                },
-            };
-            await fs.writeFile(sourcePath, JSON.stringify(sourceDoc, null, 2));
-            await importOpenApi({
-                source: sourcePath,
-                destination: destPath,
-                prompt: false,
-                "server-paths": true,
-            });
-            const result = JSON.parse(await fs.readFile(destPath, "utf-8"));
-            assert.strictEqual(result.paths["/accounts"].get.summary, "Get accounts");
-        });
-        it("should handle missing servers gracefully", async () => {
-            const sourcePath = path.join(testTmpPath, "source.oas.json");
-            const destPath = path.join(testTmpPath, "dest.oas.json");
-            const sourceDoc = {
-                openapi: "3.1.0",
-                info: {
-                    title: "Source API",
-                    version: "1.0.0",
-                },
-                paths: {
-                    "/accounts": {
-                        get: {
-                            summary: "Get accounts",
-                            operationId: "getAccounts",
-                            responses: {
-                                "200": {
-                                    description: "Success",
-                                },
-                            },
-                        },
-                    },
-                },
-            };
-            await fs.writeFile(sourcePath, JSON.stringify(sourceDoc, null, 2));
-            await importOpenApi({
-                source: sourcePath,
-                destination: destPath,
-                prompt: false,
-                "server-paths": true,
-            });
-            const result = JSON.parse(await fs.readFile(destPath, "utf-8"));
-            assert.strictEqual(result.paths["/accounts"].get.summary, "Get accounts");
-        });
-    });
-    describe("prepend-path flag", () => {
-        it("should apply prepend-path transformation", async () => {
-            const sourcePath = path.join(testTmpPath, "source.oas.json");
-            const destPath = path.join(testTmpPath, "dest.oas.json");
-            const sourceDoc = {
-                openapi: "3.1.0",
-                info: {
-                    title: "Source API",
-                    version: "1.0.0",
-                },
-                paths: {
-                    "/accounts": {
-                        get: {
-                            summary: "Get accounts",
-                            operationId: "getAccounts",
-                            responses: {
-                                "200": {
-                                    description: "Success",
-                                },
-                            },
-                        },
-                    },
-                    "/users": {
-                        get: {
-                            summary: "Get users",
-                            operationId: "getUsers",
-                            responses: {
-                                "200": {
-                                    description: "Success",
-                                },
-                            },
-                        },
-                    },
-                },
-            };
-            await fs.writeFile(sourcePath, JSON.stringify(sourceDoc, null, 2));
-            await importOpenApi({
-                source: sourcePath,
-                destination: destPath,
-                prompt: false,
-                "prepend-path": "/api/v2",
-            });
-            const result = JSON.parse(await fs.readFile(destPath, "utf-8"));
-            assert.strictEqual(result.paths["/api/v2/accounts"].get.summary, "Get accounts");
-            assert.strictEqual(result.paths["/api/v2/users"].get.summary, "Get users");
-            assert.strictEqual(result.paths["/accounts"], undefined);
-            assert.strictEqual(result.paths["/users"], undefined);
-        });
-        it("should handle prepend-path with various formats", async () => {
-            const sourcePath = path.join(testTmpPath, "source.oas.json");
-            const destPath = path.join(testTmpPath, "dest.oas.json");
-            const sourceDoc = {
-                openapi: "3.1.0",
-                info: {
-                    title: "Source API",
-                    version: "1.0.0",
-                },
-                paths: {
-                    "/test": {
-                        get: {
-                            summary: "Test endpoint",
-                            operationId: "test",
-                            responses: {
-                                "200": {
-                                    description: "Success",
-                                },
-                            },
-                        },
-                    },
-                },
-            };
-            await fs.writeFile(sourcePath, JSON.stringify(sourceDoc, null, 2));
-            await importOpenApi({
-                source: sourcePath,
-                destination: destPath,
-                prompt: false,
-                "prepend-path": "/v1/",
-            });
-            const result = JSON.parse(await fs.readFile(destPath, "utf-8"));
-            assert.strictEqual(result.paths["/v1/test"].get.summary, "Test endpoint");
-        });
-        it("should prioritize prepend-path over server-paths", async () => {
-            const sourcePath = path.join(testTmpPath, "source.oas.json");
-            const destPath = path.join(testTmpPath, "dest.oas.json");
-            const sourceDoc = {
-                openapi: "3.1.0",
-                info: {
-                    title: "Source API",
-                    version: "1.0.0",
-                },
-                servers: [
-                    {
-                        url: "https://api.example.com/v1",
-                        description: "Has a pathname that should be ignored",
-                    },
-                ],
-                paths: {
-                    "/orders": {
-                        get: {
-                            summary: "Get orders",
-                            operationId: "getOrders",
-                            responses: {
-                                "200": {
-                                    description: "Success",
-                                },
-                            },
-                        },
-                    },
-                },
-            };
-            await fs.writeFile(sourcePath, JSON.stringify(sourceDoc, null, 2));
-            await importOpenApi({
-                source: sourcePath,
-                destination: destPath,
-                prompt: false,
-                "server-paths": true,
-                "prepend-path": "/custom/path",
-            });
-            const result = JSON.parse(await fs.readFile(destPath, "utf-8"));
-            assert.strictEqual(result.paths["/custom/path/orders"].get.summary, "Get orders");
-            assert.strictEqual(result.paths["/v1/orders"], undefined);
-            assert.strictEqual(result.paths["/orders"], undefined);
-        });
-    });
-    describe("watch flag", () => {
-        it("should reject watch mode with URL sources", async () => {
-            const destPath = path.join(testTmpPath, "dest.oas.json");
-            await assert.rejects(() => importOpenApi({
-                source: "https://example.com/api.json",
-                destination: destPath,
-                prompt: false,
-                watch: true,
-            }), /Watch mode is not supported for URL sources/);
-        });
-        it("should reject watch mode with non-existent files", async () => {
-            const sourcePath = path.join(testTmpPath, "nonexistent.oas.json");
-            const destPath = path.join(testTmpPath, "dest.oas.json");
-            await assert.rejects(() => importOpenApi({
-                source: sourcePath,
-                destination: destPath,
-                prompt: false,
-                watch: true,
-            }), /does not exist/);
-        });
-    });
-});
-//# sourceMappingURL=handler.spec.js.map