Nv 2405 workflows crud controller

apps/api/src/app.module.ts

@@ -31,6 +31,7 @@ import { TopicsModule } from './app/topics/topics.module';
 import { InboundParseModule } from './app/inbound-parse/inbound-parse.module';
 import { BlueprintModule } from './app/blueprint/blueprint.module';
 import { TenantModule } from './app/tenant/tenant.module';
+import { WorkflowsModule } from './app/workflows/workflows.module';
 
 const modules: Array<Type | DynamicModule | Promise<DynamicModule> | ForwardReference> = [
   InboundParseModule,
@@ -59,6 +60,7 @@ const modules: Array<Type | DynamicModule | Promise<DynamicModule> | ForwardRefe
   TopicsModule,
   BlueprintModule,
   TenantModule,
+  WorkflowsModule,
 ];
 
 const providers: Provider[] = [];

apps/api/src/app/notification-template/notification-template.controller.ts

@@ -43,7 +43,7 @@ import { CreateNotificationTemplateQuery } from './queries';
 @Controller('/notification-templates')
 @UseInterceptors(ClassSerializerInterceptor)
 @UseGuards(JwtAuthGuard)
-@ApiTags('Workflows')
+@ApiTags('Notification Templates')
 export class NotificationTemplateController {
   constructor(
     private getNotificationTemplatesUsecase: GetNotificationTemplates,
@@ -57,8 +57,9 @@ export class NotificationTemplateController {
   @Get('')
   @ApiResponse(NotificationTemplateResponse)
   @ApiOperation({
-    summary: 'Get workflows',
-    description: `Workflows were previously named notification templates`,
+    summary: 'Get Notification templates',
+    description: `Notification templates have been renamed to Workflows, Please use the new workflows controller`,
+    deprecated: true,
   })
   @ExternalApiAccessible()
   getNotificationTemplates(
@@ -79,8 +80,9 @@ export class NotificationTemplateController {
   @Put('/:templateId')
   @ApiResponse(NotificationTemplateResponse)
   @ApiOperation({
-    summary: 'Update workflow',
-    description: `Workflow was previously named notification template`,
+    summary: 'Update Notification template',
+    description: `Notification templates have been renamed to Workflows, Please use the new workflows controller`,
+    deprecated: true,
   })
   @ExternalApiAccessible()
   async updateTemplateById(
@@ -113,8 +115,9 @@ export class NotificationTemplateController {
     type: DataBooleanDto,
   })
   @ApiOperation({
-    summary: 'Delete workflow',
-    description: `Workflow was previously named notification template`,
+    summary: 'Delete Notification template',
+    description: `Notification templates have been renamed to Workflows, Please use the new workflows controller`,
+    deprecated: true,
   })
   @ExternalApiAccessible()
   deleteTemplateById(@UserSession() user: IJwtPayload, @Param('templateId') templateId: string): Promise<boolean> {
@@ -131,8 +134,9 @@ export class NotificationTemplateController {
   @Get('/:templateId')
   @ApiResponse(NotificationTemplateResponse)
   @ApiOperation({
-    summary: 'Get workflow',
-    description: `Workflow was previously named notification template`,
+    summary: 'Get Notification template',
+    description: `Notification templates have been renamed to Workflows, Please use the new workflows controller`,
+    deprecated: true,
   })
   @ExternalApiAccessible()
   getNotificationTemplateById(
@@ -154,8 +158,9 @@ export class NotificationTemplateController {
   @UseGuards(RootEnvironmentGuard)
   @ApiResponse(NotificationTemplateResponse, 201)
   @ApiOperation({
-    summary: 'Create workflow',
-    description: `Workflow was previously named notification template`,
+    summary: 'Create Notification template',
+    description: `Notification templates have been renamed to Workflows, Please use the new workflows controller`,
+    deprecated: true,
   })
   @Roles(MemberRoleEnum.ADMIN)
   createNotificationTemplates(
@@ -188,8 +193,9 @@ export class NotificationTemplateController {
   @Roles(MemberRoleEnum.ADMIN)
   @ApiResponse(NotificationTemplateResponse)
   @ApiOperation({
-    summary: 'Update workflow status',
-    description: `Workflow was previously named notification template`,
+    summary: 'Update Notification template status',
+    description: `Notification templates have been renamed to Workflows, Please use the new workflows controller`,
+    deprecated: true,
   })
   @ExternalApiAccessible()
   changeActiveStatus(

apps/api/src/app/notification-template/usecases/change-template-active-status/change-template-active-status.command.ts

@@ -1,6 +1,11 @@
 import { IsBoolean, IsDefined, IsMongoId } from 'class-validator';
 import { EnvironmentWithUserCommand } from '../../../shared/commands/project.command';
 
+/**
+ * DEPRECATED:
+ * This command is deprecated and will be removed in the future.
+ * Please use the ChangeWorkflowActiveStatusCommand instead.
+ */
 export class ChangeTemplateActiveStatusCommand extends EnvironmentWithUserCommand {
   @IsBoolean()
   @IsDefined()

apps/api/src/app/notification-template/usecases/change-template-active-status/change-template-active-status.usecase.ts

@@ -10,6 +10,11 @@ import {
 import { ChangeTemplateActiveStatusCommand } from './change-template-active-status.command';
 import { CreateChange, CreateChangeCommand } from '../../../change/usecases';
 
+/**
+ * DEPRECATED:
+ * This usecase is deprecated and will be removed in the future.
+ * Please use the ChangeWorkflowActiveStatus usecase instead.
+ */
 @Injectable()
 export class ChangeTemplateActiveStatus {
   constructor(

apps/api/src/app/notification-template/usecases/create-notification-template/create-notification-template.command.ts

@@ -15,12 +15,17 @@ import {
   IMessageAction,
   IPreferenceChannels,
   FilterParts,
-  INotificationTemplateStepMetadata,
+  IWorkflowStepMetadata,
 } from '@novu/shared';
 
 import { EnvironmentWithUserCommand } from '../../../shared/commands/project.command';
 import { MessageTemplate } from '../../../shared/dtos/message-template';
 
+/**
+ * DEPRECATED:
+ * This command is deprecated and will be removed in the future.
+ * Please use the CreateWorkflowCommand instead.
+ */
 export class CreateNotificationTemplateCommand extends EnvironmentWithUserCommand {
   @IsMongoId()
   @IsDefined()
@@ -112,7 +117,7 @@ export class NotificationStep {
   _id?: string;
 
   @IsOptional()
-  metadata?: INotificationTemplateStepMetadata;
+  metadata?: IWorkflowStepMetadata;
 }
 
 export class MessageFilter {

apps/api/src/app/notification-template/usecases/create-notification-template/create-notification-template.usecase.ts

@@ -18,6 +18,11 @@ import { CreateMessageTemplate, CreateMessageTemplateCommand } from '../../../me
 import { CreateChange, CreateChangeCommand } from '../../../change/usecases';
 import { ApiException } from '../../../shared/exceptions/api.exception';
 
+/**
+ * DEPRECATED:
+ * This usecase is deprecated and will be removed in the future.
+ * Please use the CreateWorkflow usecase instead.
+ */
 @Injectable()
 export class CreateNotificationTemplate {
   constructor(

apps/api/src/app/notification-template/usecases/delete-notification-template/delete-notification-template.usecase.ts

@@ -15,6 +15,11 @@ import { DeleteMessageTemplateCommand } from '../../../message-template/usecases
 import { DeleteMessageTemplate } from '../../../message-template/usecases/delete-message-template/delete-message-template.usecase';
 import { GetNotificationTemplateCommand } from '../get-notification-template/get-notification-template.command';
 
+/**
+ * DEPRECATED:
+ * This usecase is deprecated and will be removed in the future.
+ * Please use the DeleteWorkflow usecase instead.
+ */
 @Injectable()
 export class DeleteNotificationTemplate {
   constructor(

apps/api/src/app/notification-template/usecases/get-notification-template/get-notification-template.command.ts

@@ -1,6 +1,11 @@
 import { IsDefined, IsMongoId } from 'class-validator';
 import { EnvironmentWithUserCommand } from '../../../shared/commands/project.command';
 
+/**
+ * DEPRECATED:
+ * This command is deprecated and will be removed in the future.
+ * Please use the GetWorkflowCommand instead.
+ */
 export class GetNotificationTemplateCommand extends EnvironmentWithUserCommand {
   @IsDefined()
   @IsMongoId()

apps/api/src/app/notification-template/usecases/get-notification-template/get-notification-template.usecase.ts

@@ -2,6 +2,11 @@ import { Injectable, NotFoundException } from '@nestjs/common';
 import { NotificationTemplateEntity, NotificationTemplateRepository } from '@novu/dal';
 import { GetNotificationTemplateCommand } from './get-notification-template.command';
 
+/**
+ * DEPRECATED:
+ * This usecase is deprecated and will be removed in the future.
+ * Please use the GetWorkflow usecase instead.
+ */
 @Injectable()
 export class GetNotificationTemplate {
   constructor(private notificationTemplateRepository: NotificationTemplateRepository) {}

apps/api/src/app/notification-template/usecases/get-notification-templates/get-notification-templates.command.ts

@@ -2,6 +2,11 @@ import { IsNumber } from 'class-validator';
 
 import { EnvironmentWithUserCommand } from '../../../shared/commands/project.command';
 
+/**
+ * DEPRECATED:
+ * This command is deprecated and will be removed in the future.
+ * Please use the GetWorkflowsCommand instead.
+ */
 export class GetNotificationTemplatesCommand extends EnvironmentWithUserCommand {
   @IsNumber()
   page: number;

apps/api/src/app/notification-template/usecases/get-notification-templates/get-notification-templates.usecase.ts

@@ -2,6 +2,11 @@ import { Injectable } from '@nestjs/common';
 import { NotificationTemplateRepository } from '@novu/dal';
 import { GetNotificationTemplatesCommand } from './get-notification-templates.command';
 import { NotificationTemplatesResponseDto } from '../../dto/notification-templates.response.dto';
+/**
+ * DEPRECATED:
+ * This usecase is deprecated and will be removed in the future.
+ * Please use the GetWorkflows usecase instead.
+ */
 @Injectable()
 export class GetNotificationTemplates {
   constructor(private notificationTemplateRepository: NotificationTemplateRepository) {}

apps/api/src/app/notification-template/usecases/update-notification-template/update-notification-template.command.ts

@@ -4,6 +4,11 @@ import { IPreferenceChannels } from '@novu/shared';
 import { EnvironmentWithUserCommand } from '../../../shared/commands/project.command';
 import { NotificationStep } from '../create-notification-template';
 
+/**
+ * DEPRECATED:
+ * This command is deprecated and will be removed in the future.
+ * Please use the UpdateWorkflowCommand instead.
+ */
 export class UpdateNotificationTemplateCommand extends EnvironmentWithUserCommand {
   @IsDefined()
   @IsMongoId()

apps/api/src/app/notification-template/usecases/update-notification-template/update-notification-template.usecase.ts

@@ -30,6 +30,11 @@ import { NotificationStep } from '../create-notification-template';
 import { DeleteMessageTemplate } from '../../../message-template/usecases/delete-message-template/delete-message-template.usecase';
 import { DeleteMessageTemplateCommand } from '../../../message-template/usecases/delete-message-template/delete-message-template.command';
 
+/**
+ * DEPRECATED:
+ * This usecase is deprecated and will be removed in the future.
+ * Please use the UpdateWorkflow usecase instead.
+ */
 @Injectable()
 export class UpdateNotificationTemplate {
   constructor(

apps/api/src/app/shared/dtos/notification-step.ts

@@ -3,7 +3,7 @@ import {
   DigestUnitEnum,
   DigestTypeEnum,
   DelayTypeEnum,
-  INotificationTemplateStepMetadata,
+  IWorkflowStepMetadata,
   IDigestBaseMetadata,
   IDigestRegularMetadata,
   IDigestTimedMetadata,
@@ -148,7 +148,7 @@ export class NotificationStep {
       { $ref: getSchemaPath(DelayScheduledMetadata) },
     ],
   })
-  metadata?: INotificationTemplateStepMetadata;
+  metadata?: IWorkflowStepMetadata;
 
   @ApiPropertyOptional()
   replyCallback?: {

apps/api/src/app/workflows/dto/change-workflow-status-request.dto.ts

@@ -0,0 +1,9 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { IsBoolean, IsDefined } from 'class-validator';
+
+export class ChangeWorkflowStatusRequestDto {
+  @ApiProperty()
+  @IsDefined()
+  @IsBoolean()
+  active: boolean;
+}

apps/api/src/app/workflows/dto/create-workflow-request.dto.ts

@@ -0,0 +1,65 @@
+import { IsArray, IsBoolean, IsDefined, IsOptional, IsString, MaxLength, ValidateNested } from 'class-validator';
+import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
+import { ICreateNotificationTemplateDto, IPreferenceChannels } from '@novu/shared';
+
+import { PreferenceChannels } from '../../shared/dtos/preference-channels';
+import { NotificationStep } from '../../shared/dtos/notification-step';
+
+export class CreateWorkflowRequestDto implements ICreateNotificationTemplateDto {
+  @ApiProperty()
+  @IsString()
+  @IsDefined()
+  name: string;
+
+  @ApiProperty()
+  @IsString()
+  @IsDefined({
+    message: 'Notification group must be provided ',
+  })
+  notificationGroupId: string;
+
+  @ApiPropertyOptional()
+  @IsOptional()
+  @IsArray()
+  tags: string[];
+
+  @ApiPropertyOptional()
+  @IsString()
+  @IsOptional()
+  @MaxLength(100)
+  description: string;
+
+  @ApiProperty({
+    type: [NotificationStep],
+  })
+  @IsDefined()
+  @IsArray()
+  @ValidateNested()
+  steps: NotificationStep[];
+
+  @ApiPropertyOptional()
+  @IsBoolean()
+  @IsOptional()
+  active?: boolean;
+
+  @ApiPropertyOptional()
+  @IsBoolean()
+  @IsOptional()
+  draft?: boolean;
+
+  @ApiPropertyOptional()
+  @IsBoolean()
+  @IsOptional()
+  critical?: boolean;
+
+  @ApiPropertyOptional({
+    type: PreferenceChannels,
+  })
+  @IsOptional()
+  preferenceSettings?: IPreferenceChannels;
+
+  @ApiPropertyOptional()
+  @IsOptional()
+  @IsString()
+  blueprintId?: string;
+}

apps/api/src/app/workflows/dto/index.ts

@@ -0,0 +1,3 @@
+export * from './change-workflow-status-request.dto';
+export * from './create-workflow-request.dto';
+export * from './update-workflow-request.dto';

apps/api/src/app/workflows/dto/update-workflow-request.dto.ts

@@ -0,0 +1,50 @@
+import { IsArray, IsMongoId, IsOptional, IsString, MaxLength, ValidateNested } from 'class-validator';
+import { ICreateNotificationTemplateDto, IPreferenceChannels } from '@novu/shared';
+import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
+import { PreferenceChannels } from '../../shared/dtos/preference-channels';
+import { NotificationStep } from '../../shared/dtos/notification-step';
+
+export class UpdateWorkflowRequestDto implements ICreateNotificationTemplateDto {
+  @ApiProperty()
+  @IsString()
+  @IsOptional()
+  name: string;
+
+  @ApiPropertyOptional()
+  @IsArray()
+  @IsOptional()
+  tags: string[];
+
+  @ApiPropertyOptional()
+  @IsString()
+  @IsOptional()
+  @MaxLength(300)
+  description: string;
+
+  @ApiPropertyOptional()
+  @IsString()
+  @IsOptional()
+  identifier?: string;
+
+  @ApiPropertyOptional()
+  @IsArray()
+  @IsOptional()
+  @ValidateNested()
+  steps: NotificationStep[];
+
+  @ApiProperty()
+  @IsOptional()
+  @IsMongoId()
+  notificationGroupId: string;
+
+  @ApiPropertyOptional()
+  active?: boolean;
+
+  @ApiPropertyOptional()
+  critical?: boolean;
+
+  @ApiPropertyOptional({
+    type: PreferenceChannels,
+  })
+  preferenceSettings?: IPreferenceChannels;
+}