refactor(api, application-generic, web, shared, dal): Remove `readOnl…

…y` from Preferences `channels` (#6575)
novuhq · Sep 25, 2024 · 76b73f2 · 76b73f2
1 parent a2d5301
commit 76b73f2
Show file tree

Hide file tree

Showing 33 changed files with 936 additions and 518 deletions.
diff --git a/apps/api/src/app/events/e2e/bridge-sync.e2e.ts b/apps/api/src/app/events/e2e/bridge-sync.e2e.ts
@@ -324,14 +324,13 @@ describe('Bridge Sync - /bridge/sync (POST)', async () => {
       },
       {
         preferences: {
-          workflow: {
+          all: {
             enabled: false,
             readOnly: true,
           },
           channels: {
             inApp: {
               enabled: true,
-              readOnly: true,
             },
           },
         },
@@ -344,13 +343,13 @@ describe('Bridge Sync - /bridge/sync (POST)', async () => {
     });
 
     const dashboardPreferences = {
-      workflow: { enabled: false, readOnly: true },
+      all: { enabled: false, readOnly: true },
       channels: {
-        email: { enabled: true, readOnly: false },
-        sms: { enabled: true, readOnly: false },
-        inApp: { enabled: false, readOnly: true },
-        chat: { enabled: true, readOnly: false },
-        push: { enabled: true, readOnly: false },
+        email: { enabled: true },
+        sms: { enabled: true },
+        inApp: { enabled: false },
+        chat: { enabled: true },
+        push: { enabled: true },
       },
     };
 

diff --git a/apps/api/src/app/events/e2e/bridge-trigger.e2e.ts b/apps/api/src/app/events/e2e/bridge-trigger.e2e.ts
@@ -852,7 +852,7 @@ contexts.forEach((context: Context) => {
         },
         {
           preferences: {
-            workflow: {
+            all: {
               enabled: false,
             },
             channels: {
@@ -893,7 +893,7 @@ contexts.forEach((context: Context) => {
         },
         {
           preferences: {
-            workflow: {
+            all: {
               enabled: false,
             },
           },

diff --git a/apps/api/src/app/inbox/usecases/update-preferences/update-preferences.usecase.ts b/apps/api/src/app/inbox/usecases/update-preferences/update-preferences.usecase.ts
@@ -238,7 +238,7 @@ export class UpdatePreferences {
     templateId?: string;
   }) {
     const preferences: WorkflowPreferencesPartial = {
-      workflow: {
+      all: {
         enabled: PREFERENCE_DEFAULT_VALUE,
         readOnly: false,
       },

diff --git a/apps/api/src/app/preferences/dtos/preferences.dto.ts b/apps/api/src/app/preferences/dtos/preferences.dto.ts
@@ -2,40 +2,45 @@ import { ChannelTypeEnum } from '@novu/shared';
 import { Type } from 'class-transformer';
 import { IsBoolean, ValidateNested } from 'class-validator';
 
-export class Preference {
+export class WorkflowPreference {
   @IsBoolean()
   enabled: boolean;
 
   @IsBoolean()
   readOnly: boolean;
 }
 
+export class ChannelPreference {
+  @IsBoolean()
+  enabled: boolean;
+}
+
 export class Channels {
   @ValidateNested({ each: true })
-  @Type(() => Preference)
-  [ChannelTypeEnum.IN_APP]: Preference;
+  @Type(() => ChannelPreference)
+  [ChannelTypeEnum.IN_APP]: ChannelPreference;
 
   @ValidateNested({ each: true })
-  @Type(() => Preference)
-  [ChannelTypeEnum.EMAIL]: Preference;
+  @Type(() => ChannelPreference)
+  [ChannelTypeEnum.EMAIL]: ChannelPreference;
 
   @ValidateNested({ each: true })
-  @Type(() => Preference)
-  [ChannelTypeEnum.SMS]: Preference;
+  @Type(() => ChannelPreference)
+  [ChannelTypeEnum.SMS]: ChannelPreference;
 
   @ValidateNested({ each: true })
-  @Type(() => Preference)
-  [ChannelTypeEnum.CHAT]: Preference;
+  @Type(() => ChannelPreference)
+  [ChannelTypeEnum.CHAT]: ChannelPreference;
 
   @ValidateNested({ each: true })
-  @Type(() => Preference)
-  [ChannelTypeEnum.PUSH]: Preference;
+  @Type(() => ChannelPreference)
+  [ChannelTypeEnum.PUSH]: ChannelPreference;
 }
 
 export class PreferencesDto {
   @ValidateNested({ each: true })
-  @Type(() => Preference)
-  workflow: Preference;
+  @Type(() => WorkflowPreference)
+  workflow: WorkflowPreference;
 
   @ValidateNested({ each: true })
   @Type(() => Channels)

diff --git a/apps/api/src/app/preferences/preferences.controller.ts b/apps/api/src/app/preferences/preferences.controller.ts
@@ -2,6 +2,7 @@ import {
   Body,
   ClassSerializerInterceptor,
   Controller,
+  Delete,
   Get,
   NotFoundException,
   Post,
@@ -63,6 +64,22 @@ export class PreferencesController {
     );
   }
 
+  @Delete('/')
+  @UseGuards(UserAuthGuard)
+  async delete(@UserSession() user: UserSessionData, @Query('workflowId') workflowId: string) {
+    await this.verifyPreferencesApiAvailability(user);
+
+    return this.upsertPreferences.upsertUserWorkflowPreferences(
+      UpsertUserWorkflowPreferencesCommand.create({
+        environmentId: user.environmentId,
+        organizationId: user.organizationId,
+        userId: user._id,
+        templateId: workflowId,
+        preferences: null,
+      })
+    );
+  }
+
   private async verifyPreferencesApiAvailability(user: UserSessionData) {
     const isEnabled = await this.getFeatureFlag.execute(
       GetFeatureFlagCommand.create({