@nauth-toolkit/core 0.1.13 → 0.1.17

package/dist/templates/html-template.engine.js

@@ -4,37 +4,112 @@ exports.HtmlTemplateEngine = void 0;
 const template_interface_1 = require("../interfaces/template.interface");
 const nauth_exception_1 = require("../exceptions/nauth.exception");
 const error_codes_enum_1 = require("../enums/error-codes.enum");
+/**
+ * HTML Template Engine
+ *
+ * Simple yet powerful template engine for email templates using HTML with placeholder tokens.
+ * Supports {{variable}} syntax for variable injection.
+ *
+ * Features:
+ * - Simple {{variable}} placeholder syntax
+ * - Built-in default templates for all email types
+ * - Custom template registration
+ * - Automatic HTML entity escaping for security
+ * - Plain text generation from HTML
+ *
+ * @example
+ * ```typescript
+ * const engine = new HtmlTemplateEngine();
+ * const result = await engine.render(
+ *   TemplateType.VERIFICATION,
+ *   { userName: 'John', code: '123456', expiryMinutes: 60 }
+ * );
+ * ```
+ */
 class HtmlTemplateEngine {
+    /**
+     * Storage for registered templates
+     * Maps template type to template definition
+     */
     templates = new Map();
+    /**
+     * Constructor
+     * Initializes the engine with default templates
+     */
     constructor() {
         this.registerDefaultTemplates();
     }
+    /**
+     * Render a template with variables
+     *
+     * Replaces all {{variable}} placeholders with actual values.
+     * Variables are HTML-escaped for security.
+     * Handles firstName/username fallback for greetings.
+     *
+     * @param type - Template type to render
+     * @param variables - Variables to inject
+     * @returns Rendered email template
+     * @throws {Error} If template type not found
+     */
     async render(type, variables) {
         const template = this.templates.get(type);
         if (!template) {
             throw new nauth_exception_1.NAuthException(error_codes_enum_1.AuthErrorCode.INTERNAL_ERROR, `Template "${type}" not found. Available templates: ${Array.from(this.templates.keys()).join(', ')}`);
         }
+        // Merge with default variables and add greeting name
         const allVariables = {
             currentYear: new Date().getFullYear(),
             ...variables,
             greetingName: this.getGreetingName(variables),
         };
+        // Render subject and HTML
         const subject = this.replaceVariables(template.subject, allVariables);
         const html = this.replaceVariables(template.html, allVariables);
+        // Generate plain text if not provided
         const text = template.text ? this.replaceVariablesForText(template.text, allVariables) : this.htmlToText(html);
         return { subject, html, text };
     }
+    /**
+     * Register a custom template
+     *
+     * @param type - Template type identifier
+     * @param template - Template definition
+     */
     registerTemplate(type, template) {
         this.templates.set(type, template);
     }
+    /**
+     * Get all available template types
+     *
+     * @returns Array of template type identifiers
+     */
     getAvailableTemplates() {
         return Array.from(this.templates.keys());
     }
+    /**
+     * Check if a template exists
+     *
+     * @param type - Template type to check
+     * @returns True if template is registered
+     */
     hasTemplate(type) {
         return this.templates.has(type);
     }
+    /**
+     * Replace {{variable}} placeholders with values
+     *
+     * Escapes HTML entities in variables for security.
+     * Handles missing variables gracefully (replaces with empty string).
+     * Supports firstName/username fallback logic and simple conditionals.
+     *
+     * @param template - Template string with {{placeholders}}
+     * @param variables - Variables to inject
+     * @returns Template with variables replaced
+     * @private
+     */
     replaceVariables(template, variables) {
         let result = template;
+        // Handle simple conditionals like {{#if greetingName}}Hi {{greetingName}},{{else}}Hi,{{/if}}
         result = result.replace(/\{\{#if (\w+)\}\}(.*?)\{\{else\}\}(.*?)\{\{\/if\}\}/g, (_match, key, ifContent, elseContent) => {
             const value = variables[key];
             if (value && value !== '') {
@@ -44,17 +119,31 @@ class HtmlTemplateEngine {
                 return elseContent;
             }
         });
+        // Replace regular variables
         result = result.replace(/\{\{(\w+)\}\}/g, (_match, key) => {
             const value = variables[key];
+            // Return empty string if variable is undefined
             if (value === undefined || value === null) {
                 return '';
             }
+            // Convert to string and escape HTML entities
             return this.escapeHtml(String(value));
         });
         return result;
     }
+    /**
+     * Replace {{variable}} placeholders with values for text content
+     *
+     * Similar to replaceVariables but doesn't escape HTML entities for plain text.
+     *
+     * @param template - Template string with {{placeholders}}
+     * @param variables - Variables to inject
+     * @returns Template with variables replaced
+     * @private
+     */
     replaceVariablesForText(template, variables) {
         let result = template;
+        // Handle simple conditionals like {{#if greetingName}}Hi {{greetingName}},{{else}}Hi,{{/if}}
         result = result.replace(/\{\{#if (\w+)\}\}(.*?)\{\{else\}\}(.*?)\{\{\/if\}\}/g, (_match, key, ifContent, elseContent) => {
             const value = variables[key];
             if (value && value !== '') {
@@ -64,15 +153,25 @@ class HtmlTemplateEngine {
                 return elseContent;
             }
         });
+        // Replace regular variables without HTML escaping
         result = result.replace(/\{\{(\w+)\}\}/g, (_match, key) => {
             const value = variables[key];
+            // Return empty string if variable is undefined
             if (value === undefined || value === null) {
                 return '';
             }
+            // Convert to string without escaping HTML entities for text
             return String(value);
         });
         return result;
     }
+    /**
+     * Get greeting name with firstName/username fallback logic
+     *
+     * @param variables - Template variables
+     * @returns Greeting name or empty string
+     * @private
+     */
     getGreetingName(variables) {
         if (variables.firstName) {
             return variables.firstName;
@@ -82,6 +181,13 @@ class HtmlTemplateEngine {
         }
         return '';
     }
+    /**
+     * Escape HTML entities to prevent XSS
+     *
+     * @param text - Text to escape
+     * @returns HTML-safe text
+     * @private
+     */
     escapeHtml(text) {
         const map = {
             '&': '&',
@@ -92,18 +198,39 @@ class HtmlTemplateEngine {
         };
         return text.replace(/[&<>"']/g, (char) => map[char] || char);
     }
+    /**
+     * Convert HTML to plain text
+     *
+     * Simple conversion: strips HTML tags and decodes entities.
+     *
+     * @param html - HTML content
+     * @returns Plain text
+     * @private
+     */
     htmlToText(html) {
+        // Strip HTML tags
         let text = html.replace(/<[^>]*>/g, '');
+        // Decode common HTML entities
         text = text.replace(/&nbsp;/g, ' ');
         text = text.replace(/&lt;/g, '<');
         text = text.replace(/&gt;/g, '>');
         text = text.replace(/&quot;/g, '"');
         text = text.replace(/&#039;/g, "'");
         text = text.replace(/&amp;/g, '&');
+        // Normalize whitespace
         text = text.replace(/\s+/g, ' ').trim();
         return text;
     }
+    /**
+     * Register default templates for all email types
+     *
+     * These templates can be overridden using registerTemplate().
+     * @private
+     */
     registerDefaultTemplates() {
+        // ============================================================================
+        // Email Verification Template
+        // ============================================================================
         this.registerTemplate(template_interface_1.TemplateType.VERIFICATION, {
             subject: 'Email Verification - {{appName}}',
             html: `
@@ -155,6 +282,9 @@ This code expires in {{expiryMinutes}} minutes.
 If you didn't request this verification, please ignore this email.
       `,
         });
+        // ============================================================================
+        // Password Reset Template
+        // ============================================================================
         this.registerTemplate(template_interface_1.TemplateType.PASSWORD_RESET, {
             subject: 'Password Reset - {{appName}}',
             html: `
@@ -202,6 +332,9 @@ This link expires in {{expiryMinutes}} minutes.
 If you didn't request a password reset, your account is secure and you can ignore this email.
       `,
         });
+        // ============================================================================
+        // Welcome Email Template
+        // ============================================================================
         this.registerTemplate(template_interface_1.TemplateType.WELCOME, {
             subject: 'Welcome to {{appName}}!',
             html: `
@@ -247,6 +380,9 @@ If you have any questions or need assistance, reach out to our support team at {
 Happy exploring!
       `,
         });
+        // ============================================================================
+        // Account Lockout Template
+        // ============================================================================
         this.registerTemplate(template_interface_1.TemplateType.ACCOUNT_LOCKOUT, {
             subject: 'Account Locked - {{appName}}',
             html: `
@@ -307,6 +443,9 @@ What should I do?
 - Consider changing your password after unlock
       `,
         });
+        // ============================================================================
+        // New Device Login Template
+        // ============================================================================
         this.registerTemplate(template_interface_1.TemplateType.NEW_DEVICE, {
             subject: 'New Device Login - {{appName}}',
             html: `
@@ -373,6 +512,8 @@ If you don't recognize this activity, secure your account immediately:
 - Contact support at {{supportEmail}}
       `,
         });
+        // Password Changed Template
+        // ============================================================================
         this.registerTemplate(template_interface_1.TemplateType.PASSWORD_CHANGED, {
             subject: 'Password Changed - {{appName}}',
             html: `
@@ -414,6 +555,9 @@ If you made this change, no further action is required.
 If you didn't make this change, please contact support immediately at {{supportEmail}}.
       `,
         });
+        // ============================================================================
+        // Email Changed Template
+        // ============================================================================
         this.registerTemplate(template_interface_1.TemplateType.EMAIL_CHANGED, {
             subject: 'Email Address Changed - {{appName}}',
             html: `
@@ -455,6 +599,9 @@ If you made this change, no further action is required.
 If you didn't make this change, please contact support immediately at {{supportEmail}}.
       `,
         });
+        // ============================================================================
+        // MFA Enabled Template
+        // ============================================================================
         this.registerTemplate(template_interface_1.TemplateType.MFA_ENABLED, {
             subject: 'Two-Factor Authentication Enabled - {{appName}}',
             html: `

package/dist/templates/html-template.engine.js.map

@@ -1 +1 @@
-{"version":3,"file":"html-template.engine.js","sourceRoot":"","sources":["../../src/templates/html-template.engine.ts"],"names":[],"mappings":";;;AAAA,yEAAkH;AAClH,mEAA+D;AAC/D,gEAA0D;AAwB1D,MAAa,kBAAkB;IAKrB,SAAS,GAA+B,IAAI,GAAG,EAAE,CAAC;IAM1D;QACE,IAAI,CAAC,wBAAwB,EAAE,CAAC;IAClC,CAAC;IAcD,KAAK,CAAC,MAAM,CAAC,IAA2B,EAAE,SAA4B;QACpE,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAE1C,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,IAAI,gCAAc,CACtB,gCAAa,CAAC,cAAc,EAC5B,aAAa,IAAI,qCAAqC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CACrG,CAAC;QACJ,CAAC;QAGD,MAAM,YAAY,GAAsB;YACtC,WAAW,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;YACrC,GAAG,SAAS;YACZ,YAAY,EAAE,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC;SAC9C,CAAC;QAGF,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;QACtE,MAAM,IAAI,GAAG,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;QAGhE,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,uBAAuB,CAAC,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAE/G,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;IACjC,CAAC;IAQD,gBAAgB,CAAC,IAA2B,EAAE,QAAuB;QACnE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACrC,CAAC;IAOD,qBAAqB;QACnB,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC;IAC3C,CAAC;IAQD,WAAW,CAAC,IAA2B;QACrC,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;IAcO,gBAAgB,CAAC,QAAgB,EAAE,SAA4B;QACrE,IAAI,MAAM,GAAG,QAAQ,CAAC;QAGtB,MAAM,GAAG,MAAM,CAAC,OAAO,CACrB,sDAAsD,EACtD,CAAC,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,WAAW,EAAE,EAAE;YACtC,MAAM,KAAK,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;YAC7B,IAAI,KAAK,IAAI,KAAK,KAAK,EAAE,EAAE,CAAC;gBAC1B,OAAO,SAAS,CAAC;YACnB,CAAC;iBAAM,CAAC;gBACN,OAAO,WAAW,CAAC;YACrB,CAAC;QACH,CAAC,CACF,CAAC;QAGF,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE;YACxD,MAAM,KAAK,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;YAG7B,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;gBAC1C,OAAO,EAAE,CAAC;YACZ,CAAC;YAGD,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;IAChB,CAAC;IAYO,uBAAuB,CAAC,QAAgB,EAAE,SAA4B;QAC5E,IAAI,MAAM,GAAG,QAAQ,CAAC;QAGtB,MAAM,GAAG,MAAM,CAAC,OAAO,CACrB,sDAAsD,EACtD,CAAC,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,WAAW,EAAE,EAAE;YACtC,MAAM,KAAK,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;YAC7B,IAAI,KAAK,IAAI,KAAK,KAAK,EAAE,EAAE,CAAC;gBAC1B,OAAO,SAAS,CAAC;YACnB,CAAC;iBAAM,CAAC;gBACN,OAAO,WAAW,CAAC;YACrB,CAAC;QACH,CAAC,CACF,CAAC;QAGF,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE;YACxD,MAAM,KAAK,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;YAG7B,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;gBAC1C,OAAO,EAAE,CAAC;YACZ,CAAC;YAGD,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;IAChB,CAAC;IASO,eAAe,CAAC,SAA4B;QAClD,IAAI,SAAS,CAAC,SAAS,EAAE,CAAC;YACxB,OAAO,SAAS,CAAC,SAAS,CAAC;QAC7B,CAAC;QACD,IAAI,SAAS,CAAC,QAAQ,EAAE,CAAC;YACvB,OAAO,SAAS,CAAC,QAAQ,CAAC;QAC5B,CAAC;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;IASO,UAAU,CAAC,IAAY;QAC7B,MAAM,GAAG,GAA2B;YAClC,GAAG,EAAE,OAAO;YACZ,GAAG,EAAE,MAAM;YACX,GAAG,EAAE,MAAM;YACX,GAAG,EAAE,QAAQ;YACb,GAAG,EAAE,QAAQ;SACd,CAAC;QAEF,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,CAAC;IAC/D,CAAC;IAWO,UAAU,CAAC,IAAY;QAE7B,IAAI,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;QAGxC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;QACpC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;QAClC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;QAClC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;QACpC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;QACpC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;QAGnC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;QAExC,OAAO,IAAI,CAAC;IACd,CAAC;IAQO,wBAAwB;QAI9B,IAAI,CAAC,gBAAgB,CAAC,iCAAY,CAAC,YAAY,EAAE;YAC/C,OAAO,EAAE,kCAAkC;YAC3C,IAAI,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCL;YACD,IAAI,EAAE;;;;;;;;;;;;;;OAcL;SACF,CAAC,CAAC;QAKH,IAAI,CAAC,gBAAgB,CAAC,iCAAY,CAAC,cAAc,EAAE;YACjD,OAAO,EAAE,8BAA8B;YACvC,IAAI,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BL;YACD,IAAI,EAAE;;;;;;;;;;;;OAYL;SACF,CAAC,CAAC;QAKH,IAAI,CAAC,gBAAgB,CAAC,iCAAY,CAAC,OAAO,EAAE;YAC1C,OAAO,EAAE,yBAAyB;YAClC,IAAI,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BL;YACD,IAAI,EAAE;;;;;;;;;;;;OAYL;SACF,CAAC,CAAC;QAKH,IAAI,CAAC,gBAAgB,CAAC,iCAAY,CAAC,eAAe,EAAE;YAClD,OAAO,EAAE,8BAA8B;YACvC,IAAI,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCL;YACD,IAAI,EAAE;;;;;;;;;;;;;;;;;;OAkBL;SACF,CAAC,CAAC;QAKH,IAAI,CAAC,gBAAgB,CAAC,iCAAY,CAAC,UAAU,EAAE;YAC7C,OAAO,EAAE,gCAAgC;YACzC,IAAI,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCL;YACD,IAAI,EAAE;;;;;;;;;;;;;;;;;;;;;OAqBL;SACF,CAAC,CAAC;QAGH,IAAI,CAAC,gBAAgB,CAAC,iCAAY,CAAC,gBAAgB,EAAE;YACnD,OAAO,EAAE,gCAAgC;YACzC,IAAI,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BL;YACD,IAAI,EAAE;;;;;;;;;;OAUL;SACF,CAAC,CAAC;QAKH,IAAI,CAAC,gBAAgB,CAAC,iCAAY,CAAC,aAAa,EAAE;YAChD,OAAO,EAAE,qCAAqC;YAC9C,IAAI,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BL;YACD,IAAI,EAAE;;;;;;;;;;OAUL;SACF,CAAC,CAAC;QAKH,IAAI,CAAC,gBAAgB,CAAC,iCAAY,CAAC,WAAW,EAAE;YAC9C,OAAO,EAAE,iDAAiD;YAC1D,IAAI,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BL;YACD,IAAI,EAAE;;;;;;;;;;OAUL;SACF,CAAC,CAAC;IACL,CAAC;CACF;AArpBD,gDAqpBC"}
+{"version":3,"file":"html-template.engine.js","sourceRoot":"","sources":["../../src/templates/html-template.engine.ts"],"names":[],"mappings":";;;AAAA,yEAAkH;AAClH,mEAA+D;AAC/D,gEAA0D;AAE1D;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAa,kBAAkB;IAC7B;;;OAGG;IACK,SAAS,GAA+B,IAAI,GAAG,EAAE,CAAC;IAE1D;;;OAGG;IACH;QACE,IAAI,CAAC,wBAAwB,EAAE,CAAC;IAClC,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,MAAM,CAAC,IAA2B,EAAE,SAA4B;QACpE,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAE1C,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,IAAI,gCAAc,CACtB,gCAAa,CAAC,cAAc,EAC5B,aAAa,IAAI,qCAAqC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CACrG,CAAC;QACJ,CAAC;QAED,qDAAqD;QACrD,MAAM,YAAY,GAAsB;YACtC,WAAW,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;YACrC,GAAG,SAAS;YACZ,YAAY,EAAE,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC;SAC9C,CAAC;QAEF,0BAA0B;QAC1B,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;QACtE,MAAM,IAAI,GAAG,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;QAEhE,sCAAsC;QACtC,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,uBAAuB,CAAC,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAE/G,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;IACjC,CAAC;IAED;;;;;OAKG;IACH,gBAAgB,CAAC,IAA2B,EAAE,QAAuB;QACnE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACrC,CAAC;IAED;;;;OAIG;IACH,qBAAqB;QACnB,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;OAKG;IACH,WAAW,CAAC,IAA2B;QACrC,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;IAED;;;;;;;;;;;OAWG;IACK,gBAAgB,CAAC,QAAgB,EAAE,SAA4B;QACrE,IAAI,MAAM,GAAG,QAAQ,CAAC;QAEtB,6FAA6F;QAC7F,MAAM,GAAG,MAAM,CAAC,OAAO,CACrB,sDAAsD,EACtD,CAAC,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,WAAW,EAAE,EAAE;YACtC,MAAM,KAAK,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;YAC7B,IAAI,KAAK,IAAI,KAAK,KAAK,EAAE,EAAE,CAAC;gBAC1B,OAAO,SAAS,CAAC;YACnB,CAAC;iBAAM,CAAC;gBACN,OAAO,WAAW,CAAC;YACrB,CAAC;QACH,CAAC,CACF,CAAC;QAEF,4BAA4B;QAC5B,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE;YACxD,MAAM,KAAK,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;YAE7B,+CAA+C;YAC/C,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;gBAC1C,OAAO,EAAE,CAAC;YACZ,CAAC;YAED,6CAA6C;YAC7C,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;;;;OASG;IACK,uBAAuB,CAAC,QAAgB,EAAE,SAA4B;QAC5E,IAAI,MAAM,GAAG,QAAQ,CAAC;QAEtB,6FAA6F;QAC7F,MAAM,GAAG,MAAM,CAAC,OAAO,CACrB,sDAAsD,EACtD,CAAC,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,WAAW,EAAE,EAAE;YACtC,MAAM,KAAK,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;YAC7B,IAAI,KAAK,IAAI,KAAK,KAAK,EAAE,EAAE,CAAC;gBAC1B,OAAO,SAAS,CAAC;YACnB,CAAC;iBAAM,CAAC;gBACN,OAAO,WAAW,CAAC;YACrB,CAAC;QACH,CAAC,CACF,CAAC;QAEF,kDAAkD;QAClD,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE;YACxD,MAAM,KAAK,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;YAE7B,+CAA+C;YAC/C,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;gBAC1C,OAAO,EAAE,CAAC;YACZ,CAAC;YAED,4DAA4D;YAC5D,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;OAMG;IACK,eAAe,CAAC,SAA4B;QAClD,IAAI,SAAS,CAAC,SAAS,EAAE,CAAC;YACxB,OAAO,SAAS,CAAC,SAAS,CAAC;QAC7B,CAAC;QACD,IAAI,SAAS,CAAC,QAAQ,EAAE,CAAC;YACvB,OAAO,SAAS,CAAC,QAAQ,CAAC;QAC5B,CAAC;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;;;;OAMG;IACK,UAAU,CAAC,IAAY;QAC7B,MAAM,GAAG,GAA2B;YAClC,GAAG,EAAE,OAAO;YACZ,GAAG,EAAE,MAAM;YACX,GAAG,EAAE,MAAM;YACX,GAAG,EAAE,QAAQ;YACb,GAAG,EAAE,QAAQ;SACd,CAAC;QAEF,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;OAQG;IACK,UAAU,CAAC,IAAY;QAC7B,kBAAkB;QAClB,IAAI,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;QAExC,8BAA8B;QAC9B,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;QACpC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;QAClC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;QAClC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;QACpC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;QACpC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;QAEnC,uBAAuB;QACvB,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;QAExC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACK,wBAAwB;QAC9B,+EAA+E;QAC/E,8BAA8B;QAC9B,+EAA+E;QAC/E,IAAI,CAAC,gBAAgB,CAAC,iCAAY,CAAC,YAAY,EAAE;YAC/C,OAAO,EAAE,kCAAkC;YAC3C,IAAI,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCL;YACD,IAAI,EAAE;;;;;;;;;;;;;;OAcL;SACF,CAAC,CAAC;QAEH,+EAA+E;QAC/E,0BAA0B;QAC1B,+EAA+E;QAC/E,IAAI,CAAC,gBAAgB,CAAC,iCAAY,CAAC,cAAc,EAAE;YACjD,OAAO,EAAE,8BAA8B;YACvC,IAAI,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BL;YACD,IAAI,EAAE;;;;;;;;;;;;OAYL;SACF,CAAC,CAAC;QAEH,+EAA+E;QAC/E,yBAAyB;QACzB,+EAA+E;QAC/E,IAAI,CAAC,gBAAgB,CAAC,iCAAY,CAAC,OAAO,EAAE;YAC1C,OAAO,EAAE,yBAAyB;YAClC,IAAI,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BL;YACD,IAAI,EAAE;;;;;;;;;;;;OAYL;SACF,CAAC,CAAC;QAEH,+EAA+E;QAC/E,2BAA2B;QAC3B,+EAA+E;QAC/E,IAAI,CAAC,gBAAgB,CAAC,iCAAY,CAAC,eAAe,EAAE;YAClD,OAAO,EAAE,8BAA8B;YACvC,IAAI,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCL;YACD,IAAI,EAAE;;;;;;;;;;;;;;;;;;OAkBL;SACF,CAAC,CAAC;QAEH,+EAA+E;QAC/E,4BAA4B;QAC5B,+EAA+E;QAC/E,IAAI,CAAC,gBAAgB,CAAC,iCAAY,CAAC,UAAU,EAAE;YAC7C,OAAO,EAAE,gCAAgC;YACzC,IAAI,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCL;YACD,IAAI,EAAE;;;;;;;;;;;;;;;;;;;;;OAqBL;SACF,CAAC,CAAC;QACH,4BAA4B;QAC5B,+EAA+E;QAC/E,IAAI,CAAC,gBAAgB,CAAC,iCAAY,CAAC,gBAAgB,EAAE;YACnD,OAAO,EAAE,gCAAgC;YACzC,IAAI,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BL;YACD,IAAI,EAAE;;;;;;;;;;OAUL;SACF,CAAC,CAAC;QAEH,+EAA+E;QAC/E,yBAAyB;QACzB,+EAA+E;QAC/E,IAAI,CAAC,gBAAgB,CAAC,iCAAY,CAAC,aAAa,EAAE;YAChD,OAAO,EAAE,qCAAqC;YAC9C,IAAI,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BL;YACD,IAAI,EAAE;;;;;;;;;;OAUL;SACF,CAAC,CAAC;QAEH,+EAA+E;QAC/E,uBAAuB;QACvB,+EAA+E;QAC/E,IAAI,CAAC,gBAAgB,CAAC,iCAAY,CAAC,WAAW,EAAE;YAC9C,OAAO,EAAE,iDAAiD;YAC1D,IAAI,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BL;YACD,IAAI,EAAE;;;;;;;;;;OAUL;SACF,CAAC,CAAC;IACL,CAAC;CACF;AArpBD,gDAqpBC"}

package/dist/templates/index.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Template System Exports
+ *
+ * Provides template engines and utilities for email and SMS notifications.
+ */
 export * from './html-template.engine';
 export * from './sms-template.engine';
 //# sourceMappingURL=index.d.ts.map

package/dist/templates/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/templates/index.ts"],"names":[],"mappings":"AAMA,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/templates/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC"}

package/dist/templates/index.js

@@ -1,4 +1,9 @@
 "use strict";
+/**
+ * Template System Exports
+ *
+ * Provides template engines and utilities for email and SMS notifications.
+ */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);

package/dist/templates/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/templates/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAMA,yDAAuC;AACvC,wDAAsC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/templates/index.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;;;;;;;;;;;;;;AAEH,yDAAuC;AACvC,wDAAsC"}

package/dist/templates/sms-template.engine.d.ts

@@ -1,19 +1,170 @@
 import { SMSTemplateEngine as ISMSTemplateEngine, SMSTemplateType, SMSTemplateVariables, SMSTemplate, SMSTemplateSource } from '../interfaces/sms-template.interface';
 import { NAuthLogger } from '../utils/nauth-logger';
+/**
+ * SMS Template Engine
+ *
+ * Simple yet powerful template engine for SMS templates using text with placeholder tokens.
+ * Supports {{variable}} syntax for variable injection using Handlebars-like syntax.
+ *
+ * Features:
+ * - Simple {{variable}} placeholder syntax
+ * - Built-in default templates for all SMS types
+ * - Custom template registration (inline and file-based)
+ * - Template validation (ensures required variables are present)
+ * - Handlebars-like conditionals support
+ *
+ * @example
+ * ```typescript
+ * const engine = new SMSTemplateEngine();
+ * const result = await engine.render(
+ *   SMSTemplateType.VERIFICATION,
+ *   { appName: 'My App', code: '123456', expiryMinutes: 5 }
+ * );
+ * // result.content: "My App: Your verification code is 123456. Valid for 5 minutes."
+ * ```
+ */
 export declare class SMSTemplateEngineImpl implements ISMSTemplateEngine {
+    /**
+     * Storage for registered templates
+     * Maps template type to template content string
+     */
     private templates;
+    /**
+     * Base directory for resolving relative template file paths
+     */
     private readonly baseDir;
+    /**
+     * Logger instance for error reporting
+     */
     private readonly logger?;
+    /**
+     * Constructor
+     *
+     * Initializes the engine with default templates.
+     *
+     * @param baseDir - Base directory for resolving template file paths (default: process.cwd())
+     * @param logger - Optional logger instance for error reporting
+     *
+     * @example
+     * ```typescript
+     * // Use default templates
+     * const engine = new SMSTemplateEngineImpl();
+     *
+     * // Use custom base directory for file-based templates
+     * const engine = new SMSTemplateEngineImpl('./sms-templates');
+     * ```
+     */
     constructor(baseDir?: string, logger?: NAuthLogger);
+    /**
+     * Render a template with variables
+     *
+     * Replaces all {{variable}} placeholders with actual values.
+     * Handles missing variables gracefully (replaces with empty string).
+     * Supports simple conditionals like {{#if variable}}...{{/if}}.
+     *
+     * @param type - Template type to render
+     * @param variables - Variables to inject
+     * @returns Rendered SMS template with content
+     * @throws {NAuthException} If template type not found
+     *
+     * @example
+     * ```typescript
+     * const result = await engine.render(
+     *   SMSTemplateType.VERIFICATION,
+     *   { appName: 'My App', code: '123456', expiryMinutes: 5 }
+     * );
+     * ```
+     */
     render(type: SMSTemplateType | string, variables: SMSTemplateVariables): Promise<SMSTemplate>;
+    /**
+     * Register a custom template from inline string
+     *
+     * Allows overriding default templates or adding new ones.
+     *
+     * @param type - Template type identifier
+     * @param template - Template definition with inline content
+     *
+     * @example
+     * ```typescript
+     * engine.registerTemplate(SMSTemplateType.VERIFICATION, {
+     *   content: '{{appName}}: Your verification code is {{code}}. Expires in {{expiryMinutes}} min.',
+     * });
+     * ```
+     */
     registerTemplate(type: SMSTemplateType | string, template: SMSTemplate): void;
+    /**
+     * Register a custom template from mixed sources (strings or files)
+     *
+     * Flexible registration that supports both inline content and file paths.
+     *
+     * @param type - Template type identifier
+     * @param templateSource - Template source (content or file path)
+     *
+     * @throws {NAuthException} If file not found or invalid source
+     *
+     * @example
+     * ```typescript
+     * // Inline content
+     * await engine.registerTemplateFromSources(SMSTemplateType.VERIFICATION, {
+     *   content: { content: '{{appName}}: Your code is {{code}}.' },
+     * });
+     *
+     * // File-based
+     * await engine.registerTemplateFromSources(SMSTemplateType.MFA, {
+     *   content: { filePath: './sms-templates/mfa.txt.hbs' },
+     * });
+     * ```
+     */
     registerTemplateFromSources(type: SMSTemplateType | string, templateSource: {
         content: SMSTemplateSource;
     }): Promise<void>;
+    /**
+     * Get all available template types
+     *
+     * @returns Array of registered template type identifiers
+     */
     getAvailableTemplates(): string[];
+    /**
+     * Check if a template exists
+     *
+     * @param type - Template type to check
+     * @returns True if template is registered
+     */
     hasTemplate(type: SMSTemplateType | string): boolean;
+    /**
+     * Validate that a template includes required variables
+     *
+     * Checks if the template content includes all required placeholders.
+     *
+     * @param type - Template type to validate
+     * @param requiredVars - Array of required variable names (without {{}})
+     * @returns True if all required variables are present
+     *
+     * @example
+     * ```typescript
+     * const isValid = engine.validateTemplate(SMSTemplateType.VERIFICATION, ['code', 'expiryMinutes']);
+     * ```
+     */
     validateTemplate(type: SMSTemplateType | string, requiredVars: string[]): boolean;
+    /**
+     * Register default templates for all SMS types
+     *
+     * Provides sensible defaults that can be overridden by custom templates.
+     *
+     * @private
+     */
     private registerDefaultTemplates;
+    /**
+     * Replace {{variable}} placeholders with values
+     *
+     * Handles missing variables gracefully (replaces with empty string).
+     * Supports simple conditionals like {{#if variable}}...{{/if}}.
+     *
+     * @param template - Template string with {{placeholders}}
+     * @param variables - Variables to inject
+     * @returns Template with variables replaced
+     * @private
+     */
     private replaceVariables;
 }
 //# sourceMappingURL=sms-template.engine.d.ts.map

package/dist/templates/sms-template.engine.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sms-template.engine.d.ts","sourceRoot":"","sources":["../../src/templates/sms-template.engine.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,IAAI,kBAAkB,EACvC,eAAe,EACf,oBAAoB,EACpB,WAAW,EACX,iBAAiB,EAClB,MAAM,sCAAsC,CAAC;AAG9C,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AA+BpD,qBAAa,qBAAsB,YAAW,kBAAkB;IAK9D,OAAO,CAAC,SAAS,CAAkC;IAKnD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IAKjC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAc;gBAmB1B,OAAO,GAAE,MAAsB,EAAE,MAAM,CAAC,EAAE,WAAW;IA0B3D,MAAM,CAAC,IAAI,EAAE,eAAe,GAAG,MAAM,EAAE,SAAS,EAAE,oBAAoB,GAAG,OAAO,CAAC,WAAW,CAAC;IAoCnG,gBAAgB,CAAC,IAAI,EAAE,eAAe,GAAG,MAAM,EAAE,QAAQ,EAAE,WAAW,GAAG,IAAI;IAkCvE,2BAA2B,CAC/B,IAAI,EAAE,eAAe,GAAG,MAAM,EAC9B,cAAc,EAAE;QAAE,OAAO,EAAE,iBAAiB,CAAA;KAAE,GAC7C,OAAO,CAAC,IAAI,CAAC;IA6ChB,qBAAqB,IAAI,MAAM,EAAE;IAUjC,WAAW,CAAC,IAAI,EAAE,eAAe,GAAG,MAAM,GAAG,OAAO;IAkBpD,gBAAgB,CAAC,IAAI,EAAE,eAAe,GAAG,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,GAAG,OAAO;IA0BjF,OAAO,CAAC,wBAAwB;IA+BhC,OAAO,CAAC,gBAAgB;CA4BzB"}
+{"version":3,"file":"sms-template.engine.d.ts","sourceRoot":"","sources":["../../src/templates/sms-template.engine.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,IAAI,kBAAkB,EACvC,eAAe,EACf,oBAAoB,EACpB,WAAW,EACX,iBAAiB,EAClB,MAAM,sCAAsC,CAAC;AAG9C,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAQpD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,qBAAa,qBAAsB,YAAW,kBAAkB;IAC9D;;;OAGG;IACH,OAAO,CAAC,SAAS,CAAkC;IAEnD;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IAEjC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAc;IAEtC;;;;;;;;;;;;;;;;OAgBG;gBACS,OAAO,GAAE,MAAsB,EAAE,MAAM,CAAC,EAAE,WAAW;IAMjE;;;;;;;;;;;;;;;;;;;OAmBG;IACG,MAAM,CAAC,IAAI,EAAE,eAAe,GAAG,MAAM,EAAE,SAAS,EAAE,oBAAoB,GAAG,OAAO,CAAC,WAAW,CAAC;IAqBnG;;;;;;;;;;;;;;OAcG;IACH,gBAAgB,CAAC,IAAI,EAAE,eAAe,GAAG,MAAM,EAAE,QAAQ,EAAE,WAAW,GAAG,IAAI;IAW7E;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,2BAA2B,CAC/B,IAAI,EAAE,eAAe,GAAG,MAAM,EAC9B,cAAc,EAAE;QAAE,OAAO,EAAE,iBAAiB,CAAA;KAAE,GAC7C,OAAO,CAAC,IAAI,CAAC;IAwChB;;;;OAIG;IACH,qBAAqB,IAAI,MAAM,EAAE;IAIjC;;;;;OAKG;IACH,WAAW,CAAC,IAAI,EAAE,eAAe,GAAG,MAAM,GAAG,OAAO;IAIpD;;;;;;;;;;;;;OAaG;IACH,gBAAgB,CAAC,IAAI,EAAE,eAAe,GAAG,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,GAAG,OAAO;IAmBjF;;;;;;OAMG;IACH,OAAO,CAAC,wBAAwB;IAoBhC;;;;;;;;;;OAUG;IACH,OAAO,CAAC,gBAAgB;CA4BzB"}