fix(plugin): fix boolean field marked as object (strict) nestjs#814

minenkom · Jun 22, 2020 · b1059a7 · b1059a7
1 parent 358692d
commit b1059a7
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 2 deletions.
diff --git a/lib/plugin/utils/plugin-utils.ts b/lib/plugin/utils/plugin-utils.ts
@@ -67,6 +67,9 @@ export function getTypeReferenceAsString(
     if (text === Date.name) {
       return text;
     }
+    if (isOptionalBoolean(text)) {
+      return Boolean.name;
+    }
     if (
       isAutoGeneratedTypeUnion(type) ||
       isAutoGeneratedEnumUnion(type, typeChecker)
@@ -241,3 +244,11 @@ export function extractTypeArgumentIfArray(type: ts.Type) {
     isArray: false
   };
 }
+
+/**
+ * when "strict" mode enabled, TypeScript transform optional boolean properties to "boolean | undefined"
+ * @param text
+ */
+function isOptionalBoolean(text: string) {
+  return typeof text === 'string' && text === 'boolean | undefined';
+}
diff --git a/test/plugin/fixtures/create-cat.dto.ts b/test/plugin/fixtures/create-cat.dto.ts
@@ -31,7 +31,7 @@ export class CreateCatDto {
   readonly breed?: string;
 
   nodes: Node[];
-
+  optionalBoolean?: boolean;
   date: Date;
 
   @ApiHideProperty()
@@ -58,7 +58,7 @@ let CreateCatDto = /** @class */ (() => {
             this.status = Status.ENABLED;
         }
         static _OPENAPI_METADATA_FACTORY() {
-            return { name: { required: true, type: () => String }, age: { required: true, type: () => Number, default: 3, minimum: 0, maximum: 10 }, tags: { required: true, type: () => [String] }, status: { required: true, default: Status.ENABLED, enum: Status }, status2: { required: false, enum: Status }, statusArr: { required: false, enum: Status, isArray: true }, oneValueEnum: { required: false, enum: OneValueEnum }, oneValueEnumArr: { required: false, enum: OneValueEnum }, breed: { required: false, type: () => String }, nodes: { required: true, type: () => [Object] }, date: { required: true, type: () => Date } };
+            return { name: { required: true, type: () => String }, age: { required: true, type: () => Number, default: 3, minimum: 0, maximum: 10 }, tags: { required: true, type: () => [String] }, status: { required: true, default: Status.ENABLED, enum: Status }, status2: { required: false, enum: Status }, statusArr: { required: false, enum: Status, isArray: true }, oneValueEnum: { required: false, enum: OneValueEnum }, oneValueEnumArr: { required: false, enum: OneValueEnum }, breed: { required: false, type: () => String }, nodes: { required: true, type: () => [Object] }, optionalBoolean: { required: false, type: () => Boolean }, date: { required: true, type: () => Date } };
         }
     }
     __decorate([