chore: used workflow shared interfaces

apps/api/src/app/shared/dtos/message-template.ts

@@ -58,4 +58,7 @@ export class MessageTemplate {
     type: ActorTypeEnum;
     data: string | null;
   };
+
+  @IsOptional()
+  _creatorId: string;
 }

apps/api/src/app/shared/helpers/content.service.ts

@@ -15,6 +15,7 @@ import {
 } from '@novu/shared';
 import Handlebars from 'handlebars';
 import { ApiException } from '../exceptions/api.exception';
+import { NotificationStep } from '../../workflows/usecases/create-notification-template';
 
 export class ContentService {
   replaceVariables(content: string, variables: { [key: string]: string }) {
@@ -41,7 +42,7 @@ export class ContentService {
     }
   }
 
-  extractMessageVariables(messages: INotificationTemplateStep[]): {
+  extractMessageVariables(messages: NotificationStep[]): {
     variables: IMustacheVariable[];
     reservedVariables: ITriggerReservedVariable[];
   } {
@@ -68,7 +69,7 @@ export class ContentService {
     };
   }
 
-  extractStepVariables(messages: INotificationTemplateStep[]): IMustacheVariable[] {
+  extractStepVariables(messages: NotificationStep[]): IMustacheVariable[] {
     const variables: IMustacheVariable[] = [];
 
     for (const message of messages) {
@@ -116,7 +117,7 @@ export class ContentService {
     return reservedVariables;
   }
 
-  extractSubscriberMessageVariables(messages: INotificationTemplateStep[]): string[] {
+  extractSubscriberMessageVariables(messages: NotificationStep[]): string[] {
     const variables: string[] = [];
 
     const hasSmsMessage = !!messages.find((i) => i.template?.type === StepTypeEnum.SMS);
@@ -132,7 +133,7 @@ export class ContentService {
     return Array.from(new Set(variables));
   }
 
-  private *messagesTextIterator(messages: INotificationTemplateStep[]): Generator<string> {
+  private *messagesTextIterator(messages: NotificationStep[]): Generator<string> {
     for (const message of messages) {
       if (!message.template) continue;
 

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

@@ -88,6 +88,10 @@ export class ChannelCTACommand {
 }
 
 export class NotificationStep {
+  @IsString()
+  @IsOptional()
+  _templateId?: string;
+
   @ValidateNested()
   @IsOptional()
   template?: MessageTemplate;

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

@@ -47,7 +47,7 @@ export class UpdateNotificationTemplateCommand extends EnvironmentWithUserComman
   @IsArray()
   @ValidateNested()
   @IsOptional()
-  steps?: Array<NotificationStep & { _templateId?: string }>;
+  steps?: NotificationStep[];
 
   @ValidateNested()
   @IsOptional()

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

@@ -340,7 +340,7 @@ export class UpdateNotificationTemplate {
     return notificationTemplate;
   }
 
-  private getRemovedSteps(existingSteps: NotificationStepEntity[], newSteps: INotificationTemplateStep[]) {
+  private getRemovedSteps(existingSteps: NotificationStepEntity[], newSteps: NotificationStep[]) {
     const existingStepsIds = existingSteps.map((i) => i._templateId);
     const newStepsIds = newSteps.map((i) => i._templateId);
 

apps/web/src/pages/templates/components/in-app-editor/InAppEditorBlock.tsx

@@ -6,6 +6,7 @@ import { useEffect, useState } from 'react';
 import { EmailCustomCodeEditor } from '../email-editor/EmailCustomCodeEditor';
 import { When } from '../../../../components/utils/When';
 import Handlebars from 'handlebars/dist/handlebars';
+import { IMessageAction } from '@novu/shared';
 
 export function InAppEditorBlock({
   control,
@@ -28,7 +29,7 @@ export function InAppEditorBlock({
   return (
     <Controller
       name={`steps.${index}.template.cta.action`}
-      defaultValue=""
+      defaultValue={{} as IMessageAction}
       data-test-id="in-app-content-form-item"
       control={control}
       render={({ field }) => {

apps/web/src/pages/templates/components/in-app-editor/preview/ActionBlockContainer.tsx

@@ -25,7 +25,7 @@ export function ActionBlockContainer({
   onRemoveTemplate: () => void;
   isButtonsTemplateSelected: boolean;
   onChange: (data: any) => void;
-  value: IMessageAction;
+  value: IMessageAction | undefined;
   readonly: boolean;
 }) {
   return (
@@ -45,7 +45,7 @@ export function ActionBlockContainer({
 }
 
 interface ISelectedButtonTemplateProps {
-  value: IMessageAction;
+  value?: IMessageAction;
   onRemoveTemplate: () => void;
   onChange: (actions: any) => void;
   readonly: boolean;

apps/web/src/pages/templates/components/in-app-editor/preview/InAppWidgetPreview.tsx

@@ -25,7 +25,7 @@ export function InAppWidgetPreview({
   readonly: boolean;
   preview?: boolean;
   children: JSX.Element;
-  value: IMessageAction;
+  value: IMessageAction | undefined;
   onChange: (data: any) => void;
   index: number;
   enableAvatar: boolean;

apps/web/src/pages/templates/components/templateToFormMappers.ts

@@ -53,7 +53,7 @@ const mapToInAppFormStep = (item: INotificationTemplateStep): IFormStep => ({
     cta: {
       data: item?.template?.cta?.data ?? { url: '' },
       type: ChannelCTATypeEnum.REDIRECT,
-      action: item?.template?.cta?.action ?? '',
+      ...(item?.template?.cta?.action ? { action: item?.template?.cta?.action } : {}),
     },
   },
 });

libs/dal/src/repositories/message-template/message-template.entity.ts

@@ -1,8 +1,13 @@
-import { StepTypeEnum, IMessageCTA, IActor } from '@novu/shared';
+import {
+  StepTypeEnum,
+  IMessageCTA,
+  IActor,
+  EnvironmentId,
+  OrganizationId,
+  MessageTemplateContentType,
+} from '@novu/shared';
 
 import { IEmailBlock, ITemplateVariable } from './types';
-import type { OrganizationId } from '../organization';
-import type { EnvironmentId } from '../environment';
 import type { ChangePropsValueType } from '../../types/helpers';
 
 export class MessageTemplateEntity {
@@ -15,15 +20,15 @@ export class MessageTemplateEntity {
   _creatorId: string;
 
   // TODO: Due a circular dependency I can't import LayoutId from Layout.
-  _layoutId: string | null;
+  _layoutId?: string;
 
   type: StepTypeEnum;
 
   variables?: ITemplateVariable[];
 
   content: string | IEmailBlock[];
 
-  contentType?: 'editor' | 'customHtml';
+  contentType?: MessageTemplateContentType;
 
   active?: boolean;
 

libs/dal/src/repositories/notification-template/notification-template.entity.ts

@@ -8,6 +8,11 @@ import {
   TemplateVariableTypeEnum,
   NotificationTemplateCustomData,
   TriggerContextTypeEnum,
+  INotificationTemplate,
+  INotificationTemplateStep,
+  IStepVariant,
+  INotificationTrigger,
+  TriggerTypeEnum,
 } from '@novu/shared';
 
 import { MessageTemplateEntity } from '../message-template';
@@ -16,7 +21,7 @@ import type { OrganizationId } from '../organization';
 import type { EnvironmentId } from '../environment';
 import type { ChangePropsValueType } from '../../types';
 
-export class NotificationTemplateEntity {
+export class NotificationTemplateEntity implements INotificationTemplate {
   _id: string;
 
   name: string;
@@ -73,8 +78,8 @@ export type NotificationTemplateDBModel = ChangePropsValueType<
   _parentId?: Types.ObjectId;
 };
 
-export class NotificationTriggerEntity {
-  type: 'event';
+export class NotificationTriggerEntity implements INotificationTrigger {
+  type: TriggerTypeEnum;
 
   identifier: string;
 
@@ -85,7 +90,7 @@ export class NotificationTriggerEntity {
   reservedVariables?: ITriggerReservedVariable[];
 }
 
-export class StepVariantEntity {
+export class StepVariantEntity implements IStepVariant {
   _id?: string;
 
   uuid?: string;
@@ -112,7 +117,7 @@ export class StepVariantEntity {
   shouldStopOnFail?: boolean;
 }
 
-export class NotificationStepEntity extends StepVariantEntity {
+export class NotificationStepEntity extends StepVariantEntity implements INotificationTemplateStep {
   variants?: StepVariantEntity[];
 }
 

libs/shared/src/entities/message-template/message-template.interface.ts

@@ -1,17 +1,25 @@
 import {
-  ActorTypeEnum,
   ChannelCTATypeEnum,
+  EnvironmentId,
   IEmailBlock,
   ITemplateVariable,
+  OrganizationId,
   StepTypeEnum,
   TemplateVariableTypeEnum,
 } from '../../types';
 import { TriggerContextTypeEnum } from '../notification-template';
+import { IActor } from '../messages';
 
 export type MessageTemplateContentType = 'editor' | 'customHtml';
 
 export interface IMessageTemplate {
   _id?: string;
+  _environmentId?: EnvironmentId;
+  _organizationId?: OrganizationId;
+  _creatorId?: string;
+  _feedId?: string;
+  _layoutId?: string;
+  _parentId?: string;
   subject?: string;
   name?: string;
   title?: string;
@@ -21,20 +29,16 @@ export interface IMessageTemplate {
   variables?: ITemplateVariable[];
   cta?: {
     type: ChannelCTATypeEnum;
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    data: any;
+    data: {
+      url?: string;
+    };
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     action?: any;
   };
-  _feedId?: string;
-  _layoutId?: string;
   active?: boolean;
   preheader?: string;
   senderName?: string;
-  actor?: {
-    type: ActorTypeEnum;
-    data: string | null;
-  };
+  actor?: IActor;
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention

libs/shared/src/entities/messages/messages.interface.ts

@@ -19,7 +19,7 @@ export interface IMessage {
   lastSeenDate: string;
   lastReadDate: string;
   createdAt: string;
-  cta: IMessageCTA;
+  cta?: IMessageCTA;
   _feedId: string;
   _layoutId?: string;
   payload: Record<string, unknown>;

libs/shared/src/entities/notification-template/notification-template.interface.ts

@@ -54,7 +54,7 @@ export interface INotificationTriggerVariable {
   type?: TemplateVariableTypeEnum;
 }
 
-export interface INotificationTemplateStep {
+export interface IStepVariant {
   _id?: string;
   uuid?: string;
   name?: string;
@@ -71,6 +71,10 @@ export interface INotificationTemplateStep {
   metadata?: IWorkflowStepMetadata;
 }
 
+export interface INotificationTemplateStep extends IStepVariant {
+  variants?: IStepVariant[];
+}
+
 export interface IMessageFilter {
   isNegated?: boolean;
   type?: BuilderFieldType;