@zuplo/openapi-tools 6.65.9 → 6.66.2

package/dist/merge.spec.js

@@ -0,0 +1,399 @@
+import assert from "node:assert";
+import fs from "node:fs/promises";
+import path from "node:path";
+import { describe, it } from "node:test";
+import { fileURLToPath } from "node:url";
+import { ZUPLO_OPEN_API_ROUTE_KEY, } from "./interfaces.js";
+import { mergeOpenApiDocumentOnOperationId, mergeOpenApiDocuments, } from "./merge.js";
+import { addOperationIdsAsNecessary, getOperationKey, } from "./operation-utils.js";
+import { parseOpenApiFileFromString } from "./parsing.js";
+import { BASE_TEMPLATE } from "./url-utils.js";
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+// Test fixtures are in the package root
+// When running from dist/, __dirname is packages/openapi-tools/dist
+// so we go up one level to get to packages/openapi-tools, then into test-fixtures
+const testFixturesPath = path.join(__dirname, "..", "test-fixtures");
+describe("OpenAPI Merge Utils", () => {
+    it("should generate merge changes between two different oas files", async () => {
+        const toImportPath = path.join(testFixturesPath, "toimport.oas.json");
+        const toImportContent = await fs.readFile(toImportPath, "utf-8");
+        const toImportOpenApiSpec = parseOpenApiFileFromString(".json", toImportContent);
+        const baseRoutesPath = path.join(testFixturesPath, "base-routes-on-import-tests.oas.json");
+        const baseRoutesContent = await fs.readFile(baseRoutesPath, "utf-8");
+        const originalDocument = parseOpenApiFileFromString(".json", baseRoutesContent);
+        const { created, merged, retained } = mergeOpenApiDocuments(originalDocument, toImportOpenApiSpec, "path-method");
+        const expectedMergedResult = new Set().add("post>/v2/second/{userUid}/nature");
+        const expectedRetainedResult = new Set().add("post>/v1/second/{userUid}/nature");
+        assert.deepStrictEqual(created, new Set());
+        assert.deepStrictEqual(merged, expectedMergedResult);
+        assert.deepStrictEqual(retained, expectedRetainedResult);
+    });
+    it("should generate merge changes between a oas file and the default base template", async () => {
+        const toImportPath = path.join(testFixturesPath, "toimport.oas.json");
+        const toImportContent = await fs.readFile(toImportPath, "utf-8");
+        const toImportOpenApiSpec = parseOpenApiFileFromString(".json", toImportContent);
+        const originalDocument = parseOpenApiFileFromString(".json", BASE_TEMPLATE);
+        const { created, merged, retained } = mergeOpenApiDocuments(originalDocument, toImportOpenApiSpec, "path-method");
+        assert.deepStrictEqual(created, new Set().add("post>/v2/second/{userUid}/nature"));
+        assert.deepStrictEqual(merged, new Set());
+        assert.deepStrictEqual(retained, new Set());
+    });
+    it("should generate missing operation ids", async () => {
+        const woOperationIdsPath = path.join(testFixturesPath, "base-routes-wo-operation-ids.oas.json");
+        const woOperationIdsContent = await fs.readFile(woOperationIdsPath, "utf-8");
+        const oasDocument = parseOpenApiFileFromString(".json", woOperationIdsContent);
+        addOperationIdsAsNecessary(oasDocument);
+        assert.ok(oasDocument.paths);
+        assert.ok(oasDocument.paths["/v2/second/{userUid}/nature"]?.post?.operationId);
+    });
+    it("should not change existing operation ids", async () => {
+        const baseRoutesPath = path.join(testFixturesPath, "base-routes-on-import-tests.oas.json");
+        const baseRoutesContent = await fs.readFile(baseRoutesPath, "utf-8");
+        const oasDocument = parseOpenApiFileFromString(".json", baseRoutesContent);
+        addOperationIdsAsNecessary(oasDocument);
+        assert.ok(oasDocument.paths);
+        const paths = oasDocument.paths;
+        assert.strictEqual(paths["/v1/second/{userUid}/nature"]?.post?.operationId, "12345");
+        assert.strictEqual(paths["/v2/second/{userUid}/nature"]?.post?.operationId, "67920");
+    });
+    it("should successfully parse a yaml open api file", async () => {
+        const toImportPath = path.join(testFixturesPath, "toimportv2.yaml");
+        const toImportContent = await fs.readFile(toImportPath, "utf-8");
+        const toImportOpenApiSpec = parseOpenApiFileFromString(".yaml", toImportContent);
+        assert.ok(toImportOpenApiSpec);
+        assert.deepStrictEqual(toImportOpenApiSpec.info, {
+            title: "Protect API",
+            description: "Buy & sell",
+            version: "0.2.0",
+            contact: {
+                name: "Zuplo YAML Test",
+                url: "https://zuplo.com/",
+                email: "test@example.com",
+            },
+        });
+        assert.deepStrictEqual(toImportOpenApiSpec.servers, [
+            {
+                url: "https://api.zuplo.com",
+                description: "Production",
+            },
+        ]);
+        assert.deepStrictEqual(toImportOpenApiSpec.tags, [
+            { name: "Order" },
+            { name: "Organization" },
+            { name: "Site" },
+            { name: "Supervisor" },
+        ]);
+        assert.ok(toImportOpenApiSpec.paths);
+        const paths = toImportOpenApiSpec.paths;
+        assert.ok(paths["/v1/orders"]);
+        assert.ok(paths["/v1/orders/wa/{waaaa}"]);
+        assert.ok(paths["/v1/orders/{order}"]);
+        assert.ok(paths["/v1/orgs/{organization}"]);
+        assert.deepStrictEqual(paths["/v1/sites"], {
+            get: {
+                operationId: "get-sites",
+                summary: "Get Sites",
+                description: "Sites are locations",
+                tags: ["Site"],
+                responses: {
+                    "200": {
+                        description: "OK",
+                        content: {
+                            "application/json": {
+                                schema: {
+                                    type: "array",
+                                    items: {
+                                        $ref: "#/components/schemas/Site",
+                                    },
+                                },
+                            },
+                        },
+                        headers: {
+                            "Cache-Control": {
+                                required: true,
+                                schema: {
+                                    type: "string",
+                                },
+                                description: "Responses are cacheable following standard HTTP headers.",
+                            },
+                        },
+                    },
+                },
+            },
+        });
+        assert.ok(toImportOpenApiSpec.components);
+    });
+});
+// Test fixtures for OperationID merge tests
+const emptyOpenApi = {
+    openapi: "3.0.0",
+    info: {
+        title: "Test",
+        version: "1.0.0",
+    },
+    paths: {},
+};
+const basicOpenApi = {
+    openapi: "3.0.0",
+    info: {
+        title: "Test",
+        version: "1.0.0",
+    },
+    paths: {
+        "/test": {
+            get: {
+                operationId: "getTest",
+            },
+        },
+    },
+};
+const openApiWithOperationIdsMissing = {
+    openapi: "3.0.0",
+    info: {
+        title: "Test",
+        version: "1.0.0",
+    },
+    components: {},
+    paths: {
+        "/test": {
+            get: {
+                responses: {
+                    "200": {
+                        description: "OK",
+                    },
+                },
+            },
+        },
+    },
+};
+const openApiWithMatchingPathMethodButDifferentOperationId = {
+    openapi: "3.0.0",
+    info: {
+        title: "Test",
+        version: "1.0.0",
+    },
+    paths: {
+        "/test": {
+            get: {
+                operationId: "get_test",
+            },
+        },
+    },
+};
+const openApiWithSomePathsAndMethods = {
+    openapi: "3.0.0",
+    info: {
+        title: "Test",
+        version: "1.0.0",
+    },
+    paths: {
+        "/test": {
+            get: {
+                operationId: "getTest",
+                deprecated: true,
+                "x-zuplo-route": {
+                    corsPolicy: "none",
+                    handler: {
+                        export: "urlForwardHandler",
+                        module: "$import(@zuplo/runtime)",
+                        options: {
+                            baseUrl: "https://echo.zuplo.io",
+                        },
+                    },
+                },
+            },
+            delete: {
+                operationId: "deleteTest",
+                "x-zuplo-route": {
+                    corsPolicy: "none",
+                    handler: {
+                        export: "urlForwardHandler",
+                        module: "$import(@zuplo/runtime)",
+                        options: {
+                            baseUrl: "https://echo.zuplo.io",
+                        },
+                    },
+                },
+            },
+            post: {
+                operationId: "postTest",
+                "x-zuplo-route": {
+                    corsPolicy: "none",
+                    handler: {
+                        export: "urlForwardHandler",
+                        module: "$import(@zuplo/runtime)",
+                        options: {
+                            baseUrl: "https://echo.zuplo.io",
+                        },
+                    },
+                },
+            },
+        },
+        "/humans": {
+            delete: {
+                operationId: "deleteHuman",
+                "x-zuplo-route": {
+                    corsPolicy: "none",
+                    handler: {
+                        export: "urlForwardHandler",
+                        module: "$import(@zuplo/runtime)",
+                        options: {
+                            baseUrl: "https://echo.zuplo.io",
+                        },
+                    },
+                },
+            },
+        },
+        "/humans/{id}": {
+            parameters: [
+                {
+                    name: "id",
+                    in: "path",
+                    required: true,
+                    schema: {
+                        type: "string",
+                    },
+                },
+            ],
+            get: {
+                operationId: "getHuman",
+                "x-zuplo-route": {
+                    corsPolicy: "none",
+                    handler: {
+                        export: "urlForwardHandler",
+                        module: "$import(@zuplo/runtime)",
+                        options: {
+                            baseUrl: "https://echo.zuplo.io",
+                        },
+                    },
+                },
+            },
+        },
+    },
+};
+const newOpenApiWithSomePathsAndMethods = {
+    openapi: "3.0.0",
+    info: {
+        title: "Test",
+        version: "1.0.0",
+    },
+    paths: {
+        "/test": {
+            get: {
+                operationId: "getTest",
+                deprecated: false, // Changed deprecated to false
+            },
+            post: {
+                operationId: "postTest",
+                summary: "Create a new test", // Added summary
+                // route definition is missing
+            },
+        },
+        "/humans": {
+            post: {
+                operationId: "createHuman",
+            },
+            delete: {
+                operationId: "deleteHuman",
+            },
+        },
+        "/humans/{humanId}": {
+            // Changed path parameter name
+            parameters: [
+                {
+                    name: "humanId",
+                    in: "path",
+                    required: true,
+                    schema: {
+                        type: "string",
+                    },
+                },
+            ],
+            get: {
+                operationId: "getHuman",
+            },
+        },
+    },
+};
+describe("OpenAPI OperationID Merge Tests", () => {
+    it("Doesn't change the original document when merging two empty OpenAPI files", () => {
+        const { mergedDocument, created, merged, retained } = mergeOpenApiDocumentOnOperationId(emptyOpenApi, emptyOpenApi);
+        assert.strictEqual(created.size, 0, "No operations should be created");
+        assert.strictEqual(merged.size, 0, "No operations should be merged");
+        assert.strictEqual(retained.size, 0, "No operations should be retained");
+        assert.deepStrictEqual(mergedDocument, emptyOpenApi, "The original document should not be changed");
+    });
+    it("Retains existing operations when merging in an empty OpenAPI file", () => {
+        const { mergedDocument, created, merged, retained } = mergeOpenApiDocumentOnOperationId(basicOpenApi, emptyOpenApi);
+        assert.strictEqual(created.size, 0, "No operations should be created");
+        assert.strictEqual(merged.size, 0, "No operations should be merged");
+        assert.deepStrictEqual(retained, new Set(["getTest"]), "The existing operation should be retained");
+        assert.deepStrictEqual(mergedDocument, basicOpenApi, "The original document should not be changed");
+    });
+    it("Creates new operations when merging into an empty OpenAPI file", () => {
+        const { mergedDocument, created, merged, retained } = mergeOpenApiDocumentOnOperationId(emptyOpenApi, basicOpenApi);
+        assert.strictEqual(merged.size, 0, "No operations should be merged");
+        assert.strictEqual(retained.size, 0, "No operations should be retained");
+        assert.deepStrictEqual(created, new Set(["getTest"]), "The new operation should be created");
+        assert.deepStrictEqual(mergedDocument, basicOpenApi, "The merged document should match the new document");
+    });
+    it("Throws when operations are missing operationId", () => {
+        assert.throws(() => {
+            mergeOpenApiDocumentOnOperationId(basicOpenApi, openApiWithOperationIdsMissing);
+        }, {
+            message: `OperationId is required for all operations. OperationId missing on ${getOperationKey("get", "/test")}. Please add an operationId to all operations before merging.`,
+        });
+    });
+    it("Throws when operation already exists at path+method and operationIds do not match", () => {
+        assert.throws(() => {
+            mergeOpenApiDocumentOnOperationId(basicOpenApi, openApiWithMatchingPathMethodButDifferentOperationId);
+        }, {
+            message: `Operation 'get_test' has a matching path/method to an existing operation at ${getOperationKey("get", "/test")}, but a different operationId. Either update the operationId on the existing operation or remove it entirely.`,
+        });
+    });
+    it("Creates new operations when merging into an OpenAPI file with operations", () => {
+        const { mergedDocument, created } = mergeOpenApiDocumentOnOperationId(openApiWithSomePathsAndMethods, newOpenApiWithSomePathsAndMethods);
+        assert.deepStrictEqual(created, new Set(["createHuman"]), "The new operations should be created");
+        assert.deepStrictEqual(mergedDocument?.paths?.["/humans"]?.post, { operationId: "createHuman" }, "The new operation should be created");
+    });
+    it("Retains old operations when new document does not include those operations", () => {
+        const { mergedDocument, retained } = mergeOpenApiDocumentOnOperationId(openApiWithSomePathsAndMethods, newOpenApiWithSomePathsAndMethods);
+        assert.deepStrictEqual(retained, new Set(["deleteTest"]), "The existing operations should be retained");
+        assert.deepStrictEqual(mergedDocument?.paths?.["/test"]?.delete, openApiWithSomePathsAndMethods?.paths?.["/test"]?.delete, "The existing operation should be retained");
+    });
+    it("Merges operations and updates properties", () => {
+        const { mergedDocument, merged } = mergeOpenApiDocumentOnOperationId(openApiWithSomePathsAndMethods, newOpenApiWithSomePathsAndMethods);
+        assert.deepStrictEqual(merged, new Set(["getTest", "postTest", "deleteHuman", "getHuman"]), "The operations should be merged");
+        assert.strictEqual(mergedDocument?.paths?.["/test"]?.get?.deprecated, false, "The operation's 'deprecated' property should be updated");
+        assert.deepStrictEqual(mergedDocument?.paths?.["/test"]?.post?.summary, "Create a new test", "The operation's 'summary' property should be updated");
+        assert.deepStrictEqual(mergedDocument?.paths?.["/humans"]?.delete?.[ZUPLO_OPEN_API_ROUTE_KEY], openApiWithSomePathsAndMethods?.paths?.["/humans"]?.delete?.[ZUPLO_OPEN_API_ROUTE_KEY], "Merged operation with no changes should be the same");
+        assert.strictEqual(mergedDocument?.paths?.["/humans/{id}"]?.get, undefined, "The old operation should not exist in the merged document");
+        // NOTE: Parameters at the path level are not merged since operationId
+        // merging implies only operations are merged
+        assert.deepStrictEqual(mergedDocument?.paths?.["/humans/{humanId}"], {
+            get: {
+                operationId: "getHuman",
+                "x-zuplo-route": {
+                    corsPolicy: "none",
+                    handler: {
+                        export: "urlForwardHandler",
+                        module: "$import(@zuplo/runtime)",
+                        options: {
+                            baseUrl: "https://echo.zuplo.io",
+                        },
+                    },
+                },
+            },
+        }, "The new operation should exist in the merged document");
+    });
+    it("Retains zuplo config when merging operations", () => {
+        const { mergedDocument, merged } = mergeOpenApiDocumentOnOperationId(openApiWithSomePathsAndMethods, newOpenApiWithSomePathsAndMethods);
+        assert.deepStrictEqual(merged, new Set(["getTest", "postTest", "deleteHuman", "getHuman"]), "The operations should be merged");
+        assert.deepStrictEqual(mergedDocument?.paths?.["/test"]?.get?.[ZUPLO_OPEN_API_ROUTE_KEY], openApiWithSomePathsAndMethods?.paths?.["/test"]?.get?.[ZUPLO_OPEN_API_ROUTE_KEY], "The existing zuplo config should be retained");
+        assert.deepStrictEqual(mergedDocument?.paths?.["/test"]?.post?.[ZUPLO_OPEN_API_ROUTE_KEY], openApiWithSomePathsAndMethods?.paths?.["/test"]?.post?.[ZUPLO_OPEN_API_ROUTE_KEY], "The existing zuplo config should be retained");
+        assert.deepStrictEqual(mergedDocument?.paths?.["/humans"]?.delete?.[ZUPLO_OPEN_API_ROUTE_KEY], openApiWithSomePathsAndMethods?.paths?.["/humans"]?.delete?.[ZUPLO_OPEN_API_ROUTE_KEY], "The existing zuplo config should be retained");
+        assert.deepStrictEqual(mergedDocument?.paths?.["/humans/{humanId}"]?.get?.[ZUPLO_OPEN_API_ROUTE_KEY], openApiWithSomePathsAndMethods?.paths?.["/humans/{id}"]?.get?.[ZUPLO_OPEN_API_ROUTE_KEY], "The existing zuplo config should be retained");
+    });
+});
+//# sourceMappingURL=merge.spec.js.map

package/dist/merge.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"merge.spec.js","sourceRoot":"","sources":["../src/merge.spec.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,aAAa,CAAC;AACjC,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAClC,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EACL,wBAAwB,GAEzB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,iCAAiC,EACjC,qBAAqB,GACtB,MAAM,YAAY,CAAC;AACpB,OAAO,EACL,0BAA0B,EAC1B,eAAe,GAChB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,0BAA0B,EAAE,MAAM,cAAc,CAAC;AAC1D,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAE/C,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAClD,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;AAE3C,wCAAwC;AACxC,oEAAoE;AACpE,kFAAkF;AAClF,MAAM,gBAAgB,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,eAAe,CAAC,CAAC;AAErE,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE;IACnC,EAAE,CAAC,+DAA+D,EAAE,KAAK,IAAI,EAAE;QAC7E,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,mBAAmB,CAAC,CAAC;QACtE,MAAM,eAAe,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;QACjE,MAAM,mBAAmB,GAAG,0BAA0B,CACpD,OAAO,EACP,eAAe,CAChB,CAAC;QAEF,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,CAC9B,gBAAgB,EAChB,sCAAsC,CACvC,CAAC;QACF,MAAM,iBAAiB,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;QACrE,MAAM,gBAAgB,GAAG,0BAA0B,CACjD,OAAO,EACP,iBAAiB,CACM,CAAC;QAE1B,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,qBAAqB,CACzD,gBAAgB,EAChB,mBAAmB,EACnB,aAAa,CACd,CAAC;QAEF,MAAM,oBAAoB,GAAG,IAAI,GAAG,EAAE,CAAC,GAAG,CACxC,kCAAkC,CACnC,CAAC;QACF,MAAM,sBAAsB,GAAG,IAAI,GAAG,EAAE,CAAC,GAAG,CAC1C,kCAAkC,CACnC,CAAC;QAEF,MAAM,CAAC,eAAe,CAAC,OAAO,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;QAC3C,MAAM,CAAC,eAAe,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;QACrD,MAAM,CAAC,eAAe,CAAC,QAAQ,EAAE,sBAAsB,CAAC,CAAC;IAC3D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gFAAgF,EAAE,KAAK,IAAI,EAAE;QAC9F,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,mBAAmB,CAAC,CAAC;QACtE,MAAM,eAAe,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;QACjE,MAAM,mBAAmB,GAAG,0BAA0B,CACpD,OAAO,EACP,eAAe,CAChB,CAAC;QAEF,MAAM,gBAAgB,GAAG,0BAA0B,CACjD,OAAO,EACP,aAAa,CACU,CAAC;QAE1B,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,qBAAqB,CACzD,gBAAgB,EAChB,mBAAmB,EACnB,aAAa,CACd,CAAC;QAEF,MAAM,CAAC,eAAe,CACpB,OAAO,EACP,IAAI,GAAG,EAAE,CAAC,GAAG,CAAC,kCAAkC,CAAC,CAClD,CAAC;QACF,MAAM,CAAC,eAAe,CAAC,MAAM,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;QAC1C,MAAM,CAAC,eAAe,CAAC,QAAQ,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uCAAuC,EAAE,KAAK,IAAI,EAAE;QACrD,MAAM,kBAAkB,GAAG,IAAI,CAAC,IAAI,CAClC,gBAAgB,EAChB,uCAAuC,CACxC,CAAC;QACF,MAAM,qBAAqB,GAAG,MAAM,EAAE,CAAC,QAAQ,CAC7C,kBAAkB,EAClB,OAAO,CACR,CAAC;QACF,MAAM,WAAW,GAAG,0BAA0B,CAC5C,OAAO,EACP,qBAAqB,CACtB,CAAC;QAEF,0BAA0B,CAAC,WAAW,CAAC,CAAC;QAExC,MAAM,CAAC,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAC7B,MAAM,CAAC,EAAE,CAEL,WAAW,CAAC,KAIb,CAAC,6BAA6B,CAAC,EAAE,IAAI,EAAE,WAAW,CACpD,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0CAA0C,EAAE,KAAK,IAAI,EAAE;QACxD,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,CAC9B,gBAAgB,EAChB,sCAAsC,CACvC,CAAC;QACF,MAAM,iBAAiB,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;QACrE,MAAM,WAAW,GAAG,0BAA0B,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC;QAE3E,0BAA0B,CAAC,WAAW,CAAC,CAAC;QAExC,MAAM,CAAC,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAC7B,MAAM,KAAK,GAAG,WAAW,CAAC,KAGzB,CAAC;QACF,MAAM,CAAC,WAAW,CAChB,KAAK,CAAC,6BAA6B,CAAC,EAAE,IAAI,EAAE,WAAW,EACvD,OAAO,CACR,CAAC;QACF,MAAM,CAAC,WAAW,CAChB,KAAK,CAAC,6BAA6B,CAAC,EAAE,IAAI,EAAE,WAAW,EACvD,OAAO,CACR,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gDAAgD,EAAE,KAAK,IAAI,EAAE;QAC9D,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,iBAAiB,CAAC,CAAC;QACpE,MAAM,eAAe,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;QACjE,MAAM,mBAAmB,GAAG,0BAA0B,CACpD,OAAO,EACP,eAAe,CAChB,CAAC;QAEF,MAAM,CAAC,EAAE,CAAC,mBAAmB,CAAC,CAAC;QAC/B,MAAM,CAAC,eAAe,CAAC,mBAAmB,CAAC,IAAI,EAAE;YAC/C,KAAK,EAAE,aAAa;YACpB,WAAW,EAAE,YAAY;YACzB,OAAO,EAAE,OAAO;YAChB,OAAO,EAAE;gBACP,IAAI,EAAE,iBAAiB;gBACvB,GAAG,EAAE,oBAAoB;gBACzB,KAAK,EAAE,kBAAkB;aAC1B;SACF,CAAC,CAAC;QACH,MAAM,CAAC,eAAe,CAAC,mBAAmB,CAAC,OAAO,EAAE;YAClD;gBACE,GAAG,EAAE,uBAAuB;gBAC5B,WAAW,EAAE,YAAY;aAC1B;SACF,CAAC,CAAC;QACH,MAAM,CAAC,eAAe,CAAC,mBAAmB,CAAC,IAAI,EAAE;YAC/C,EAAE,IAAI,EAAE,OAAO,EAAE;YACjB,EAAE,IAAI,EAAE,cAAc,EAAE;YACxB,EAAE,IAAI,EAAE,MAAM,EAAE;YAChB,EAAE,IAAI,EAAE,YAAY,EAAE;SACvB,CAAC,CAAC;QAEH,MAAM,CAAC,EAAE,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;QAErC,MAAM,KAAK,GAAG,mBAAmB,CAAC,KAAgC,CAAC;QACnE,MAAM,CAAC,EAAE,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC;QAC/B,MAAM,CAAC,EAAE,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC,CAAC;QAC1C,MAAM,CAAC,EAAE,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC,CAAC;QACvC,MAAM,CAAC,EAAE,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC,CAAC;QAC5C,MAAM,CAAC,eAAe,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE;YACzC,GAAG,EAAE;gBACH,WAAW,EAAE,WAAW;gBACxB,OAAO,EAAE,WAAW;gBACpB,WAAW,EAAE,qBAAqB;gBAClC,IAAI,EAAE,CAAC,MAAM,CAAC;gBACd,SAAS,EAAE;oBACT,KAAK,EAAE;wBACL,WAAW,EAAE,IAAI;wBACjB,OAAO,EAAE;4BACP,kBAAkB,EAAE;gCAClB,MAAM,EAAE;oCACN,IAAI,EAAE,OAAO;oCACb,KAAK,EAAE;wCACL,IAAI,EAAE,2BAA2B;qCAClC;iCACF;6BACF;yBACF;wBACD,OAAO,EAAE;4BACP,eAAe,EAAE;gCACf,QAAQ,EAAE,IAAI;gCACd,MAAM,EAAE;oCACN,IAAI,EAAE,QAAQ;iCACf;gCACD,WAAW,EACT,0DAA0D;6BAC7D;yBACF;qBACF;iBACF;aACF;SACF,CAAC,CAAC;QACH,MAAM,CAAC,EAAE,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;IAC5C,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,4CAA4C;AAC5C,MAAM,YAAY,GAAG;IACnB,OAAO,EAAE,OAAO;IAChB,IAAI,EAAE;QACJ,KAAK,EAAE,MAAM;QACb,OAAO,EAAE,OAAO;KACjB;IACD,KAAK,EAAE,EAAE;CACV,CAAC;AAEF,MAAM,YAAY,GAAG;IACnB,OAAO,EAAE,OAAO;IAChB,IAAI,EAAE;QACJ,KAAK,EAAE,MAAM;QACb,OAAO,EAAE,OAAO;KACjB;IACD,KAAK,EAAE;QACL,OAAO,EAAE;YACP,GAAG,EAAE;gBACH,WAAW,EAAE,SAAS;aACvB;SACF;KACF;CACF,CAAC;AAEF,MAAM,8BAA8B,GAAG;IACrC,OAAO,EAAE,OAAO;IAChB,IAAI,EAAE;QACJ,KAAK,EAAE,MAAM;QACb,OAAO,EAAE,OAAO;KACjB;IACD,UAAU,EAAE,EAAE;IACd,KAAK,EAAE;QACL,OAAO,EAAE;YACP,GAAG,EAAE;gBACH,SAAS,EAAE;oBACT,KAAK,EAAE;wBACL,WAAW,EAAE,IAAI;qBAClB;iBACF;aACF;SACF;KACF;CACF,CAAC;AAEF,MAAM,oDAAoD,GAAG;IAC3D,OAAO,EAAE,OAAO;IAChB,IAAI,EAAE;QACJ,KAAK,EAAE,MAAM;QACb,OAAO,EAAE,OAAO;KACjB;IACD,KAAK,EAAE;QACL,OAAO,EAAE;YACP,GAAG,EAAE;gBACH,WAAW,EAAE,UAAU;aACxB;SACF;KACF;CACF,CAAC;AAEF,MAAM,8BAA8B,GAAyB;IAC3D,OAAO,EAAE,OAAO;IAChB,IAAI,EAAE;QACJ,KAAK,EAAE,MAAM;QACb,OAAO,EAAE,OAAO;KACjB;IACD,KAAK,EAAE;QACL,OAAO,EAAE;YACP,GAAG,EAAE;gBACH,WAAW,EAAE,SAAS;gBACtB,UAAU,EAAE,IAAI;gBAChB,eAAe,EAAE;oBACf,UAAU,EAAE,MAAM;oBAClB,OAAO,EAAE;wBACP,MAAM,EAAE,mBAAmB;wBAC3B,MAAM,EAAE,yBAAyB;wBACjC,OAAO,EAAE;4BACP,OAAO,EAAE,uBAAuB;yBACjC;qBACF;iBACF;aACF;YACD,MAAM,EAAE;gBACN,WAAW,EAAE,YAAY;gBACzB,eAAe,EAAE;oBACf,UAAU,EAAE,MAAM;oBAClB,OAAO,EAAE;wBACP,MAAM,EAAE,mBAAmB;wBAC3B,MAAM,EAAE,yBAAyB;wBACjC,OAAO,EAAE;4BACP,OAAO,EAAE,uBAAuB;yBACjC;qBACF;iBACF;aACF;YACD,IAAI,EAAE;gBACJ,WAAW,EAAE,UAAU;gBACvB,eAAe,EAAE;oBACf,UAAU,EAAE,MAAM;oBAClB,OAAO,EAAE;wBACP,MAAM,EAAE,mBAAmB;wBAC3B,MAAM,EAAE,yBAAyB;wBACjC,OAAO,EAAE;4BACP,OAAO,EAAE,uBAAuB;yBACjC;qBACF;iBACF;aACF;SACF;QACD,SAAS,EAAE;YACT,MAAM,EAAE;gBACN,WAAW,EAAE,aAAa;gBAC1B,eAAe,EAAE;oBACf,UAAU,EAAE,MAAM;oBAClB,OAAO,EAAE;wBACP,MAAM,EAAE,mBAAmB;wBAC3B,MAAM,EAAE,yBAAyB;wBACjC,OAAO,EAAE;4BACP,OAAO,EAAE,uBAAuB;yBACjC;qBACF;iBACF;aACF;SACF;QACD,cAAc,EAAE;YACd,UAAU,EAAE;gBACV;oBACE,IAAI,EAAE,IAAI;oBACV,EAAE,EAAE,MAAM;oBACV,QAAQ,EAAE,IAAI;oBACd,MAAM,EAAE;wBACN,IAAI,EAAE,QAAQ;qBACf;iBACF;aACF;YACD,GAAG,EAAE;gBACH,WAAW,EAAE,UAAU;gBACvB,eAAe,EAAE;oBACf,UAAU,EAAE,MAAM;oBAClB,OAAO,EAAE;wBACP,MAAM,EAAE,mBAAmB;wBAC3B,MAAM,EAAE,yBAAyB;wBACjC,OAAO,EAAE;4BACP,OAAO,EAAE,uBAAuB;yBACjC;qBACF;iBACF;aACF;SACF;KACF;CACF,CAAC;AAEF,MAAM,iCAAiC,GAAyB;IAC9D,OAAO,EAAE,OAAO;IAChB,IAAI,EAAE;QACJ,KAAK,EAAE,MAAM;QACb,OAAO,EAAE,OAAO;KACjB;IACD,KAAK,EAAE;QACL,OAAO,EAAE;YACP,GAAG,EAAE;gBACH,WAAW,EAAE,SAAS;gBACtB,UAAU,EAAE,KAAK,EAAE,8BAA8B;aAClD;YACD,IAAI,EAAE;gBACJ,WAAW,EAAE,UAAU;gBACvB,OAAO,EAAE,mBAAmB,EAAE,gBAAgB;gBAC9C,8BAA8B;aAC/B;SACF;QACD,SAAS,EAAE;YACT,IAAI,EAAE;gBACJ,WAAW,EAAE,aAAa;aAC3B;YACD,MAAM,EAAE;gBACN,WAAW,EAAE,aAAa;aAC3B;SACF;QACD,mBAAmB,EAAE;YACnB,8BAA8B;YAC9B,UAAU,EAAE;gBACV;oBACE,IAAI,EAAE,SAAS;oBACf,EAAE,EAAE,MAAM;oBACV,QAAQ,EAAE,IAAI;oBACd,MAAM,EAAE;wBACN,IAAI,EAAE,QAAQ;qBACf;iBACF;aACF;YACD,GAAG,EAAE;gBACH,WAAW,EAAE,UAAU;aACxB;SACF;KACF;CACF,CAAC;AAEF,QAAQ,CAAC,iCAAiC,EAAE,GAAG,EAAE;IAC/C,EAAE,CAAC,2EAA2E,EAAE,GAAG,EAAE;QACnF,MAAM,EAAE,cAAc,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,GACjD,iCAAiC,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;QAChE,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,EAAE,iCAAiC,CAAC,CAAC;QACvE,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,EAAE,gCAAgC,CAAC,CAAC;QACrE,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,EAAE,kCAAkC,CAAC,CAAC;QACzE,MAAM,CAAC,eAAe,CACpB,cAAc,EACd,YAAY,EACZ,6CAA6C,CAC9C,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mEAAmE,EAAE,GAAG,EAAE;QAC3E,MAAM,EAAE,cAAc,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,GACjD,iCAAiC,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;QAChE,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,EAAE,iCAAiC,CAAC,CAAC;QACvE,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,EAAE,gCAAgC,CAAC,CAAC;QACrE,MAAM,CAAC,eAAe,CACpB,QAAQ,EACR,IAAI,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,EACpB,2CAA2C,CAC5C,CAAC;QACF,MAAM,CAAC,eAAe,CACpB,cAAc,EACd,YAAY,EACZ,6CAA6C,CAC9C,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE;QACxE,MAAM,EAAE,cAAc,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,GACjD,iCAAiC,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;QAChE,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,EAAE,gCAAgC,CAAC,CAAC;QACrE,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,EAAE,kCAAkC,CAAC,CAAC;QACzE,MAAM,CAAC,eAAe,CACpB,OAAO,EACP,IAAI,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,EACpB,qCAAqC,CACtC,CAAC;QACF,MAAM,CAAC,eAAe,CACpB,cAAc,EACd,YAAY,EACZ,mDAAmD,CACpD,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE;QACxD,MAAM,CAAC,MAAM,CACX,GAAG,EAAE;YACH,iCAAiC,CAC/B,YAAY,EACZ,8BAA8B,CAC/B,CAAC;QACJ,CAAC,EACD;YACE,OAAO,EAAE,sEAAsE,eAAe,CAAC,KAAK,EAAE,OAAO,CAAC,+DAA+D;SAC9K,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mFAAmF,EAAE,GAAG,EAAE;QAC3F,MAAM,CAAC,MAAM,CACX,GAAG,EAAE;YACH,iCAAiC,CAC/B,YAAY,EACZ,oDAAoD,CACrD,CAAC;QACJ,CAAC,EACD;YACE,OAAO,EAAE,+EAA+E,eAAe,CAAC,KAAK,EAAE,OAAO,CAAC,+GAA+G;SACvO,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0EAA0E,EAAE,GAAG,EAAE;QAClF,MAAM,EAAE,cAAc,EAAE,OAAO,EAAE,GAAG,iCAAiC,CACnE,8BAA8B,EAC9B,iCAAiC,CAClC,CAAC;QACF,MAAM,CAAC,eAAe,CACpB,OAAO,EACP,IAAI,GAAG,CAAC,CAAC,aAAa,CAAC,CAAC,EACxB,sCAAsC,CACvC,CAAC;QACF,MAAM,CAAC,eAAe,CACpB,cAAc,EAAE,KAAK,EAAE,CAAC,SAAS,CAAC,EAAE,IAAI,EACxC,EAAE,WAAW,EAAE,aAAa,EAAE,EAC9B,qCAAqC,CACtC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4EAA4E,EAAE,GAAG,EAAE;QACpF,MAAM,EAAE,cAAc,EAAE,QAAQ,EAAE,GAAG,iCAAiC,CACpE,8BAA8B,EAC9B,iCAAiC,CAClC,CAAC;QACF,MAAM,CAAC,eAAe,CACpB,QAAQ,EACR,IAAI,GAAG,CAAC,CAAC,YAAY,CAAC,CAAC,EACvB,4CAA4C,CAC7C,CAAC;QACF,MAAM,CAAC,eAAe,CACpB,cAAc,EAAE,KAAK,EAAE,CAAC,OAAO,CAAC,EAAE,MAAM,EACxC,8BAA8B,EAAE,KAAK,EAAE,CAAC,OAAO,CAAC,EAAE,MAAM,EACxD,2CAA2C,CAC5C,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0CAA0C,EAAE,GAAG,EAAE;QAClD,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,GAAG,iCAAiC,CAClE,8BAA8B,EAC9B,iCAAiC,CAClC,CAAC;QACF,MAAM,CAAC,eAAe,CACpB,MAAM,EACN,IAAI,GAAG,CAAC,CAAC,SAAS,EAAE,UAAU,EAAE,aAAa,EAAE,UAAU,CAAC,CAAC,EAC3D,iCAAiC,CAClC,CAAC;QACF,MAAM,CAAC,WAAW,CAChB,cAAc,EAAE,KAAK,EAAE,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,UAAU,EACjD,KAAK,EACL,yDAAyD,CAC1D,CAAC;QACF,MAAM,CAAC,eAAe,CACpB,cAAc,EAAE,KAAK,EAAE,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,OAAO,EAC/C,mBAAmB,EACnB,sDAAsD,CACvD,CAAC;QACF,MAAM,CAAC,eAAe,CACpB,cAAc,EAAE,KAAK,EAAE,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC,wBAAwB,CAAC,EACtE,8BAA8B,EAAE,KAAK,EAAE,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,CAC1D,wBAAwB,CACzB,EACD,qDAAqD,CACtD,CAAC;QACF,MAAM,CAAC,WAAW,CAChB,cAAc,EAAE,KAAK,EAAE,CAAC,cAAc,CAAC,EAAE,GAAG,EAC5C,SAAS,EACT,2DAA2D,CAC5D,CAAC;QACF,sEAAsE;QACtE,6CAA6C;QAC7C,MAAM,CAAC,eAAe,CACpB,cAAc,EAAE,KAAK,EAAE,CAAC,mBAAmB,CAAC,EAC5C;YACE,GAAG,EAAE;gBACH,WAAW,EAAE,UAAU;gBACvB,eAAe,EAAE;oBACf,UAAU,EAAE,MAAM;oBAClB,OAAO,EAAE;wBACP,MAAM,EAAE,mBAAmB;wBAC3B,MAAM,EAAE,yBAAyB;wBACjC,OAAO,EAAE;4BACP,OAAO,EAAE,uBAAuB;yBACjC;qBACF;iBACF;aACF;SACF,EACD,uDAAuD,CACxD,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACtD,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,GAAG,iCAAiC,CAClE,8BAA8B,EAC9B,iCAAiC,CAClC,CAAC;QACF,MAAM,CAAC,eAAe,CACpB,MAAM,EACN,IAAI,GAAG,CAAC,CAAC,SAAS,EAAE,UAAU,EAAE,aAAa,EAAE,UAAU,CAAC,CAAC,EAC3D,iCAAiC,CAClC,CAAC;QACF,MAAM,CAAC,eAAe,CACpB,cAAc,EAAE,KAAK,EAAE,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,CAAC,wBAAwB,CAAC,EACjE,8BAA8B,EAAE,KAAK,EAAE,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,CACrD,wBAAwB,CACzB,EACD,8CAA8C,CAC/C,CAAC;QACF,MAAM,CAAC,eAAe,CACpB,cAAc,EAAE,KAAK,EAAE,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,CAAC,wBAAwB,CAAC,EAClE,8BAA8B,EAAE,KAAK,EAAE,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,CACtD,wBAAwB,CACzB,EACD,8CAA8C,CAC/C,CAAC;QACF,MAAM,CAAC,eAAe,CACpB,cAAc,EAAE,KAAK,EAAE,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC,wBAAwB,CAAC,EACtE,8BAA8B,EAAE,KAAK,EAAE,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,CAC1D,wBAAwB,CACzB,EACD,8CAA8C,CAC/C,CAAC;QACF,MAAM,CAAC,eAAe,CACpB,cAAc,EAAE,KAAK,EAAE,CAAC,mBAAmB,CAAC,EAAE,GAAG,EAAE,CACjD,wBAAwB,CACzB,EACD,8BAA8B,EAAE,KAAK,EAAE,CAAC,cAAc,CAAC,EAAE,GAAG,EAAE,CAC5D,wBAAwB,CACzB,EACD,8CAA8C,CAC/C,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/operation-utils.d.ts

@@ -0,0 +1,29 @@
+import type { OpenAPIV3_1 } from "openapi-types";
+import { type HttpMethod } from "./constants.js";
+import type { ZuploOpenApiDocument, ZuploOpenApiPathsObject } from "./interfaces.js";
+export declare const OPERATION_PATH_MERGE_DELIMITER = ">";
+export declare const getOperationKey: (method: string, path: string) => string;
+/**
+ * Get all operation keys (method + path) from a paths object
+ */
+export declare const getAllOperationKeys: (pathsObject: ZuploOpenApiPathsObject | OpenAPIV3_1.PathsObject) => string[];
+/**
+ * Create an index of operations by their operationId
+ *
+ * @param openapiSpec The OpenAPI specification object
+ * @returns A map of operationId -> { path, method }
+ */
+export declare const indexOperationsById: (openapiSpec: ZuploOpenApiDocument | OpenAPIV3_1.Document) => Record<string, {
+    path: string;
+    method: HttpMethod;
+}>;
+/**
+ * Add operation ID to any operations that don't have one, this makes
+ * onboarding smoother for new users
+ */
+export declare const addOperationIdsAsNecessary: (openApi: OpenAPIV3_1.Document | ZuploOpenApiDocument) => ZuploOpenApiDocument;
+/**
+ * Remove operations that don't have an operationId
+ */
+export declare const removeOperationsWithoutAnId: (openApi: OpenAPIV3_1.Document | ZuploOpenApiDocument) => ZuploOpenApiDocument;
+//# sourceMappingURL=operation-utils.d.ts.map

package/dist/operation-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"operation-utils.d.ts","sourceRoot":"","sources":["../src/operation-utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAEjD,OAAO,EAAgB,KAAK,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC/D,OAAO,KAAK,EACV,oBAAoB,EAGpB,uBAAuB,EACxB,MAAM,iBAAiB,CAAC;AAIzB,eAAO,MAAM,8BAA8B,MAAM,CAAC;AAElD,eAAO,MAAM,eAAe,GAAI,QAAQ,MAAM,EAAE,MAAM,MAAM,WACP,CAAC;AAEtD;;GAEG;AACH,eAAO,MAAM,mBAAmB,GAC9B,aAAa,uBAAuB,GAAG,WAAW,CAAC,WAAW,aA2C/D,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,GAC9B,aAAa,oBAAoB,GAAG,WAAW,CAAC,QAAQ,KACvD,MAAM,CACP,MAAM,EACN;IACE,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,UAAU,CAAC;CACpB,CAyBF,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,0BAA0B,GACrC,SAAS,WAAW,CAAC,QAAQ,GAAG,oBAAoB,KACnD,oBA4BF,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,2BAA2B,GACtC,SAAS,WAAW,CAAC,QAAQ,GAAG,oBAAoB,KACnD,oBAmBF,CAAC"}

package/dist/operation-utils.js

@@ -0,0 +1,123 @@
+import { v4 } from "uuid";
+import { HTTP_METHODS } from "./constants.js";
+const METHODS = HTTP_METHODS;
+export const OPERATION_PATH_MERGE_DELIMITER = ">";
+export const getOperationKey = (method, path) => `${method}${OPERATION_PATH_MERGE_DELIMITER}${path}`;
+/**
+ * Get all operation keys (method + path) from a paths object
+ */
+export const getAllOperationKeys = (pathsObject) => {
+    return Object.entries(pathsObject).flatMap(([path, pathObject]) => {
+        const pathItemObject = pathObject;
+        const { get, put, post, delete: deleteOperation, options, head, patch, trace, } = pathItemObject;
+        const methods = [];
+        if (get) {
+            methods.push("get");
+        }
+        if (put) {
+            methods.push("put");
+        }
+        if (post) {
+            methods.push("post");
+        }
+        if (deleteOperation) {
+            methods.push("delete");
+        }
+        if (options) {
+            methods.push("options");
+        }
+        if (head) {
+            methods.push("head");
+        }
+        if (patch) {
+            methods.push("patch");
+        }
+        if (trace) {
+            methods.push("trace");
+        }
+        return methods.map((method) => getOperationKey(method, path));
+    });
+};
+/**
+ * Create an index of operations by their operationId
+ *
+ * @param openapiSpec The OpenAPI specification object
+ * @returns A map of operationId -> { path, method }
+ */
+export const indexOperationsById = (openapiSpec) => {
+    const operationsIndex = {};
+    const paths = openapiSpec.paths;
+    if (paths) {
+        Object.entries(paths).forEach(([path, pathItem]) => {
+            if (pathItem) {
+                METHODS.forEach((method) => {
+                    const operation = pathItem[method];
+                    if (operation?.operationId) {
+                        operationsIndex[operation.operationId] = {
+                            path,
+                            method,
+                        };
+                    }
+                });
+            }
+        });
+    }
+    return operationsIndex;
+};
+/**
+ * Add operation ID to any operations that don't have one, this makes
+ * onboarding smoother for new users
+ */
+export const addOperationIdsAsNecessary = (openApi) => {
+    const paths = openApi.paths;
+    if (!paths) {
+        return openApi;
+    }
+    for (const path of Object.keys(paths)) {
+        const pathItem = paths[path];
+        if (!pathItem) {
+            continue;
+        }
+        const methods = [
+            "get",
+            "put",
+            "post",
+            "delete",
+            "options",
+            "head",
+            "patch",
+            "trace",
+        ];
+        for (const method of methods) {
+            const operation = pathItem[method];
+            if (operation && !operation.operationId) {
+                operation.operationId = v4();
+            }
+        }
+    }
+    return openApi;
+};
+/**
+ * Remove operations that don't have an operationId
+ */
+export const removeOperationsWithoutAnId = (openApi) => {
+    const newDocument = { ...openApi };
+    const paths = newDocument.paths;
+    if (!paths) {
+        return openApi;
+    }
+    for (const path of Object.keys(paths)) {
+        const pathItem = paths[path];
+        if (!pathItem) {
+            continue;
+        }
+        for (const method of METHODS) {
+            const operation = pathItem[method];
+            if (operation && !operation.operationId) {
+                delete pathItem[method];
+            }
+        }
+    }
+    return openApi;
+};
+//# sourceMappingURL=operation-utils.js.map

package/dist/operation-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"operation-utils.js","sourceRoot":"","sources":["../src/operation-utils.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,EAAE,EAAE,MAAM,MAAM,CAAC;AAC1B,OAAO,EAAE,YAAY,EAAmB,MAAM,gBAAgB,CAAC;AAQ/D,MAAM,OAAO,GAAG,YAAuC,CAAC;AAExD,MAAM,CAAC,MAAM,8BAA8B,GAAG,GAAG,CAAC;AAElD,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,MAAc,EAAE,IAAY,EAAE,EAAE,CAC9D,GAAG,MAAM,GAAG,8BAA8B,GAAG,IAAI,EAAE,CAAC;AAEtD;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CACjC,WAA8D,EAC9D,EAAE;IACF,OAAO,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,UAAU,CAAC,EAAE,EAAE;QAChE,MAAM,cAAc,GAEa,UAAU,CAAC;QAC5C,MAAM,EACJ,GAAG,EACH,GAAG,EACH,IAAI,EACJ,MAAM,EAAE,eAAe,EACvB,OAAO,EACP,IAAI,EACJ,KAAK,EACL,KAAK,GACN,GAAG,cAAc,CAAC;QACnB,MAAM,OAAO,GAAG,EAAE,CAAC;QACnB,IAAI,GAAG,EAAE,CAAC;YACR,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACtB,CAAC;QACD,IAAI,GAAG,EAAE,CAAC;YACR,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACtB,CAAC;QACD,IAAI,IAAI,EAAE,CAAC;YACT,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACvB,CAAC;QACD,IAAI,eAAe,EAAE,CAAC;YACpB,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACzB,CAAC;QACD,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC1B,CAAC;QACD,IAAI,IAAI,EAAE,CAAC;YACT,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACvB,CAAC;QACD,IAAI,KAAK,EAAE,CAAC;YACV,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxB,CAAC;QACD,IAAI,KAAK,EAAE,CAAC;YACV,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxB,CAAC;QACD,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,eAAe,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;IAChE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CACjC,WAAwD,EAOxD,EAAE;IACF,MAAM,eAAe,GACnB,EAAE,CAAC;IACL,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC;IAEhC,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE;YACjD,IAAI,QAAQ,EAAE,CAAC;gBACb,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;oBACzB,MAAM,SAAS,GAAG,QAAQ,CAAC,MAAM,CAEpB,CAAC;oBACd,IAAI,SAAS,EAAE,WAAW,EAAE,CAAC;wBAC3B,eAAe,CAAC,SAAS,CAAC,WAAW,CAAC,GAAG;4BACvC,IAAI;4BACJ,MAAM;yBACP,CAAC;oBACJ,CAAC;gBACH,CAAC,CAAC,CAAC;YACL,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,OAAO,eAAe,CAAC;AACzB,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CACxC,OAAoD,EAC9B,EAAE;IACxB,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;IAC5B,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,OAA+B,CAAC;IACzC,CAAC;IACD,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QACtC,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;QAC7B,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,SAAS;QACX,CAAC;QACD,MAAM,OAAO,GAAG;YACd,KAAK;YACL,KAAK;YACL,MAAM;YACN,QAAQ;YACR,SAAS;YACT,MAAM;YACN,OAAO;YACP,OAAO;SACqB,CAAC;QAC/B,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,MAAM,SAAS,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC;YACnC,IAAI,SAAS,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC;gBACxC,SAAS,CAAC,WAAW,GAAG,EAAE,EAAE,CAAC;YAC/B,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,OAA+B,CAAC;AACzC,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CACzC,OAAoD,EAC9B,EAAE;IACxB,MAAM,WAAW,GAAG,EAAE,GAAG,OAAO,EAAE,CAAC;IACnC,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC;IAChC,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,OAA+B,CAAC;IACzC,CAAC;IACD,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QACtC,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;QAC7B,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,SAAS;QACX,CAAC;QACD,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,MAAM,SAAS,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC;YACnC,IAAI,SAAS,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC;gBACxC,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC;YAC1B,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,OAA+B,CAAC;AACzC,CAAC,CAAC"}

package/dist/overlay.d.ts

@@ -0,0 +1,78 @@
+/**
+ * OpenAPI Overlay implementation
+ * Applies overlay modifications to OpenAPI documents following the OpenAPI Overlay Specification
+ */
+import { type OverlayAction, type OverlayDocument, type RemoveCondition } from "./validation.js";
+export interface ApplyResult {
+    applied: boolean;
+    count: number;
+}
+export interface OverlayStats {
+    applied: number;
+    skipped: number;
+    totalNodes: number;
+}
+/**
+ * Deep clone an object using structuredClone for better performance and correctness
+ * Falls back to JSON parse/stringify for environments without structuredClone
+ */
+export declare function deepClone<T>(obj: T): T;
+/**
+ * Deep merge two objects
+ * Special handling for OpenAPI parameters (merge by name+in)
+ * Returns the merged result, which will have the shape of source if target is not an object,
+ * or a merged object/array if both are objects/arrays
+ */
+export declare function deepMerge(target: unknown, source: unknown): unknown;
+/**
+ * Check if a condition is met for conditional removal
+ */
+export declare function checkCondition(value: unknown, condition: RemoveCondition): boolean;
+export declare function setValueAtPath(doc: unknown, target: string, value: unknown): void;
+/**
+ * Apply a single overlay action to the document
+ */
+export declare function applyAction(doc: unknown, action: OverlayAction): ApplyResult;
+/**
+ * Extract path order from overlay actions
+ * Returns array of paths in the order they appear in overlay
+ */
+export declare function extractPathOrder(overlay: OverlayDocument): string[];
+/**
+ * Reorder operation properties so summary, description, operationId come first
+ * Returns a new object with reordered keys
+ */
+export declare function reorderOperationProperties(operation: unknown): Record<string, unknown>;
+/**
+ * Reorder paths object to match the order from overlay
+ * Modifies the document in place and returns it
+ */
+export declare function reorderPaths<T>(doc: T, pathOrder: string[]): T;
+/**
+ * Reorder top-level document properties to ensure proper ordering
+ * OpenAPI spec should have: openapi, info, tags, servers, paths, components, etc.
+ * Returns a new object with reordered keys
+ */
+export declare function reorderDocumentProperties(doc: unknown): Record<string, unknown>;
+/**
+ * Apply overlay to OpenAPI document
+ *
+ * Validates both the OpenAPI document and overlay upfront, then applies
+ * all actions defined in the overlay to produce a modified OpenAPI document.
+ *
+ * @param openapi The OpenAPI document to modify (will be validated)
+ * @param overlay The overlay document to apply (will be validated)
+ * @returns The modified OpenAPI document and statistics about what was applied
+ * @throws {Error} if either document is invalid, with actionable error messages
+ *
+ * @example
+ * ```typescript
+ * const result = applyOverlay(openapiDoc, overlayDoc);
+ * console.log(`Applied ${result.stats.applied} actions`);
+ * ```
+ */
+export declare function applyOverlay(openapi: unknown, overlay: unknown): {
+    result: Record<string, unknown>;
+    stats: OverlayStats;
+};
+//# sourceMappingURL=overlay.d.ts.map