tests: adds tests for --make-paths-enum option and paths-enum.ts transformer

Author: laurenz-glueck

packages/openapi-typescript/test/index.test.ts

@@ -694,6 +694,71 @@ export type operations = Record<string, never>;`,
         },
       },
     ],
+    [
+      "$refs > path object & paths enum",
+      {
+        given: new URL("./fixtures/path-object-refs.yaml", import.meta.url),
+        want: `export interface paths {
+    "/get-item": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description OK */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Item"];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+}
+export type webhooks = Record<string, never>;
+export interface components {
+    schemas: {
+        Item: {
+            id: string;
+            name: string;
+        };
+    };
+    responses: never;
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+export type $defs = Record<string, never>;
+export type operations = Record<string, never>;
+export enum ApiPaths {
+    GetGetitem = "/get-item"
+}`,
+        options: {
+          makePathsEnum: true,
+        }
+      },
+    ],
   ];
 
   for (const [testName, { given, want, options, ci }] of tests) {

packages/openapi-typescript/test/transform/paths-enum.test.ts

@@ -0,0 +1,127 @@
+import { fileURLToPath } from "node:url";
+import { astToString } from "../../src/lib/ts.js";
+import makeApiPathsEnum from "../../src/transform/paths-enum.js";
+import type { GlobalContext } from "../../src/types.js";
+import { type TestCase } from "../test-helpers.js";
+
+describe("transformPathsObjectToEnum", () => {
+  const tests: TestCase<any, GlobalContext>[] = [
+    [
+      "basic",
+      {
+        given: {
+          "/api/v1/user": {
+            get: {
+            },
+          },
+        },
+        want: `export enum ApiPaths {
+    GetApiV1User = "/api/v1/user"
+}`,
+      },
+    ],
+    [
+      "basic with path parameter",
+      {
+        given: {
+          "/api/v1/user/{user_id}": {
+            parameters: [
+              {
+                name: "page",
+                in: "query",
+                schema: { type: "number" },
+                description: "Page number.",
+              },
+            ],
+            get: {
+              parameters: [{ name: "user_id", in: "path", description: "User ID." }],
+            },
+          },
+        },
+        want: `export enum ApiPaths {
+    GetApiV1User = "/api/v1/user/:user_id"
+}`,
+      },
+    ],
+    [
+      "with operationId",
+      {
+        given: {
+          "/api/v1/user/{user_id}": {
+            parameters: [
+              {
+                name: "page",
+                in: "query",
+                schema: { type: "number" },
+                description: "Page number.",
+              },
+            ],
+            get: {
+              operationId: "GetUserById",
+              parameters: [{ name: "user_id", in: "path", description: "User ID." }],
+            },
+          },
+        },
+        want: `export enum ApiPaths {
+    GetUserById = "/api/v1/user/:user_id"
+}`,
+      },
+    ],
+    [
+      "with and without operationId",
+      {
+        given: {
+          "/api/v1/user/{user_id}": {
+            parameters: [
+              {
+                name: "page",
+                in: "query",
+                schema: { type: "number" },
+                description: "Page number.",
+              },
+            ],
+            get: {
+              operationId: "GetUserById",
+              parameters: [{ name: "user_id", in: "path", description: "User ID." }],
+            },
+            post: {
+              parameters: [{ name: "user_id", in: "path", description: "User ID." }],
+            },
+          },
+        },
+        want: `export enum ApiPaths {
+    GetUserById = "/api/v1/user/:user_id",
+    PostApiV1User = "/api/v1/user/:user_id"
+}`,
+      },
+    ],
+    [
+      "invalid method",
+      {
+        given: {
+          "/api/v1/user": {
+            invalidMethod: {
+            },
+          },
+        },
+        want: `export enum ApiPaths {
+}`,
+      },
+    ],
+  ];
+
+  for (const [testName, { given, want, ci }] of tests) {
+    test.skipIf(ci?.skipIf)(
+      testName,
+      async () => {
+        const result = astToString(makeApiPathsEnum(given));
+        if (want instanceof URL) {
+          expect(result).toMatchFileSnapshot(fileURLToPath(want));
+        } else {
+          expect(result).toBe(`${want}\n`);
+        }
+      },
+      ci?.timeout,
+    );
+  }
+});