Version Packages (#267)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
vivid-planet · Jan 28, 2025 · 18db5b9 · 18db5b9
1 parent a7e2bc8
commit 18db5b9
Show file tree

Hide file tree

Showing 17 changed files with 191 additions and 152 deletions.
diff --git a/.changeset/fast-weeks-remember.md b/.changeset/fast-weeks-remember.md
diff --git a/.changeset/funny-glasses-rhyme.md b/.changeset/funny-glasses-rhyme.md
diff --git a/.changeset/happy-cups-design.md b/.changeset/happy-cups-design.md
diff --git a/.changeset/many-lamps-move.md b/.changeset/many-lamps-move.md
diff --git a/.changeset/nervous-rats-walk.md b/.changeset/nervous-rats-walk.md
diff --git a/.changeset/new-cobras-thank.md b/.changeset/new-cobras-thank.md
diff --git a/.changeset/short-feet-sing.md b/.changeset/short-feet-sing.md
diff --git a/.changeset/silly-seals-begin.md b/.changeset/silly-seals-begin.md
diff --git a/.changeset/twelve-games-run.md b/.changeset/twelve-games-run.md
diff --git a/.changeset/weak-points-tan.md b/.changeset/weak-points-tan.md
diff --git a/.changeset/witty-coats-perform.md b/.changeset/witty-coats-perform.md
diff --git a/packages/admin/CHANGELOG.md b/packages/admin/CHANGELOG.md
@@ -1,5 +1,92 @@
 # @comet/brevo-admin
 
+## 3.0.0
+
+### Major Changes
+
+-   adb69fd: Refactor brevo contact import to upload files to public uploads temporarily
+
+    The files for the brevo contact import now get temporarily stored in the public uploads until the import is concluded.
+    This change prepares for future imports to be handled in a separate job, allowing more than 100 contacts to be imported without exhausting api resources or blocking the event loop.
+
+    It is now necessary to import the `PublicUploadsModule` in the project's `AppModule` and configure it to accept csv files.
+
+    ```ts
+            PublicUploadModule.register({
+                acceptedMimeTypes: ["text/csv"],
+                maxFileSize: config.publicUploads.maxFileSize,
+                directory: `${config.blob.storageDirectoryPrefix}-public-uploads`,
+            }),
+    ```
+
+-   d5319bc: Add `mail-rendering` package for providing reuseable components for rendering emails
+
+    Add new `NewsletterImageBlock`
+
+-   4fb6b8f: A required brevo config page must now be generated with `createBrevoConfigPage`.
+    All necessary brevo configuration (for each scope) must be configured within this page for emails campaigns to be sent.
+
+    ```diff
+    + const BrevoConfigPage = createBrevoConfigPage({
+    +        scopeParts: ["domain", "language"],
+    + });
+    ```
+
+    Env vars containing the brevo sender information can be removed.
+
+    ```diff
+    - BREVO_SENDER_NAME=senderName
+    - BREVO_SENDER_EMAIL=senderEmail
+    ```
+
+-   aa75e4c: Define `scopeParts` in `BrevoConfig`
+
+    Previously the `scopeParts` were passed to the functions:
+
+    -   createBrevoContactsPage
+    -   createTargetGroupsPage
+    -   createEmailCampaignsPage
+    -   createBrevoConfigPage
+
+    Now they are defined once in the `BrevoConfig`:
+
+    ```tsx
+    <BrevoConfigProvider
+        value={{
+            scopeParts: ["domain", "language"],
+            ...otherProps,
+        }}
+    >
+        {children}
+    </BrevoConfigProvider>
+    ```
+
+### Minor Changes
+
+-   e931996: Add field for `doubleOptInTemplateId` to `BrevoConfigPage`
+
+    The environment variable BREVO_DOUBLE_OPT_IN_TEMPLATE_ID can be removed, as it is now available as a maintainable variable in the admin interface.
+
+-   7215ec1: Add `folderId` to `BrevoConfig` to allow overwriting the default folderId `1`
+-   cc4bd07: Add a brevo configuration field for `allowedRedirectionUrl`
+    Env vars containing this information can be removed and must be removed from the brevo module configuration.
+
+    ```diff
+    BrevoModule.register({
+        brevo: {
+    -       allowedRedirectionUrl: config.brevo.allowedRedirectionUrl,
+            //...
+        },
+        //..
+    })
+    ```
+
+-   ea503b9: Add a brevo configuration field for `unsubscriptionPageId`
+
+### Patch Changes
+
+-   a605a42: Remove the `totalContactsBlocked` field from the `TargetGroup` type, because it is not delivered in the list request in Brevo anymore.
+
 ## 2.2.0
 
 ### Minor Changes

diff --git a/packages/admin/package.json b/packages/admin/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@comet/brevo-admin",
-    "version": "2.2.0",
+    "version": "3.0.0",
     "repository": {
         "type": "git",
         "url": "https://github.com/vivid-planet/comet-brevo-module/",

diff --git a/packages/api/CHANGELOG.md b/packages/api/CHANGELOG.md
@@ -1,5 +1,97 @@
 # @comet/brevo-api
 
+## 3.0.0
+
+### Major Changes
+
+-   0db9f4a: Make this package compatible with [COMET v7](https://docs.comet-dxp.com/docs/migration/migration-from-v6-to-v7)
+
+    **Breaking Changes**:
+
+    -   Now requires >= v7.5.0 for `@comet` packages
+    -   Now requires >= 5.9.8 for `@mikro-orm` packages (except `@mikro-orm/nestjs` where >= 5.2.3 is required)
+
+-   8ef6341: Refactor `email-campaign` and `target-group` entity
+
+    Use `createEmailCampaignEntity` for creating `email-campaign` entity. Pass `EmailCampaignContentBlock`, `Scope` and `TargetGroup`.
+
+    Use `createTargetGroupEntity` for creating `target-group` entity. Pass `Scope` and optional `BrevoFilterAttributes`
+
+    Pass both to the `AppModule`:
+
+    ````diff
+          BrevoModule.register({
+            brevo: {
+                  //...
+      +        EmailCampaign
+      +        TargetGroup
+               }
+            //...
+          });
+      ```
+    ````
+
+-   adb69fd: Refactor brevo contact import to upload files to public uploads temporarily
+
+    The files for the brevo contact import now get temporarily stored in the public uploads until the import is concluded.
+    This change prepares for future imports to be handled in a separate job, allowing more than 100 contacts to be imported without exhausting api resources or blocking the event loop.
+
+    It is now necessary to import the `PublicUploadsModule` in the project's `AppModule` and configure it to accept csv files.
+
+    ```ts
+            PublicUploadModule.register({
+                acceptedMimeTypes: ["text/csv"],
+                maxFileSize: config.publicUploads.maxFileSize,
+                directory: `${config.blob.storageDirectoryPrefix}-public-uploads`,
+            }),
+    ```
+
+-   d5319bc: Add `mail-rendering` package for providing reuseable components for rendering emails
+
+    Add new `NewsletterImageBlock`
+
+-   cc4bd07: Add a brevo configuration field for `allowedRedirectionUrl`
+    Env vars containing this information can be removed and must be removed from the brevo module configuration.
+
+    ```diff
+    BrevoModule.register({
+        brevo: {
+    -       allowedRedirectionUrl: config.brevo.allowedRedirectionUrl,
+            //...
+        },
+        //..
+    })
+    ```
+
+### Minor Changes
+
+-   e931996: Add field for `doubleOptInTemplateId` to `BrevoConfigPage`
+
+    The environment variable BREVO_DOUBLE_OPT_IN_TEMPLATE_ID can be removed, as it is now available as a maintainable variable in the admin interface.
+
+-   7215ec1: Add `folderId` to `BrevoConfig` to allow overwriting the default folderId `1`
+-   4fb6b8f: A required brevo config page must now be generated with `createBrevoConfigPage`.
+    All necessary brevo configuration (for each scope) must be configured within this page for emails campaigns to be sent.
+
+    ```diff
+    + const BrevoConfigPage = createBrevoConfigPage({
+    +        scopeParts: ["domain", "language"],
+    + });
+    ```
+
+    Env vars containing the brevo sender information can be removed.
+
+    ```diff
+    - BREVO_SENDER_NAME=senderName
+    - BREVO_SENDER_EMAIL=senderEmail
+    ```
+
+-   ea503b9: Add a brevo configuration field for `unsubscriptionPageId`
+
+### Patch Changes
+
+-   a605a42: Remove the `totalContactsBlocked` field from the `TargetGroup` type, because it is not delivered in the list request in Brevo anymore.
+
 ## 2.2.0
 
 ### Minor Changes

diff --git a/packages/api/package.json b/packages/api/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@comet/brevo-api",
-    "version": "2.2.0",
+    "version": "3.0.0",
     "repository": {
         "type": "git",
         "url": "https://github.com/vivid-planet/comet-brevo-module/",

diff --git a/packages/mail-rendering/CHANGELOG.md b/packages/mail-rendering/CHANGELOG.md
@@ -0,0 +1,9 @@
+# @comet/brevo-mail-rendering
+
+## 3.0.0
+
+### Major Changes
+
+-   d5319bc: Add `mail-rendering` package for providing reuseable components for rendering emails
+
+    Add new `NewsletterImageBlock`
diff --git a/packages/mail-rendering/package.json b/packages/mail-rendering/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@comet/brevo-mail-rendering",
-    "version": "2.1.6",
+    "version": "3.0.0",
     "repository": {
         "type": "git",
         "url": "https://github.com/vivid-planet/comet-brevo-module/",