feat: Extend useEnums to all schema files (#223)

Co-authored-by: Schwager, Sandro <[email protected]>

Author: sschw

plugins/typescript/src/fixtures/petstore.ts

@@ -243,6 +243,16 @@ export const petstore: OpenAPIObject = {
           type: "string",
         },
       },
+      petFilterParam: {
+        name: "petFilter",
+        in: "query",
+        required: false,
+        schema: {
+          description: "Filter by type",
+          type: "string",
+          enum: ["cat", "dog"],
+        },
+      },
     },
     requestBodies: {
       updatePetRequest: {
@@ -255,6 +265,17 @@ export const petstore: OpenAPIObject = {
         },
         required: true,
       },
+      searchPetRequest: {
+        content: {
+          "application/json": {
+            schema: {
+              type: "string",
+              enum: ["cat", "dog"],
+            },
+          },
+        },
+        required: true,
+      },
     },
     responses: {
       NotModified: {
@@ -270,6 +291,17 @@ export const petstore: OpenAPIObject = {
           },
         },
       },
+      PetTypeResponse: {
+        description: "Type of pet",
+        content: {
+          "application/json": {
+            schema: {
+              type: "string",
+              enum: ["cat", "dog"],
+            },
+          },
+        },
+      },
     },
     schemas: {
       Pet: {

plugins/typescript/src/generators/generateSchemaTypes.test.ts

@@ -326,6 +326,8 @@ describe("generateSchemaTypes", () => {
        export type NotModified = void;
 
        export type PetResponse = Schemas.Pet;
+
+       export type PetTypeResponse = "cat" | "dog";
        "
       `);
     });
@@ -356,6 +358,8 @@ describe("generateSchemaTypes", () => {
        import type * as Schemas from "./swaggerPetstoreSchemas";
 
        export type UpdatePetRequest = Schemas.NewPet;
+
+       export type SearchPetRequest = "cat" | "dog";
        "
       `);
     });
@@ -386,6 +390,122 @@ describe("generateSchemaTypes", () => {
          * Unique identifier
          */
         export type IdParam = string;
+
+        /**
+         * Filter by type
+         */
+        export type PetFilterParam = "cat" | "dog";
+        "
+      `);
+    });
+
+    it("should generate the responses file with enums instead of string unions", async () => {
+      const writeFile = jest.fn();
+      const readFile = jest.fn(() => Promise.resolve(""));
+      await generateSchemaTypes(
+        {
+          openAPIDocument: petstore,
+          writeFile,
+          readFile,
+          existsFile: () => true,
+        },
+        {
+          filenameCase: "camel",
+          useEnums: true,
+        },
+      );
+      expect(writeFile.mock.calls[1][0]).toBe("swaggerPetstoreResponses.ts");
+      expect(writeFile.mock.calls[1][1]).toMatchInlineSnapshot(`
+        "/**
+         * Generated by @openapi-codegen
+         * 
+         * @version 1.0.0
+         */
+        import type * as Schemas from "./swaggerPetstoreSchemas";
+
+        export enum PetTypeResponse {
+            cat = "cat",
+            dog = "dog"
+        }
+
+        export type NotModified = void;
+
+        export type PetResponse = Schemas.Pet;
+        "
+      `);
+    });
+
+    it("should generate the request bodies file with enums instead of string unions", async () => {
+      const writeFile = jest.fn();
+      const readFile = jest.fn(() => Promise.resolve(""));
+      await generateSchemaTypes(
+        {
+          openAPIDocument: petstore,
+          writeFile,
+          readFile,
+          existsFile: () => true,
+        },
+        {
+          filenameCase: "camel",
+          useEnums: true,
+        },
+      );
+      expect(writeFile.mock.calls[2][0]).toBe(
+        "swaggerPetstoreRequestBodies.ts",
+      );
+      expect(writeFile.mock.calls[2][1]).toMatchInlineSnapshot(`
+        "/**
+         * Generated by @openapi-codegen
+         * 
+         * @version 1.0.0
+         */
+        import type * as Schemas from "./swaggerPetstoreSchemas";
+        
+        export enum SearchPetRequest {
+            cat = "cat",
+            dog = "dog"
+        }
+
+        export type UpdatePetRequest = Schemas.NewPet;
+        "
+      `);
+    });
+
+    it("should generate the parameters file with enums instead of string unions", async () => {
+      const writeFile = jest.fn();
+      const readFile = jest.fn(() => Promise.resolve(""));
+
+      await generateSchemaTypes(
+        {
+          openAPIDocument: petstore,
+          writeFile,
+          readFile,
+          existsFile: () => true,
+        },
+        {
+          filenameCase: "camel",
+          useEnums: true,
+        },
+      );
+      expect(writeFile.mock.calls[3][0]).toBe("swaggerPetstoreParameters.ts");
+      expect(writeFile.mock.calls[3][1]).toMatchInlineSnapshot(`
+        "/**
+         * Generated by @openapi-codegen
+         * 
+         * @version 1.0.0
+         */
+        /**
+         * Filter by type
+         */
+        export enum PetFilterParam {
+            cat = "cat",
+            dog = "dog"
+        }
+
+        /**
+         * Unique identifier
+         */
+        export type IdParam = string;
         "
       `);
     });