generate-layout-preview-response.dto.ts

import { ApiExtraModels, ApiProperty, ApiPropertyOptional, getSchemaPath, type ApiPropertyOptions } from '@nestjs/swagger';
import { ChannelTypeEnum } from '@novu/shared';
import { Type } from 'class-transformer';
import { IsOptional, IsString, ValidateNested } from 'class-validator';

import { LayoutPreviewPayloadDto } from './layout-preview-payload.dto';

export class EmailLayoutRenderOutput {
  @ApiProperty({ description: 'Content of the email' })
  @IsString()
  body: string;
}

@ApiExtraModels(EmailLayoutRenderOutput)
export class GenerateLayoutPreviewResponseDto {
  @ApiProperty({
    description: 'Preview payload example',
    type: () => LayoutPreviewPayloadDto,
  })
  @ValidateNested()
  @Type(() => LayoutPreviewPayloadDto)
  previewPayloadExample: LayoutPreviewPayloadDto;

  @ApiPropertyOptional({
    description: 'The payload schema that was used to generate the preview payload example',
    type: Object,
    nullable: true,
    additionalProperties: true,
  })
  @IsOptional()
  schema?: any | null;

  @ApiProperty({
    description: 'Preview result',
    type: Object,
    oneOf: [
      {
        properties: {
          type: { enum: [ChannelTypeEnum.EMAIL] },
          preview: { $ref: getSchemaPath(EmailLayoutRenderOutput) },
        },
      },
    ],
  } as ApiPropertyOptions)
  result: {
    type: ChannelTypeEnum.EMAIL;
    preview?: EmailLayoutRenderOutput;
  };
}