fix: use object instead of array for enum (#124)

Author: alanpoulain

src/Field.ts

@@ -36,7 +36,7 @@ export interface FieldOptions
     range?: string;
     type?: FieldType;
     arrayType?: FieldType;
-    enum?: string[] | number[];
+    enum?: { [key: string | number]: string | number };
     reference?: string | Resource;
     embedded?: Resource;
     required?: boolean;

src/openapi3/handleJson.test.ts

@@ -516,7 +516,7 @@ const openApi3Definition: OpenAPIV3.Document = {
           bookFormat: {
             type: "string",
             description: "The publication format of the book.",
-            enum: ["AudiobookFormat", "EBook", "Paperback", "Hardcover"],
+            enum: ["AUDIOBOOK_FORMAT", "E_BOOK", "PAPERBACK", "HARDCOVER"],
           },
           publicationDate: {
             type: "string",
@@ -573,7 +573,7 @@ const openApi3Definition: OpenAPIV3.Document = {
           bookFormat: {
             type: "string",
             description: "The publication format of the book.",
-            enum: ["AudiobookFormat", "EBook", "Paperback", "Hardcover"],
+            enum: ["AUDIOBOOK_FORMAT", "E_BOOK", "PAPERBACK", "HARDCOVER"],
           },
           publicationDate: {
             type: "string",
@@ -705,7 +705,12 @@ const parsed = [
         range: null,
         type: "string",
         arrayType: null,
-        enum: ["AudiobookFormat", "EBook", "Paperback", "Hardcover"],
+        enum: {
+          "Audiobook format": "AUDIOBOOK_FORMAT",
+          "E book": "E_BOOK",
+          Paperback: "PAPERBACK",
+          Hardcover: "HARDCOVER",
+        },
         reference: null,
         embedded: null,
         nullable: false,
@@ -829,7 +834,12 @@ const parsed = [
         range: null,
         type: "string",
         arrayType: null,
-        enum: ["AudiobookFormat", "EBook", "Paperback", "Hardcover"],
+        enum: {
+          "Audiobook format": "AUDIOBOOK_FORMAT",
+          "E book": "E_BOOK",
+          Paperback: "PAPERBACK",
+          Hardcover: "HARDCOVER",
+        },
         reference: null,
         embedded: null,
         nullable: false,
@@ -927,7 +937,12 @@ const parsed = [
         range: null,
         type: "string",
         arrayType: null,
-        enum: ["AudiobookFormat", "EBook", "Paperback", "Hardcover"],
+        enum: {
+          "Audiobook format": "AUDIOBOOK_FORMAT",
+          "E book": "E_BOOK",
+          Paperback: "PAPERBACK",
+          Hardcover: "HARDCOVER",
+        },
         reference: null,
         embedded: null,
         nullable: false,

src/openapi3/handleJson.ts

@@ -74,8 +74,17 @@ const buildResourceFromSchema = (
               (property.items as OpenAPIV3.SchemaObject).format
             )
           : null,
-      // Object.values is used because the array is annotated: it contains the __meta symbol used by jsonref.
-      enum: property.enum ? Object.values(property.enum) : null,
+      enum: property.enum
+        ? Object.fromEntries(
+            // Object.values is used because the array is annotated: it contains the __meta symbol used by jsonref.
+            Object.values<string | number>(property.enum).map((enumValue) => [
+              typeof enumValue === "string"
+                ? inflection.humanize(enumValue)
+                : enumValue,
+              enumValue,
+            ])
+          )
+        : null,
       reference: null,
       embedded: null,
       nullable: property.nullable || false,

src/swagger/handleJson.test.ts

@@ -329,7 +329,7 @@ const swaggerApiDefinition: OpenAPIV2.Document = {
         bookFormat: {
           type: "string",
           description: "The publication format of the book.",
-          enum: ["AudiobookFormat", "EBook", "Paperback", "Hardcover"],
+          enum: ["AUDIOBOOK_FORMAT", "E_BOOK", "PAPERBACK", "HARDCOVER"],
         },
         publicationDate: {
           description:
@@ -445,7 +445,12 @@ const parsed = [
         type: "string",
         reference: null,
         embedded: null,
-        enum: ["AudiobookFormat", "EBook", "Paperback", "Hardcover"],
+        enum: {
+          "Audiobook format": "AUDIOBOOK_FORMAT",
+          "E book": "E_BOOK",
+          Paperback: "PAPERBACK",
+          Hardcover: "HARDCOVER",
+        },
         required: true,
         description: "The publication format of the book.",
       },

src/swagger/handleJson.ts

@@ -60,7 +60,16 @@ export default function (
           get(property, "type", "") as string,
           get(property, "format", "") as string
         ),
-        enum: property.enum ?? null,
+        enum: property.enum
+          ? Object.fromEntries(
+              property.enum.map((enumValue: string | number) => [
+                typeof enumValue === "string"
+                  ? inflection.humanize(enumValue)
+                  : enumValue,
+                enumValue,
+              ])
+            )
+          : null,
         reference: null,
         embedded: null,
         required: !!requiredFields.find((value) => value === fieldName),