@nauth-toolkit/core 0.1.14 → 0.1.17

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

@@ -9,32 +9,142 @@ const path_1 = require("path");
 const util_1 = require("util");
 const fs_2 = require("fs");
 const accessAsync = (0, util_1.promisify)(fs_2.access);
+/**
+ * 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."
+ * ```
+ */
 class SMSTemplateEngineImpl {
+    /**
+     * Storage for registered templates
+     * Maps template type to template content string
+     */
     templates = new Map();
+    /**
+     * Base directory for resolving relative template file paths
+     */
     baseDir;
+    /**
+     * Logger instance for error reporting
+     */
     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 = process.cwd(), logger) {
         this.baseDir = baseDir;
         this.logger = logger;
         this.registerDefaultTemplates();
     }
+    /**
+     * 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 }
+     * );
+     * ```
+     */
     async render(type, variables) {
         const templateContent = this.templates.get(type);
         if (!templateContent) {
             throw new nauth_exception_1.NAuthException(error_codes_enum_1.AuthErrorCode.INTERNAL_ERROR, `SMS template "${type}" not found. Available templates: ${Array.from(this.templates.keys()).join(', ')}`);
         }
+        // Merge with default variables
         const allVariables = {
             ...variables,
         };
+        // Render template content
         const content = this.replaceVariables(templateContent, allVariables);
         return { content };
     }
+    /**
+     * 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, template) {
         if (!template.content) {
             throw new nauth_exception_1.NAuthException(error_codes_enum_1.AuthErrorCode.VALIDATION_FAILED, `SMS template must have content property. Template type: ${type}`);
         }
         this.templates.set(type, template.content);
     }
+    /**
+     * 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' },
+     * });
+     * ```
+     */
     async registerTemplateFromSources(type, templateSource) {
         const source = templateSource.content;
         if (!source) {
@@ -42,11 +152,14 @@ class SMSTemplateEngineImpl {
         }
         let content;
         if (source.content) {
+            // Inline content
             content = source.content;
         }
         else if (source.filePath) {
+            // File-based content
             const filePath = (0, path_1.resolve)(this.baseDir, source.filePath);
             try {
+                // Check if file exists
                 await accessAsync(filePath);
                 content = (0, fs_1.readFileSync)(filePath, 'utf-8');
             }
@@ -60,45 +173,103 @@ class SMSTemplateEngineImpl {
         }
         this.templates.set(type, content);
     }
+    /**
+     * Get all available template types
+     *
+     * @returns Array of registered 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);
     }
+    /**
+     * 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, requiredVars) {
         const templateContent = this.templates.get(type);
         if (!templateContent) {
             return false;
         }
+        // Check if all required variables are present in template
         return requiredVars.every((varName) => {
+            // Check for {{varName}} or {{ varName }} (with optional spaces)
             const regex = new RegExp(`\\{\\{\\s*${varName}\\s*\\}\\}`, 'g');
             return regex.test(templateContent);
         });
     }
+    // ============================================================================
+    // Private Helper Methods
+    // ============================================================================
+    /**
+     * Register default templates for all SMS types
+     *
+     * Provides sensible defaults that can be overridden by custom templates.
+     *
+     * @private
+     */
     registerDefaultTemplates() {
+        // Verification template
         this.templates.set(sms_template_interface_1.SMSTemplateType.VERIFICATION, '{{#if appName}}{{appName}}: {{/if}}Your verification code is: {{code}}. Valid for {{expiryMinutes}} minutes.');
+        // MFA template
         this.templates.set(sms_template_interface_1.SMSTemplateType.MFA, '{{#if appName}}{{appName}}: {{/if}}Your MFA code is: {{code}}. Valid for {{expiryMinutes}} minutes.');
+        // Password reset template
         this.templates.set(sms_template_interface_1.SMSTemplateType.PASSWORD_RESET, '{{#if appName}}{{appName}}: {{/if}}Your password reset code is: {{code}}. Valid for {{expiryMinutes}} minutes.');
     }
+    /**
+     * 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
+     */
     replaceVariables(template, variables) {
         let result = template;
+        // Handle simple conditionals like {{#if appName}}...{{/if}}
         result = result.replace(/\{\{#if (\w+)\}\}(.*?)\{\{\/if\}\}/g, (_match, key, ifContent) => {
             const value = variables[key];
+            // Return content if variable exists and is truthy, otherwise empty string
             if (value !== undefined && value !== null && value !== '') {
                 return ifContent;
             }
             return '';
         });
+        // Replace regular variables {{variable}}
         result = result.replace(/\{\{(\w+)\}\}/g, (_match, key) => {
             const value = variables[key];
+            // Return empty string if variable is undefined or null
             if (value === undefined || value === null) {
                 return '';
             }
+            // Convert to string
             return String(value);
         });
         return result;
     }
 }
 exports.SMSTemplateEngineImpl = SMSTemplateEngineImpl;
+// Export the implementation class
+// Note: SMSTemplateEngine interface is exported from interfaces/sms-template.interface.ts
 //# sourceMappingURL=sms-template.engine.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"sms-template.engine.js","sourceRoot":"","sources":["../../src/templates/sms-template.engine.ts"],"names":[],"mappings":";;;AAAA,iFAM8C;AAC9C,mEAA+D;AAC/D,gEAA0D;AAE1D,2BAAkC;AAClC,+BAA+B;AAC/B,+BAAiC;AACjC,2BAA4B;AAE5B,MAAM,WAAW,GAAG,IAAA,gBAAS,EAAC,WAAM,CAAC,CAAC;AAyBtC,MAAa,qBAAqB;IAKxB,SAAS,GAAwB,IAAI,GAAG,EAAE,CAAC;IAKlC,OAAO,CAAS;IAKhB,MAAM,CAAe;IAmBtC,YAAY,UAAkB,OAAO,CAAC,GAAG,EAAE,EAAE,MAAoB;QAC/D,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,wBAAwB,EAAE,CAAC;IAClC,CAAC;IAsBD,KAAK,CAAC,MAAM,CAAC,IAA8B,EAAE,SAA+B;QAC1E,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAEjD,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,MAAM,IAAI,gCAAc,CACtB,gCAAa,CAAC,cAAc,EAC5B,iBAAiB,IAAI,qCAAqC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CACzG,CAAC;QACJ,CAAC;QAGD,MAAM,YAAY,GAAyB;YACzC,GAAG,SAAS;SACb,CAAC;QAGF,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,eAAe,EAAE,YAAY,CAAC,CAAC;QAErE,OAAO,EAAE,OAAO,EAAE,CAAC;IACrB,CAAC;IAiBD,gBAAgB,CAAC,IAA8B,EAAE,QAAqB;QACpE,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;YACtB,MAAM,IAAI,gCAAc,CACtB,gCAAa,CAAC,iBAAiB,EAC/B,2DAA2D,IAAI,EAAE,CAClE,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;IAC7C,CAAC;IAyBD,KAAK,CAAC,2BAA2B,CAC/B,IAA8B,EAC9B,cAA8C;QAE9C,MAAM,MAAM,GAAG,cAAc,CAAC,OAAO,CAAC;QAEtC,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,gCAAc,CACtB,gCAAa,CAAC,iBAAiB,EAC/B,kEAAkE,IAAI,EAAE,CACzE,CAAC;QACJ,CAAC;QAED,IAAI,OAAe,CAAC;QAEpB,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YAEnB,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;QAC3B,CAAC;aAAM,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;YAE3B,MAAM,QAAQ,GAAG,IAAA,cAAO,EAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;YAExD,IAAI,CAAC;gBAEH,MAAM,WAAW,CAAC,QAAQ,CAAC,CAAC;gBAC5B,OAAO,GAAG,IAAA,iBAAY,EAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;YAC5C,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,MAAM,YAAY,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC;gBAC9E,MAAM,IAAI,gCAAc,CACtB,gCAAa,CAAC,cAAc,EAC5B,qCAAqC,QAAQ,YAAY,YAAY,EAAE,CACxE,CAAC;YACJ,CAAC;QACH,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,gCAAc,CACtB,gCAAa,CAAC,iBAAiB,EAC/B,4EAA4E,IAAI,EAAE,CACnF,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACpC,CAAC;IAOD,qBAAqB;QACnB,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC;IAC3C,CAAC;IAQD,WAAW,CAAC,IAA8B;QACxC,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;IAgBD,gBAAgB,CAAC,IAA8B,EAAE,YAAsB;QACrE,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAEjD,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,OAAO,KAAK,CAAC;QACf,CAAC;QAGD,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,EAAE;YAEpC,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,aAAa,OAAO,YAAY,EAAE,GAAG,CAAC,CAAC;YAChE,OAAO,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;IACL,CAAC;IAaO,wBAAwB;QAE9B,IAAI,CAAC,SAAS,CAAC,GAAG,CAChB,wCAAe,CAAC,YAAY,EAC5B,8GAA8G,CAC/G,CAAC;QAGF,IAAI,CAAC,SAAS,CAAC,GAAG,CAChB,wCAAe,CAAC,GAAG,EACnB,qGAAqG,CACtG,CAAC;QAGF,IAAI,CAAC,SAAS,CAAC,GAAG,CAChB,wCAAe,CAAC,cAAc,EAC9B,gHAAgH,CACjH,CAAC;IACJ,CAAC;IAaO,gBAAgB,CAAC,QAAgB,EAAE,SAA+B;QACxE,IAAI,MAAM,GAAG,QAAQ,CAAC;QAGtB,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,qCAAqC,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,EAAE;YACxF,MAAM,KAAK,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;YAE7B,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,EAAE,EAAE,CAAC;gBAC1D,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC,CAAC;QAGH,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;CACF;AAnSD,sDAmSC"}
+{"version":3,"file":"sms-template.engine.js","sourceRoot":"","sources":["../../src/templates/sms-template.engine.ts"],"names":[],"mappings":";;;AAAA,iFAM8C;AAC9C,mEAA+D;AAC/D,gEAA0D;AAE1D,2BAAkC;AAClC,+BAA+B;AAC/B,+BAAiC;AACjC,2BAA4B;AAE5B,MAAM,WAAW,GAAG,IAAA,gBAAS,EAAC,WAAM,CAAC,CAAC;AAEtC;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAa,qBAAqB;IAChC;;;OAGG;IACK,SAAS,GAAwB,IAAI,GAAG,EAAE,CAAC;IAEnD;;OAEG;IACc,OAAO,CAAS;IAEjC;;OAEG;IACc,MAAM,CAAe;IAEtC;;;;;;;;;;;;;;;;OAgBG;IACH,YAAY,UAAkB,OAAO,CAAC,GAAG,EAAE,EAAE,MAAoB;QAC/D,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,wBAAwB,EAAE,CAAC;IAClC,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,CAAC,MAAM,CAAC,IAA8B,EAAE,SAA+B;QAC1E,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAEjD,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,MAAM,IAAI,gCAAc,CACtB,gCAAa,CAAC,cAAc,EAC5B,iBAAiB,IAAI,qCAAqC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CACzG,CAAC;QACJ,CAAC;QAED,+BAA+B;QAC/B,MAAM,YAAY,GAAyB;YACzC,GAAG,SAAS;SACb,CAAC;QAEF,0BAA0B;QAC1B,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,eAAe,EAAE,YAAY,CAAC,CAAC;QAErE,OAAO,EAAE,OAAO,EAAE,CAAC;IACrB,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,gBAAgB,CAAC,IAA8B,EAAE,QAAqB;QACpE,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;YACtB,MAAM,IAAI,gCAAc,CACtB,gCAAa,CAAC,iBAAiB,EAC/B,2DAA2D,IAAI,EAAE,CAClE,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,KAAK,CAAC,2BAA2B,CAC/B,IAA8B,EAC9B,cAA8C;QAE9C,MAAM,MAAM,GAAG,cAAc,CAAC,OAAO,CAAC;QAEtC,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,gCAAc,CACtB,gCAAa,CAAC,iBAAiB,EAC/B,kEAAkE,IAAI,EAAE,CACzE,CAAC;QACJ,CAAC;QAED,IAAI,OAAe,CAAC;QAEpB,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACnB,iBAAiB;YACjB,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;QAC3B,CAAC;aAAM,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC3B,qBAAqB;YACrB,MAAM,QAAQ,GAAG,IAAA,cAAO,EAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;YAExD,IAAI,CAAC;gBACH,uBAAuB;gBACvB,MAAM,WAAW,CAAC,QAAQ,CAAC,CAAC;gBAC5B,OAAO,GAAG,IAAA,iBAAY,EAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;YAC5C,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,MAAM,YAAY,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC;gBAC9E,MAAM,IAAI,gCAAc,CACtB,gCAAa,CAAC,cAAc,EAC5B,qCAAqC,QAAQ,YAAY,YAAY,EAAE,CACxE,CAAC;YACJ,CAAC;QACH,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,gCAAc,CACtB,gCAAa,CAAC,iBAAiB,EAC/B,4EAA4E,IAAI,EAAE,CACnF,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACpC,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,IAA8B;QACxC,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,gBAAgB,CAAC,IAA8B,EAAE,YAAsB;QACrE,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAEjD,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,OAAO,KAAK,CAAC;QACf,CAAC;QAED,0DAA0D;QAC1D,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,EAAE;YACpC,gEAAgE;YAChE,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,aAAa,OAAO,YAAY,EAAE,GAAG,CAAC,CAAC;YAChE,OAAO,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;IACL,CAAC;IAED,+EAA+E;IAC/E,yBAAyB;IACzB,+EAA+E;IAE/E;;;;;;OAMG;IACK,wBAAwB;QAC9B,wBAAwB;QACxB,IAAI,CAAC,SAAS,CAAC,GAAG,CAChB,wCAAe,CAAC,YAAY,EAC5B,8GAA8G,CAC/G,CAAC;QAEF,eAAe;QACf,IAAI,CAAC,SAAS,CAAC,GAAG,CAChB,wCAAe,CAAC,GAAG,EACnB,qGAAqG,CACtG,CAAC;QAEF,0BAA0B;QAC1B,IAAI,CAAC,SAAS,CAAC,GAAG,CAChB,wCAAe,CAAC,cAAc,EAC9B,gHAAgH,CACjH,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACK,gBAAgB,CAAC,QAAgB,EAAE,SAA+B;QACxE,IAAI,MAAM,GAAG,QAAQ,CAAC;QAEtB,4DAA4D;QAC5D,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,qCAAqC,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,EAAE;YACxF,MAAM,KAAK,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;YAC7B,0EAA0E;YAC1E,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,EAAE,EAAE,CAAC;gBAC1D,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC,CAAC;QAEH,yCAAyC;QACzC,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE;YACxD,MAAM,KAAK,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;YAE7B,uDAAuD;YACvD,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;gBAC1C,OAAO,EAAE,CAAC;YACZ,CAAC;YAED,oBAAoB;YACpB,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AAnSD,sDAmSC;AAED,kCAAkC;AAClC,0FAA0F"}

package/dist/templates.d.ts

@@ -1,2 +1,10 @@
+/**
+ * Templates barrel export (shim)
+ *
+ * This file exists to ensure TypeScript's emitted declaration paths (e.g. `./templates.js`)
+ * resolve correctly for consumers.
+ *
+ * See `packages/core/src/dto.ts` for background.
+ */
 export * from './templates/index';
 //# sourceMappingURL=templates.d.ts.map

package/dist/templates.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"templates.d.ts","sourceRoot":"","sources":["../src/templates.ts"],"names":[],"mappings":"AAQA,cAAc,mBAAmB,CAAC"}
+{"version":3,"file":"templates.d.ts","sourceRoot":"","sources":["../src/templates.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,cAAc,mBAAmB,CAAC"}

package/dist/templates.js

@@ -14,5 +14,13 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Templates barrel export (shim)
+ *
+ * This file exists to ensure TypeScript's emitted declaration paths (e.g. `./templates.js`)
+ * resolve correctly for consumers.
+ *
+ * See `packages/core/src/dto.ts` for background.
+ */
 __exportStar(require("./templates/index"), exports);
 //# sourceMappingURL=templates.js.map

package/dist/templates.js.map

@@ -1 +1 @@
-{"version":3,"file":"templates.js","sourceRoot":"","sources":["../src/templates.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAQA,oDAAkC"}
+{"version":3,"file":"templates.js","sourceRoot":"","sources":["../src/templates.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA;;;;;;;GAOG;AACH,oDAAkC"}

package/dist/utils/common-passwords.d.ts

@@ -1,4 +1,46 @@
+/**
+ * Load common passwords from bundled file
+ *
+ * This function loads once on first call and caches the result.
+ * Subsequent calls return the cached Set immediately.
+ *
+ * File location: packages/core/src/data/common-passwords-10000.txt
+ * Format: One password per line, lowercase
+ *
+ * @returns Set of common passwords (lowercase)
+ *
+ * @example
+ * ```typescript
+ * // Load passwords (cached after first call)
+ * const passwords = loadCommonPasswords();
+ *
+ * // Check if password is common
+ * if (passwords.has('mypassword'.toLowerCase())) {
+ *   console.log('Password is too common');
+ * }
+ * ```
+ */
 export declare function loadCommonPasswords(): Set<string>;
+/**
+ * Check if a password is in the common password list
+ *
+ * Case-insensitive comparison.
+ *
+ * @param password - Password to check
+ * @returns True if password is common, false otherwise
+ *
+ * @example
+ * ```typescript
+ * if (isCommonPassword('Password123')) {
+ *   throw new Error('Password is too common');
+ * }
+ * ```
+ */
 export declare function isCommonPassword(password: string): boolean;
+/**
+ * Get the size of the common password list
+ *
+ * @returns Number of passwords in the list
+ */
 export declare function getCommonPasswordCount(): number;
 //# sourceMappingURL=common-passwords.d.ts.map

package/dist/utils/common-passwords.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"common-passwords.d.ts","sourceRoot":"","sources":["../../src/utils/common-passwords.ts"],"names":[],"mappings":"AAoGA,wBAAgB,mBAAmB,IAAI,GAAG,CAAC,MAAM,CAAC,CAoCjD;AAiBD,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAG1D;AAOD,wBAAgB,sBAAsB,IAAI,MAAM,CAG/C"}
+{"version":3,"file":"common-passwords.d.ts","sourceRoot":"","sources":["../../src/utils/common-passwords.ts"],"names":[],"mappings":"AA8EA;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,mBAAmB,IAAI,GAAG,CAAC,MAAM,CAAC,CAoCjD;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAG1D;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,IAAI,MAAM,CAG/C"}

package/dist/utils/common-passwords.js

@@ -38,13 +38,55 @@ exports.isCommonPassword = isCommonPassword;
 exports.getCommonPasswordCount = getCommonPasswordCount;
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
+/**
+ * Common Passwords Loader
+ *
+ * Loads a curated list of common passwords from bundled file at startup.
+ * Platform-agnostic - works on Mac, Linux, Windows, Docker, serverless, etc.
+ *
+ * Security Features:
+ * - One-time load on module initialization (memory cached)
+ * - 10,000 most common passwords from SecLists
+ * - O(1) lookup performance with Set
+ * - Graceful fallback if file not found
+ * - No runtime file I/O or network calls
+ * - Silent by default (won't interfere with JSON logging)
+ *
+ * Memory footprint: ~200KB for 10K passwords in Set
+ *
+ * Environment Variables:
+ * - NAUTH_DEBUG=true - Enable debug logging to stderr
+ *
+ * @example
+ * ```typescript
+ * const passwords = loadCommonPasswords();
+ * if (passwords.has('password123')) {
+ *   throw new Error('Password too common');
+ * }
+ * ```
+ */
 let COMMON_PASSWORDS = null;
+/**
+ * Internal logging helper
+ *
+ * Writes to stderr (not stdout) to avoid interfering with JSON logging.
+ * Only logs if NAUTH_DEBUG environment variable is set.
+ *
+ * @param message - Message to log
+ * @param isError - Whether this is an error/warning
+ */
 function debugLog(message, isError = false) {
     if (process.env.NAUTH_DEBUG === 'true') {
         const prefix = isError ? '[nauth-toolkit:WARN]' : '[nauth-toolkit:INFO]';
         process.stderr.write(`${prefix} ${message}\n`);
     }
 }
+/**
+ * Minimal fallback password list
+ *
+ * Used if the main password file cannot be loaded.
+ * Contains only the most common passwords.
+ */
 const FALLBACK_PASSWORDS = [
     'password',
     'password123',
@@ -67,11 +109,35 @@ const FALLBACK_PASSWORDS = [
     'admin123',
     'root',
 ];
+/**
+ * Load common passwords from bundled file
+ *
+ * This function loads once on first call and caches the result.
+ * Subsequent calls return the cached Set immediately.
+ *
+ * File location: packages/core/src/data/common-passwords-10000.txt
+ * Format: One password per line, lowercase
+ *
+ * @returns Set of common passwords (lowercase)
+ *
+ * @example
+ * ```typescript
+ * // Load passwords (cached after first call)
+ * const passwords = loadCommonPasswords();
+ *
+ * // Check if password is common
+ * if (passwords.has('mypassword'.toLowerCase())) {
+ *   console.log('Password is too common');
+ * }
+ * ```
+ */
 function loadCommonPasswords() {
+    // Return cached version if already loaded
     if (COMMON_PASSWORDS) {
         return COMMON_PASSWORDS;
     }
     try {
+        // Try to load from bundled file
         const filePath = path.join(__dirname, '../data/common-passwords-10000.txt');
         if (fs.existsSync(filePath)) {
             const content = fs.readFileSync(filePath, 'utf-8');
@@ -92,17 +158,39 @@ function loadCommonPasswords() {
             debugLog(`Error details: ${error.message}`, true);
         }
     }
+    // Fallback to minimal list (silent by default)
     COMMON_PASSWORDS = new Set(FALLBACK_PASSWORDS.map((p) => p.toLowerCase()));
     debugLog(`Using fallback password list with ${COMMON_PASSWORDS.size} entries`, true);
     return COMMON_PASSWORDS;
 }
+/**
+ * Check if a password is in the common password list
+ *
+ * Case-insensitive comparison.
+ *
+ * @param password - Password to check
+ * @returns True if password is common, false otherwise
+ *
+ * @example
+ * ```typescript
+ * if (isCommonPassword('Password123')) {
+ *   throw new Error('Password is too common');
+ * }
+ * ```
+ */
 function isCommonPassword(password) {
     const passwords = loadCommonPasswords();
     return passwords.has(password.toLowerCase());
 }
+/**
+ * Get the size of the common password list
+ *
+ * @returns Number of passwords in the list
+ */
 function getCommonPasswordCount() {
     const passwords = loadCommonPasswords();
     return passwords.size;
 }
+// Load passwords on module import (cached for subsequent use)
 loadCommonPasswords();
 //# sourceMappingURL=common-passwords.js.map

package/dist/utils/common-passwords.js.map

@@ -1 +1 @@
-{"version":3,"file":"common-passwords.js","sourceRoot":"","sources":["../../src/utils/common-passwords.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoGA,kDAoCC;AAiBD,4CAGC;AAOD,wDAGC;AAtKD,uCAAyB;AACzB,2CAA6B;AA8B7B,IAAI,gBAAgB,GAAuB,IAAI,CAAC;AAWhD,SAAS,QAAQ,CAAC,OAAe,EAAE,UAAmB,KAAK;IACzD,IAAI,OAAO,CAAC,GAAG,CAAC,WAAW,KAAK,MAAM,EAAE,CAAC;QACvC,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,sBAAsB,CAAC;QACzE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,IAAI,OAAO,IAAI,CAAC,CAAC;IACjD,CAAC;AACH,CAAC;AAQD,MAAM,kBAAkB,GAAG;IACzB,UAAU;IACV,aAAa;IACb,QAAQ;IACR,WAAW;IACX,UAAU;IACV,OAAO;IACP,QAAQ;IACR,QAAQ;IACR,WAAW;IACX,OAAO;IACP,SAAS;IACT,SAAS;IACT,QAAQ;IACR,QAAQ;IACR,SAAS;IACT,WAAW;IACX,WAAW;IACX,UAAU;IACV,UAAU;IACV,MAAM;CACP,CAAC;AAwBF,SAAgB,mBAAmB;IAEjC,IAAI,gBAAgB,EAAE,CAAC;QACrB,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAED,IAAI,CAAC;QAEH,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,oCAAoC,CAAC,CAAC;QAE5E,IAAI,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC5B,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;YACnD,gBAAgB,GAAG,IAAI,GAAG,CACxB,OAAO;iBACJ,KAAK,CAAC,IAAI,CAAC;iBACX,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;iBAClC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAC/B,CAAC;YAEF,QAAQ,CAAC,UAAU,gBAAgB,CAAC,IAAI,6BAA6B,CAAC,CAAC;YACvE,OAAO,gBAAgB,CAAC;QAC1B,CAAC;aAAM,CAAC;YACN,QAAQ,CAAC,sCAAsC,QAAQ,uBAAuB,EAAE,IAAI,CAAC,CAAC;QACxF,CAAC;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,QAAQ,CAAC,2DAA2D,EAAE,IAAI,CAAC,CAAC;QAC5E,IAAI,KAAK,YAAY,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,WAAW,KAAK,MAAM,EAAE,CAAC;YACjE,QAAQ,CAAC,kBAAkB,KAAK,CAAC,OAAO,EAAE,EAAE,IAAI,CAAC,CAAC;QACpD,CAAC;IACH,CAAC;IAGD,gBAAgB,GAAG,IAAI,GAAG,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;IAC3E,QAAQ,CAAC,qCAAqC,gBAAgB,CAAC,IAAI,UAAU,EAAE,IAAI,CAAC,CAAC;IAErF,OAAO,gBAAgB,CAAC;AAC1B,CAAC;AAiBD,SAAgB,gBAAgB,CAAC,QAAgB;IAC/C,MAAM,SAAS,GAAG,mBAAmB,EAAE,CAAC;IACxC,OAAO,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC;AAC/C,CAAC;AAOD,SAAgB,sBAAsB;IACpC,MAAM,SAAS,GAAG,mBAAmB,EAAE,CAAC;IACxC,OAAO,SAAS,CAAC,IAAI,CAAC;AACxB,CAAC;AAGD,mBAAmB,EAAE,CAAC"}
+{"version":3,"file":"common-passwords.js","sourceRoot":"","sources":["../../src/utils/common-passwords.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoGA,kDAoCC;AAiBD,4CAGC;AAOD,wDAGC;AAtKD,uCAAyB;AACzB,2CAA6B;AAE7B;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH,IAAI,gBAAgB,GAAuB,IAAI,CAAC;AAEhD;;;;;;;;GAQG;AACH,SAAS,QAAQ,CAAC,OAAe,EAAE,UAAmB,KAAK;IACzD,IAAI,OAAO,CAAC,GAAG,CAAC,WAAW,KAAK,MAAM,EAAE,CAAC;QACvC,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,sBAAsB,CAAC;QACzE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,IAAI,OAAO,IAAI,CAAC,CAAC;IACjD,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,kBAAkB,GAAG;IACzB,UAAU;IACV,aAAa;IACb,QAAQ;IACR,WAAW;IACX,UAAU;IACV,OAAO;IACP,QAAQ;IACR,QAAQ;IACR,WAAW;IACX,OAAO;IACP,SAAS;IACT,SAAS;IACT,QAAQ;IACR,QAAQ;IACR,SAAS;IACT,WAAW;IACX,WAAW;IACX,UAAU;IACV,UAAU;IACV,MAAM;CACP,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,SAAgB,mBAAmB;IACjC,0CAA0C;IAC1C,IAAI,gBAAgB,EAAE,CAAC;QACrB,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAED,IAAI,CAAC;QACH,gCAAgC;QAChC,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,oCAAoC,CAAC,CAAC;QAE5E,IAAI,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC5B,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;YACnD,gBAAgB,GAAG,IAAI,GAAG,CACxB,OAAO;iBACJ,KAAK,CAAC,IAAI,CAAC;iBACX,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;iBAClC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAC/B,CAAC;YAEF,QAAQ,CAAC,UAAU,gBAAgB,CAAC,IAAI,6BAA6B,CAAC,CAAC;YACvE,OAAO,gBAAgB,CAAC;QAC1B,CAAC;aAAM,CAAC;YACN,QAAQ,CAAC,sCAAsC,QAAQ,uBAAuB,EAAE,IAAI,CAAC,CAAC;QACxF,CAAC;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,QAAQ,CAAC,2DAA2D,EAAE,IAAI,CAAC,CAAC;QAC5E,IAAI,KAAK,YAAY,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,WAAW,KAAK,MAAM,EAAE,CAAC;YACjE,QAAQ,CAAC,kBAAkB,KAAK,CAAC,OAAO,EAAE,EAAE,IAAI,CAAC,CAAC;QACpD,CAAC;IACH,CAAC;IAED,+CAA+C;IAC/C,gBAAgB,GAAG,IAAI,GAAG,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;IAC3E,QAAQ,CAAC,qCAAqC,gBAAgB,CAAC,IAAI,UAAU,EAAE,IAAI,CAAC,CAAC;IAErF,OAAO,gBAAgB,CAAC;AAC1B,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,SAAgB,gBAAgB,CAAC,QAAgB;IAC/C,MAAM,SAAS,GAAG,mBAAmB,EAAE,CAAC;IACxC,OAAO,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC;AAC/C,CAAC;AAED;;;;GAIG;AACH,SAAgB,sBAAsB;IACpC,MAAM,SAAS,GAAG,mBAAmB,EAAE,CAAC;IACxC,OAAO,SAAS,CAAC,IAAI,CAAC;AACxB,CAAC;AAED,8DAA8D;AAC9D,mBAAmB,EAAE,CAAC"}

package/dist/utils/context-storage.d.ts

@@ -1,13 +1,142 @@
+/**
+ * Context Storage - Platform-Agnostic Async Local Storage
+ *
+ * Provides request-scoped storage using Node.js AsyncLocalStorage.
+ * Replaces nestjs-cls for platform-agnostic context management.
+ *
+ * **Features:**
+ * - Request-scoped data storage
+ * - Works across async boundaries
+ * - No framework dependencies
+ * - Type-safe storage and retrieval
+ *
+ * @example
+ * ```typescript
+ * // Store data in context
+ * ContextStorage.run(() => {
+ *   ContextStorage.set('userId', '123');
+ *   ContextStorage.set('clientInfo', { ip: '1.2.3.4' });
+ *
+ *   // Access from any nested function
+ *   const userId = ContextStorage.get<string>('userId');
+ * });
+ * ```
+ */
 export declare class ContextStorage {
     private static als;
+    /**
+     * Run a callback within a new context
+     *
+     * Creates a new async local storage context for the callback.
+     * All ContextStorage operations within the callback will use this context.
+     *
+     * @param callback - Function to execute with context
+     * @returns Result of the callback
+     *
+     * @example
+     * ```typescript
+     * const result = ContextStorage.run(() => {
+     *   ContextStorage.set('key', 'value');
+     *   return processRequest();
+     * });
+     * ```
+     */
     static run<T>(callback: () => T): T;
+    /**
+     * Store a value in the current context
+     *
+     * @param key - Storage key
+     * @param value - Value to store
+     * @throws Error if called outside of a context (ContextStorage.run not called)
+     *
+     * @example
+     * ```typescript
+     * ContextStorage.set('userId', '123');
+     * ContextStorage.set('clientInfo', { ip: '1.2.3.4', userAgent: 'Mozilla...' });
+     * ```
+     */
     static set<T>(key: string, value: T): void;
+    /**
+     * Retrieve a value from the current context
+     *
+     * @param key - Storage key
+     * @returns Stored value or undefined if not found
+     *
+     * @example
+     * ```typescript
+     * const userId = ContextStorage.get<string>('userId');
+     * const clientInfo = ContextStorage.get<ClientInfo>('CLIENT_INFO');
+     * ```
+     */
     static get<T>(key: string): T | undefined;
+    /**
+     * Check if a key exists in the current context
+     *
+     * @param key - Storage key
+     * @returns True if key exists, false otherwise
+     *
+     * @example
+     * ```typescript
+     * if (ContextStorage.has('userId')) {
+     *   const userId = ContextStorage.get<string>('userId');
+     * }
+     * ```
+     */
     static has(key: string): boolean;
+    /**
+     * Delete a value from the current context
+     *
+     * @param key - Storage key
+     * @returns True if key was deleted, false if it didn't exist
+     *
+     * @example
+     * ```typescript
+     * ContextStorage.delete('temporaryData');
+     * ```
+     */
     static delete(key: string): boolean;
+    /**
+     * Clear all values from the current context
+     *
+     * @example
+     * ```typescript
+     * ContextStorage.clear();
+     * ```
+     */
     static clear(): void;
+    /**
+     * Get all keys in the current context
+     *
+     * @returns Array of storage keys
+     *
+     * @example
+     * ```typescript
+     * const keys = ContextStorage.keys();
+     * console.log('Stored keys:', keys);
+     * ```
+     */
     static keys(): string[];
+    /**
+     * Get the current store instance
+     *
+     * This is useful for frameworks like Fastify where hooks run independently
+     * and you need to preserve the store across hook boundaries.
+     *
+     * @returns The current Map store or undefined
+     * @internal
+     */
     static getStore(): Map<string, unknown> | undefined;
+    /**
+     * Enter an existing context store
+     *
+     * This allows re-entering a context that was created elsewhere,
+     * useful for frameworks where handlers run in separate scopes.
+     *
+     * @param store - The store to enter
+     * @param callback - Function to execute with the store
+     * @returns Result of the callback
+     * @internal
+     */
     static enterStore<T>(store: Map<string, unknown>, callback: () => T): T;
 }
 //# sourceMappingURL=context-storage.d.ts.map

package/dist/utils/context-storage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"context-storage.d.ts","sourceRoot":"","sources":["../../src/utils/context-storage.ts"],"names":[],"mappings":"AA0BA,qBAAa,cAAc;IACzB,OAAO,CAAC,MAAM,CAAC,GAAG,CAAiD;IAmBnE,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC;IAkBnC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI;IAoB1C,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS;IAkBzC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAgBhC,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAgBnC,MAAM,CAAC,KAAK,IAAI,IAAI;IAkBpB,MAAM,CAAC,IAAI,IAAI,MAAM,EAAE;IAiBvB,MAAM,CAAC,QAAQ,IAAI,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS;IAenD,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC;CAGxE"}
+{"version":3,"file":"context-storage.d.ts","sourceRoot":"","sources":["../../src/utils/context-storage.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,MAAM,CAAC,GAAG,CAAiD;IAEnE;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC;IAKnC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI;IAQ1C;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS;IAKzC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAKhC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAQnC;;;;;;;OAOG;IACH,MAAM,CAAC,KAAK,IAAI,IAAI;IAOpB;;;;;;;;;;OAUG;IACH,MAAM,CAAC,IAAI,IAAI,MAAM,EAAE;IAQvB;;;;;;;;OAQG;IACH,MAAM,CAAC,QAAQ,IAAI,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS;IAInD;;;;;;;;;;OAUG;IACH,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC;CAGxE"}