updated IsSwaggerEnum decorator for optional fields

src/request/dto/create-request.dto.ts

@@ -96,6 +96,7 @@ export class RequestStatusDto {
 export class RequestFilterDto {
   // Optional status filter, validate that it's a valid enum value.
   @IsOptional()
+  @IsSwaggerEnum(RequestStatusEnum, { isOptional: true })
   @IsEnum(RequestStatusEnum, { each: true })
   status?: RequestStatusEnum;
 
@@ -116,6 +117,7 @@ export class RequestFilterDto {
 
   // Optional request type filter, validate that it's a valid enum value.
   @IsOptional()
+  @IsSwaggerEnum(RequestTypeEnum, { isOptional: true })
   @IsEnum(RequestTypeEnum, { each: true })
   type?: RequestTypeEnum;
 }

src/request/dto/response-request.dto.ts

@@ -1,11 +1,14 @@
-import { RequestStatusEnum, RequestTypeEnum } from '../enum/request.enum';
+import { RequestStatusEnum, RequestTypeEnum } from '@prisma/client';
+import { IsSwaggerEnum } from 'src/utils/decorator/decorators';
 
 export class ResponseRequestDto {
   readonly requestId: number;
   readonly userId: number;
   readonly title: string;
+  @IsSwaggerEnum(RequestTypeEnum)
   readonly type: RequestTypeEnum;
   readonly description: string;
+  @IsSwaggerEnum(RequestStatusEnum)
   readonly status: RequestStatusEnum;
   readonly requestContent: object;
   readonly responseContent: object;

src/settlement/dto/create-settlement.dto.ts

@@ -76,11 +76,13 @@ export class CreateSettlementDto {
 export class SettlementFilterDto {
   // Optional settlement status filter, validated that it's valid SettlementStatusEnum value
   @IsOptional()
+  @IsSwaggerEnum(SettlementStatusEnum, { isOptional: true })
   @IsEnum(SettlementStatusEnum, { each: true })
   requestStatus?: SettlementStatusEnum;
 
   // Optional third party status filter, validate that it's valid thirdPartyResponseStatusEnum value
   @IsOptional()
+  @IsSwaggerEnum(thirdPartyResponseStatusEnum, { isOptional: true })
   @IsEnum(thirdPartyResponseStatusEnum, { each: true })
   thirdPartyResponseStatus?: thirdPartyResponseStatusEnum;
 

src/settlement/dto/response-settlement.dto.ts

@@ -1,15 +1,18 @@
 import {
   SettlementStatusEnum,
   thirdPartyResponseStatusEnum,
-} from '../enum/settlement.enum';
+} from '@prisma/client';
+import { IsSwaggerEnum } from 'src/utils/decorator/decorators';
 
 export class ResponseSettlementDto {
   readonly SettlementId: number;
   readonly requestId: number;
   readonly userId: number;
   readonly adminId: number;
+  @IsSwaggerEnum(thirdPartyResponseStatusEnum)
   readonly type: thirdPartyResponseStatusEnum;
   readonly transactionId: number;
+  @IsSwaggerEnum(SettlementStatusEnum)
   readonly requestStatus: SettlementStatusEnum;
   readonly createdAt: Date;
   readonly updatedAt: Date;

src/utils/decorator/decorators.ts

@@ -1,13 +1,39 @@
-import { ApiProperty } from '@nestjs/swagger';
+import { ApiProperty, ApiPropertyOptions } from '@nestjs/swagger';
 
-// eslint-disable-next-line @typescript-eslint/ban-types
-export function IsSwaggerEnum(enumObject: Record<string, string>): Function {
+// Decorator to document enum properties in Swagger
+// @param enumObject: The enum object to document
+// @param options: An object with options for the decorator (including isOptional)
+export function IsSwaggerEnum(
+  enumObject: Record<string, string>,
+  options: {
+    isOptional?: boolean;
+    apiPropertyOptions?: ApiPropertyOptions; // Additional decorator options for ApiProperty
+  } = {},
+) {
   return (target: any, propertyKey: string) => {
+    const { isOptional = false, apiPropertyOptions = {} } = options; // Destructure options
+
+    // Get the enum values from the provided enumObject
     const values = Object.values(enumObject);
-    ApiProperty({
-      type: enumObject,
-      enum: values,
-      example: values.join(' || '), // Set an example enum value for documentation purposes
-    })(target, propertyKey);
+
+    // Create decorator options for ApiProperty
+    const decoratorOptions = {
+      type: enumObject, // Use the cloned enumObject
+      enum: values, // Specify the enum values
+      ...apiPropertyOptions, // Merge additional ApiProperty options
+    };
+
+    // If the property is not optional, add the example property
+    if (!isOptional) {
+      decoratorOptions.example = values.join(' || '); // Set an example enum value for documentation purposes
+    }
+
+    // If the property is optional, mark it as such in Swagger documentation
+    if (isOptional) {
+      decoratorOptions['required'] = false;
+    }
+
+    // Apply the ApiProperty decorator with the specified options to the property
+    ApiProperty(decoratorOptions)(target, propertyKey);
   };
 }