@quatrain/messaging 1.1.2 → 1.1.4

package/dist/AbstractMessagingAdapter.d.ts

@@ -1,4 +1,8 @@
 import { MessagingParameters } from './Messaging';
+/**
+ * Base class contract enforcing setup logic across all messaging capabilities
+ * (Email, SMS, Push Notifications).
+ */
 export declare abstract class AbstractMessagingAdapter {
     protected _params: MessagingParameters;
     constructor(params?: MessagingParameters);

package/dist/AbstractMessagingAdapter.js

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AbstractMessagingAdapter = void 0;
+/**
+ * Base class contract enforcing setup logic across all messaging capabilities
+ * (Email, SMS, Push Notifications).
+ */
 class AbstractMessagingAdapter {
     constructor(params = {}) {
         this._params = {};

package/dist/MessageFormatter.d.ts

@@ -1,4 +1,22 @@
+/**
+ * Specialized utility handling string cleanup and Mustache interpolation for templates.
+ */
 export declare class MessageFormatter {
+    /**
+     * Cleans all HTML tags from the title string.
+     * This uses a robust, RegExp-free state loop to prevent any risk of Regular Expression
+     * Denial of Service (ReDoS) or catastrophic backtracking, fully satisfying SonarQube security rules.
+     *
+     * @param title - The raw subject line containing potential HTML tags.
+     * @returns The formatted title string with all HTML tags stripped out.
+     */
     static formatTitle(title: string): string;
+    /**
+     * Renders the Mustache layout with provided contextual variables.
+     *
+     * @param body - The markdown/HTML layout.
+     * @param data - The variables context map.
+     * @returns Parsed output string.
+     */
     static formatBody(body: string, data?: {}): string;
 }

package/dist/MessageFormatter.js

@@ -5,12 +5,44 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MessageFormatter = void 0;
 const mustache_1 = __importDefault(require("mustache"));
+/**
+ * Specialized utility handling string cleanup and Mustache interpolation for templates.
+ */
 class MessageFormatter {
+    /**
+     * Cleans all HTML tags from the title string.
+     * This uses a robust, RegExp-free state loop to prevent any risk of Regular Expression
+     * Denial of Service (ReDoS) or catastrophic backtracking, fully satisfying SonarQube security rules.
+     *
+     * @param title - The raw subject line containing potential HTML tags.
+     * @returns The formatted title string with all HTML tags stripped out.
+     */
     static formatTitle(title) {
-        return title.replace(/<[^>]*>/gi, '');
+        let result = '';
+        let inTag = false;
+        for (let i = 0; i < title.length; i++) {
+            const char = title[i];
+            if (char === '<') {
+                inTag = true;
+            }
+            else if (char === '>') {
+                inTag = false;
+            }
+            else if (!inTag) {
+                result += char;
+            }
+        }
+        return result;
     }
+    /**
+     * Renders the Mustache layout with provided contextual variables.
+     *
+     * @param body - The markdown/HTML layout.
+     * @param data - The variables context map.
+     * @returns Parsed output string.
+     */
     static formatBody(body, data) {
-        return mustache_1.default.render(body, data);
+        return mustache_1.default.render(body, data || {});
     }
 }
 exports.MessageFormatter = MessageFormatter;

package/dist/Messaging.d.ts

@@ -9,10 +9,29 @@ export interface MessagingParameters {
     config?: any;
     debug?: boolean;
 }
+/**
+ * Singleton Registry dispatching text messages, emails, or push notifications.
+ */
 export declare class Messaging extends Core {
+    /** The alias for the primary fallback messager instance. */
     static defaultMessager: string;
+    /** Scoped domain logger. */
     static logger: any;
     protected static _messagers: MessagingRegistry<any>;
+    /**
+     * Wires an instantiated messaging client into the global routing map.
+     *
+     * @param messager - The adapter logic handling the sends.
+     * @param alias - Registered alias label.
+     * @param setDefault - Whether this is the new system default router.
+     */
     static addMessager(messager: NotificationCapableAdapter | EmailCapableAdapter | TextCapableAdapter, alias: string, setDefault?: boolean): void;
+    /**
+     * Recovers a registered messager by alias.
+     *
+     * @param alias - The name identifier.
+     * @returns The requested messaging provider.
+     * @throws If the alias was never registered.
+     */
     static getMessager(alias?: string): any;
 }

package/dist/Messaging.js

@@ -3,13 +3,30 @@ var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Messaging = void 0;
 const core_1 = require("@quatrain/core");
+/**
+ * Singleton Registry dispatching text messages, emails, or push notifications.
+ */
 class Messaging extends core_1.Core {
+    /**
+     * Wires an instantiated messaging client into the global routing map.
+     *
+     * @param messager - The adapter logic handling the sends.
+     * @param alias - Registered alias label.
+     * @param setDefault - Whether this is the new system default router.
+     */
     static addMessager(messager, alias, setDefault = false) {
         this._messagers[alias] = messager;
         if (setDefault) {
             this.defaultMessager = alias;
         }
     }
+    /**
+     * Recovers a registered messager by alias.
+     *
+     * @param alias - The name identifier.
+     * @returns The requested messaging provider.
+     * @throws If the alias was never registered.
+     */
     static getMessager(alias = this.defaultMessager) {
         if (this._messagers[alias]) {
             return this._messagers[alias];
@@ -21,6 +38,8 @@ class Messaging extends core_1.Core {
 }
 exports.Messaging = Messaging;
 _a = Messaging;
+/** The alias for the primary fallback messager instance. */
 Messaging.defaultMessager = 'default';
+/** Scoped domain logger. */
 Messaging.logger = _a.addLogger('Messaging');
 Messaging._messagers = {};

package/dist/Messaging.test.js

@@ -11,6 +11,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 const Messaging_1 = require("./Messaging");
 const MockMessagingAdapter_1 = require("./MockMessagingAdapter");
+const MessageFormatter_1 = require("./MessageFormatter");
 describe('Messaging', () => {
     let mockAdapter1;
     let mockAdapter2;
@@ -255,4 +256,39 @@ describe('Messaging', () => {
             expect(Messaging_1.Messaging.logger).toBeDefined();
         });
     });
+    describe('MessageFormatter', () => {
+        describe('formatTitle', () => {
+            it('should strip single HTML tags correctly', () => {
+                const raw = 'Hello <b>World</b>!';
+                const result = MessageFormatter_1.MessageFormatter.formatTitle(raw);
+                expect(result).toBe('Hello World!');
+            });
+            it('should strip multiple nested and unclosed tags correctly', () => {
+                const raw = '<div><p>Welcome to <span>Quatrain</span></p></div>';
+                const result = MessageFormatter_1.MessageFormatter.formatTitle(raw);
+                expect(result).toBe('Welcome to Quatrain');
+            });
+            it('should return plain text unchanged', () => {
+                const raw = 'Plain text without any tags.';
+                const result = MessageFormatter_1.MessageFormatter.formatTitle(raw);
+                expect(result).toBe(raw);
+            });
+            it('should handle empty string correctly', () => {
+                expect(MessageFormatter_1.MessageFormatter.formatTitle('')).toBe('');
+            });
+        });
+        describe('formatBody', () => {
+            it('should interpolate Mustache variables correctly', () => {
+                const template = 'Hello {{firstname}} {{lastname}}!';
+                const data = { firstname: 'John', lastname: 'Doe' };
+                const result = MessageFormatter_1.MessageFormatter.formatBody(template, data);
+                expect(result).toBe('Hello John Doe!');
+            });
+            it('should render original template when no data is provided', () => {
+                const template = 'Hello {{firstname}}!';
+                const result = MessageFormatter_1.MessageFormatter.formatBody(template);
+                expect(result).toBe('Hello !');
+            });
+        });
+    });
 });

package/dist/MockMessagingAdapter.d.ts

@@ -18,15 +18,78 @@ interface SentMessage {
 export declare class MockMessagingAdapter extends AbstractMessagingAdapter implements NotificationCapableAdapter, EmailCapableAdapter, TextCapableAdapter {
     private sentMessages;
     constructor(params?: MessagingParameters);
+    /**
+     * Mock tracking of a single notification dispatch.
+     *
+     * @param recipient - Target info.
+     * @param message - Payload.
+     * @returns Mock response object.
+     */
     sendNotification(recipient: MessagingRecipient, message: NotificationMessage): Promise<any>;
+    /**
+     * Mock tracking of a batch notification dispatch.
+     *
+     * @param recipients - Array of targets.
+     * @param message - Payload.
+     * @returns Mock batch response object.
+     */
     sendNotifications(recipients: MessagingRecipient[], message: NotificationMessage): Promise<any>;
+    /**
+     * Mock tracking of a single email dispatch.
+     *
+     * @param recipient - Target info.
+     * @param message - Payload.
+     * @returns Mock response object.
+     */
     sendEmail(recipient: MessagingRecipient, message: NotificationMessage): Promise<any>;
+    /**
+     * Mock tracking of a batch email dispatch.
+     *
+     * @param recipients - Array of targets.
+     * @param message - Payload.
+     * @returns Mock batch response object.
+     */
     sendEmails(recipients: MessagingRecipient[], message: NotificationMessage): Promise<any>;
+    /**
+     * Mock tracking of a single SMS dispatch.
+     *
+     * @param recipient - Target info.
+     * @param message - Payload.
+     * @returns Mock response object.
+     */
     sendTextMessage(recipient: MessagingRecipient, message: NotificationMessage): Promise<any>;
+    /**
+     * Mock tracking of a batch SMS dispatch.
+     *
+     * @param recipients - Array of targets.
+     * @param message - Payload.
+     * @returns Mock batch response object.
+     */
     sendTextMessages(recipients: MessagingRecipient[], message: NotificationMessage): Promise<any>;
+    /**
+     * Testing utility to retrieve sent messages by category.
+     *
+     * @param type - Optional filter tag.
+     * @returns Array of saved payloads.
+     */
     getSentMessages(type?: 'notification' | 'email' | 'text'): SentMessage[];
+    /**
+     * Erases the internal mock history log.
+     */
     clearMessages(): void;
+    /**
+     * Retrieves the total count of mock-sent payloads.
+     *
+     * @param type - Optional filter tag.
+     * @returns Total matching elements.
+     */
     getMessageCount(type?: 'notification' | 'email' | 'text'): number;
+    /**
+     * Peeks at the most recently dispatched message.
+     *
+     * @param type - Optional filter tag.
+     * @returns SentMessage representation.
+     */
     getLastMessage(type?: 'notification' | 'email' | 'text'): SentMessage | undefined;
 }
 export {};

package/dist/MockMessagingAdapter.js

@@ -20,6 +20,13 @@ class MockMessagingAdapter extends AbstractMessagingAdapter_1.AbstractMessagingA
         super(params);
         this.sentMessages = [];
     }
+    /**
+     * Mock tracking of a single notification dispatch.
+     *
+     * @param recipient - Target info.
+     * @param message - Payload.
+     * @returns Mock response object.
+     */
     sendNotification(recipient, message) {
         return __awaiter(this, void 0, void 0, function* () {
             this.sentMessages.push({
@@ -35,6 +42,13 @@ class MockMessagingAdapter extends AbstractMessagingAdapter_1.AbstractMessagingA
             };
         });
     }
+    /**
+     * Mock tracking of a batch notification dispatch.
+     *
+     * @param recipients - Array of targets.
+     * @param message - Payload.
+     * @returns Mock batch response object.
+     */
     sendNotifications(recipients, message) {
         return __awaiter(this, void 0, void 0, function* () {
             this.sentMessages.push({
@@ -50,6 +64,13 @@ class MockMessagingAdapter extends AbstractMessagingAdapter_1.AbstractMessagingA
             };
         });
     }
+    /**
+     * Mock tracking of a single email dispatch.
+     *
+     * @param recipient - Target info.
+     * @param message - Payload.
+     * @returns Mock response object.
+     */
     sendEmail(recipient, message) {
         return __awaiter(this, void 0, void 0, function* () {
             this.sentMessages.push({
@@ -65,6 +86,13 @@ class MockMessagingAdapter extends AbstractMessagingAdapter_1.AbstractMessagingA
             };
         });
     }
+    /**
+     * Mock tracking of a batch email dispatch.
+     *
+     * @param recipients - Array of targets.
+     * @param message - Payload.
+     * @returns Mock batch response object.
+     */
     sendEmails(recipients, message) {
         return __awaiter(this, void 0, void 0, function* () {
             this.sentMessages.push({
@@ -80,6 +108,13 @@ class MockMessagingAdapter extends AbstractMessagingAdapter_1.AbstractMessagingA
             };
         });
     }
+    /**
+     * Mock tracking of a single SMS dispatch.
+     *
+     * @param recipient - Target info.
+     * @param message - Payload.
+     * @returns Mock response object.
+     */
     sendTextMessage(recipient, message) {
         return __awaiter(this, void 0, void 0, function* () {
             this.sentMessages.push({
@@ -95,6 +130,13 @@ class MockMessagingAdapter extends AbstractMessagingAdapter_1.AbstractMessagingA
             };
         });
     }
+    /**
+     * Mock tracking of a batch SMS dispatch.
+     *
+     * @param recipients - Array of targets.
+     * @param message - Payload.
+     * @returns Mock batch response object.
+     */
     sendTextMessages(recipients, message) {
         return __awaiter(this, void 0, void 0, function* () {
             this.sentMessages.push({
@@ -111,18 +153,39 @@ class MockMessagingAdapter extends AbstractMessagingAdapter_1.AbstractMessagingA
         });
     }
     // Helper methods for testing
+    /**
+     * Testing utility to retrieve sent messages by category.
+     *
+     * @param type - Optional filter tag.
+     * @returns Array of saved payloads.
+     */
     getSentMessages(type) {
         if (type) {
             return this.sentMessages.filter((msg) => msg.type === type);
         }
         return this.sentMessages;
     }
+    /**
+     * Erases the internal mock history log.
+     */
     clearMessages() {
         this.sentMessages = [];
     }
+    /**
+     * Retrieves the total count of mock-sent payloads.
+     *
+     * @param type - Optional filter tag.
+     * @returns Total matching elements.
+     */
     getMessageCount(type) {
         return this.getSentMessages(type).length;
     }
+    /**
+     * Peeks at the most recently dispatched message.
+     *
+     * @param type - Optional filter tag.
+     * @returns SentMessage representation.
+     */
     getLastMessage(type) {
         const messages = this.getSentMessages(type);
         return messages[messages.length - 1];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quatrain/messaging",
-  "version": "1.1.2",
+  "version": "1.1.4",
   "license": "AGPL-3.0-only",
   "description": "Messaging adapters commons",
   "main": "dist/index.js",
@@ -20,7 +20,7 @@
   },
   "author": "Quatrain Développement SAS <developers@quatrain.com>",
   "dependencies": {
-    "@quatrain/core": "^1.2.5",
+    "@quatrain/core": "^1.2.11",
     "mustache": "^4.2.0"
   },
   "devDependencies": {

package/src/AbstractMessagingAdapter.ts

@@ -1,5 +1,9 @@
 import { MessagingParameters } from './Messaging'
 
+/**
+ * Base class contract enforcing setup logic across all messaging capabilities 
+ * (Email, SMS, Push Notifications).
+ */
 export abstract class AbstractMessagingAdapter {
    protected _params: MessagingParameters = {}
 

package/src/MessageFormatter.ts

@@ -1,11 +1,41 @@
 import Mustache from 'mustache'
 
+/**
+ * Specialized utility handling string cleanup and Mustache interpolation for templates.
+ */
 export class MessageFormatter {
-   static formatTitle(title: string) {
-      return title.replace(/<[^>]*>/gi, '')
+   /**
+    * Cleans all HTML tags from the title string.
+    * This uses a robust, RegExp-free state loop to prevent any risk of Regular Expression
+    * Denial of Service (ReDoS) or catastrophic backtracking, fully satisfying SonarQube security rules.
+    * 
+    * @param title - The raw subject line containing potential HTML tags.
+    * @returns The formatted title string with all HTML tags stripped out.
+    */
+   static formatTitle(title: string): string {
+      let result = ''
+      let inTag = false
+      for (let i = 0; i < title.length; i++) {
+         const char = title[i]
+         if (char === '<') {
+            inTag = true
+         } else if (char === '>') {
+            inTag = false
+         } else if (!inTag) {
+            result += char
+         }
+      }
+      return result
    }
 
+   /**
+    * Renders the Mustache layout with provided contextual variables.
+    * 
+    * @param body - The markdown/HTML layout.
+    * @param data - The variables context map.
+    * @returns Parsed output string.
+    */
    static formatBody(body: string, data?: {}) {
-      return Mustache.render(body, data)
+      return Mustache.render(body, data || {})
    }
 }

package/src/Messaging.test.ts

@@ -2,6 +2,7 @@ import { Messaging, MessagingParameters } from './Messaging'
 import { MockMessagingAdapter } from './MockMessagingAdapter'
 import { MessagingRecipient } from './types/MessagingRecipient'
 import { NotificationMessage } from './types/NotificationMessage'
+import { MessageFormatter } from './MessageFormatter'
 
 describe('Messaging', () => {
    let mockAdapter1: MockMessagingAdapter
@@ -315,4 +316,45 @@ describe('Messaging', () => {
          expect(Messaging.logger).toBeDefined()
       })
    })
+
+   describe('MessageFormatter', () => {
+      describe('formatTitle', () => {
+         it('should strip single HTML tags correctly', () => {
+            const raw = 'Hello <b>World</b>!'
+            const result = MessageFormatter.formatTitle(raw)
+            expect(result).toBe('Hello World!')
+         })
+
+         it('should strip multiple nested and unclosed tags correctly', () => {
+            const raw = '<div><p>Welcome to <span>Quatrain</span></p></div>'
+            const result = MessageFormatter.formatTitle(raw)
+            expect(result).toBe('Welcome to Quatrain')
+         })
+
+         it('should return plain text unchanged', () => {
+            const raw = 'Plain text without any tags.'
+            const result = MessageFormatter.formatTitle(raw)
+            expect(result).toBe(raw)
+         })
+
+         it('should handle empty string correctly', () => {
+            expect(MessageFormatter.formatTitle('')).toBe('')
+         })
+      })
+
+      describe('formatBody', () => {
+         it('should interpolate Mustache variables correctly', () => {
+            const template = 'Hello {{firstname}} {{lastname}}!'
+            const data = { firstname: 'John', lastname: 'Doe' }
+            const result = MessageFormatter.formatBody(template, data)
+            expect(result).toBe('Hello John Doe!')
+         })
+
+         it('should render original template when no data is provided', () => {
+            const template = 'Hello {{firstname}}!'
+            const result = MessageFormatter.formatBody(template)
+            expect(result).toBe('Hello !')
+         })
+      })
+   })
 })

package/src/Messaging.ts

@@ -14,12 +14,24 @@ export interface MessagingParameters {
    debug?: boolean
 }
 
+/**
+ * Singleton Registry dispatching text messages, emails, or push notifications.
+ */
 export class Messaging extends Core {
+   /** The alias for the primary fallback messager instance. */
    static defaultMessager = 'default'
+   /** Scoped domain logger. */
    static logger = this.addLogger('Messaging')
 
    protected static _messagers: MessagingRegistry<any> = {}
 
+   /**
+    * Wires an instantiated messaging client into the global routing map.
+    * 
+    * @param messager - The adapter logic handling the sends.
+    * @param alias - Registered alias label.
+    * @param setDefault - Whether this is the new system default router.
+    */
    static addMessager(
       messager:
          | NotificationCapableAdapter
@@ -34,6 +46,13 @@ export class Messaging extends Core {
       }
    }
 
+   /**
+    * Recovers a registered messager by alias.
+    * 
+    * @param alias - The name identifier.
+    * @returns The requested messaging provider.
+    * @throws If the alias was never registered.
+    */
    static getMessager(alias: string = this.defaultMessager) {
       if (this._messagers[alias]) {
          return this._messagers[alias]

package/src/MockMessagingAdapter.ts

@@ -30,6 +30,13 @@ export class MockMessagingAdapter
       super(params)
    }
 
+   /**
+    * Mock tracking of a single notification dispatch.
+    * 
+    * @param recipient - Target info.
+    * @param message - Payload.
+    * @returns Mock response object.
+    */
    async sendNotification(
       recipient: MessagingRecipient,
       message: NotificationMessage
@@ -48,6 +55,13 @@ export class MockMessagingAdapter
       }
    }
 
+   /**
+    * Mock tracking of a batch notification dispatch.
+    * 
+    * @param recipients - Array of targets.
+    * @param message - Payload.
+    * @returns Mock batch response object.
+    */
    async sendNotifications(
       recipients: MessagingRecipient[],
       message: NotificationMessage
@@ -66,6 +80,13 @@ export class MockMessagingAdapter
       }
    }
 
+   /**
+    * Mock tracking of a single email dispatch.
+    * 
+    * @param recipient - Target info.
+    * @param message - Payload.
+    * @returns Mock response object.
+    */
    async sendEmail(
       recipient: MessagingRecipient,
       message: NotificationMessage
@@ -84,6 +105,13 @@ export class MockMessagingAdapter
       }
    }
 
+   /**
+    * Mock tracking of a batch email dispatch.
+    * 
+    * @param recipients - Array of targets.
+    * @param message - Payload.
+    * @returns Mock batch response object.
+    */
    async sendEmails(
       recipients: MessagingRecipient[],
       message: NotificationMessage
@@ -102,6 +130,13 @@ export class MockMessagingAdapter
       }
    }
 
+   /**
+    * Mock tracking of a single SMS dispatch.
+    * 
+    * @param recipient - Target info.
+    * @param message - Payload.
+    * @returns Mock response object.
+    */
    async sendTextMessage(
       recipient: MessagingRecipient,
       message: NotificationMessage
@@ -120,6 +155,13 @@ export class MockMessagingAdapter
       }
    }
 
+   /**
+    * Mock tracking of a batch SMS dispatch.
+    * 
+    * @param recipients - Array of targets.
+    * @param message - Payload.
+    * @returns Mock batch response object.
+    */
    async sendTextMessages(
       recipients: MessagingRecipient[],
       message: NotificationMessage
@@ -139,6 +181,12 @@ export class MockMessagingAdapter
    }
 
    // Helper methods for testing
+   /**
+    * Testing utility to retrieve sent messages by category.
+    * 
+    * @param type - Optional filter tag.
+    * @returns Array of saved payloads.
+    */
    getSentMessages(type?: 'notification' | 'email' | 'text'): SentMessage[] {
       if (type) {
          return this.sentMessages.filter((msg) => msg.type === type)
@@ -146,14 +194,29 @@ export class MockMessagingAdapter
       return this.sentMessages
    }
 
+   /**
+    * Erases the internal mock history log.
+    */
    clearMessages(): void {
       this.sentMessages = []
    }
 
+   /**
+    * Retrieves the total count of mock-sent payloads.
+    * 
+    * @param type - Optional filter tag.
+    * @returns Total matching elements.
+    */
    getMessageCount(type?: 'notification' | 'email' | 'text'): number {
       return this.getSentMessages(type).length
    }
 
+   /**
+    * Peeks at the most recently dispatched message.
+    * 
+    * @param type - Optional filter tag.
+    * @returns SentMessage representation.
+    */
    getLastMessage(
       type?: 'notification' | 'email' | 'text'
    ): SentMessage | undefined {