@catbee/utils 0.0.8-rc.3 → 1.0.1

package/build/cjs/utils/cache.utils.d.ts

@@ -1,152 +0,0 @@
-/**
- * Options for configuring a TTLCache instance.
- */
-export interface TTLCacheOptions {
-    /** Default time-to-live in milliseconds for cache entries */
-    ttlMs?: number;
-    /** Maximum number of entries to keep in cache (uses LRU eviction policy) */
-    maxSize?: number;
-    /** Auto-cleanup interval in milliseconds (disabled if 0 or negative) */
-    autoCleanupMs?: number;
-}
-/**
- * An in-memory cache with time-to-live (TTL) support for each entry.
- *
- * @typeParam K - Type of the key.
- * @typeParam V - Type of the value.
- *
- * @example
- * const cache = new TTLCache<string, number>({ ttlMs: 1000 });
- * cache.set("x", 123);
- * const value = cache.get("x"); // 123
- */
-export declare class TTLCache<K, V> {
-    private cache;
-    private ttlMs;
-    private maxSize?;
-    private cleanupInterval?;
-    /**
-     * @param options - Configuration options for the cache
-     */
-    constructor(options?: TTLCacheOptions);
-    /**
-     * Sets a key-value pair in the cache with the default TTL.
-     *
-     * @param key - The key to set.
-     * @param value - The value to associate with the key.
-     */
-    set(key: K, value: V): void;
-    /**
-     * Sets a key-value pair in the cache with a custom TTL.
-     *
-     * @param key - The key to set.
-     * @param value - The value to associate with the key.
-     * @param ttlMs - Time-to-live in milliseconds.
-     */
-    setWithTTL(key: K, value: V, ttlMs: number): void;
-    /**
-     * Retrieves the value for a given key if it hasn't expired.
-     *
-     * @param key - The key to retrieve.
-     * @returns The cached value, or undefined if not found or expired.
-     */
-    get(key: K): V | undefined;
-    /**
-     * Retrieves or computes a value if it's not in the cache or has expired.
-     *
-     * @param key - The key to retrieve
-     * @param producer - Function to generate the value if not cached
-     * @param ttlMs - Optional custom TTL for the computed value
-     * @returns The cached or computed value
-     */
-    getOrCompute(key: K, producer: () => Promise<V>, ttlMs?: number): Promise<V>;
-    /**
-     * Checks if the key exists and hasn't expired.
-     *
-     * @param key - The key to check.
-     * @returns `true` if key exists and is valid, otherwise `false`.
-     */
-    has(key: K): boolean;
-    /**
-     * Deletes a key from the cache.
-     *
-     * @param key - The key to delete.
-     * @returns `true` if the key existed and was removed, `false` otherwise.
-     */
-    delete(key: K): boolean;
-    /**
-     * Clears all entries from the cache.
-     */
-    clear(): void;
-    /**
-     * Returns the number of entries currently in the cache (includes expired entries until next access/cleanup).
-     *
-     * @returns Number of items in the cache (may include expired keys).
-     */
-    size(): number;
-    /**
-     * Set multiple key-value pairs at once with the default TTL.
-     *
-     * @param entries - Array of [key, value] tuples to set
-     */
-    setMany(entries: [K, V][]): void;
-    /**
-     * Get multiple values at once.
-     *
-     * @param keys - Array of keys to retrieve
-     * @returns Array of values (undefined for keys that don't exist or expired)
-     */
-    getMany(keys: K[]): (V | undefined)[];
-    /**
-     * Removes all expired entries from the cache.
-     *
-     * @returns Number of entries removed.
-     */
-    cleanup(): number;
-    /**
-     * Returns an iterator of all current valid [key, value] pairs.
-     *
-     * @returns IterableIterator<[K, V]>
-     */
-    entries(): IterableIterator<[K, V]>;
-    /**
-     * Returns an iterator of all current valid keys.
-     *
-     * @returns IterableIterator<K>
-     */
-    keys(): IterableIterator<K>;
-    /**
-     * Returns an iterator of all current valid values.
-     *
-     * @returns IterableIterator<V>
-     */
-    values(): IterableIterator<V>;
-    /**
-     * Extends the expiration of a key by the specified time or default TTL.
-     *
-     * @param key - The key to refresh
-     * @param ttlMs - Optional new TTL in milliseconds (uses default if not specified)
-     * @returns true if the key was found and refreshed, false otherwise
-     */
-    refresh(key: K, ttlMs?: number): boolean;
-    /**
-     * Returns a snapshot of cache stats.
-     *
-     * @returns Object containing cache statistics
-     */
-    stats(): {
-        size: number;
-        validEntries: number;
-        expiredEntries: number;
-        maxSize: number | undefined;
-    };
-    /**
-     * Stop the auto-cleanup interval if it's running.
-     */
-    destroy(): void;
-    /**
-     * Evict the least recently used entry from the cache.
-     * @private
-     */
-    private evictLRU;
-}

package/build/cjs/utils/cache.utils.js

@@ -1,298 +0,0 @@
-"use strict";
-/*
- * 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.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TTLCache = void 0;
-const config_1 = require("../config");
-/**
- * An in-memory cache with time-to-live (TTL) support for each entry.
- *
- * @typeParam K - Type of the key.
- * @typeParam V - Type of the value.
- *
- * @example
- * const cache = new TTLCache<string, number>({ ttlMs: 1000 });
- * cache.set("x", 123);
- * const value = cache.get("x"); // 123
- */
-class TTLCache {
-    cache = new Map();
-    ttlMs;
-    maxSize;
-    cleanupInterval;
-    /**
-     * @param options - Configuration options for the cache
-     */
-    constructor(options = {}) {
-        this.ttlMs = options.ttlMs ?? config_1.config.cache.defaultTtl;
-        this.maxSize = options.maxSize;
-        // Setup auto-cleanup if enabled
-        const autoCleanupMs = options.autoCleanupMs;
-        if (autoCleanupMs && autoCleanupMs > 0) {
-            this.cleanupInterval = setInterval(() => {
-                this.cleanup();
-            }, autoCleanupMs);
-        }
-    }
-    /**
-     * Sets a key-value pair in the cache with the default TTL.
-     *
-     * @param key - The key to set.
-     * @param value - The value to associate with the key.
-     */
-    set(key, value) {
-        this.setWithTTL(key, value, this.ttlMs);
-    }
-    /**
-     * Sets a key-value pair in the cache with a custom TTL.
-     *
-     * @param key - The key to set.
-     * @param value - The value to associate with the key.
-     * @param ttlMs - Time-to-live in milliseconds.
-     */
-    setWithTTL(key, value, ttlMs) {
-        const now = Date.now();
-        const expiresAt = now + ttlMs;
-        if (this.cache.has(key)) {
-            this.cache.delete(key); // remove old entry to maintain LRU order
-        }
-        this.cache.set(key, { value, expiresAt, lastAccessed: now });
-        if (this.maxSize && this.cache.size > this.maxSize) {
-            this.evictLRU();
-        }
-    }
-    /**
-     * Retrieves the value for a given key if it hasn't expired.
-     *
-     * @param key - The key to retrieve.
-     * @returns The cached value, or undefined if not found or expired.
-     */
-    get(key) {
-        const entry = this.cache.get(key);
-        if (!entry)
-            return undefined;
-        const now = Date.now();
-        if (now > entry.expiresAt) {
-            this.cache.delete(key);
-            return undefined;
-        }
-        // Update lastAccessed and move key to the end (most recently used)
-        entry.lastAccessed = now;
-        // Re-insert to end of Map to maintain LRU order
-        this.cache.delete(key);
-        this.cache.set(key, entry);
-        return entry.value;
-    }
-    /**
-     * Retrieves or computes a value if it's not in the cache or has expired.
-     *
-     * @param key - The key to retrieve
-     * @param producer - Function to generate the value if not cached
-     * @param ttlMs - Optional custom TTL for the computed value
-     * @returns The cached or computed value
-     */
-    async getOrCompute(key, producer, ttlMs) {
-        const value = this.get(key);
-        if (value !== undefined)
-            return value;
-        const newValue = await producer();
-        this.setWithTTL(key, newValue, ttlMs ?? this.ttlMs);
-        return newValue;
-    }
-    /**
-     * Checks if the key exists and hasn't expired.
-     *
-     * @param key - The key to check.
-     * @returns `true` if key exists and is valid, otherwise `false`.
-     */
-    has(key) {
-        return this.get(key) !== undefined;
-    }
-    /**
-     * Deletes a key from the cache.
-     *
-     * @param key - The key to delete.
-     * @returns `true` if the key existed and was removed, `false` otherwise.
-     */
-    delete(key) {
-        return this.cache.delete(key);
-    }
-    /**
-     * Clears all entries from the cache.
-     */
-    clear() {
-        this.cache.clear();
-    }
-    /**
-     * Returns the number of entries currently in the cache (includes expired entries until next access/cleanup).
-     *
-     * @returns Number of items in the cache (may include expired keys).
-     */
-    size() {
-        return this.cache.size;
-    }
-    /**
-     * Set multiple key-value pairs at once with the default TTL.
-     *
-     * @param entries - Array of [key, value] tuples to set
-     */
-    setMany(entries) {
-        for (const [key, value] of entries) {
-            this.set(key, value);
-        }
-    }
-    /**
-     * Get multiple values at once.
-     *
-     * @param keys - Array of keys to retrieve
-     * @returns Array of values (undefined for keys that don't exist or expired)
-     */
-    getMany(keys) {
-        return keys.map(key => this.get(key));
-    }
-    /**
-     * Removes all expired entries from the cache.
-     *
-     * @returns Number of entries removed.
-     */
-    cleanup() {
-        let removed = 0;
-        const now = Date.now();
-        for (const [key, entry] of this.cache.entries()) {
-            if (now > entry.expiresAt) {
-                this.cache.delete(key);
-                removed++;
-            }
-        }
-        return removed;
-    }
-    /**
-     * Returns an iterator of all current valid [key, value] pairs.
-     *
-     * @returns IterableIterator<[K, V]>
-     */
-    *entries() {
-        for (const [key, entry] of this.cache.entries()) {
-            if (Date.now() <= entry.expiresAt) {
-                yield [key, entry.value];
-            }
-        }
-    }
-    /**
-     * Returns an iterator of all current valid keys.
-     *
-     * @returns IterableIterator<K>
-     */
-    *keys() {
-        for (const [key, entry] of this.cache.entries()) {
-            if (Date.now() <= entry.expiresAt) {
-                yield key;
-            }
-        }
-    }
-    /**
-     * Returns an iterator of all current valid values.
-     *
-     * @returns IterableIterator<V>
-     */
-    *values() {
-        for (const entry of this.cache.values()) {
-            if (Date.now() <= entry.expiresAt) {
-                yield entry.value;
-            }
-        }
-    }
-    /**
-     * Extends the expiration of a key by the specified time or default TTL.
-     *
-     * @param key - The key to refresh
-     * @param ttlMs - Optional new TTL in milliseconds (uses default if not specified)
-     * @returns true if the key was found and refreshed, false otherwise
-     */
-    refresh(key, ttlMs) {
-        const entry = this.cache.get(key);
-        if (!entry)
-            return false;
-        const now = Date.now();
-        if (now > entry.expiresAt) {
-            this.cache.delete(key);
-            return false;
-        }
-        entry.expiresAt = now + (ttlMs ?? this.ttlMs);
-        entry.lastAccessed = now;
-        return true;
-    }
-    /**
-     * Returns a snapshot of cache stats.
-     *
-     * @returns Object containing cache statistics
-     */
-    stats() {
-        const now = Date.now();
-        let expired = 0;
-        let valid = 0;
-        for (const entry of this.cache.values()) {
-            if (now > entry.expiresAt) {
-                expired++;
-            }
-            else {
-                valid++;
-            }
-        }
-        return {
-            size: this.cache.size,
-            validEntries: valid,
-            expiredEntries: expired,
-            maxSize: this.maxSize
-        };
-    }
-    /**
-     * Stop the auto-cleanup interval if it's running.
-     */
-    destroy() {
-        if (this.cleanupInterval) {
-            clearInterval(this.cleanupInterval);
-            this.cleanupInterval = undefined;
-        }
-    }
-    /**
-     * Evict the least recently used entry from the cache.
-     * @private
-     */
-    evictLRU() {
-        const now = Date.now();
-        // Remove all expired items first
-        for (const [key, entry] of Array.from(this.cache.entries())) {
-            if (now > entry.expiresAt) {
-                this.cache.delete(key);
-            }
-        }
-        // Evict oldest entries until within max size
-        while (this.maxSize && this.cache.size > this.maxSize) {
-            const oldestKey = this.cache.keys().next().value;
-            this.cache.delete(oldestKey);
-        }
-    }
-}
-exports.TTLCache = TTLCache;

package/build/cjs/utils/context-store.utils.d.ts

@@ -1,188 +0,0 @@
-import { AsyncLocalStorage } from 'async_hooks';
-/**
- * Type representing the store object used in AsyncLocalStorage.
- * Keys must be unique symbols to ensure isolation and prevent collisions.
- */
-export interface Store {
-    [key: symbol]: unknown;
-}
-/**
- * Predefined symbols used as keys in AsyncLocalStorage.
- * Add new symbols here to avoid duplication.
- */
-export declare const StoreKeys: {
-    LOGGER: symbol;
-    REQUEST_ID: symbol;
-    USER: symbol;
-    SESSION: symbol;
-    TRANSACTION_ID: symbol;
-    USER_ID: symbol;
-    TENANT_ID: symbol;
-    TRACE_ID: symbol;
-    CORRELATION_ID: symbol;
-};
-/**
- * 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 declare function getRequestId(): string | undefined;
-/**
- * Type-safe getter for common context values.
- *
- * @param key The store key symbol
- * @returns The typed value from the store
- */
-export declare function getFromContext<T>(key: symbol): T | undefined;
-/**
- * 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 declare class ContextStore {
-    /**
-     * The underlying AsyncLocalStorage instance for context.
-     * @private
-     */
-    private static readonly storage;
-    /**
-     * Returns the raw AsyncLocalStorage instance for advanced access.
-     *
-     * @returns {AsyncLocalStorage<Store>} The AsyncLocalStorage instance.
-     */
-    static getInstance(): AsyncLocalStorage<Store>;
-    /**
-     * 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<T>(key: symbol): T | undefined;
-    /**
-     * 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<T>(key: symbol, value: T): void;
-    /**
-     * 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(): Store | undefined;
-    /**
-     * 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<T>(store: Store, callback: () => T): T;
-    /**
-     * 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: symbol): boolean;
-    /**
-     * 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: symbol): boolean;
-    /**
-     * 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: Partial<Record<symbol, unknown>>): void;
-    /**
-     * 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<T>(key: symbol, value: unknown, callback: () => T): T;
-    /**
-     * 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<T>(newValues: Partial<Record<symbol, unknown>>, callback: () => T): T;
-    /**
-     * 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?: (req: any) => Partial<Record<symbol, unknown>>): (req: any, _res: any, next: any) => void;
-}
-/**
- * Type-safe wrapper for accessing and modifying context values with specific types.
- *
- * @typeParam T - The value type.
- */
-export declare class TypedContextKey<T> {
-    private symbol;
-    private defaultValue?;
-    /**
-     * 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: symbol, defaultValue?: T | undefined);
-    /**
-     * Gets the current value for this key.
-     *
-     * @returns The value or defaultValue if not found
-     */
-    get(): T | undefined;
-    /**
-     * Sets the value for this key.
-     *
-     * @param value The value to set
-     */
-    set(value: T): void;
-    /**
-     * Checks if this key exists in the context.
-     *
-     * @returns True if the key exists
-     */
-    exists(): boolean;
-    /**
-     * Deletes this key from the context.
-     *
-     * @returns True if the key was deleted
-     */
-    delete(): boolean;
-}