@fufulog/brevomorphic-cms-sdk 1.0.0 → 1.0.2

package/INTEGRATION.md

@@ -11,8 +11,8 @@ Make sure to define these keys in the host environment (`.env`):
 ```bash
 # Brevo SMTP Configuration
 BREVO_API_KEY="xkeysib-..."
-DEFAULT_SENDER_EMAIL="info@yourdomain.com"
-DEFAULT_SENDER_NAME="Your Brand Name"
+BREVO_DEFAULT_SENDER_EMAIL="info@yourdomain.com"
+BREVO_DEFAULT_SENDER_NAME="Your Brand Name"
 DB_TYPE="firestore" # or 'postgres' | 'mysql'
 ```
 
@@ -99,3 +99,49 @@ await cmsService.sendEventEmail('user.welcome', email, {
 });
 ```
 The SDK runs outbound event-check safety checks. If the template is unassigned, missing, or inactive (`isActive` is false), the send is safely ignored without breaking transaction flows.
+
+---
+
+## 6. Brevo Template Loops & Object Decomposition
+
+When passing arrays of objects (like tickets or shopping cart items) to Brevo transactional templates, use **Brevo's native template language** (based on Django/Jinja syntax):
+
+### Loop Syntax & Decomposing Properties
+* **Root Scope**: All variables passed via `sendEventEmail` reside under the `params` object (e.g. `params.tickets`).
+* **Loop Declaration**: Loop through the array using `{% for %}` tags:
+  ```django
+  {% for item in params.tickets %}
+    <!-- Decompose attributes directly from the loop item -->
+    <h3>{{ item.name }}</h3>
+    <p>Ticket ID: {{ item.ticketId }}</p>
+    <p>Attendee: {{ item.attendeeName }}</p>
+    <!-- Render QR code dynamically using the standard image tag -->
+    <img src="{{ item.qrCodeUrl }}" width="110" height="110" alt="QR Code" />
+  {% endfor %}
+  ```
+* **Gmail/Email Client Compatibility Warning**: Gmail strips inline `<svg>` blocks and inline base64-encoded images. To guarantee delivery across all devices, pass a hosted/generated PNG dynamic URL (such as GoQR/QRServer) and render it inside a standard `<img />` tag.
+
+### Example Transactional Dispatch (Tickets)
+```typescript
+await cmsService.sendEventEmail('order.tickets', email, {
+  customerName: profile.name,
+  orderId: order.id,
+  appUrl: 'https://yourdomain.com',
+  tickets: [
+    {
+      name: 'VIP Admission Pass',
+      ticketId: 'tkt_VIP123',
+      orderIdShort: 'ORD-1234',
+      dateRange: 'Oct 15 - 17, 2026',
+      timeRange: '10am to 4pm',
+      location: 'Design Center, NY',
+      entryType: 'Multi Entry',
+      isMultiDay: true,
+      purchasedDate: '2026-05-28',
+      attendeeName: 'Jane Doe',
+      qrCodeUrl: 'https://api.qrserver.com/v1/create-qr-code/?size=220x220&margin=0&data=tkt_VIP123'
+    }
+  ]
+});
+```
+

package/LICENSE

@@ -0,0 +1,192 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, be controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf
+      of the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if distributed along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      LIABLE to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+
+Copyright [2026] [Joseph Quesnel / TicketHouse LLC]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -334,3 +334,21 @@ function TemplateEditor() {
 | `variables` | `{ label: string, key: string }[]` | `[]` | Available Brevo template variables |
 | `placeholder` | `string` | `'Start designing...'` | Placeholder text |
 | `disabled` | `boolean` | `false` | Disables editing |
+
+---
+
+## License
+
+Copyright [2026] [Joseph Quesnel / TicketHouse LLC]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/dist/brevoClient.js

@@ -127,11 +127,20 @@ export class BrevoClient {
      */
     async sendEmail(params) {
         try {
-            await this.client.post('/smtp/email', {
+            const replyToEmail = params.variables?.replyToEmail;
+            const replyToName = params.variables?.replyToName;
+            const payload = {
                 templateId: params.templateId,
                 to: [{ email: params.to }],
                 params: params.variables || {},
-            });
+            };
+            if (replyToEmail) {
+                payload.replyTo = {
+                    email: replyToEmail,
+                    ...(replyToName ? { name: replyToName } : {}),
+                };
+            }
+            await this.client.post('/smtp/email', payload);
         }
         catch (error) {
             const msg = error.response?.data?.message || error.message;

package/dist/repository.js

@@ -33,6 +33,9 @@ export class EmailTemplateRepository {
      * Fetch all event-to-template mappings from the local database
      */
     async getAllMappings() {
+        if (this.dbType === 'custom') {
+            return this.dbClient.getAllMappings();
+        }
         if (this.dbType === 'firestore') {
             const snapshot = await this.dbClient.collection(this.tableName).get();
             const mappings = [];
@@ -64,6 +67,9 @@ export class EmailTemplateRepository {
      * Fetch mapping for a specific template ID
      */
     async getMappingByTemplateId(templateId) {
+        if (this.dbType === 'custom') {
+            return this.dbClient.getMappingByTemplateId(templateId);
+        }
         if (this.dbType === 'firestore') {
             const doc = await this.dbClient.collection(this.tableName).doc(templateId.toString()).get();
             if (!doc.exists)
@@ -98,6 +104,9 @@ export class EmailTemplateRepository {
      * Assumes we want the active template linked to this event.
      */
     async getActiveMappingByEvent(eventName) {
+        if (this.dbType === 'custom') {
+            return this.dbClient.getActiveMappingByEvent(eventName);
+        }
         if (this.dbType === 'firestore') {
             const snapshot = await this.dbClient
                 .collection(this.tableName)
@@ -140,6 +149,9 @@ export class EmailTemplateRepository {
      * Upsert a mapping (insert or update template config)
      */
     async upsertMapping(templateId, eventName, isActive) {
+        if (this.dbType === 'custom') {
+            return this.dbClient.upsertMapping(templateId, eventName, isActive);
+        }
         if (this.dbType === 'firestore') {
             await this.dbClient
                 .collection(this.tableName)
@@ -186,6 +198,9 @@ export class EmailTemplateRepository {
      * If mapping does not exist, insert blank inactive mapping.
      */
     async insertJITMapping(templateId) {
+        if (this.dbType === 'custom') {
+            return this.dbClient.insertJITMapping(templateId);
+        }
         if (this.dbType === 'firestore') {
             const docRef = this.dbClient.collection(this.tableName).doc(templateId.toString());
             const doc = await docRef.get();

package/dist/types.d.ts

@@ -40,7 +40,7 @@ export interface SDKConfig {
         name?: string;
         email: string;
     };
-    dbType: 'postgres' | 'mysql' | 'firestore';
+    dbType: 'postgres' | 'mysql' | 'firestore' | 'custom';
     /**
      * For 'postgres': an object satisfying { query: (sql, params) => Promise<{ rows: any[] }> } or equivalent
      * For 'mysql': an object satisfying { query: (sql, params) => Promise<[any[], any]> } or equivalent

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fufulog/brevomorphic-cms-sdk",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "type": "module",
   "description": "SDK library to bootstrap Brevo email templates and manage local mappings in Postgres, MySQL, or Firestore",
   "main": "dist/index.js",
@@ -20,7 +20,7 @@
     "mysql"
   ],
   "author": "Joseph",
-  "license": "MIT",
+  "license": "Apache-2.0",
   "dependencies": {
     "axios": "^1.6.8",
     "dotenv": "^16.4.5"
@@ -31,5 +31,8 @@
     "typescript": "^5.4.3",
     "tsx": "^4.7.1",
     "express": "^4.19.2"
+  },
+  "publishConfig": {
+    "access": "public"
   }
-}
+}

package/src/brevoClient.ts

@@ -158,11 +158,23 @@ export class BrevoClient {
     variables?: Record<string, any>;
   }): Promise<void> {
     try {
-      await this.client.post('/smtp/email', {
+      const replyToEmail = params.variables?.replyToEmail;
+      const replyToName = params.variables?.replyToName;
+
+      const payload: any = {
         templateId: params.templateId,
         to: [{ email: params.to }],
         params: params.variables || {},
-      });
+      };
+
+      if (replyToEmail) {
+        payload.replyTo = {
+          email: replyToEmail,
+          ...(replyToName ? { name: replyToName } : {}),
+        };
+      }
+
+      await this.client.post('/smtp/email', payload);
     } catch (error: any) {
       const msg = error.response?.data?.message || error.message;
       throw new Error(`Failed to send event email via Brevo: ${msg}`);

package/src/repository.ts

@@ -1,7 +1,7 @@
 import { SDKConfig, LocalMapping } from './types.js';
 
 export class EmailTemplateRepository {
-  private dbType: 'postgres' | 'mysql' | 'firestore';
+  private dbType: 'postgres' | 'mysql' | 'firestore' | 'custom';
   private dbClient: any;
   private tableName: string;
 
@@ -38,6 +38,9 @@ export class EmailTemplateRepository {
    * Fetch all event-to-template mappings from the local database
    */
   async getAllMappings(): Promise<LocalMapping[]> {
+    if (this.dbType === 'custom') {
+      return this.dbClient.getAllMappings();
+    }
     if (this.dbType === 'firestore') {
       const snapshot = await this.dbClient.collection(this.tableName).get();
       const mappings: LocalMapping[] = [];
@@ -69,6 +72,9 @@ export class EmailTemplateRepository {
    * Fetch mapping for a specific template ID
    */
   async getMappingByTemplateId(templateId: number): Promise<LocalMapping | null> {
+    if (this.dbType === 'custom') {
+      return this.dbClient.getMappingByTemplateId(templateId);
+    }
     if (this.dbType === 'firestore') {
       const doc = await this.dbClient.collection(this.tableName).doc(templateId.toString()).get();
       if (!doc.exists) return null;
@@ -102,6 +108,9 @@ export class EmailTemplateRepository {
    * Assumes we want the active template linked to this event.
    */
   async getActiveMappingByEvent(eventName: string): Promise<LocalMapping | null> {
+    if (this.dbType === 'custom') {
+      return this.dbClient.getActiveMappingByEvent(eventName);
+    }
     if (this.dbType === 'firestore') {
       const snapshot = await this.dbClient
         .collection(this.tableName)
@@ -145,6 +154,9 @@ export class EmailTemplateRepository {
    * Upsert a mapping (insert or update template config)
    */
   async upsertMapping(templateId: number, eventName: string, isActive: boolean): Promise<void> {
+    if (this.dbType === 'custom') {
+      return this.dbClient.upsertMapping(templateId, eventName, isActive);
+    }
     if (this.dbType === 'firestore') {
       await this.dbClient
         .collection(this.tableName)
@@ -193,6 +205,9 @@ export class EmailTemplateRepository {
    * If mapping does not exist, insert blank inactive mapping.
    */
   async insertJITMapping(templateId: number): Promise<void> {
+    if (this.dbType === 'custom') {
+      return this.dbClient.insertJITMapping(templateId);
+    }
     if (this.dbType === 'firestore') {
       const docRef = this.dbClient.collection(this.tableName).doc(templateId.toString());
       const doc = await docRef.get();

package/src/types.ts

@@ -46,7 +46,7 @@ export interface SDKConfig {
     name?: string;
     email: string;
   };
-  dbType: 'postgres' | 'mysql' | 'firestore';
+  dbType: 'postgres' | 'mysql' | 'firestore' | 'custom';
   /**
    * For 'postgres': an object satisfying { query: (sql, params) => Promise<{ rows: any[] }> } or equivalent
    * For 'mysql': an object satisfying { query: (sql, params) => Promise<[any[], any]> } or equivalent