feat: support enum boolean union types (#76)

Author: Himenon

src/internal/OpenApiTools/Guard.ts

@@ -38,6 +38,10 @@ export const isPrimitiveSchema = (schema: OpenApi.Schema): schema is Types.Primi
   return true;
 };
 
+export const isBooleanArray = (list: any[]): list is boolean[] => {
+  return !list.some(item => typeof item !== "boolean");
+};
+
 export const isNumberArray = (list: any[]): list is number[] => {
   return !list.some(item => typeof item !== "number");
 };

src/internal/OpenApiTools/components/Schema.ts

@@ -149,6 +149,11 @@ export const generateTypeAlias = (
         type: schema.type,
         enum: schema.enum,
       });
+    } else if (schema.type === "boolean") {
+      type = factory.TypeNode.create({
+        type: schema.type,
+        enum: Guard.isBooleanArray(schema.enum) ? schema.enum : undefined,
+      });
     } else {
       type = factory.TypeNode.create({
         type: schema.type,

src/internal/OpenApiTools/toTypeNode.ts

@@ -186,9 +186,18 @@ export const convert: Convert = (
   }
   switch (schema.type) {
     case "boolean": {
-      const typeNode = factory.TypeNode.create({
-        type: "boolean",
-      });
+      const items = schema.enum;
+      let typeNode: ts.TypeNode;
+      if (items && Guard.isBooleanArray(items)) {
+        typeNode = factory.TypeNode.create({
+          type: schema.type,
+          enum: items,
+        });
+      } else {
+        typeNode = factory.TypeNode.create({
+          type: schema.type,
+        });
+      }
       return nullable(factory, typeNode, !!schema.nullable);
     }
     case "null": {

src/internal/TsGenerator/factory/TypeNode.ts

@@ -21,6 +21,7 @@ export interface NumberParams {
 
 export interface BooleanParams {
   type: "boolean";
+  enum?: boolean[];
 }
 
 export interface ObjectParams {
@@ -91,8 +92,14 @@ export const create = (context: Pick<ts.TransformationContext, "factory">): Fact
           });
         }
         return factory.createKeywordTypeNode(ts.SyntaxKind.NumberKeyword);
-      case "boolean":
+      case "boolean": {
+        if (params.enum) {
+          return unionTypeNode({
+            typeNodes: params.enum.map(value => literalTypeNode({ value })),
+          });
+        }
         return factory.createKeywordTypeNode(ts.SyntaxKind.BooleanKeyword);
+      }
       case "object":
         return factory.createTypeLiteralNode(params.value);
       case "undefined":

test/__tests__/__snapshots__/spit-code-test.ts.snap

@@ -262,6 +262,9 @@ export namespace Schemas {
     export type NumberDouble = number;
     /** Boolean Literal */
     export type BooleanType = boolean;
+    export type BooleanEnumType = true;
+    export type BooleanEnumType2 = false;
+    export type BooleanEnumType3 = true | false;
     export type ArrayStringType = string[];
     export type ArrayNumberType = number[];
     export type ArrayBooleanType = boolean[];

test/__tests__/__snapshots__/typedef-only-test.ts.snap

@@ -29,6 +29,9 @@ export namespace Schemas {
     export type NumberDouble = number;
     /** Boolean Literal */
     export type BooleanType = boolean;
+    export type BooleanEnumType = true;
+    export type BooleanEnumType2 = false;
+    export type BooleanEnumType3 = true | false;
     export type ArrayStringType = string[];
     export type ArrayNumberType = number[];
     export type ArrayBooleanType = boolean[];

test/__tests__/__snapshots__/typedef-with-template-test.ts.snap

@@ -29,6 +29,9 @@ export namespace Schemas {
     export type NumberDouble = number;
     /** Boolean Literal */
     export type BooleanType = boolean;
+    export type BooleanEnumType = true;
+    export type BooleanEnumType2 = false;
+    export type BooleanEnumType3 = true | false;
     export type ArrayStringType = string[];
     export type ArrayNumberType = number[];
     export type ArrayBooleanType = boolean[];
@@ -569,6 +572,9 @@ export namespace Schemas {
     export type NumberDouble = number;
     /** Boolean Literal */
     export type BooleanType = boolean;
+    export type BooleanEnumType = true;
+    export type BooleanEnumType2 = false;
+    export type BooleanEnumType3 = true | false;
     export type ArrayStringType = string[];
     export type ArrayNumberType = number[];
     export type ArrayBooleanType = boolean[];

test/api.test.domain/index.yml

@@ -68,6 +68,15 @@ components:
     BooleanType:
       type: boolean
       description: Boolean Literal
+    BooleanEnumType:
+      type: boolean
+      enum: [true]
+    BooleanEnumType2:
+      type: boolean
+      enum: [false]
+    BooleanEnumType3:
+      type: boolean
+      enum: [true, false]
     ArrayStringType:
       type: array
       items: