feat(api): add preferences entity and schema (#6396)

apps/api/src/app.module.ts

@@ -42,6 +42,7 @@ import { ProductFeatureInterceptor } from './app/shared/interceptors/product-fea
 import { AnalyticsModule } from './app/analytics/analytics.module';
 import { InboxModule } from './app/inbox/inbox.module';
 import { BridgeModule } from './app/bridge/bridge.module';
+import { PreferencesModule } from './app/preferences';
 
 const enterpriseImports = (): Array<Type | DynamicModule | Promise<DynamicModule> | ForwardReference> => {
   const modules: Array<Type | DynamicModule | Promise<DynamicModule> | ForwardReference> = [];
@@ -101,6 +102,7 @@ const baseModules: Array<Type | DynamicModule | Promise<DynamicModule> | Forward
   ProfilingModule.register(packageJson.name),
   TracingModule.register(packageJson.name, packageJson.version),
   BridgeModule,
+  PreferencesModule,
 ];
 
 const enterpriseModules = enterpriseImports();

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

@@ -16,10 +16,10 @@ import {
 
 import { UserSessionData, ControlVariablesLevelEnum, WorkflowTypeEnum } from '@novu/shared';
 import { AnalyticsService, ExternalApiAccessible, UserAuthGuard, UserSession } from '@novu/application-generic';
-
 import { EnvironmentRepository, NotificationTemplateRepository, ControlVariablesRepository } from '@novu/dal';
 
 import { ApiExcludeController } from '@nestjs/swagger';
+
 import { StoreControlVariables, StoreControlVariablesCommand } from './usecases/store-control-variables';
 import { PreviewStep, PreviewStepCommand } from './usecases/preview-step';
 import { SyncCommand } from './usecases/sync';

apps/api/src/app/bridge/bridge.module.ts

@@ -1,5 +1,4 @@
 import { MiddlewareConsumer, Module, NestModule } from '@nestjs/common';
-
 import {
   CreateChange,
   CreateMessageTemplate,
@@ -8,11 +7,12 @@ import {
   UpdateChange,
   UpdateMessageTemplate,
   UpdateWorkflow,
+  UpsertPreferences,
 } from '@novu/application-generic';
-
+import { PreferencesRepository } from '@novu/dal';
+import { SharedModule } from '../shared/shared.module';
 import { BridgeController } from './bridge.controller';
 import { USECASES } from './usecases';
-import { SharedModule } from '../shared/shared.module';
 
 const PROVIDERS = [
   CreateWorkflow,
@@ -22,6 +22,8 @@ const PROVIDERS = [
   DeleteMessageTemplate,
   CreateChange,
   UpdateChange,
+  PreferencesRepository,
+  UpsertPreferences,
 ];
 
 @Module({

apps/api/src/app/bridge/usecases/sync/sync.usecase.ts

@@ -5,6 +5,7 @@ import {
   EnvironmentRepository,
   NotificationGroupRepository,
   NotificationTemplateEntity,
+  PreferencesActorEnum,
 } from '@novu/dal';
 import {
   AnalyticsService,
@@ -14,6 +15,8 @@ import {
   UpdateWorkflow,
   UpdateWorkflowCommand,
   ExecuteBridgeRequest,
+  UpsertPreferences,
+  UpsertWorkflowPreferencesCommand,
 } from '@novu/application-generic';
 import { WorkflowTypeEnum } from '@novu/shared';
 import { DiscoverOutput, DiscoverStepOutput, DiscoverWorkflowOutput, GetActionEnum } from '@novu/framework';
@@ -32,7 +35,8 @@ export class Sync {
     private notificationGroupRepository: NotificationGroupRepository,
     private environmentRepository: EnvironmentRepository,
     private executeBridgeRequest: ExecuteBridgeRequest,
-    private analyticsService: AnalyticsService
+    private analyticsService: AnalyticsService,
+    private upsertPreferences: UpsertPreferences
   ) {}
   async execute(command: SyncCommand): Promise<CreateBridgeResponseDto> {
     const environment = await this.environmentRepository.findOne({ _id: command.environmentId });
@@ -126,8 +130,10 @@ export class Sync {
           workflow.workflowId
         );
 
+        let savedWorkflow: NotificationTemplateEntity | undefined;
+
         if (workflowExist) {
-          return await this.updateWorkflowUsecase.execute(
+          savedWorkflow = await this.updateWorkflowUsecase.execute(
             UpdateWorkflowCommand.create({
               id: workflowExist._id,
               environmentId: command.environmentId,
@@ -165,7 +171,7 @@ export class Sync {
           }
           const isWorkflowActive = this.castToAnyNotSupportedParam(workflow.options)?.active ?? true;
 
-          return this.createWorkflowUsecase.execute(
+          savedWorkflow = await this.createWorkflowUsecase.execute(
             CreateWorkflowCommand.create({
               notificationGroupId,
               draft: !isWorkflowActive,
@@ -197,6 +203,17 @@ export class Sync {
             })
           );
         }
+
+        await this.upsertPreferences.upsertWorkflowPreferences(
+          UpsertWorkflowPreferencesCommand.create({
+            environmentId: savedWorkflow._environmentId,
+            organizationId: savedWorkflow._organizationId,
+            templateId: savedWorkflow._id,
+            preferences: workflow.preferences,
+          })
+        );
+
+        return savedWorkflow;
       })
     );
   }

apps/api/src/app/inbox/inbox.module.ts

@@ -1,14 +1,14 @@
 import { Module } from '@nestjs/common';
-
-import { USE_CASES } from './usecases';
-import { InboxController } from './inbox.controller';
-import { SharedModule } from '../shared/shared.module';
 import { AuthModule } from '../auth/auth.module';
-import { SubscribersModule } from '../subscribers/subscribers.module';
 import { IntegrationModule } from '../integrations/integrations.module';
+import { SharedModule } from '../shared/shared.module';
+import { SubscribersModule } from '../subscribers/subscribers.module';
+import { InboxController } from './inbox.controller';
+import { USE_CASES } from './usecases';
+import { PreferencesModule } from '../preferences';
 
 @Module({
-  imports: [SharedModule, SubscribersModule, AuthModule, IntegrationModule],
+  imports: [SharedModule, SubscribersModule, AuthModule, IntegrationModule, PreferencesModule],
   providers: [...USE_CASES],
   exports: [...USE_CASES],
   controllers: [InboxController],

apps/api/src/app/inbox/usecases/update-preferences/update-preferences.usecase.ts

@@ -5,6 +5,9 @@ import {
   GetSubscriberGlobalPreferenceCommand,
   GetSubscriberTemplatePreference,
   GetSubscriberTemplatePreferenceCommand,
+  UpsertPreferences,
+  UpsertSubscriberWorkflowPreferencesCommand,
+  UpsertSubscriberGlobalPreferencesCommand,
 } from '@novu/application-generic';
 import {
   ChannelTypeEnum,
@@ -15,11 +18,14 @@ import {
   SubscriberPreferenceRepository,
   SubscriberRepository,
 } from '@novu/dal';
+import { IPreferenceChannels } from '@novu/shared';
 import { ApiException } from '../../../shared/exceptions/api.exception';
 import { AnalyticsEventsEnum } from '../../utils';
 import { InboxPreference } from '../../utils/types';
 import { UpdatePreferencesCommand } from './update-preferences.command';
 
+const PREFERENCE_DEFAULT_VALUE = true;
+
 @Injectable()
 export class UpdatePreferences {
   constructor(
@@ -28,7 +34,8 @@ export class UpdatePreferences {
     private subscriberRepository: SubscriberRepository,
     private analyticsService: AnalyticsService,
     private getSubscriberGlobalPreference: GetSubscriberGlobalPreference,
-    private getSubscriberTemplatePreferenceUsecase: GetSubscriberTemplatePreference
+    private getSubscriberTemplatePreferenceUsecase: GetSubscriberTemplatePreference,
+    private upsertPreferences: UpsertPreferences
   ) {}
 
   async execute(command: UpdatePreferencesCommand): Promise<InboxPreference> {
@@ -133,6 +140,15 @@ export class UpdatePreferences {
         })
       );
 
+      await this.storePreferences({
+        enabled: preference.enabled,
+        channels: preference.channels,
+        organizationId: command.organizationId,
+        environmentId: command.environmentId,
+        subscriberId: command.subscriberId,
+        templateId: workflow._id,
+      });
+
       return {
         level: PreferenceLevelEnum.TEMPLATE,
         enabled: preference.enabled,
@@ -155,6 +171,14 @@ export class UpdatePreferences {
       })
     );
 
+    await this.storePreferences({
+      enabled: preference.enabled,
+      channels: preference.channels,
+      organizationId: command.organizationId,
+      environmentId: command.environmentId,
+      subscriberId: command.subscriberId,
+    });
+
     return {
       level: PreferenceLevelEnum.GLOBAL,
       enabled: preference.enabled,
@@ -171,4 +195,63 @@ export class UpdatePreferences {
       ...(command.level === PreferenceLevelEnum.TEMPLATE && command.workflowId && { _templateId: command.workflowId }),
     };
   }
+
+  private async storePreferences(item: {
+    enabled: boolean;
+    channels: IPreferenceChannels;
+    organizationId: string;
+    subscriberId: string;
+    environmentId: string;
+    templateId?: string;
+  }) {
+    const preferences = {
+      workflow: {
+        defaultValue: item.enabled || PREFERENCE_DEFAULT_VALUE,
+        readOnly: false,
+      },
+      channels: {
+        in_app: {
+          defaultValue: item.channels.in_app || PREFERENCE_DEFAULT_VALUE,
+          readOnly: false,
+        },
+        sms: {
+          defaultValue: item.channels.sms || PREFERENCE_DEFAULT_VALUE,
+          readOnly: false,
+        },
+        email: {
+          defaultValue: item.channels.email || PREFERENCE_DEFAULT_VALUE,
+          readOnly: false,
+        },
+        push: {
+          defaultValue: item.channels.push || PREFERENCE_DEFAULT_VALUE,
+          readOnly: false,
+        },
+        chat: {
+          defaultValue: item.channels.chat || PREFERENCE_DEFAULT_VALUE,
+          readOnly: false,
+        },
+      },
+    };
+
+    if (item.templateId) {
+      return await this.upsertPreferences.upsertSubscriberWorkflowPreferences(
+        UpsertSubscriberWorkflowPreferencesCommand.create({
+          environmentId: item.environmentId,
+          organizationId: item.organizationId,
+          subscriberId: item.subscriberId,
+          templateId: item.templateId,
+          preferences,
+        })
+      );
+    }
+
+    return await this.upsertPreferences.upsertSubscriberGlobalPreferences(
+      UpsertSubscriberGlobalPreferencesCommand.create({
+        preferences,
+        environmentId: item.environmentId,
+        organizationId: item.organizationId,
+        subscriberId: item.subscriberId,
+      })
+    );
+  }
 }

apps/api/src/app/preferences/dtos/preferences.dto.ts

@@ -0,0 +1,43 @@
+import { ChannelTypeEnum } from '@novu/shared';
+import { Type } from 'class-transformer';
+import { IsBoolean, ValidateNested } from 'class-validator';
+
+export class Preference {
+  @IsBoolean()
+  defaultValue: boolean;
+
+  @IsBoolean()
+  readOnly: boolean;
+}
+
+export class Channels {
+  @ValidateNested({ each: true })
+  @Type(() => Preference)
+  [ChannelTypeEnum.IN_APP]: Preference;
+
+  @ValidateNested({ each: true })
+  @Type(() => Preference)
+  [ChannelTypeEnum.EMAIL]: Preference;
+
+  @ValidateNested({ each: true })
+  @Type(() => Preference)
+  [ChannelTypeEnum.SMS]: Preference;
+
+  @ValidateNested({ each: true })
+  @Type(() => Preference)
+  [ChannelTypeEnum.CHAT]: Preference;
+
+  @ValidateNested({ each: true })
+  @Type(() => Preference)
+  [ChannelTypeEnum.PUSH]: Preference;
+}
+
+export class PreferencesDto {
+  @ValidateNested({ each: true })
+  @Type(() => Preference)
+  workflow: Preference;
+
+  @ValidateNested({ each: true })
+  @Type(() => Channels)
+  channels: Channels;
+}

apps/api/src/app/preferences/dtos/upsert-preferences.dto.ts

@@ -0,0 +1,12 @@
+import { Type } from 'class-transformer';
+import { IsString, ValidateNested } from 'class-validator';
+import { PreferencesDto } from './preferences.dto';
+
+export class UpsertPreferencesDto {
+  @IsString()
+  workflowId: string;
+
+  @ValidateNested({ each: true })
+  @Type(() => PreferencesDto)
+  preferences: PreferencesDto;
+}

apps/api/src/app/preferences/index.ts

@@ -0,0 +1 @@
+export { PreferencesModule } from './preferences.module';