Add undefined in union support

nestjs · Apr 3, 2021 · 3c414c5 · 3c414c5
1 parent 265bce6
commit 3c414c5
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 4 deletions.
diff --git a/lib/plugin/utils/ast-utils.ts b/lib/plugin/utils/ast-utils.ts
@@ -80,6 +80,14 @@ export function isNull(type: Type) {
   }
 }
 
+export function isUndefined(type: Type) {
+  if (type.isUnion()) {
+    return Boolean(type.types.find((t) => hasFlag(t, TypeFlags.Undefined)));
+  } else {
+    return hasFlag(type, TypeFlags.Undefined);
+  }
+}
+
 export function hasFlag(type: Type, flag: TypeFlags) {
   return (type.flags & flag) === flag;
 }

diff --git a/lib/plugin/visitors/model-class.visitor.ts b/lib/plugin/visitors/model-class.visitor.ts
@@ -8,9 +8,9 @@ import {
   getDecoratorArguments,
   getMainCommentAndExamplesOfNode,
   getText,
-  hasFlag,
   isEnum,
-  isNull
+  isNull,
+  isUndefined
 } from '../utils/ast-utils';
 import {
   extractTypeArgumentIfArray,
@@ -147,7 +147,7 @@ export class ModelClassVisitor extends AbstractFileVisitor {
   ): ts.ObjectLiteralExpression {
     const type = typeChecker.getTypeAtLocation(node);
     const isRequired = !node.questionToken;
-    const isNullable = !!node.questionToken || isNull(type);
+    const isNullable = !!node.questionToken || isNull(type) || isUndefined(type);
 
     let properties = [
       ...existingProperties,

diff --git a/test/plugin/fixtures/nullable.dto.ts b/test/plugin/fixtures/nullable.dto.ts
@@ -4,12 +4,16 @@ export class NullableDto {
   stringValue: string | null;
   @ApiProperty()
   stringArr: string[] | null;
+  @ApiProperty()
+  optionalString?: string;
+  @ApiProperty()
+  undefinedString: string | undefined;
 }
 `;
 
 export const nullableDtoTextTranspiled = `export class NullableDto {
     static _OPENAPI_METADATA_FACTORY() {
-        return { stringValue: { required: true, nullable: true, type: () => String }, stringArr: { required: true, nullable: true, type: () => [String] } };
+        return { stringValue: { required: true, nullable: true, type: () => String }, stringArr: { required: true, nullable: true, type: () => [String] }, optionalString: { required: false, nullable: true, type: () => String }, undefinedString: { required: true, nullable: true, type: () => String } };
     }
 }
 __decorate([
@@ -18,4 +22,10 @@ __decorate([
 __decorate([
     ApiProperty()
 ], NullableDto.prototype, "stringArr", void 0);
+__decorate([
+    ApiProperty()
+], NullableDto.prototype, "optionalString", void 0);
+__decorate([
+    ApiProperty()
+], NullableDto.prototype, "undefinedString", void 0);
 `;