feat(api): add support for nested validations

apps/api/src/app/shared/commands/base.command.ts

@@ -3,6 +3,28 @@ import { validateSync } from 'class-validator';
 import { addBreadcrumb } from '@sentry/node';
 import { BadRequestException } from '@nestjs/common';
 
+interface IConstraint {
+  path: string[];
+  constraint: string[];
+}
+
+function extractConstraints(obj: any, path: string[] = []): IConstraint[] {
+  const constraints: IConstraint[] = [];
+
+  for (const key in obj) {
+    if (obj[key] && typeof obj[key] === 'object') {
+      const currentLocation = obj[key]?.property;
+      const newPath = [...path, currentLocation];
+      if (obj[key].constraints) {
+        constraints.push({ path: [...newPath, key], constraint: Object.values(obj[key].constraints) });
+      }
+      constraints.push(...extractConstraints(obj[key].children, newPath));
+    }
+  }
+
+  return constraints;
+}
+
 export abstract class BaseCommand {
   static create<T extends BaseCommand>(this: new (...args: unknown[]) => T, data: T): T {
     const convertedObject = plainToInstance<T, unknown>(this, {
@@ -11,13 +33,7 @@ export abstract class BaseCommand {
 
     const errors = validateSync(convertedObject as unknown as object);
     if (errors?.length) {
-      const mappedErrors = errors.flatMap((item) => {
-        if (!item.constraints) {
-          return [];
-        }
-
-        return Object.values(item.constraints);
-      });
+      const mappedErrors = extractConstraints(errors);
 
       if (mappedErrors.length > 0) {
         addBreadcrumb({

apps/api/src/app/workflows-v2/usecases/upsert-workflow/upsert-workflow.command.ts

@@ -1,8 +1,12 @@
 import { EnvironmentWithUserObjectCommand } from '@novu/application-generic';
 import { CreateWorkflowDto, IdentifierOrInternalId, UpdateWorkflowDto } from '@novu/shared';
+import { IsDefined, IsOptional, IsString } from 'class-validator';
 
 export class UpsertWorkflowCommand extends EnvironmentWithUserObjectCommand {
+  @IsOptional()
+  @IsString()
   identifierOrInternalId?: IdentifierOrInternalId;
 
+  @IsDefined()
   workflowDto: CreateWorkflowDto | UpdateWorkflowDto;
 }

apps/api/src/app/workflows-v2/usecases/upsert-workflow/upsert-workflow.usecase.ts

@@ -206,7 +206,7 @@ export class UpsertWorkflowUseCase {
       description: workflowDto.description || '',
       tags: workflowDto.tags || [],
       critical: false,
-      triggerIdentifier: slugifyName(workflowDto.name),
+      triggerIdentifier: slugifyName(workflowDto.workflowId),
     };
   }
 
@@ -229,7 +229,7 @@ export class UpsertWorkflowUseCase {
       description: workflowDto.description,
       tags: workflowDto.tags,
       active: workflowDto.active ?? true,
-      workflowId: workflowDto.workflowId,
+      workflowId: slugifyName(workflowDto.workflowId),
     };
   }
 

apps/api/src/main.ts

@@ -1,3 +1,5 @@
+import 'reflect-metadata';
+
 import { bootstrap } from './bootstrap';
 
 bootstrap();

packages/shared/src/dto/workflows/create-workflow-dto.ts

@@ -1,10 +1,19 @@
+import { Type } from 'class-transformer';
+import { IsEnum, IsNotEmpty, ValidateNested, IsDefined, IsOptional } from 'class-validator';
+
 import { PreferencesRequestDto, StepCreateDto, WorkflowCommonsFields } from './workflow-commons-fields';
 import { WorkflowCreationSourceEnum } from '../../types';
 
-export type CreateWorkflowDto = WorkflowCommonsFields & {
+export class CreateWorkflowDto extends WorkflowCommonsFields {
+  @ValidateNested({ each: true })
+  @Type(() => StepCreateDto)
+  @IsDefined()
   steps: StepCreateDto[];
 
+  @IsEnum(WorkflowCreationSourceEnum)
+  @IsNotEmpty()
   __source: WorkflowCreationSourceEnum;
 
+  @IsOptional()
   preferences?: PreferencesRequestDto;
-};
+}

packages/shared/src/dto/workflows/update-workflow-dto.ts

@@ -1,9 +1,21 @@
-import { PreferencesRequestDto, StepCreateDto, StepUpdateDto, WorkflowCommonsFields } from './workflow-commons-fields';
+import { IsDefined, ValidateNested } from 'class-validator';
+import { Type } from 'class-transformer';
 
-export type UpdateWorkflowDto = WorkflowCommonsFields & {
+import {
+  PreferencesRequestDto,
+  StepCreateDto,
+  StepDto,
+  StepUpdateDto,
+  WorkflowCommonsFields,
+} from './workflow-commons-fields';
+
+export class UpdateWorkflowDto extends WorkflowCommonsFields {
   updatedAt: string;
 
+  @Type(() => StepDto)
+  @ValidateNested({ each: true })
   steps: (StepCreateDto | StepUpdateDto)[];
 
+  @IsDefined()
   preferences: PreferencesRequestDto;
-};
+}

packages/shared/src/dto/workflows/workflow-commons-fields.ts

@@ -1,4 +1,4 @@
-import { IsArray, IsBoolean, IsDefined, IsObject, IsOptional, IsString } from 'class-validator';
+import { IsArray, IsBoolean, IsEnum, IsNotEmpty, IsObject, IsOptional, IsString } from 'class-validator';
 
 import { JSONSchema } from 'json-schema-to-ts';
 import { WorkflowResponseDto } from './workflow-response-dto';
@@ -10,18 +10,34 @@ export class ControlsSchema {
   schema: JSONSchema;
 }
 
+export class StepDto {
+  @IsString()
+  @IsNotEmpty()
+  name: string;
+
+  @IsEnum(StepTypeEnum)
+  @IsNotEmpty()
+  type: StepTypeEnum;
+
+  @IsObject()
+  @IsOptional()
+  controlValues?: Record<string, unknown>;
+}
+
 export type StepResponseDto = StepDto & {
   _id: string;
   slug: Slug;
   stepId: string;
   controls: ControlsSchema;
 };
 
-export type StepUpdateDto = StepDto & {
+export class StepUpdateDto extends StepDto {
+  @IsString()
+  @IsNotEmpty()
   _id: string;
-};
+}
 
-export type StepCreateDto = StepDto;
+export class StepCreateDto extends StepDto {}
 
 export type ListWorkflowResponse = {
   workflows: WorkflowListResponseDto[];
@@ -35,19 +51,6 @@ export type WorkflowListResponseDto = Pick<
   stepTypeOverviews: StepTypeEnum[];
 };
 
-export class StepDto {
-  @IsString()
-  @IsDefined()
-  name: string;
-
-  @IsString()
-  @IsDefined()
-  type: StepTypeEnum;
-
-  @IsObject()
-  controlValues: Record<string, unknown>;
-}
-
 export class WorkflowCommonsFields {
   @IsOptional()
   @IsArray()
@@ -59,11 +62,11 @@ export class WorkflowCommonsFields {
   active?: boolean;
 
   @IsString()
-  @IsDefined()
+  @IsNotEmpty()
   name: string;
 
   @IsString()
-  @IsDefined()
+  @IsNotEmpty()
   workflowId: string;
 
   @IsString()