Add folder id to config

.changeset/new-cobras-thank.md

@@ -0,0 +1,6 @@
+---
+"@comet/brevo-admin": minor
+"@comet/brevo-api": minor
+---
+
+Add `folderId` to `BrevoConfig` to allow overwriting the default folderId `1`

demo/api/schema.gql

@@ -460,6 +460,7 @@ type BrevoConfig implements DocumentInterface {
   updatedAt: DateTime!
   senderMail: String!
   senderName: String!
+  folderId: Int!
   createdAt: DateTime!
   scope: EmailCampaignContentScope!
 }
@@ -997,9 +998,11 @@ input TargetGroupUpdateInput {
 input BrevoConfigInput {
   senderMail: String!
   senderName: String!
+  folderId: Int!
 }
 
 input BrevoConfigUpdateInput {
   senderMail: String
   senderName: String
+  folderId: Int
 }

packages/admin/src/brevoConfiguration/BrevoConfigForm.gql.ts

@@ -4,6 +4,7 @@ export const brevoConfigFormFragment = gql`
     fragment BrevoConfigForm on BrevoConfig {
         senderMail
         senderName
+        folderId
     }
 `;
 

packages/admin/src/brevoConfiguration/BrevoConfigForm.tsx

@@ -7,13 +7,16 @@ import {
     FinalFormSubmitEvent,
     Loading,
     MainContent,
+    NumberField,
     Toolbar,
     ToolbarActions,
     ToolbarFillSpace,
     ToolbarTitleItem,
+    Tooltip,
     useFormApiRef,
     useStackSwitchApi,
 } from "@comet/admin";
+import { Info } from "@comet/admin-icons";
 import { ContentScopeIndicator, ContentScopeInterface, resolveHasSaveConflict, useFormSaveConflict } from "@comet/cms-admin";
 import { FormApi } from "final-form";
 import React from "react";
@@ -37,6 +40,7 @@ interface Option {
 }
 type FormValues = {
     sender: Option;
+    folderId: number;
 };
 
 interface FormProps {
@@ -76,9 +80,10 @@ export function BrevoConfigForm({ scope }: FormProps): React.ReactElement {
                       value: sender.id,
                       label: `${sender.name} (${sender.email})`,
                   },
+                  folderId: data?.brevoConfig?.folderId ?? 1,
               }
             : {};
-    }, [data?.brevoConfig?.senderMail, data?.brevoConfig?.senderName, sendersData?.senders]);
+    }, [data?.brevoConfig?.folderId, data?.brevoConfig?.senderMail, data?.brevoConfig?.senderName, sendersData?.senders]);
 
     const saveConflict = useFormSaveConflict({
         checkConflict: async () => {
@@ -117,6 +122,7 @@ export function BrevoConfigForm({ scope }: FormProps): React.ReactElement {
         const output = {
             senderName: sender?.name,
             senderMail: sender?.email,
+            folderId: state.folderId ?? 1,
         };
 
         if (mode === "edit") {
@@ -174,6 +180,28 @@ export function BrevoConfigForm({ scope }: FormProps): React.ReactElement {
                                 label={<FormattedMessage id="cometBrevoModule.brevoConfig.sender" defaultMessage="Sender" />}
                                 fullWidth
                             />
+                            <NumberField
+                                name="folderId"
+                                defaultValue={1}
+                                label={
+                                    <>
+                                        <FormattedMessage id="cometBrevoModule.brevoConfig.folderId" defaultMessage="Folder ID" />
+                                        <Tooltip
+                                            title={
+                                                <FormattedMessage
+                                                    id="cometBrevoModule.brevoConfig.folderId.info"
+                                                    defaultMessage="By default, the folder ID should be set to 1 unless you have specifically configured another folder in Brevo."
+                                                />
+                                            }
+                                            sx={{ marginLeft: "5px" }}
+                                        >
+                                            <Info />
+                                        </Tooltip>
+                                    </>
+                                }
+                                fullWidth
+                                required
+                            />
                         </MainContent>
                     </>
                 );

packages/api/schema.gql

@@ -1,3 +1,9 @@
+type User {
+  id: String!
+  name: String!
+  email: String!
+}
+
 type CurrentUserPermission {
   permission: String!
   contentScopes: [JSONObject!]!
@@ -37,12 +43,6 @@ enum FocalPoint {
   SOUTHEAST
 }
 
-type User {
-  id: String!
-  name: String!
-  email: String!
-}
-
 type BrevoApiSender {
   id: ID!
   name: String!
@@ -185,6 +185,7 @@ type BrevoConfig implements DocumentInterface {
   updatedAt: DateTime!
   senderMail: String!
   senderName: String!
+  folderId: Int!
   createdAt: DateTime!
   scope: EmailCampaignContentScope!
 }
@@ -359,9 +360,11 @@ input SendTestEmailCampaignArgs {
 input BrevoConfigInput {
   senderMail: String!
   senderName: String!
+  folderId: Int!
 }
 
 input BrevoConfigUpdateInput {
   senderMail: String
   senderName: String
+  folderId: Int
 }

packages/api/src/brevo-api/brevo-api-contact.service.ts

@@ -1,5 +1,8 @@
 import * as Brevo from "@getbrevo/brevo";
+import { EntityRepository } from "@mikro-orm/core";
+import { InjectRepository } from "@mikro-orm/nestjs";
 import { Inject, Injectable } from "@nestjs/common";
+import { BrevoConfigInterface } from "src/brevo-config/entities/brevo-config-entity.factory";
 import { BrevoContactAttributesInterface, EmailCampaignScopeInterface } from "src/types";
 
 import { BrevoContactInterface } from "../brevo-contact/dto/brevo-contact.factory";
@@ -18,7 +21,10 @@ export interface CreateDoubleOptInContactData {
 export class BrevoApiContactsService {
     private readonly contactsApis = new Map<string, Brevo.ContactsApi>();
 
-    constructor(@Inject(BREVO_MODULE_CONFIG) private readonly config: BrevoModuleConfig) {}
+    constructor(
+        @Inject(BREVO_MODULE_CONFIG) private readonly config: BrevoModuleConfig,
+        @InjectRepository("BrevoConfig") private readonly brevoConfigRepository: EntityRepository<BrevoConfigInterface>,
+    ) {}
 
     private getContactsApi(scope: EmailCampaignScopeInterface): Brevo.ContactsApi {
         try {
@@ -186,10 +192,12 @@ export class BrevoApiContactsService {
     }
 
     public async createBrevoContactList(title: string, scope: EmailCampaignScopeInterface): Promise<number | undefined> {
+        const brevoConfig = await this.brevoConfigRepository.findOne({ scope });
+
         try {
             const contactList = {
                 name: title,
-                folderId: 1, // folderId is required, folder #1 is created by default
+                folderId: brevoConfig?.folderId ?? 1,
             };
 
             const data = await this.getContactsApi(scope).createList(contactList);

packages/api/src/brevo-config/dto/brevo-config.input.ts

@@ -1,6 +1,6 @@
 import { PartialType } from "@comet/cms-api";
-import { Field, InputType } from "@nestjs/graphql";
-import { IsEmail, IsNotEmpty, IsString } from "class-validator";
+import { Field, InputType, Int } from "@nestjs/graphql";
+import { IsEmail, IsInt, IsNotEmpty, IsString } from "class-validator";
 
 @InputType()
 export class BrevoConfigInput {
@@ -14,6 +14,10 @@ export class BrevoConfigInput {
     @IsString()
     @Field()
     senderName: string;
+
+    @Field(() => Int)
+    @IsInt()
+    folderId: number;
 }
 
 @InputType()

packages/api/src/brevo-config/entities/brevo-config-entity.factory.ts

@@ -1,7 +1,7 @@
 import { DocumentInterface } from "@comet/cms-api";
 import { Embedded, Entity, OptionalProps, PrimaryKey, Property } from "@mikro-orm/core";
 import { Type } from "@nestjs/common";
-import { Field, ID, ObjectType } from "@nestjs/graphql";
+import { Field, ID, Int, ObjectType } from "@nestjs/graphql";
 import { v4 } from "uuid";
 
 import { EmailCampaignScopeInterface } from "../../types";
@@ -11,6 +11,7 @@ export interface BrevoConfigInterface {
     id: string;
     senderName: string;
     senderMail: string;
+    folderId: number;
     createdAt: Date;
     updatedAt: Date;
     scope: EmailCampaignScopeInterface;
@@ -37,6 +38,10 @@ export class BrevoConfigEntityFactory {
             @Field()
             senderName: string;
 
+            @Property({ columnType: "int" })
+            @Field(() => Int)
+            folderId: number;
+
             @Property({
                 columnType: "timestamp with time zone",
             })

packages/api/src/mikro-orm/migrations/Migration20241119101706.ts

@@ -0,0 +1,8 @@
+import { Migration } from "@mikro-orm/migrations";
+
+export class Migration20241119101706 extends Migration {
+    async up(): Promise<void> {
+        this.addSql('alter table "BrevoConfig" add column "folderId" int not null default 1;');
+        this.addSql('alter table "BrevoConfig" alter column "folderId" drop default;');
+    }
+}

packages/api/src/mikro-orm/migrations/migrations.ts

@@ -9,6 +9,7 @@ import { Migration20240619145217 } from "./Migration20240619145217";
 import { Migration20240621102349 } from "./Migration20240621102349";
 import { Migration20240819214939 } from "./Migration20240819214939";
 import { Migration20241016123307 } from "./Migration20241016123307";
+import { Migration20241119101706 } from "./Migration20241119101706";
 
 export const migrationsList: MigrationObject[] = [
     { name: "Migration20240115095733", class: Migration20240115095733 },
@@ -20,4 +21,5 @@ export const migrationsList: MigrationObject[] = [
     { name: "Migration20240621102349", class: Migration20240621102349 },
     { name: "Migration20240819214939", class: Migration20240819214939 },
     { name: "Migration20241016123307", class: Migration20241016123307 },
+    { name: "Migration20241119101706", class: Migration20241119101706 },
 ];