@catbee/utils 0.0.8-rc.1 → 0.0.8-rc.3

package/build/esnext/utils/context-store.utils.js

@@ -1,289 +0,0 @@
-/*
- * The MIT License
- *
- * Copyright (c) 2025 Catbee Technologies. https://catbee-utils.npm.hprasath.com/license
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-import { AsyncLocalStorage } from 'async_hooks';
-/**
- * Predefined symbols used as keys in AsyncLocalStorage.
- * Add new symbols here to avoid duplication.
- */
-export const StoreKeys = {
-    LOGGER: Symbol('LOGGER'),
-    REQUEST_ID: Symbol('REQUEST_ID'),
-    USER: Symbol('USER'),
-    SESSION: Symbol('SESSION'),
-    TRANSACTION_ID: Symbol('TRANSACTION_ID'),
-    USER_ID: Symbol('USER_ID'),
-    TENANT_ID: Symbol('TENANT_ID'),
-    TRACE_ID: Symbol('TRACE_ID'),
-    CORRELATION_ID: Symbol('CORRELATION_ID')
-};
-/**
- * Retrieves the current request ID from the async context, if available.
- *
- * @returns {string | undefined} The request ID string or undefined if not present in the current context.
- */
-export function getRequestId() {
-    return ContextStore.get(StoreKeys.REQUEST_ID);
-}
-/**
- * Type-safe getter for common context values.
- *
- * @param key The store key symbol
- * @returns The typed value from the store
- */
-export function getFromContext(key) {
-    return ContextStore.get(key);
-}
-/**
- * ContextStore manages per-request scoped context using AsyncLocalStorage.
- * It allows storing and retrieving data across async calls (e.g., request ID, logger).
- *
- * Example (Express middleware):
- * ```
- * // Middleware to initialize context and logger
- * app.use((req, res, next) => {
- *   const requestId = req.headers["x-request-id"]?.toString() || crypto.randomUUID();
- *   ContextStore.run({ [StoreKeys.REQUEST_ID]: requestId }, () => {
- *     ContextStore.set(StoreKeys.LOGGER, getLogger().child({ requestId }));
- *     next();
- *   });
- * });
- * ```
- */
-export class ContextStore {
-    /**
-     * Returns the raw AsyncLocalStorage instance for advanced access.
-     *
-     * @returns {AsyncLocalStorage<Store>} The AsyncLocalStorage instance.
-     */
-    static getInstance() {
-        return this.storage;
-    }
-    /**
-     * Retrieves a value from the async context store by symbol key.
-     *
-     * @typeParam T - The expected return type of the value.
-     * @param {symbol} key - Unique symbol used as the store key.
-     * @returns {T | undefined} The value found (typed) or undefined if not present.
-     */
-    static get(key) {
-        const store = this.storage.getStore();
-        return store === null || store === void 0 ? void 0 : store[key];
-    }
-    /**
-     * Sets a value in the current context store by symbol key.
-     *
-     * @typeParam T - The value type to set.
-     * @param {symbol} key - Unique symbol key.
-     * @param {T} value - Value to set in context.
-     * @throws {Error} If called outside an active context (not within a .run call or in the wrong async boundaries).
-     */
-    static set(key, value) {
-        const store = this.storage.getStore();
-        if (!store) {
-            throw new Error(`Failed to set ${String(key)}: AsyncLocalStorage store is not initialized.`);
-        }
-        store[key] = value;
-    }
-    /**
-     * Retrieves the entire context store object for the current async context.
-     *
-     * @returns {Store | undefined} The current store object or undefined if called outside a context.
-     */
-    static getAll() {
-        return this.storage.getStore();
-    }
-    /**
-     * Initializes a new async context and executes a callback within it.
-     * This must be called at the beginning of a request or logical async flow.
-     *
-     * @typeParam T - The callback's return type.
-     * @param {Store} store - The initial key-value store object.
-     * @param {() => T} callback - The function to run within the new context.
-     * @returns {T} The result of the callback function.
-     */
-    static run(store, callback) {
-        return this.storage.run(store, callback);
-    }
-    /**
-     * Checks if a key exists in the current context store.
-     *
-     * @param {symbol} key - The symbol key to check.
-     * @returns {boolean} True if the key exists, false otherwise.
-     */
-    static has(key) {
-        const store = this.storage.getStore();
-        return store !== undefined && key in store;
-    }
-    /**
-     * Removes a value from the current context store by symbol key.
-     *
-     * @param {symbol} key - The symbol key to delete.
-     * @returns {boolean} True if the key was deleted, false if the key wasn't found or no active context.
-     * @throws {Error} If called outside an active context.
-     */
-    static delete(key) {
-        const store = this.storage.getStore();
-        if (!store) {
-            throw new Error(`Failed to delete ${String(key)}: AsyncLocalStorage store is not initialized.`);
-        }
-        return delete store[key];
-    }
-    /**
-     * Updates multiple values in the current context store at once.
-     *
-     * @param {Partial<Record<symbol, unknown>>} values - Object containing symbol keys and values to update.
-     * @throws {Error} If called outside an active context.
-     */
-    static patch(values) {
-        const store = this.storage.getStore();
-        if (!store) {
-            throw new Error('Failed to patch: AsyncLocalStorage store is not initialized.');
-        }
-        Object.getOwnPropertySymbols(values).forEach(key => {
-            store[key] = values[key];
-        });
-    }
-    /**
-     * Executes a callback with a temporary store value that only exists during execution.
-     * Original store is restored after callback completes.
-     *
-     * @typeParam T - The callback's return type.
-     * @param {symbol} key - The symbol key to temporarily set.
-     * @param {unknown} value - The temporary value.
-     * @param {() => T} callback - The function to execute with the temporary value.
-     * @returns {T} The result of the callback function.
-     * @throws {Error} If called outside an active context.
-     */
-    static withValue(key, value, callback) {
-        const store = this.storage.getStore();
-        if (!store) {
-            throw new Error(`Failed to set temporary value: AsyncLocalStorage store is not initialized.`);
-        }
-        // Save original value
-        const hasOriginal = key in store;
-        const originalValue = store[key];
-        // Set temporary value
-        store[key] = value;
-        try {
-            // Run callback
-            return callback();
-        }
-        finally {
-            // Restore original value
-            if (hasOriginal) {
-                store[key] = originalValue;
-            }
-            else {
-                delete store[key];
-            }
-        }
-    }
-    /**
-     * Creates a new context that inherits values from the current context.
-     *
-     * @typeParam T - The callback's return type.
-     * @param {Partial<Record<symbol, unknown>>} newValues - New values to add to or override in the context.
-     * @param {() => T} callback - The function to execute in the new context.
-     * @returns {T} The result of the callback function.
-     */
-    static extend(newValues, callback) {
-        const currentStore = this.storage.getStore() || {};
-        // Create new store with current values plus new ones
-        const newStore = Object.assign({}, currentStore);
-        // Add new values
-        Object.getOwnPropertySymbols(newValues).forEach(key => {
-            newStore[key] = newValues[key];
-        });
-        // Run with extended store
-        return this.storage.run(newStore, callback);
-    }
-    /**
-     * Creates Express middleware that initializes a context for each request.
-     *
-     * @param {(req: any) => Partial<Record<symbol, unknown>>} initialValuesFactory - Function that returns initial context values.
-     * @returns Express middleware function.
-     */
-    static createExpressMiddleware(initialValuesFactory = () => ({})) {
-        return (req, res, next) => {
-            const initialValues = initialValuesFactory(req);
-            ContextStore.run(initialValues, next);
-        };
-    }
-}
-/**
- * The underlying AsyncLocalStorage instance for context.
- * @private
- */
-ContextStore.storage = new AsyncLocalStorage();
-/**
- * Type-safe wrapper for accessing and modifying context values with specific types.
- *
- * @typeParam T - The value type.
- */
-export class TypedContextKey {
-    /**
-     * Creates a new typed context key.
-     *
-     * @param symbol - The unique symbol for this key
-     * @param defaultValue - Optional default value if key is not found
-     */
-    constructor(symbol, defaultValue) {
-        this.symbol = symbol;
-        this.defaultValue = defaultValue;
-    }
-    /**
-     * Gets the current value for this key.
-     *
-     * @returns The value or defaultValue if not found
-     */
-    get() {
-        const value = ContextStore.get(this.symbol);
-        return value !== undefined ? value : this.defaultValue;
-    }
-    /**
-     * Sets the value for this key.
-     *
-     * @param value The value to set
-     */
-    set(value) {
-        ContextStore.set(this.symbol, value);
-    }
-    /**
-     * Checks if this key exists in the context.
-     *
-     * @returns True if the key exists
-     */
-    exists() {
-        return ContextStore.has(this.symbol);
-    }
-    /**
-     * Deletes this key from the context.
-     *
-     * @returns True if the key was deleted
-     */
-    delete() {
-        return ContextStore.delete(this.symbol);
-    }
-}
-//# sourceMappingURL=context-store.utils.js.map

package/build/esnext/utils/context-store.utils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"context-store.utils.js","sourceRoot":"","sources":["../../../src/utils/context-store.utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAUhD;;;GAGG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG;IACvB,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC;IACxB,UAAU,EAAE,MAAM,CAAC,YAAY,CAAC;IAChC,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC,SAAS,CAAC;IAC1B,cAAc,EAAE,MAAM,CAAC,gBAAgB,CAAC;IACxC,OAAO,EAAE,MAAM,CAAC,SAAS,CAAC;IAC1B,SAAS,EAAE,MAAM,CAAC,WAAW,CAAC;IAC9B,QAAQ,EAAE,MAAM,CAAC,UAAU,CAAC;IAC5B,cAAc,EAAE,MAAM,CAAC,gBAAgB,CAAC;CACzC,CAAC;AAEF;;;;GAIG;AACH,MAAM,UAAU,YAAY;IAC1B,OAAO,YAAY,CAAC,GAAG,CAAS,SAAS,CAAC,UAAU,CAAC,CAAC;AACxD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAAI,GAAW;IAC3C,OAAO,YAAY,CAAC,GAAG,CAAI,GAAG,CAAC,CAAC;AAClC,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,OAAO,YAAY;IAOvB;;;;OAIG;IACH,MAAM,CAAC,WAAW;QAChB,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,GAAG,CAAI,GAAW;QACvB,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;QACtC,OAAO,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAG,GAAG,CAAkB,CAAC;IACvC,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,GAAG,CAAI,GAAW,EAAE,KAAQ;QACjC,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;QACtC,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,iBAAiB,MAAM,CAAC,GAAG,CAAC,+CAA+C,CAAC,CAAC;QAC/F,CAAC;QACD,KAAK,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,MAAM;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;IACjC,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,GAAG,CAAI,KAAY,EAAE,QAAiB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,GAAG,CAAC,GAAW;QACpB,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;QACtC,OAAO,KAAK,KAAK,SAAS,IAAI,GAAG,IAAI,KAAK,CAAC;IAC7C,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,MAAM,CAAC,GAAW;QACvB,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;QACtC,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,oBAAoB,MAAM,CAAC,GAAG,CAAC,+CAA+C,CAAC,CAAC;QAClG,CAAC;QACD,OAAO,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC;IAC3B,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,KAAK,CAAC,MAAwC;QACnD,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;QACtC,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,8DAA8D,CAAC,CAAC;QAClF,CAAC;QACD,MAAM,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YACjD,KAAK,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;IACL,CAAC;IACD;;;;;;;;;;OAUG;IACH,MAAM,CAAC,SAAS,CAAI,GAAW,EAAE,KAAc,EAAE,QAAiB;QAChE,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;QACtC,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,4EAA4E,CAAC,CAAC;QAChG,CAAC;QAED,sBAAsB;QACtB,MAAM,WAAW,GAAG,GAAG,IAAI,KAAK,CAAC;QACjC,MAAM,aAAa,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;QAEjC,sBAAsB;QACtB,KAAK,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QAEnB,IAAI,CAAC;YACH,eAAe;YACf,OAAO,QAAQ,EAAE,CAAC;QACpB,CAAC;gBAAS,CAAC;YACT,yBAAyB;YACzB,IAAI,WAAW,EAAE,CAAC;gBAChB,KAAK,CAAC,GAAG,CAAC,GAAG,aAAa,CAAC;YAC7B,CAAC;iBAAM,CAAC;gBACN,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC;YACpB,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,MAAM,CAAI,SAA2C,EAAE,QAAiB;QAC7E,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC;QAEnD,qDAAqD;QACrD,MAAM,QAAQ,qBAAe,YAAY,CAAE,CAAC;QAE5C,iBAAiB;QACjB,MAAM,CAAC,qBAAqB,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YACpD,QAAQ,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;QAEH,0BAA0B;QAC1B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,uBAAuB,CAAC,uBAAuE,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC;QAC9G,OAAO,CAAC,GAAQ,EAAE,GAAQ,EAAE,IAAS,EAAE,EAAE;YACvC,MAAM,aAAa,GAAG,oBAAoB,CAAC,GAAG,CAAC,CAAC;YAChD,YAAY,CAAC,GAAG,CAAC,aAAsB,EAAE,IAAI,CAAC,CAAC;QACjD,CAAC,CAAC;IACJ,CAAC;;AAjLD;;;GAGG;AACqB,oBAAO,GAAG,IAAI,iBAAiB,EAAS,CAAC;AAgLnE;;;;GAIG;AACH,MAAM,OAAO,eAAe;IAC1B;;;;;OAKG;IACH,YACU,MAAc,EACd,YAAgB;QADhB,WAAM,GAAN,MAAM,CAAQ;QACd,iBAAY,GAAZ,YAAY,CAAI;IACvB,CAAC;IAEJ;;;;OAIG;IACH,GAAG;QACD,MAAM,KAAK,GAAG,YAAY,CAAC,GAAG,CAAI,IAAI,CAAC,MAAM,CAAC,CAAC;QAC/C,OAAO,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC;IACzD,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAC,KAAQ;QACV,YAAY,CAAC,GAAG,CAAI,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAC1C,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,OAAO,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACvC,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,OAAO,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC1C,CAAC;CACF","sourcesContent":["/*\n * The MIT License\n *\n * Copyright (c) 2025 Catbee Technologies. https://catbee-utils.npm.hprasath.com/license\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport { AsyncLocalStorage } from 'async_hooks';\n\n/**\n * Type representing the store object used in AsyncLocalStorage.\n * Keys must be unique symbols to ensure isolation and prevent collisions.\n */\nexport interface Store {\n  [key: symbol]: unknown;\n}\n\n/**\n * Predefined symbols used as keys in AsyncLocalStorage.\n * Add new symbols here to avoid duplication.\n */\nexport const StoreKeys = {\n  LOGGER: Symbol('LOGGER'),\n  REQUEST_ID: Symbol('REQUEST_ID'),\n  USER: Symbol('USER'),\n  SESSION: Symbol('SESSION'),\n  TRANSACTION_ID: Symbol('TRANSACTION_ID'),\n  USER_ID: Symbol('USER_ID'),\n  TENANT_ID: Symbol('TENANT_ID'),\n  TRACE_ID: Symbol('TRACE_ID'),\n  CORRELATION_ID: Symbol('CORRELATION_ID')\n};\n\n/**\n * Retrieves the current request ID from the async context, if available.\n *\n * @returns {string | undefined} The request ID string or undefined if not present in the current context.\n */\nexport function getRequestId(): string | undefined {\n  return ContextStore.get<string>(StoreKeys.REQUEST_ID);\n}\n\n/**\n * Type-safe getter for common context values.\n *\n * @param key The store key symbol\n * @returns The typed value from the store\n */\nexport function getFromContext<T>(key: symbol): T | undefined {\n  return ContextStore.get<T>(key);\n}\n\n/**\n * ContextStore manages per-request scoped context using AsyncLocalStorage.\n * It allows storing and retrieving data across async calls (e.g., request ID, logger).\n *\n * Example (Express middleware):\n * ```\n * // Middleware to initialize context and logger\n * app.use((req, res, next) => {\n *   const requestId = req.headers[\"x-request-id\"]?.toString() || crypto.randomUUID();\n *   ContextStore.run({ [StoreKeys.REQUEST_ID]: requestId }, () => {\n *     ContextStore.set(StoreKeys.LOGGER, getLogger().child({ requestId }));\n *     next();\n *   });\n * });\n * ```\n */\nexport class ContextStore {\n  /**\n   * The underlying AsyncLocalStorage instance for context.\n   * @private\n   */\n  private static readonly storage = new AsyncLocalStorage<Store>();\n\n  /**\n   * Returns the raw AsyncLocalStorage instance for advanced access.\n   *\n   * @returns {AsyncLocalStorage<Store>} The AsyncLocalStorage instance.\n   */\n  static getInstance(): AsyncLocalStorage<Store> {\n    return this.storage;\n  }\n\n  /**\n   * Retrieves a value from the async context store by symbol key.\n   *\n   * @typeParam T - The expected return type of the value.\n   * @param {symbol} key - Unique symbol used as the store key.\n   * @returns {T | undefined} The value found (typed) or undefined if not present.\n   */\n  static get<T>(key: symbol): T | undefined {\n    const store = this.storage.getStore();\n    return store?.[key] as T | undefined;\n  }\n\n  /**\n   * Sets a value in the current context store by symbol key.\n   *\n   * @typeParam T - The value type to set.\n   * @param {symbol} key - Unique symbol key.\n   * @param {T} value - Value to set in context.\n   * @throws {Error} If called outside an active context (not within a .run call or in the wrong async boundaries).\n   */\n  static set<T>(key: symbol, value: T): void {\n    const store = this.storage.getStore();\n    if (!store) {\n      throw new Error(`Failed to set ${String(key)}: AsyncLocalStorage store is not initialized.`);\n    }\n    store[key] = value;\n  }\n\n  /**\n   * Retrieves the entire context store object for the current async context.\n   *\n   * @returns {Store | undefined} The current store object or undefined if called outside a context.\n   */\n  static getAll(): Store | undefined {\n    return this.storage.getStore();\n  }\n\n  /**\n   * Initializes a new async context and executes a callback within it.\n   * This must be called at the beginning of a request or logical async flow.\n   *\n   * @typeParam T - The callback's return type.\n   * @param {Store} store - The initial key-value store object.\n   * @param {() => T} callback - The function to run within the new context.\n   * @returns {T} The result of the callback function.\n   */\n  static run<T>(store: Store, callback: () => T): T {\n    return this.storage.run(store, callback);\n  }\n\n  /**\n   * Checks if a key exists in the current context store.\n   *\n   * @param {symbol} key - The symbol key to check.\n   * @returns {boolean} True if the key exists, false otherwise.\n   */\n  static has(key: symbol): boolean {\n    const store = this.storage.getStore();\n    return store !== undefined && key in store;\n  }\n\n  /**\n   * Removes a value from the current context store by symbol key.\n   *\n   * @param {symbol} key - The symbol key to delete.\n   * @returns {boolean} True if the key was deleted, false if the key wasn't found or no active context.\n   * @throws {Error} If called outside an active context.\n   */\n  static delete(key: symbol): boolean {\n    const store = this.storage.getStore();\n    if (!store) {\n      throw new Error(`Failed to delete ${String(key)}: AsyncLocalStorage store is not initialized.`);\n    }\n    return delete store[key];\n  }\n\n  /**\n   * Updates multiple values in the current context store at once.\n   *\n   * @param {Partial<Record<symbol, unknown>>} values - Object containing symbol keys and values to update.\n   * @throws {Error} If called outside an active context.\n   */\n  static patch(values: Partial<Record<symbol, unknown>>): void {\n    const store = this.storage.getStore();\n    if (!store) {\n      throw new Error('Failed to patch: AsyncLocalStorage store is not initialized.');\n    }\n    Object.getOwnPropertySymbols(values).forEach(key => {\n      store[key] = values[key];\n    });\n  }\n  /**\n   * Executes a callback with a temporary store value that only exists during execution.\n   * Original store is restored after callback completes.\n   *\n   * @typeParam T - The callback's return type.\n   * @param {symbol} key - The symbol key to temporarily set.\n   * @param {unknown} value - The temporary value.\n   * @param {() => T} callback - The function to execute with the temporary value.\n   * @returns {T} The result of the callback function.\n   * @throws {Error} If called outside an active context.\n   */\n  static withValue<T>(key: symbol, value: unknown, callback: () => T): T {\n    const store = this.storage.getStore();\n    if (!store) {\n      throw new Error(`Failed to set temporary value: AsyncLocalStorage store is not initialized.`);\n    }\n\n    // Save original value\n    const hasOriginal = key in store;\n    const originalValue = store[key];\n\n    // Set temporary value\n    store[key] = value;\n\n    try {\n      // Run callback\n      return callback();\n    } finally {\n      // Restore original value\n      if (hasOriginal) {\n        store[key] = originalValue;\n      } else {\n        delete store[key];\n      }\n    }\n  }\n\n  /**\n   * Creates a new context that inherits values from the current context.\n   *\n   * @typeParam T - The callback's return type.\n   * @param {Partial<Record<symbol, unknown>>} newValues - New values to add to or override in the context.\n   * @param {() => T} callback - The function to execute in the new context.\n   * @returns {T} The result of the callback function.\n   */\n  static extend<T>(newValues: Partial<Record<symbol, unknown>>, callback: () => T): T {\n    const currentStore = this.storage.getStore() || {};\n\n    // Create new store with current values plus new ones\n    const newStore: Store = { ...currentStore };\n\n    // Add new values\n    Object.getOwnPropertySymbols(newValues).forEach(key => {\n      newStore[key] = newValues[key];\n    });\n\n    // Run with extended store\n    return this.storage.run(newStore, callback);\n  }\n\n  /**\n   * Creates Express middleware that initializes a context for each request.\n   *\n   * @param {(req: any) => Partial<Record<symbol, unknown>>} initialValuesFactory - Function that returns initial context values.\n   * @returns Express middleware function.\n   */\n  static createExpressMiddleware(initialValuesFactory: (req: any) => Partial<Record<symbol, unknown>> = () => ({})) {\n    return (req: any, res: any, next: any) => {\n      const initialValues = initialValuesFactory(req);\n      ContextStore.run(initialValues as Store, next);\n    };\n  }\n}\n\n/**\n * Type-safe wrapper for accessing and modifying context values with specific types.\n *\n * @typeParam T - The value type.\n */\nexport class TypedContextKey<T> {\n  /**\n   * Creates a new typed context key.\n   *\n   * @param symbol - The unique symbol for this key\n   * @param defaultValue - Optional default value if key is not found\n   */\n  constructor(\n    private symbol: symbol,\n    private defaultValue?: T\n  ) {}\n\n  /**\n   * Gets the current value for this key.\n   *\n   * @returns The value or defaultValue if not found\n   */\n  get(): T | undefined {\n    const value = ContextStore.get<T>(this.symbol);\n    return value !== undefined ? value : this.defaultValue;\n  }\n\n  /**\n   * Sets the value for this key.\n   *\n   * @param value The value to set\n   */\n  set(value: T): void {\n    ContextStore.set<T>(this.symbol, value);\n  }\n\n  /**\n   * Checks if this key exists in the context.\n   *\n   * @returns True if the key exists\n   */\n  exists(): boolean {\n    return ContextStore.has(this.symbol);\n  }\n\n  /**\n   * Deletes this key from the context.\n   *\n   * @returns True if the key was deleted\n   */\n  delete(): boolean {\n    return ContextStore.delete(this.symbol);\n  }\n}\n"]}

package/build/esnext/utils/crypto.utils.js

@@ -1,276 +0,0 @@
-/*
- * The MIT License
- *
- * Copyright (c) 2025 Catbee Technologies. https://catbee-utils.npm.hprasath.com/license
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-import { createHmac, createHash, randomBytes, createCipheriv, createDecipheriv, scrypt, timingSafeEqual } from 'crypto';
-import { promisify } from 'util';
-import { uuid } from './id.utils';
-/**
- * Generates an HMAC digest using the specified algorithm and secret key.
- *
- * @param {string} algorithm - The hashing algorithm (e.g., 'sha256', 'sha1').
- * @param {string} input - The string to hash.
- * @param {string} secret - The secret key for HMAC.
- * @param {BinaryToTextEncoding} [encoding='hex'] - Output encoding ('hex', 'base64', etc).
- * @returns {string} HMAC digest as a string.
- */
-export function hmac(algorithm, input, secret, encoding = 'hex') {
-    return createHmac(algorithm, secret).update(input).digest(encoding);
-}
-/**
- * Generates a hash digest using the specified algorithm.
- *
- * @param {string} algorithm - The hashing algorithm (e.g., 'sha256', 'md5').
- * @param {string} input - The string to hash.
- * @param {BinaryToTextEncoding} [encoding='hex'] - Output encoding ('hex', 'base64', etc).
- * @returns {string} Hash digest as a string.
- */
-export function hash(algorithm, input, encoding = 'hex') {
-    return createHash(algorithm).update(input).digest(encoding);
-}
-/**
- * Generates an HMAC-SHA256 digest.
- *
- * @param {string} input - The string to hash.
- * @param {string} secret - The secret key.
- * @returns {string} SHA-256 HMAC digest as a string.
- */
-export function sha256Hmac(input, secret) {
-    return hmac('sha256', input, secret);
-}
-/**
- * Generates a SHA1 hash digest.
- *
- * @param {string} input - The string to hash.
- * @param {BinaryToTextEncoding} [encoding='hex'] - Output encoding.
- * @returns {string} SHA-1 hash as a string.
- */
-export function sha1(input, encoding = 'hex') {
-    return hash('sha1', input, encoding);
-}
-/**
- * Generates a SHA256 hash digest.
- *
- * @param {string} input - The string to hash.
- * @param {BinaryToTextEncoding} [encoding='hex'] - Output encoding.
- * @returns {string} SHA-256 hash as a string.
- */
-export function sha256(input, encoding = 'hex') {
-    return hash('sha256', input, encoding);
-}
-/**
- * Generates an MD5 hash digest.
- *
- * @param {string} input - The string to hash.
- * @returns {string} MD5 hash as a string.
- */
-export function md5(input) {
-    return hash('md5', input);
-}
-/**
- * Generates a cryptographically strong random string by hashing a random UUID with SHA-256.
- *
- * @returns {string} Random string hashed with SHA-256 (hex encoding).
- */
-export function randomString() {
-    return sha256(uuid());
-}
-/**
- * Generates a secure random buffer of specified byte length.
- *
- * @param {number} [byteLength=32] - Number of random bytes to generate.
- * @returns {Buffer} Buffer containing random bytes.
- */
-export function generateRandomBytes(byteLength = 32) {
-    return randomBytes(byteLength);
-}
-/**
- * Generates a secure random string of specified byte length with specified encoding.
- *
- * @param {number} [byteLength=32] - Number of random bytes to generate.
- * @param {BinaryToTextEncoding} [encoding='hex'] - Output encoding.
- * @returns {string} Random string in specified encoding.
- */
-export function generateRandomBytesAsString(byteLength = 32, encoding = 'hex') {
-    return randomBytes(byteLength).toString(encoding);
-}
-/**
- * Generates a secure API key with a specified format.
- *
- * @param {string} [prefix=''] - Optional prefix for the key.
- * @param {number} [byteLength=24] - Number of random bytes to generate.
- * @returns {string} Formatted API key.
- */
-export function generateApiKey(prefix = '', byteLength = 24) {
-    const randomString = generateRandomBytesAsString(byteLength, 'base64');
-    const key = randomString
-        .replace(/[+/=]/g, '') // Remove non-URL-safe characters
-        .substring(0, 32); // Limit length
-    return prefix ? `${prefix}_${key}` : key;
-}
-/**
- * Compares two strings, arrays, or buffers in constant time to prevent timing attacks.
- *
- * @param {string | Buffer | Uint8Array} a - First value to compare
- * @param {string | Buffer | Uint8Array} b - Second value to compare
- * @returns {boolean} True if values are equal
- */
-export function safeCompare(a, b) {
-    if (typeof a === 'string' && typeof b === 'string') {
-        // Convert strings to buffers
-        const bufA = Buffer.from(a);
-        const bufB = Buffer.from(b);
-        // Compare lengths first (not constant time, but prevents timing attack on contents)
-        if (bufA.length !== bufB.length)
-            return false;
-        return timingSafeEqual(bufA, bufB);
-    }
-    else if ((a instanceof Buffer || a instanceof Uint8Array) && (b instanceof Buffer || b instanceof Uint8Array)) {
-        // Compare lengths first
-        if (a.length !== b.length)
-            return false;
-        return timingSafeEqual(a instanceof Buffer ? a : Buffer.from(a), b instanceof Buffer ? b : Buffer.from(b));
-    }
-    throw new Error('Cannot compare: inputs must be strings, Buffers, or Uint8Arrays');
-}
-// Promisified version of scrypt for key derivation
-const scryptAsync = promisify(scrypt);
-/**
- * Encrypts data using a symmetric key with secure defaults (AES-256-GCM).
- *
- * @param {string | Buffer} data - Data to encrypt
- * @param {string | Buffer} key - Encryption key or passphrase
- * @param {EncryptionOptions} [options] - Encryption options
- * @returns {Promise<EncryptionResult>} Encrypted data with metadata
- */
-export async function encrypt(data, key, options = {}) {
-    const algorithm = options.algorithm || 'aes-256-gcm';
-    const inputEncoding = options.inputEncoding || 'utf8';
-    const outputEncoding = options.outputEncoding || 'hex';
-    // Generate a random IV
-    const iv = randomBytes(16);
-    // Derive key using scrypt if key is a string (passphrase)
-    const derivedKey = typeof key === 'string' ? await scryptAsync(key, iv.slice(0, 8), 32) : key;
-    // Create cipher
-    const cipher = createCipheriv(algorithm, derivedKey, iv);
-    // Encrypt the data
-    let ciphertext;
-    if (typeof data === 'string') {
-        ciphertext = cipher.update(data, inputEncoding, outputEncoding);
-        ciphertext += cipher.final(outputEncoding);
-    }
-    else {
-        const encrypted = Buffer.concat([cipher.update(data), cipher.final()]);
-        ciphertext = outputEncoding ? encrypted.toString(outputEncoding) : encrypted;
-    }
-    // Get authentication tag if using GCM mode
-    const authTag = algorithm.includes('gcm') ? cipher.getAuthTag() : undefined;
-    return {
-        ciphertext,
-        iv,
-        authTag,
-        algorithm
-    };
-}
-/**
- * Decrypts data that was encrypted with the encrypt function.
- *
- * @param {EncryptionResult} encryptedData - The encrypted data and metadata
- * @param {string | Buffer} key - Decryption key or passphrase
- * @param {DecryptionOptions} [options] - Decryption options
- * @returns {Promise<string | Buffer>} Decrypted data
- */
-export async function decrypt(encryptedData, key, options = {}) {
-    const algorithm = options.algorithm || encryptedData.algorithm || 'aes-256-gcm';
-    const inputEncoding = options.inputEncoding || 'hex';
-    const outputEncoding = options.outputEncoding || 'utf8';
-    // Derive key using scrypt if key is a string (passphrase)
-    const derivedKey = typeof key === 'string' ? await scryptAsync(key, encryptedData.iv.slice(0, 8), 32) : key;
-    // Create decipher
-    const decipher = createDecipheriv(algorithm, derivedKey, encryptedData.iv);
-    // Set auth tag if using GCM mode
-    if (encryptedData.authTag && algorithm.includes('gcm')) {
-        decipher.setAuthTag(encryptedData.authTag);
-    }
-    // Decrypt the data
-    let decrypted;
-    if (typeof encryptedData.ciphertext === 'string') {
-        decrypted = decipher.update(encryptedData.ciphertext, inputEncoding, outputEncoding);
-        decrypted += decipher.final(outputEncoding);
-    }
-    else {
-        const result = Buffer.concat([decipher.update(encryptedData.ciphertext), decipher.final()]);
-        decrypted = outputEncoding ? result.toString(outputEncoding) : result;
-    }
-    return decrypted;
-}
-/**
- * Creates a signed token with an expiration time and payload.
- *
- * @param {object} payload - Data to include in the token
- * @param {string} secret - Secret key for signing
- * @param {number} [expiresInSeconds=3600] - Token expiration in seconds
- * @returns {string} Signed token string
- */
-export function createSignedToken(payload, secret, expiresInSeconds = 3600) {
-    // Create payload with expiration
-    const tokenPayload = Object.assign(Object.assign({}, payload), { exp: Math.floor(Date.now() / 1000) + expiresInSeconds });
-    // Convert to string
-    const payloadStr = JSON.stringify(tokenPayload);
-    // Base64 encode the payload
-    const base64Payload = Buffer.from(payloadStr).toString('base64url');
-    // Create signature
-    const signature = hmac('sha256', base64Payload, secret, 'base64url');
-    // Combine payload and signature
-    return `${base64Payload}.${signature}`;
-}
-/**
- * Verifies and decodes a signed token.
- *
- * @param {string} token - The token to verify
- * @param {string} secret - Secret key for verification
- * @returns {object | null} Decoded payload if valid, null if invalid
- */
-export function verifySignedToken(token, secret) {
-    try {
-        // Split token into parts
-        const [payloadB64, signature] = token.split('.');
-        if (!payloadB64 || !signature)
-            return null;
-        // Verify signature
-        const expectedSignature = hmac('sha256', payloadB64, secret, 'base64url');
-        if (!safeCompare(signature, expectedSignature))
-            return null;
-        // Decode payload
-        const payloadStr = Buffer.from(payloadB64, 'base64url').toString('utf8');
-        const payload = JSON.parse(payloadStr);
-        // Check expiration
-        if (payload.exp && payload.exp < Math.floor(Date.now() / 1000)) {
-            return null;
-        }
-        return payload;
-    }
-    catch (_a) {
-        return null;
-    }
-}
-//# sourceMappingURL=crypto.utils.js.map

package/build/esnext/utils/crypto.utils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"crypto.utils.js","sourceRoot":"","sources":["../../../src/utils/crypto.utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,OAAO,EACL,UAAU,EACV,UAAU,EAEV,WAAW,EACX,cAAc,EACd,gBAAgB,EAChB,MAAM,EACN,eAAe,EAEhB,MAAM,QAAQ,CAAC;AAChB,OAAO,EAAE,SAAS,EAAE,MAAM,MAAM,CAAC;AACjC,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAgBlC;;;;;;;;GAQG;AACH,MAAM,UAAU,IAAI,CAAC,SAAiB,EAAE,KAAa,EAAE,MAAc,EAAE,WAAiC,KAAK;IAC3G,OAAO,UAAU,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;AACtE,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,IAAI,CAAC,SAAiB,EAAE,KAAa,EAAE,WAAiC,KAAK;IAC3F,OAAO,UAAU,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;AAC9D,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,UAAU,CAAC,KAAa,EAAE,MAAc;IACtD,OAAO,IAAI,CAAC,QAAQ,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;AACvC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,IAAI,CAAC,KAAa,EAAE,WAAiC,KAAK;IACxE,OAAO,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;AACvC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,MAAM,CAAC,KAAa,EAAE,WAAiC,KAAK;IAC1E,OAAO,IAAI,CAAC,QAAQ,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;AACzC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,GAAG,CAAC,KAAa;IAC/B,OAAO,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;AAC5B,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,YAAY;IAC1B,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;AACxB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CAAC,aAAqB,EAAE;IACzD,OAAO,WAAW,CAAC,UAAU,CAAC,CAAC;AACjC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,2BAA2B,CAAC,aAAqB,EAAE,EAAE,WAAiC,KAAK;IACzG,OAAO,WAAW,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AACpD,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,cAAc,CAAC,SAAiB,EAAE,EAAE,aAAqB,EAAE;IACzE,MAAM,YAAY,GAAG,2BAA2B,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;IACvE,MAAM,GAAG,GAAG,YAAY;SACrB,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,iCAAiC;SACvD,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,eAAe;IAEpC,OAAO,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;AAC3C,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,WAAW,CAAC,CAA+B,EAAE,CAA+B;IAC1F,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE,CAAC;QACnD,6BAA6B;QAC7B,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC5B,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAE5B,oFAAoF;QACpF,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,MAAM;YAAE,OAAO,KAAK,CAAC;QAE9C,OAAO,eAAe,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACrC,CAAC;SAAM,IAAI,CAAC,CAAC,YAAY,MAAM,IAAI,CAAC,YAAY,UAAU,CAAC,IAAI,CAAC,CAAC,YAAY,MAAM,IAAI,CAAC,YAAY,UAAU,CAAC,EAAE,CAAC;QAChH,wBAAwB;QACxB,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM;YAAE,OAAO,KAAK,CAAC;QAExC,OAAO,eAAe,CAAC,CAAC,YAAY,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,YAAY,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAC7G,CAAC;IAED,MAAM,IAAI,KAAK,CAAC,iEAAiE,CAAC,CAAC;AACrF,CAAC;AAwCD,mDAAmD;AACnD,MAAM,WAAW,GAAG,SAAS,CAAmD,MAAM,CAAC,CAAC;AAExF;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,OAAO,CAC3B,IAAqB,EACrB,GAAoB,EACpB,UAA6B,EAAE;IAE/B,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,aAAa,CAAC;IACrD,MAAM,aAAa,GAAG,OAAO,CAAC,aAAa,IAAI,MAAM,CAAC;IACtD,MAAM,cAAc,GAAG,OAAO,CAAC,cAAc,IAAI,KAAK,CAAC;IAEvD,uBAAuB;IACvB,MAAM,EAAE,GAAG,WAAW,CAAC,EAAE,CAAC,CAAC;IAE3B,0DAA0D;IAC1D,MAAM,UAAU,GAAG,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,WAAW,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;IAE9F,gBAAgB;IAChB,MAAM,MAAM,GAAG,cAAc,CAAC,SAAS,EAAE,UAAU,EAAE,EAAE,CAAC,CAAC;IAEzD,mBAAmB;IACnB,IAAI,UAA2B,CAAC;IAEhC,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC7B,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,aAAa,EAAE,cAAgC,CAAC,CAAC;QAClF,UAAU,IAAI,MAAM,CAAC,KAAK,CAAC,cAAgC,CAAC,CAAC;IAC/D,CAAC;SAAM,CAAC;QACN,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QACvE,UAAU,GAAG,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC/E,CAAC;IAED,2CAA2C;IAC3C,MAAM,OAAO,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAE,MAAc,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;IAErF,OAAO;QACL,UAAU;QACV,EAAE;QACF,OAAO;QACP,SAAS;KACV,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,OAAO,CAC3B,aAA+B,EAC/B,GAAoB,EACpB,UAA6B,EAAE;IAE/B,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,aAAa,CAAC,SAAS,IAAI,aAAa,CAAC;IAChF,MAAM,aAAa,GAAG,OAAO,CAAC,aAAa,IAAI,KAAK,CAAC;IACrD,MAAM,cAAc,GAAG,OAAO,CAAC,cAAc,IAAI,MAAM,CAAC;IAExD,0DAA0D;IAC1D,MAAM,UAAU,GAAG,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,WAAW,CAAC,GAAG,EAAE,aAAa,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;IAE5G,kBAAkB;IAClB,MAAM,QAAQ,GAAG,gBAAgB,CAAC,SAAS,EAAE,UAAU,EAAE,aAAa,CAAC,EAAE,CAAC,CAAC;IAE3E,iCAAiC;IACjC,IAAI,aAAa,CAAC,OAAO,IAAI,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACtD,QAAgB,CAAC,UAAU,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IACtD,CAAC;IAED,mBAAmB;IACnB,IAAI,SAA0B,CAAC;IAE/B,IAAI,OAAO,aAAa,CAAC,UAAU,KAAK,QAAQ,EAAE,CAAC;QACjD,SAAS,GAAG,QAAQ,CAAC,MAAM,CAAC,aAAa,CAAC,UAAU,EAAE,aAA+B,EAAE,cAAc,CAAC,CAAC;QACvG,SAAS,IAAI,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;IAC9C,CAAC;SAAM,CAAC;QACN,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QAC5F,SAAS,GAAG,cAAc,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;IACxE,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,iBAAiB,CAC/B,OAA4B,EAC5B,MAAc,EACd,mBAA2B,IAAI;IAE/B,iCAAiC;IACjC,MAAM,YAAY,mCACb,OAAO,KACV,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,GAAG,gBAAgB,GACtD,CAAC;IAEF,oBAAoB;IACpB,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;IAEhD,4BAA4B;IAC5B,MAAM,aAAa,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;IAEpE,mBAAmB;IACnB,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,EAAE,aAAa,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAErE,gCAAgC;IAChC,OAAO,GAAG,aAAa,IAAI,SAAS,EAAE,CAAC;AACzC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,iBAAiB,CAAC,KAAa,EAAE,MAAc;IAC7D,IAAI,CAAC;QACH,yBAAyB;QACzB,MAAM,CAAC,UAAU,EAAE,SAAS,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAEjD,IAAI,CAAC,UAAU,IAAI,CAAC,SAAS;YAAE,OAAO,IAAI,CAAC;QAE3C,mBAAmB;QACnB,MAAM,iBAAiB,GAAG,IAAI,CAAC,QAAQ,EAAE,UAAU,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;QAC1E,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,iBAAiB,CAAC;YAAE,OAAO,IAAI,CAAC;QAE5D,iBAAiB;QACjB,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACzE,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAEvC,mBAAmB;QACnB,IAAI,OAAO,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC;YAC/D,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAAC,WAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC","sourcesContent":["/*\n * The MIT License\n *\n * Copyright (c) 2025 Catbee Technologies. https://catbee-utils.npm.hprasath.com/license\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport {\n  createHmac,\n  createHash,\n  BinaryToTextEncoding,\n  randomBytes,\n  createCipheriv,\n  createDecipheriv,\n  scrypt,\n  timingSafeEqual,\n  CipherGCMTypes\n} from 'crypto';\nimport { promisify } from 'util';\nimport { uuid } from './id.utils';\n\nexport type BufferEncoding =\n  | 'ascii'\n  | 'utf8'\n  | 'utf-8'\n  | 'utf16le'\n  | 'utf-16le'\n  | 'ucs2'\n  | 'ucs-2'\n  | 'base64'\n  | 'base64url'\n  | 'latin1'\n  | 'binary'\n  | 'hex';\n\n/**\n * Generates an HMAC digest using the specified algorithm and secret key.\n *\n * @param {string} algorithm - The hashing algorithm (e.g., 'sha256', 'sha1').\n * @param {string} input - The string to hash.\n * @param {string} secret - The secret key for HMAC.\n * @param {BinaryToTextEncoding} [encoding='hex'] - Output encoding ('hex', 'base64', etc).\n * @returns {string} HMAC digest as a string.\n */\nexport function hmac(algorithm: string, input: string, secret: string, encoding: BinaryToTextEncoding = 'hex'): string {\n  return createHmac(algorithm, secret).update(input).digest(encoding);\n}\n\n/**\n * Generates a hash digest using the specified algorithm.\n *\n * @param {string} algorithm - The hashing algorithm (e.g., 'sha256', 'md5').\n * @param {string} input - The string to hash.\n * @param {BinaryToTextEncoding} [encoding='hex'] - Output encoding ('hex', 'base64', etc).\n * @returns {string} Hash digest as a string.\n */\nexport function hash(algorithm: string, input: string, encoding: BinaryToTextEncoding = 'hex'): string {\n  return createHash(algorithm).update(input).digest(encoding);\n}\n\n/**\n * Generates an HMAC-SHA256 digest.\n *\n * @param {string} input - The string to hash.\n * @param {string} secret - The secret key.\n * @returns {string} SHA-256 HMAC digest as a string.\n */\nexport function sha256Hmac(input: string, secret: string): string {\n  return hmac('sha256', input, secret);\n}\n\n/**\n * Generates a SHA1 hash digest.\n *\n * @param {string} input - The string to hash.\n * @param {BinaryToTextEncoding} [encoding='hex'] - Output encoding.\n * @returns {string} SHA-1 hash as a string.\n */\nexport function sha1(input: string, encoding: BinaryToTextEncoding = 'hex'): string {\n  return hash('sha1', input, encoding);\n}\n\n/**\n * Generates a SHA256 hash digest.\n *\n * @param {string} input - The string to hash.\n * @param {BinaryToTextEncoding} [encoding='hex'] - Output encoding.\n * @returns {string} SHA-256 hash as a string.\n */\nexport function sha256(input: string, encoding: BinaryToTextEncoding = 'hex'): string {\n  return hash('sha256', input, encoding);\n}\n\n/**\n * Generates an MD5 hash digest.\n *\n * @param {string} input - The string to hash.\n * @returns {string} MD5 hash as a string.\n */\nexport function md5(input: string): string {\n  return hash('md5', input);\n}\n\n/**\n * Generates a cryptographically strong random string by hashing a random UUID with SHA-256.\n *\n * @returns {string} Random string hashed with SHA-256 (hex encoding).\n */\nexport function randomString(): string {\n  return sha256(uuid());\n}\n\n/**\n * Generates a secure random buffer of specified byte length.\n *\n * @param {number} [byteLength=32] - Number of random bytes to generate.\n * @returns {Buffer} Buffer containing random bytes.\n */\nexport function generateRandomBytes(byteLength: number = 32): Buffer {\n  return randomBytes(byteLength);\n}\n\n/**\n * Generates a secure random string of specified byte length with specified encoding.\n *\n * @param {number} [byteLength=32] - Number of random bytes to generate.\n * @param {BinaryToTextEncoding} [encoding='hex'] - Output encoding.\n * @returns {string} Random string in specified encoding.\n */\nexport function generateRandomBytesAsString(byteLength: number = 32, encoding: BinaryToTextEncoding = 'hex'): string {\n  return randomBytes(byteLength).toString(encoding);\n}\n\n/**\n * Generates a secure API key with a specified format.\n *\n * @param {string} [prefix=''] - Optional prefix for the key.\n * @param {number} [byteLength=24] - Number of random bytes to generate.\n * @returns {string} Formatted API key.\n */\nexport function generateApiKey(prefix: string = '', byteLength: number = 24): string {\n  const randomString = generateRandomBytesAsString(byteLength, 'base64');\n  const key = randomString\n    .replace(/[+/=]/g, '') // Remove non-URL-safe characters\n    .substring(0, 32); // Limit length\n\n  return prefix ? `${prefix}_${key}` : key;\n}\n\n/**\n * Compares two strings, arrays, or buffers in constant time to prevent timing attacks.\n *\n * @param {string | Buffer | Uint8Array} a - First value to compare\n * @param {string | Buffer | Uint8Array} b - Second value to compare\n * @returns {boolean} True if values are equal\n */\nexport function safeCompare(a: string | Buffer | Uint8Array, b: string | Buffer | Uint8Array): boolean {\n  if (typeof a === 'string' && typeof b === 'string') {\n    // Convert strings to buffers\n    const bufA = Buffer.from(a);\n    const bufB = Buffer.from(b);\n\n    // Compare lengths first (not constant time, but prevents timing attack on contents)\n    if (bufA.length !== bufB.length) return false;\n\n    return timingSafeEqual(bufA, bufB);\n  } else if ((a instanceof Buffer || a instanceof Uint8Array) && (b instanceof Buffer || b instanceof Uint8Array)) {\n    // Compare lengths first\n    if (a.length !== b.length) return false;\n\n    return timingSafeEqual(a instanceof Buffer ? a : Buffer.from(a), b instanceof Buffer ? b : Buffer.from(b));\n  }\n\n  throw new Error('Cannot compare: inputs must be strings, Buffers, or Uint8Arrays');\n}\n\n/**\n * Interface for encryption options\n */\nexport interface EncryptionOptions {\n  /** Algorithm to use (default: aes-256-gcm) */\n  algorithm?: CipherGCMTypes;\n  /** Input encoding for plaintext if string (default: utf8) */\n  inputEncoding?: BufferEncoding;\n  /** Output encoding for ciphertext (default: hex) */\n  outputEncoding?: BinaryToTextEncoding;\n}\n\n/**\n * Interface for decryption options\n */\nexport interface DecryptionOptions {\n  /** Algorithm to use (default: aes-256-gcm) */\n  algorithm?: CipherGCMTypes;\n  /** Input encoding for ciphertext if string (default: hex) */\n  inputEncoding?: BinaryToTextEncoding;\n  /** Output encoding for plaintext (default: utf8) */\n  outputEncoding?: BufferEncoding;\n}\n\n/**\n * Result of encryption operation including all data needed for decryption\n */\nexport interface EncryptionResult {\n  /** Encrypted data (string or Buffer based on options) */\n  ciphertext: string | Buffer;\n  /** Initialization vector */\n  iv: Buffer;\n  /** Authentication tag (for GCM mode) */\n  authTag?: Buffer;\n  /** Algorithm used */\n  algorithm: string;\n}\n\n// Promisified version of scrypt for key derivation\nconst scryptAsync = promisify<string | Buffer, string | Buffer, number, Buffer>(scrypt);\n\n/**\n * Encrypts data using a symmetric key with secure defaults (AES-256-GCM).\n *\n * @param {string | Buffer} data - Data to encrypt\n * @param {string | Buffer} key - Encryption key or passphrase\n * @param {EncryptionOptions} [options] - Encryption options\n * @returns {Promise<EncryptionResult>} Encrypted data with metadata\n */\nexport async function encrypt(\n  data: string | Buffer,\n  key: string | Buffer,\n  options: EncryptionOptions = {}\n): Promise<EncryptionResult> {\n  const algorithm = options.algorithm || 'aes-256-gcm';\n  const inputEncoding = options.inputEncoding || 'utf8';\n  const outputEncoding = options.outputEncoding || 'hex';\n\n  // Generate a random IV\n  const iv = randomBytes(16);\n\n  // Derive key using scrypt if key is a string (passphrase)\n  const derivedKey = typeof key === 'string' ? await scryptAsync(key, iv.slice(0, 8), 32) : key;\n\n  // Create cipher\n  const cipher = createCipheriv(algorithm, derivedKey, iv);\n\n  // Encrypt the data\n  let ciphertext: string | Buffer;\n\n  if (typeof data === 'string') {\n    ciphertext = cipher.update(data, inputEncoding, outputEncoding as BufferEncoding);\n    ciphertext += cipher.final(outputEncoding as BufferEncoding);\n  } else {\n    const encrypted = Buffer.concat([cipher.update(data), cipher.final()]);\n    ciphertext = outputEncoding ? encrypted.toString(outputEncoding) : encrypted;\n  }\n\n  // Get authentication tag if using GCM mode\n  const authTag = algorithm.includes('gcm') ? (cipher as any).getAuthTag() : undefined;\n\n  return {\n    ciphertext,\n    iv,\n    authTag,\n    algorithm\n  };\n}\n\n/**\n * Decrypts data that was encrypted with the encrypt function.\n *\n * @param {EncryptionResult} encryptedData - The encrypted data and metadata\n * @param {string | Buffer} key - Decryption key or passphrase\n * @param {DecryptionOptions} [options] - Decryption options\n * @returns {Promise<string | Buffer>} Decrypted data\n */\nexport async function decrypt(\n  encryptedData: EncryptionResult,\n  key: string | Buffer,\n  options: DecryptionOptions = {}\n): Promise<string | Buffer> {\n  const algorithm = options.algorithm || encryptedData.algorithm || 'aes-256-gcm';\n  const inputEncoding = options.inputEncoding || 'hex';\n  const outputEncoding = options.outputEncoding || 'utf8';\n\n  // Derive key using scrypt if key is a string (passphrase)\n  const derivedKey = typeof key === 'string' ? await scryptAsync(key, encryptedData.iv.slice(0, 8), 32) : key;\n\n  // Create decipher\n  const decipher = createDecipheriv(algorithm, derivedKey, encryptedData.iv);\n\n  // Set auth tag if using GCM mode\n  if (encryptedData.authTag && algorithm.includes('gcm')) {\n    (decipher as any).setAuthTag(encryptedData.authTag);\n  }\n\n  // Decrypt the data\n  let decrypted: string | Buffer;\n\n  if (typeof encryptedData.ciphertext === 'string') {\n    decrypted = decipher.update(encryptedData.ciphertext, inputEncoding as BufferEncoding, outputEncoding);\n    decrypted += decipher.final(outputEncoding);\n  } else {\n    const result = Buffer.concat([decipher.update(encryptedData.ciphertext), decipher.final()]);\n    decrypted = outputEncoding ? result.toString(outputEncoding) : result;\n  }\n\n  return decrypted;\n}\n\n/**\n * Creates a signed token with an expiration time and payload.\n *\n * @param {object} payload - Data to include in the token\n * @param {string} secret - Secret key for signing\n * @param {number} [expiresInSeconds=3600] - Token expiration in seconds\n * @returns {string} Signed token string\n */\nexport function createSignedToken(\n  payload: Record<string, any>,\n  secret: string,\n  expiresInSeconds: number = 3600\n): string {\n  // Create payload with expiration\n  const tokenPayload = {\n    ...payload,\n    exp: Math.floor(Date.now() / 1000) + expiresInSeconds\n  };\n\n  // Convert to string\n  const payloadStr = JSON.stringify(tokenPayload);\n\n  // Base64 encode the payload\n  const base64Payload = Buffer.from(payloadStr).toString('base64url');\n\n  // Create signature\n  const signature = hmac('sha256', base64Payload, secret, 'base64url');\n\n  // Combine payload and signature\n  return `${base64Payload}.${signature}`;\n}\n\n/**\n * Verifies and decodes a signed token.\n *\n * @param {string} token - The token to verify\n * @param {string} secret - Secret key for verification\n * @returns {object | null} Decoded payload if valid, null if invalid\n */\nexport function verifySignedToken(token: string, secret: string): Record<string, any> | null {\n  try {\n    // Split token into parts\n    const [payloadB64, signature] = token.split('.');\n\n    if (!payloadB64 || !signature) return null;\n\n    // Verify signature\n    const expectedSignature = hmac('sha256', payloadB64, secret, 'base64url');\n    if (!safeCompare(signature, expectedSignature)) return null;\n\n    // Decode payload\n    const payloadStr = Buffer.from(payloadB64, 'base64url').toString('utf8');\n    const payload = JSON.parse(payloadStr);\n\n    // Check expiration\n    if (payload.exp && payload.exp < Math.floor(Date.now() / 1000)) {\n      return null;\n    }\n\n    return payload;\n  } catch {\n    return null;\n  }\n}\n"]}