@fufulog/brevomorphic-cms-sdk 1.0.4 → 1.0.5

package/.kilo/worktrees/chip-sputter/tests/sdk.test.ts

@@ -0,0 +1,239 @@
+import { EmailTemplateRepository } from '../src/repository.js';
+import { EmailTemplateService } from '../src/service.js';
+import { EmailTemplateController } from '../src/controller.js';
+import { SQLClient, LocalMapping } from '../src/types.js';
+
+// Setup basic assertion helper
+function assert(condition: boolean, message: string) {
+  if (!condition) {
+    throw new Error(`Assertion Failed: ${message}`);
+  }
+}
+
+async function runTests() {
+  console.log('🧪 Starting Brevo CMS SDK Unit Tests...\n');
+
+  let testPassedCount = 0;
+  let testFailedCount = 0;
+
+  function runTest(name: string, testFn: () => void | Promise<void>) {
+    try {
+      const p = testFn();
+      if (p instanceof Promise) {
+        p.then(() => {
+          console.log(`✅ PASSED: ${name}`);
+          testPassedCount++;
+        }).catch((err) => {
+          console.error(`❌ FAILED: ${name}`);
+          console.error(err);
+          testFailedCount++;
+        });
+      } else {
+        console.log(`✅ PASSED: ${name}`);
+        testPassedCount++;
+      }
+    } catch (err) {
+      console.error(`❌ FAILED: ${name}`);
+      console.error(err);
+      testFailedCount++;
+    }
+  }
+
+  // 1. REPOSITORY TESTS (SQL PostgreSQL Dialect)
+  runTest('Repository - PostgreSQL Queries', async () => {
+    const executedQueries: { sql: string; params: any[] }[] = [];
+    const mockPgClient: SQLClient = {
+      query: async (sql: string, params: any[]) => {
+        executedQueries.push({ sql, params });
+        // return standard PG rows layout
+        return {
+          rows: [
+            { id: 1, template_id: 100, event_name: 'test.event', is_active: true, updated_at: new Date() }
+          ]
+        };
+      }
+    };
+
+    const repo = new EmailTemplateRepository({
+      brevoApiKey: 'test-key',
+      defaultSender: { email: 'test@example.com' },
+      dbType: 'postgres',
+      dbClient: mockPgClient
+    });
+
+    const mapping = await repo.getMappingByTemplateId(100);
+    assert(mapping !== null, 'Should return parsed mapping');
+    assert(mapping?.template_id === 100, 'Should match template id');
+    assert(executedQueries.length === 1, 'Should execute 1 query');
+    assert(executedQueries[0].sql.includes('$1'), 'PostgreSQL should use $1 placeholder');
+
+    // Test upsert Postgres query
+    await repo.upsertMapping(100, 'updated.event', false);
+    assert(executedQueries.length === 2, 'Should execute another query');
+    assert(executedQueries[1].sql.includes('ON CONFLICT (template_id)'), 'Postgres query should have ON CONFLICT');
+  });
+
+  // 2. REPOSITORY TESTS (SQL MySQL Dialect)
+  runTest('Repository - MySQL Queries', async () => {
+    const executedQueries: { sql: string; params: any[] }[] = [];
+    const mockMySQLClient: SQLClient = {
+      query: async (sql: string, params: any[]) => {
+        executedQueries.push({ sql, params });
+        // return MySQL row arrays
+        return [
+          [
+            { id: 1, template_id: 200, event_name: 'mysql.event', is_active: true, updated_at: new Date() }
+          ],
+          {} // Fields meta
+        ];
+      }
+    };
+
+    const repo = new EmailTemplateRepository({
+      brevoApiKey: 'test-key',
+      defaultSender: { email: 'test@example.com' },
+      dbType: 'mysql',
+      dbClient: mockMySQLClient
+    });
+
+    const mapping = await repo.getMappingByTemplateId(200);
+    assert(mapping !== null, 'Should return MySQL mapped record');
+    assert(mapping?.template_id === 200, 'Should match template id');
+    assert(executedQueries.length === 1, 'Should execute 1 query');
+    assert(executedQueries[0].sql.includes('?'), 'MySQL should use ? placeholders');
+
+    // Test upsert MySQL query
+    await repo.upsertMapping(200, 'updated.event', true);
+    assert(executedQueries.length === 2, 'Should execute upsert query');
+    assert(executedQueries[1].sql.includes('ON DUPLICATE KEY UPDATE'), 'MySQL should use ON DUPLICATE KEY UPDATE');
+  });
+
+  // 3. REPOSITORY TESTS (Firestore)
+  runTest('Repository - Firestore Collections', async () => {
+    const firestoreDbState: Record<string, any> = {};
+    let whereClauseCalled = false;
+
+    const mockFirestoreClient = {
+      collection: (collectionName: string) => {
+        assert(collectionName === 'email_event_templates', 'Should default collection path');
+        return {
+          doc: (docId: string) => ({
+            get: async () => ({
+              exists: firestoreDbState[docId] !== undefined,
+              data: () => firestoreDbState[docId],
+            }),
+            set: async (data: any, options: any) => {
+              if (options?.merge && firestoreDbState[docId]) {
+                firestoreDbState[docId] = { ...firestoreDbState[docId], ...data };
+              } else {
+                firestoreDbState[docId] = data;
+              }
+            }
+          }),
+          where: (field: string, op: string, val: any) => {
+            whereClauseCalled = true;
+            return {
+              where: () => ({
+                limit: () => ({
+                  get: async () => ({
+                    empty: false,
+                    docs: [
+                      {
+                        data: () => ({
+                          template_id: 300,
+                          event_name: 'firestore.event',
+                          is_active: true
+                        })
+                      }
+                    ]
+                  })
+                })
+              })
+            };
+          }
+        };
+      }
+    };
+
+    const repo = new EmailTemplateRepository({
+      brevoApiKey: 'test-key',
+      defaultSender: { email: 'test@example.com' },
+      dbType: 'firestore',
+      dbClient: mockFirestoreClient
+    });
+
+    // JIT Sync Mock
+    await repo.insertJITMapping(300);
+    const cached = await repo.getMappingByTemplateId(300);
+    assert(cached !== null, 'Doc should be created JIT');
+    assert(cached?.event_name === '', 'JIT mapping event_name should be empty');
+
+    // Upsert and get
+    await repo.upsertMapping(300, 'firestore.event', true);
+    const updated = await repo.getMappingByTemplateId(300);
+    assert(updated?.event_name === 'firestore.event', 'Updated event should match');
+    assert(updated?.is_active === true, 'Updated active state should match');
+
+    // Active event query
+    const active = await repo.getActiveMappingByEvent('firestore.event');
+    assert(active !== null, 'Active event record should match query');
+    assert(whereClauseCalled === true, 'Should use firestore where filters');
+  });
+
+  // 4. SERVICE VALIDATION TESTS
+  runTest('Service - Input Validations', async () => {
+    const mockPgClient: SQLClient = { query: async () => ({ rows: [] }) };
+    const service = new EmailTemplateService({
+      brevoApiKey: 'dummy-key',
+      defaultSender: { email: 'test@example.com', name: 'Tester' },
+      dbType: 'postgres',
+      dbClient: mockPgClient
+    });
+
+    // Test blank name constraint
+    try {
+      await service.updateTemplate(1, {
+        templateName: '',
+        subject: 'Sub',
+        sender: { email: 'test@example.com' },
+        htmlContent: '<html><body>Hello World!</body></html>',
+        eventName: 'test',
+        isActive: true
+      });
+      assert(false, 'Should throw error for blank name');
+    } catch (e: any) {
+      assert(e.message === 'Template name cannot be blank', 'Error message matches blank template validation');
+    }
+
+    // Test minimum HTML content length constraint (<= 10 chars)
+    try {
+      await service.updateTemplate(1, {
+        templateName: 'Valid Name',
+        subject: 'Sub',
+        sender: { email: 'test@example.com' },
+        htmlContent: '<html>',
+        eventName: 'test',
+        isActive: true
+      });
+      assert(false, 'Should throw error for short HTML body');
+    } catch (e: any) {
+      assert(e.message.includes('HTML content must be greater than 10 characters'), 'Error message matches HTML constraint');
+    }
+  });
+
+  // Wait a small duration to let asynchronous assertions print out
+  setTimeout(() => {
+    console.log(`\n📊 Tests complete. Total Passed: ${testPassedCount}, Failed: ${testFailedCount}`);
+    if (testFailedCount > 0) {
+      process.exit(1);
+    } else {
+      console.log('🌟 All unit tests executed successfully without issues!');
+      process.exit(0);
+    }
+  }, 100);
+}
+
+runTests().catch((err) => {
+  console.error('Fatal crash during test execution:', err);
+  process.exit(1);
+});

package/.kilo/worktrees/chip-sputter/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "declaration": true,
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist", "tests", "svelte", "react"]
+}

package/dist/controller.d.ts

@@ -1,4 +1,4 @@
-import { Request, Response, Router } from 'express';
+import type { Request, Response, Router } from 'express';
 import { EmailTemplateService } from './service.js';
 export declare class EmailTemplateController {
     private service;
@@ -7,7 +7,7 @@ export declare class EmailTemplateController {
      * Generates a fully configured Express Router.
      * Can be directly mounted into any Express app: `app.use('/api/cms', controller.getRouter())`
      */
-    getRouter(): Router;
+    getRouter(customRouter?: Router): Router;
     /**
      * GET /templates
      * Lists all templates synchronized from Brevo and mapped locally.

package/dist/controller.js

@@ -1,4 +1,18 @@
-import { Router } from 'express';
+import { createRequire } from 'node:module';
+let cachedExpressRouter;
+function getExpressRouter() {
+    if (cachedExpressRouter)
+        return cachedExpressRouter;
+    try {
+        const require = createRequire(import.meta.url);
+        const express = require('express');
+        cachedExpressRouter = express.Router;
+        return cachedExpressRouter;
+    }
+    catch {
+        throw new Error("The 'express' package is required to use EmailTemplateController. Please install express in your project: npm install express");
+    }
+}
 export class EmailTemplateController {
     service;
     constructor(service) {
@@ -8,8 +22,8 @@ export class EmailTemplateController {
      * Generates a fully configured Express Router.
      * Can be directly mounted into any Express app: `app.use('/api/cms', controller.getRouter())`
      */
-    getRouter() {
-        const router = Router();
+    getRouter(customRouter) {
+        const router = customRouter || getExpressRouter()();
         // Standard express mapping
         router.get('/templates', this.listTemplates.bind(this));
         router.get('/templates/:id', this.getTemplate.bind(this));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fufulog/brevomorphic-cms-sdk",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "type": "module",
   "description": "SDK library to bootstrap Brevo email templates and manage local mappings in Postgres, MySQL, or Firestore",
   "main": "dist/index.js",
@@ -11,6 +11,11 @@
       "import": "./dist/index.js",
       "default": "./dist/index.js"
     },
+    "./express": {
+      "types": "./dist/controller.d.ts",
+      "import": "./dist/controller.js",
+      "default": "./dist/controller.js"
+    },
     "./svelte/BrevoWysiwyg.svelte": {
       "types": "./svelte/BrevoWysiwyg.svelte.d.ts",
       "import": "./svelte/BrevoWysiwyg.svelte",
@@ -57,5 +62,13 @@
   },
   "publishConfig": {
     "access": "public"
+  },
+  "peerDependencies": {
+    "express": "^4.19.2 || ^5.0.0"
+  },
+  "peerDependenciesMeta": {
+    "express": {
+      "optional": true
+    }
   }
-}
+}

package/src/controller.ts

@@ -1,6 +1,23 @@
-import { Request, Response, Router } from 'express';
+import type { Request, Response, Router } from 'express';
+import { createRequire } from 'node:module';
 import { EmailTemplateService } from './service.js';
 
+let cachedExpressRouter: any;
+
+function getExpressRouter(): any {
+  if (cachedExpressRouter) return cachedExpressRouter;
+  try {
+    const require = createRequire(import.meta.url);
+    const express = require('express');
+    cachedExpressRouter = express.Router;
+    return cachedExpressRouter;
+  } catch {
+    throw new Error(
+      "The 'express' package is required to use EmailTemplateController. Please install express in your project: npm install express"
+    );
+  }
+}
+
 export class EmailTemplateController {
   private service: EmailTemplateService;
 
@@ -12,8 +29,8 @@ export class EmailTemplateController {
    * Generates a fully configured Express Router.
    * Can be directly mounted into any Express app: `app.use('/api/cms', controller.getRouter())`
    */
-  getRouter(): Router {
-    const router = Router();
+  getRouter(customRouter?: Router): Router {
+    const router = customRouter || getExpressRouter()();
 
     // Standard express mapping
     router.get('/templates', this.listTemplates.bind(this));

package/tests/sdk.test.ts

@@ -221,6 +221,20 @@ async function runTests() {
     }
   });
 
+  // 5. CONTROLLER TESTS
+  runTest('Controller - getRouter with Express', async () => {
+    const mockPgClient: SQLClient = { query: async () => ({ rows: [] }) };
+    const service = new EmailTemplateService({
+      brevoApiKey: 'dummy-key',
+      defaultSender: { email: 'test@example.com' },
+      dbType: 'postgres',
+      dbClient: mockPgClient
+    });
+    const controller = new EmailTemplateController(service);
+    const router = controller.getRouter();
+    assert(typeof router === 'function' || typeof router === 'object', 'Router should be created');
+  });
+
   // Wait a small duration to let asynchronous assertions print out
   setTimeout(() => {
     console.log(`\n📊 Tests complete. Total Passed: ${testPassedCount}, Failed: ${testFailedCount}`);