add public api route to subscribe to brevo

vivid-planet · Jul 11, 2024 · ef65801 · ef65801
1 parent 23371d5
commit ef65801
Show file tree

Hide file tree

Showing 8 changed files with 106 additions and 19 deletions.
diff --git a/.changeset/cool-walls-drop.md b/.changeset/cool-walls-drop.md
@@ -0,0 +1,5 @@
+---
+"@comet/brevo-api": major
+---
+
+Add a new public route that allows subscribing to the Brevo Module. By default, this route is disabled and can be enabled in the Brevo module configuration via `enablePublicApiSubscriptionRoute: true`. This feature allows external applications to create a newsletter form and subscribe via REST to the Brevo module.
diff --git a/demo/api/src/app.module.ts b/demo/api/src/app.module.ts
@@ -173,6 +173,7 @@ export class AppModule {
                             },
                         },
                     },
+                    enablePublicApiSubscriptionRoute: true,
                 }),
             ],
         };

diff --git a/packages/api/src/brevo-contact/brevo-contact.controller.ts b/packages/api/src/brevo-contact/brevo-contact.controller.ts
@@ -0,0 +1,56 @@
+import { DisableGlobalGuard } from "@comet/cms-api";
+import { Body, Controller, Post, Type as NestType } from "@nestjs/common";
+import { Type } from "class-transformer";
+import { IsEmail, IsNotEmpty, IsUrl, Validate, ValidateNested } from "class-validator";
+import { BrevoContactAttributesInterface } from "src/types";
+
+import { EmailCampaignScopeInterface } from "../types";
+import { BrevoContactsService } from "./brevo-contacts.service";
+import { SubscribeResponse } from "./dto/subscribe-response.enum";
+import { IsValidRedirectURLConstraint } from "./validator/redirect-url.validator";
+
+export function createBrevoContactController({
+    BrevoContactAttributes,
+    Scope,
+}: {
+    BrevoContactAttributes?: NestType<BrevoContactAttributesInterface>;
+    Scope: NestType<EmailCampaignScopeInterface>;
+}): NestType<unknown> {
+    class SubscribeInputBase {
+        @IsEmail()
+        email: string;
+
+        @IsUrl({ require_tld: process.env.NODE_ENV === "production" })
+        @Validate(IsValidRedirectURLConstraint)
+        redirectionUrl: string;
+
+        @IsNotEmpty()
+        @Type(() => Scope)
+        @ValidateNested()
+        scope: typeof Scope;
+    }
+
+    class SubscribeInputWithAttributes extends SubscribeInputBase {
+        @IsNotEmpty()
+        @Type(typeof BrevoContactAttributes !== "undefined" ? () => BrevoContactAttributes : undefined)
+        @ValidateNested()
+        attributes: typeof BrevoContactAttributes;
+    }
+
+    class SubscribeInput extends (typeof BrevoContactAttributes !== "undefined" ? SubscribeInputWithAttributes : SubscribeInputBase) {}
+
+    @Controller("brevo-contacts")
+    class BrevoContactsController {
+        constructor(private readonly brevoContactsService: BrevoContactsService) {}
+
+        @DisableGlobalGuard()
+        @Post(`/subscribe`)
+        async subscribe(@Body() data: SubscribeInput): Promise<SubscribeResponse> {
+            const { scope, ...input } = data;
+
+            return this.brevoContactsService.subscribeBrevoContact(input, data.scope);
+        }
+    }
+
+    return BrevoContactsController;
+}
diff --git a/packages/api/src/brevo-contact/brevo-contact.module.ts b/packages/api/src/brevo-contact/brevo-contact.module.ts
@@ -5,6 +5,7 @@ import { BrevoApiModule } from "../brevo-api/brevo-api.module";
 import { ConfigModule } from "../config/config.module";
 import { TargetGroupInterface } from "../target-group/entity/target-group-entity.factory";
 import { BrevoContactAttributesInterface, EmailCampaignScopeInterface } from "../types";
+import { createBrevoContactController } from "./brevo-contact.controller";
 import { createBrevoContactResolver } from "./brevo-contact.resolver";
 import { BrevoContactsService } from "./brevo-contacts.service";
 import { BrevoContactFactory } from "./dto/brevo-contact.factory";
@@ -17,11 +18,12 @@ interface BrevoContactModuleConfig {
     BrevoContactAttributes?: Type<BrevoContactAttributesInterface>;
     Scope: Type<EmailCampaignScopeInterface>;
     TargetGroup: Type<TargetGroupInterface>;
+    enablePublicApiSubscriptionRoute?: boolean;
 }
 
 @Module({})
 export class BrevoContactModule {
-    static register({ BrevoContactAttributes, Scope, TargetGroup }: BrevoContactModuleConfig): DynamicModule {
+    static register({ BrevoContactAttributes, Scope, TargetGroup, enablePublicApiSubscriptionRoute }: BrevoContactModuleConfig): DynamicModule {
         const BrevoContact = BrevoContactFactory.create({ BrevoContactAttributes });
         const BrevoContactSubscribeInput = SubscribeInputFactory.create({ BrevoContactAttributes, Scope });
         const [BrevoContactInput, BrevoContactUpdateInput] = BrevoContactInputFactory.create({ BrevoContactAttributes });
@@ -33,10 +35,18 @@ export class BrevoContactModule {
             BrevoContactUpdateInput,
         });
 
+        const controllers = [];
+        if (enablePublicApiSubscriptionRoute) {
+            const BrevoContactController = createBrevoContactController({ BrevoContactAttributes, Scope });
+            controllers.push(BrevoContactController);
+        }
+
         return {
             module: BrevoContactModule,
             imports: [BrevoApiModule, ConfigModule, MikroOrmModule.forFeature([TargetGroup])],
             providers: [BrevoContactsService, BrevoContactResolver, EcgRtrListService, IsValidRedirectURLConstraint],
+            controllers,
+            exports: [BrevoContactsService],
         };
     }
 }
diff --git a/packages/api/src/brevo-contact/brevo-contact.resolver.ts b/packages/api/src/brevo-contact/brevo-contact.resolver.ts
@@ -173,21 +173,7 @@ export function createBrevoContactResolver({
             @Args("scope", { type: () => Scope }, new DynamicDtoValidationPipe(Scope))
             scope: typeof Scope,
         ): Promise<SubscribeResponse> {
-            if ((await this.ecgRtrListService.getContainedEcgRtrListEmails([data.email])).length > 0) {
-                return SubscribeResponse.ERROR_CONTAINED_IN_ECG_RTR_LIST;
-            }
-
-            const created = await this.brevoContactsService.createDoubleOptInContact({
-                ...data,
-                scope,
-                templateId: this.config.brevo.resolveConfig(scope).doubleOptInTemplateId,
-            });
-
-            if (created) {
-                return SubscribeResponse.SUCCESSFUL;
-            }
-
-            return SubscribeResponse.ERROR_UNKNOWN;
+            return this.brevoContactsService.subscribeBrevoContact(data, scope);
         }
     }
 

diff --git a/packages/api/src/brevo-contact/brevo-contacts.service.ts b/packages/api/src/brevo-contact/brevo-contacts.service.ts
@@ -1,12 +1,22 @@
-import { Injectable } from "@nestjs/common";
+import { Inject, Injectable } from "@nestjs/common";
 
 import { BrevoApiContactsService } from "../brevo-api/brevo-api-contact.service";
+import { BrevoModuleConfig } from "../config/brevo-module.config";
+import { BREVO_MODULE_CONFIG } from "../config/brevo-module.constants";
 import { TargetGroupsService } from "../target-group/target-groups.service";
 import { BrevoContactAttributesInterface, EmailCampaignScopeInterface } from "../types";
+import { SubscribeInputInterface } from "./dto/subscribe-input.factory";
+import { SubscribeResponse } from "./dto/subscribe-response.enum";
+import { EcgRtrListService } from "./ecg-rtr-list/ecg-rtr-list.service";
 
 @Injectable()
 export class BrevoContactsService {
-    constructor(private readonly brevoContactsApiService: BrevoApiContactsService, private readonly targetGroupService: TargetGroupsService) {}
+    constructor(
+        @Inject(BREVO_MODULE_CONFIG) private readonly config: BrevoModuleConfig,
+        private readonly brevoContactsApiService: BrevoApiContactsService,
+        private readonly ecgRtrListService: EcgRtrListService,
+        private readonly targetGroupService: TargetGroupsService,
+    ) {}
 
     public async createDoubleOptInContact({
         email,
@@ -61,4 +71,22 @@ export class BrevoContactsService {
 
         return targetGroupIds;
     }
+
+    public async subscribeBrevoContact(data: SubscribeInputInterface, scope: EmailCampaignScopeInterface): Promise<SubscribeResponse> {
+        if ((await this.ecgRtrListService.getContainedEcgRtrListEmails([data.email])).length > 0) {
+            return SubscribeResponse.ERROR_CONTAINED_IN_ECG_RTR_LIST;
+        }
+
+        const created = await this.createDoubleOptInContact({
+            ...data,
+            scope,
+            templateId: this.config.brevo.resolveConfig(scope).doubleOptInTemplateId,
+        });
+
+        if (created) {
+            return SubscribeResponse.SUCCESSFUL;
+        }
+
+        return SubscribeResponse.ERROR_UNKNOWN;
+    }
 }
diff --git a/packages/api/src/brevo-module.ts b/packages/api/src/brevo-module.ts
@@ -25,6 +25,7 @@ export class BrevoModule {
                     BrevoContactAttributes: config.brevo.BrevoContactAttributes,
                     Scope: config.emailCampaigns.Scope,
                     TargetGroup,
+                    enablePublicApiSubscriptionRoute: config.enablePublicApiSubscriptionRoute,
                 }),
                 EmailCampaignModule.register({
                     EmailCampaignContentBlock: config.emailCampaigns.EmailCampaignContentBlock,

diff --git a/packages/api/src/config/brevo-module.config.ts b/packages/api/src/config/brevo-module.config.ts
@@ -21,7 +21,6 @@ export interface BrevoModuleConfig {
     ecgRtrList: {
         apiKey: string;
     };
-
     emailCampaigns: {
         Scope: Type<EmailCampaignScopeInterface>;
         EmailCampaignContentBlock: Block;
@@ -33,4 +32,5 @@ export interface BrevoModuleConfig {
             };
         };
     };
+    enablePublicApiSubscriptionRoute?: boolean;
 }
-Original file line number
+Diff line change
@@ Expand Up / @@ -173,6 +173,7 @@ export class AppModule { @@
                                 },
                             },
                         },
+                        enablePublicApiSubscriptionRoute: true,
                     }),
                 ],
             };
@@ Expand Down @@