feat: add actor to system variables

apps/api/src/app/events/dtos/trigger-event-request.dto.ts

@@ -112,6 +112,9 @@ export class TriggerEventRequestDto {
     ],
   })
   @IsOptional()
+  @ValidateIf((_, value) => typeof value !== 'string')
+  @ValidateNested()
+  @Type(() => SubscriberPayloadDto)
   actor?: TriggerRecipientSubscriber;
 
   @ApiProperty({

apps/api/src/app/events/dtos/trigger-event-to-all-request.dto.ts

@@ -58,6 +58,9 @@ export class TriggerEventToAllRequestDto {
     ],
   })
   @IsOptional()
+  @ValidateIf((_, value) => typeof value !== 'string')
+  @ValidateNested()
+  @Type(() => SubscriberPayloadDto)
   actor?: TriggerRecipientSubscriber;
 
   @ApiProperty({

apps/api/src/app/events/e2e/trigger-event.e2e.ts

@@ -1178,6 +1178,44 @@ describe(`Trigger event - ${eventTriggerPath} (POST)`, function () {
       expect(message!.subject).to.equal('Test email a subject nested');
     });
 
+    it('should trigger E-Mail notification with actor data', async function () {
+      const newSubscriberId = SubscriberRepository.createObjectId();
+      const channelType = ChannelTypeEnum.EMAIL;
+      const actorSubscriber = await subscriberService.createSubscriber({ firstName: 'Actor' });
+
+      template = await session.createTemplate({
+        steps: [
+          {
+            name: 'Message Name',
+            subject: 'Test email',
+            type: StepTypeEnum.EMAIL,
+            content: [
+              {
+                type: EmailBlockTypeEnum.TEXT,
+                content: 'Hello {{actor.firstName}}, Welcome to {{organizationName}}' as string,
+              },
+            ],
+          },
+        ],
+      });
+
+      await sendTrigger(session, template, newSubscriberId, {}, {}, '', actorSubscriber.subscriberId);
+
+      await session.awaitRunningJobs(template._id);
+
+      const createdSubscriber = await subscriberRepository.findBySubscriberId(session.environment._id, newSubscriberId);
+
+      const message = await messageRepository.findOne({
+        _environmentId: session.environment._id,
+        _subscriberId: createdSubscriber?._id,
+        channel: channelType,
+      });
+
+      const block = message!.content[0] as IEmailBlock;
+
+      expect(block.content).to.equal('Hello Actor, Welcome to Umbrella Corp');
+    });
+
     it('should not trigger notification with subscriber data if integration is inactive', async function () {
       const newSubscriberIdInAppNotification = SubscriberRepository.createObjectId();
       const channelType = ChannelTypeEnum.SMS;
@@ -2442,7 +2480,8 @@ export async function sendTrigger(
   newSubscriberIdInAppNotification: string,
   payload: Record<string, unknown> = {},
   overrides: Record<string, unknown> = {},
-  tenant?: string
+  tenant?: string,
+  actor?: string
 ): Promise<AxiosResponse> {
   return await axiosInstance.post(
     `${session.serverUrl}${eventTriggerPath}`,
@@ -2456,6 +2495,7 @@ export async function sendTrigger(
       },
       overrides,
       tenant,
+      actor,
     },
     {
       headers: {

apps/api/src/app/events/events.controller.ts

@@ -60,6 +60,7 @@ export class EventsController {
     @Body() body: TriggerEventRequestDto
   ): Promise<TriggerEventResponseDto> {
     const mappedTenant = body.tenant ? this.mapTenant(body.tenant) : null;
+    const mappedActor = body.actor ? this.mapActor(body.actor) : null;
 
     const result = await this.parseEventRequest.execute(
       ParseEventRequestCommand.create({
@@ -70,7 +71,7 @@ export class EventsController {
         payload: body.payload || {},
         overrides: body.overrides || {},
         to: body.to,
-        actor: body.actor,
+        actor: mappedActor,
         tenant: mappedTenant,
         transactionId: body.transactionId,
       })

apps/api/src/app/events/usecases/parse-event-request/parse-event-request.command.ts

@@ -22,6 +22,7 @@ export class ParseEventRequestCommand extends EnvironmentWithUserCommand {
   transactionId?: string;
 
   @IsOptional()
+  @ValidateNested()
   actor?: TriggerRecipientSubscriber | null;
 
   @IsOptional()

apps/api/src/app/events/usecases/process-bulk-trigger/process-bulk-trigger.usecase.ts

@@ -18,6 +18,7 @@ export class ProcessBulkTrigger {
     for (const event of command.events) {
       let result: TriggerEventResponseDto;
       const mappedTenant = event.tenant ? this.parseEventRequest.mapTenant(event.tenant) : null;
+      const mappedActor = event.actor ? this.mapTriggerRecipients.mapSubscriber(event.actor) : null;
 
       try {
         result = (await this.parseEventRequest.execute(
@@ -29,7 +30,7 @@ export class ProcessBulkTrigger {
             payload: event.payload,
             overrides: event.overrides || {},
             to: event.to,
-            actor: event.actor,
+            actor: mappedActor,
             tenant: mappedTenant,
             transactionId: event.transactionId,
           })

apps/web/src/components/execution-detail/ExecutionDetailTrigger.tsx

@@ -11,9 +11,12 @@ const TriggerTitle = styled(Text)`
 `;
 
 export const ExecutionDetailTrigger = ({ identifier, step, subscriberVariables }) => {
-  const { payload, overrides, tenant } = step || {};
+  const { payload, overrides, tenant, actorId } = step || {};
 
-  const curlSnippet = getCurlTriggerSnippet(identifier, subscriberVariables, payload, overrides, { tenant });
+  const curlSnippet = getCurlTriggerSnippet(identifier, subscriberVariables, payload, overrides, {
+    ...(tenant && { tenant }),
+    ...(actorId && { actor: { subscriberId: actorId } }),
+  });
 
   return (
     <>

apps/worker/src/app/workflow/usecases/send-message/send-message-chat.usecase.ts

@@ -8,6 +8,7 @@ import {
   IntegrationEntity,
   IChannelSettings,
   TenantRepository,
+  SubscriberEntity,
 } from '@novu/dal';
 import {
   ChannelTypeEnum,
@@ -75,6 +76,13 @@ export class SendMessageChat extends SendMessageBase {
     if (!chatChannel?.template) throw new PlatformException('Chat channel template not found');
 
     const tenant = await this.handleTenantExecution(command.job);
+    let actor: SubscriberEntity | null = null;
+    if (command.job.actorId) {
+      actor = await this.getSubscriberBySubscriberId({
+        subscriberId: command.job.actorId,
+        _environmentId: command.environmentId,
+      });
+    }
 
     let content = '';
     const data = {
@@ -85,6 +93,7 @@ export class SendMessageChat extends SendMessageBase {
         total_count: command.events?.length,
       },
       ...(tenant && { tenant }),
+      ...(actor && { actor }),
       ...command.payload,
     };
 

apps/worker/src/app/workflow/usecases/send-message/send-message-email.usecase.ts

@@ -8,6 +8,7 @@ import {
   MessageEntity,
   LayoutRepository,
   TenantRepository,
+  SubscriberEntity,
 } from '@novu/dal';
 import {
   ChannelTypeEnum,
@@ -135,6 +136,14 @@ export class SendMessageEmail extends SendMessageBase {
       return;
     }
 
+    let actor: SubscriberEntity | null = null;
+    if (command.job.actorId) {
+      actor = await this.getSubscriberBySubscriberId({
+        subscriberId: command.job.actorId,
+        _environmentId: command.environmentId,
+      });
+    }
+
     const [tenant, overrideLayoutId] = await Promise.all([
       this.handleTenantExecution(command.job),
       this.getOverrideLayoutId(command),
@@ -167,6 +176,7 @@ export class SendMessageEmail extends SendMessageBase {
           total_count: command.events?.length,
         },
         ...(tenant && { tenant }),
+        ...(actor && { actor }),
         subscriber,
       },
     };

apps/worker/src/app/workflow/usecases/send-message/send-message-in-app.usecase.ts

@@ -113,6 +113,14 @@ export class SendMessageInApp extends SendMessageBase {
 
     const { actor } = command.step.template;
 
+    let actorSubscriber: SubscriberEntity | null = null;
+    if (command.job.actorId) {
+      actorSubscriber = await this.getSubscriberBySubscriberId({
+        subscriberId: command.job.actorId,
+        _environmentId: command.environmentId,
+      });
+    }
+
     const [tenant, organization] = await Promise.all([
       this.handleTenantExecution(command.job),
       this.organizationRepository.findById(command.organizationId, 'branding'),
@@ -125,7 +133,8 @@ export class SendMessageInApp extends SendMessageBase {
         subscriber,
         command,
         organization,
-        tenant
+        tenant,
+        actorSubscriber
       );
 
       if (inAppChannel.template.cta?.data?.url) {
@@ -135,7 +144,8 @@ export class SendMessageInApp extends SendMessageBase {
           subscriber,
           command,
           organization,
-          tenant
+          tenant,
+          actorSubscriber
         );
       }
 
@@ -149,7 +159,8 @@ export class SendMessageInApp extends SendMessageBase {
             subscriber,
             command,
             organization,
-            tenant
+            tenant,
+            actorSubscriber
           );
           ctaButtons.push({ type: action.type, content: buttonContent });
         }
@@ -286,7 +297,8 @@ export class SendMessageInApp extends SendMessageBase {
     subscriber: SubscriberEntity,
     command: SendMessageCommand,
     organization: OrganizationEntity | null,
-    tenant: TenantEntity | null
+    tenant: TenantEntity | null,
+    actor: SubscriberEntity | null
   ): Promise<string> {
     return await this.compileTemplate.execute(
       CompileTemplateCommand.create({
@@ -303,6 +315,7 @@ export class SendMessageInApp extends SendMessageBase {
             color: organization?.branding?.color || '#f47373',
           },
           ...(tenant && { tenant }),
+          ...(actor && { actor }),
           ...payload,
         },
       })

apps/worker/src/app/workflow/usecases/send-message/send-message-push.usecase.ts

@@ -7,6 +7,7 @@ import {
   MessageEntity,
   IntegrationEntity,
   TenantRepository,
+  SubscriberEntity,
   JobEntity,
 } from '@novu/dal';
 import {
@@ -86,11 +87,19 @@ export class SendMessagePush extends SendMessageBase {
       total_count: command.events?.length,
     };
     const tenant = await this.handleTenantExecution(command.job);
+    let actor: SubscriberEntity | null = null;
+    if (command.job.actorId) {
+      actor = await this.getSubscriberBySubscriberId({
+        subscriberId: command.job.actorId,
+        _environmentId: command.environmentId,
+      });
+    }
 
     const data = {
       subscriber: subscriber,
       step: stepData,
       ...(tenant && { tenant }),
+      ...(actor && { actor }),
       ...command.payload,
     };
     let content = '';

apps/worker/src/app/workflow/usecases/send-message/send-message-sms.usecase.ts

@@ -7,6 +7,7 @@ import {
   MessageEntity,
   IntegrationEntity,
   TenantRepository,
+  SubscriberEntity,
 } from '@novu/dal';
 import { ChannelTypeEnum, LogCodeEnum, ExecutionDetailsSourceEnum, ExecutionDetailsStatusEnum } from '@novu/shared';
 import {
@@ -79,6 +80,13 @@ export class SendMessageSms extends SendMessageBase {
     const smsChannel: NotificationStepEntity = command.step;
     if (!smsChannel.template) throw new PlatformException(`Unexpected error: SMS template is missing`);
 
+    let actor: SubscriberEntity | null = null;
+    if (command.job.actorId) {
+      actor = await this.getSubscriberBySubscriberId({
+        subscriberId: command.job.actorId,
+        _environmentId: command.environmentId,
+      });
+    }
     const tenant = await this.handleTenantExecution(command.job);
 
     const payload = {
@@ -89,6 +97,7 @@ export class SendMessageSms extends SendMessageBase {
         total_count: command.events?.length,
       },
       ...(tenant && { tenant }),
+      ...(actor && { actor }),
       ...command.payload,
     };
 

libs/dal/src/repositories/job/job.entity.ts

@@ -40,6 +40,7 @@ export class JobEntity {
   };
   type?: StepTypeEnum;
   _actorId?: string;
+  actorId?: string;
 }
 
 export type JobDBModel = ChangePropsValueType<

libs/dal/src/repositories/job/job.schema.ts

@@ -123,6 +123,9 @@ const jobSchema = new Schema<JobDBModel>(
       type: Schema.Types.ObjectId,
       ref: 'Subscriber',
     },
+    actorId: {
+      type: Schema.Types.String,
+    },
     expireAt: Schema.Types.Date,
   },
   schemaOptions

libs/dal/src/repositories/notification/notification.repository.ts

@@ -110,7 +110,7 @@ export class NotificationRepository extends BaseRepository<
             $nin: [StepTypeEnum.TRIGGER],
           },
         },
-        select: 'createdAt digest payload overrides to tenant providerId step status type updatedAt',
+        select: 'createdAt digest payload overrides to tenant actorId providerId step status type updatedAt',
         populate: [
           {
             path: 'executionDetails',

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

@@ -38,7 +38,7 @@ export interface IMessageTemplate {
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-export const TemplateSystemVariables = ['subscriber', 'step', 'branding', 'tenant', 'preheader'];
+export const TemplateSystemVariables = ['subscriber', 'step', 'branding', 'tenant', 'preheader', 'actor'];
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
 export const SystemVariablesWithTypes = {
@@ -51,6 +51,15 @@ export const SystemVariablesWithTypes = {
     locale: 'string',
     subscriberId: 'string',
   },
+  actor: {
+    firstName: 'string',
+    lastName: 'string',
+    email: 'string',
+    phone: 'string',
+    avatar: 'string',
+    locale: 'string',
+    subscriberId: 'string',
+  },
   step: {
     digest: 'boolean',
     events: 'array',
@@ -67,9 +76,10 @@ export const SystemVariablesWithTypes = {
 };
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-export const TriggerReservedVariables = ['tenant'];
+export const TriggerReservedVariables = ['tenant', 'actor'];
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
 export const ReservedVariablesMap = {
   [TriggerContextTypeEnum.TENANT]: [{ name: 'identifier', type: TemplateVariableTypeEnum.STRING }],
+  [TriggerContextTypeEnum.ACTOR]: [{ name: 'subscriberId', type: TemplateVariableTypeEnum.STRING }],
 };

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

@@ -41,6 +41,7 @@ export interface INotificationTrigger {
 
 export enum TriggerContextTypeEnum {
   TENANT = 'tenant',
+  ACTOR = 'actor',
 }
 
 export interface ITriggerReservedVariable {