@catbee/utils 0.0.5 → 0.0.7

package/build/src/utils/performance.utils.js

@@ -0,0 +1,278 @@
+"use strict";
+/*
+ * The MIT License
+ *
+ * Copyright (c) 2025 Catbee Technologies
+ *
+ * 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.timeSync = timeSync;
+exports.timeAsync = timeAsync;
+exports.timed = timed;
+exports.memoize = memoize;
+exports.trackMemoryUsage = trackMemoryUsage;
+const cache_utils_1 = require("./cache.utils");
+const logger_utils_1 = require("./logger.utils");
+/**
+ * Measure the execution time of a synchronous function.
+ *
+ * @param fn - Function to measure
+ * @param options - Timing options
+ * @returns Result containing the return value and timing information
+ *
+ * @example
+ * ```typescript
+ * const { result, timing } = timeSync(() => {
+ *   // Some expensive operation
+ *   return computeResult();
+ * }, { label: 'Computation', log: true });
+ *
+ * console.log(`Result: ${result}, took ${timing.durationMs}ms`);
+ * ```
+ */
+function timeSync(fn, options = {}) {
+    const { label = fn.name || 'anonymous function', log = false, logLevel = 'debug' } = options;
+    const startTime = performance.now();
+    const result = fn();
+    const endTime = performance.now();
+    const durationMs = endTime - startTime;
+    const durationSec = durationMs / 1000;
+    const timing = {
+        durationMs,
+        durationSec,
+        startTime,
+        endTime,
+        label
+    };
+    if (log) {
+        const logger = (0, logger_utils_1.getLogger)();
+        const message = `${label} completed in ${durationMs.toFixed(2)}ms`;
+        switch (logLevel) {
+            case 'trace':
+                logger.trace({ timing }, message);
+                break;
+            case 'debug':
+                logger.debug({ timing }, message);
+                break;
+            case 'info':
+                logger.info({ timing }, message);
+                break;
+            case 'warn':
+                logger.warn({ timing }, message);
+                break;
+            case 'error':
+                logger.error({ timing }, message);
+                break;
+            default:
+                logger.debug({ timing }, message);
+                break;
+        }
+    }
+    return { result, timing };
+}
+/**
+ * Measure the execution time of an asynchronous function.
+ *
+ * @param fn - Async function to measure
+ * @param options - Timing options
+ * @returns Promise resolving to result and timing information
+ *
+ * @example
+ * ```typescript
+ * const { result, timing } = await timeAsync(async () => {
+ *   // Some expensive async operation
+ *   const data = await fetchData();
+ *   return processData(data);
+ * }, { label: 'API Request', log: true });
+ *
+ * console.log(`Fetched ${result.length} items in ${timing.durationSec.toFixed(2)}s`);
+ * ```
+ */
+async function timeAsync(fn, options = {}) {
+    const { label = fn.name || 'anonymous async function', log = false, logLevel = 'debug' } = options;
+    const startTime = performance.now();
+    const result = await fn();
+    const endTime = performance.now();
+    const durationMs = endTime - startTime;
+    const durationSec = durationMs / 1000;
+    const timing = {
+        durationMs,
+        durationSec,
+        startTime,
+        endTime,
+        label
+    };
+    if (log) {
+        const logger = (0, logger_utils_1.getLogger)();
+        const message = `${label} completed in ${durationMs.toFixed(2)}ms`;
+        switch (logLevel) {
+            case 'trace':
+                logger.trace({ timing }, message);
+                break;
+            case 'debug':
+                logger.debug({ timing }, message);
+                break;
+            case 'info':
+                logger.info({ timing }, message);
+                break;
+            case 'warn':
+                logger.warn({ timing }, message);
+                break;
+            case 'error':
+                logger.error({ timing }, message);
+                break;
+            default:
+                logger.debug({ timing }, message);
+                break;
+        }
+    }
+    return { result, timing };
+}
+/**
+ * Create a timing decorator for class methods.
+ *
+ * @param options - Timing options
+ * @returns Method decorator
+ *
+ * @example
+ * ```typescript
+ * class DataService {
+ *   @timed({ log: true, logLevel: 'info' })
+ *   async fetchData() {
+ *     // ...implementation
+ *   }
+ * }
+ * ```
+ */
+function timed(options = {}) {
+    return function (target, propertyKeyOrContext, descriptor) {
+        let propertyKey;
+        let actualDescriptor;
+        // ESNext decorator: second argument is context object
+        if (typeof propertyKeyOrContext === 'object' && propertyKeyOrContext !== null && 'name' in propertyKeyOrContext) {
+            propertyKey = propertyKeyOrContext.name;
+            actualDescriptor = descriptor !== null && descriptor !== void 0 ? descriptor : Object.getOwnPropertyDescriptor(target, propertyKey);
+        }
+        else {
+            // Legacy decorator: second argument is property key
+            propertyKey = propertyKeyOrContext;
+            actualDescriptor = descriptor !== null && descriptor !== void 0 ? descriptor : Object.getOwnPropertyDescriptor(target, propertyKey);
+        }
+        const originalMethod = actualDescriptor.value;
+        actualDescriptor.value = function (...args) {
+            const methodOptions = Object.assign(Object.assign({}, options), { label: options.label || `${target.constructor.name}.${String(propertyKey)}` });
+            if (originalMethod.constructor.name === 'AsyncFunction') {
+                return timeAsync(() => originalMethod.apply(this, args), methodOptions).then(({ result }) => result);
+            }
+            else {
+                return timeSync(() => originalMethod.apply(this, args), methodOptions).result;
+            }
+        };
+        // For legacy decorators, assign the new descriptor
+        if (descriptor) {
+            descriptor.value = actualDescriptor.value;
+        }
+        else {
+            Object.defineProperty(target, propertyKey, actualDescriptor);
+        }
+        // No return needed for method decorators
+    };
+}
+/**
+ * Memoize function results with optional TTL and max cache size.
+ *
+ * @param fn - Function to memoize
+ * @param options - Memoization options
+ * @returns Memoized function
+ *
+ * @example
+ * ```typescript
+ * // Cache results for 30 seconds, with a maximum of 100 entries
+ * const cachedFetch = memoize(
+ *   async (url) => {
+ *     const response = await fetch(url);
+ *     return response.json();
+ *   },
+ *   { ttl: 30000, maxSize: 100, cacheKey: (url) => url }
+ * );
+ * ```
+ */
+function memoize(fn, options = {}) {
+    const { ttl, maxSize, autoCleanupMs, cacheKey = (...args) => JSON.stringify(args) } = options;
+    // Create a properly configured TTLCache instance
+    const cache = new cache_utils_1.TTLCache({
+        ttlMs: ttl,
+        maxSize: maxSize,
+        autoCleanupMs: autoCleanupMs
+    });
+    return function (...args) {
+        const key = cacheKey(...args);
+        // Try to get from cache first - TTLCache handles expiration internally
+        const cachedValue = cache.get(key);
+        if (cachedValue !== undefined) {
+            return cachedValue;
+        }
+        // Calculate the value and store in cache with configured TTL
+        const value = fn(...args);
+        cache.set(key, value);
+        return value;
+    };
+}
+/**
+ * Track memory usage for a function execution.
+ *
+ * @param fn - Function to track
+ * @param options - Memory tracking options
+ * @returns Result and memory usage information
+ */
+function trackMemoryUsage(fn, options = {}) {
+    const { log = false, label = fn.name || 'anonymous function' } = options;
+    // Collect garbage before measuring (optional)
+    if (global.gc) {
+        global.gc();
+    }
+    const beforeMemory = process.memoryUsage();
+    const result = fn();
+    const afterMemory = process.memoryUsage();
+    // Calculate differences
+    const diff = {};
+    for (const key in afterMemory) {
+        if (Object.prototype.hasOwnProperty.call(afterMemory, key)) {
+            diff[key] = afterMemory[key] - beforeMemory[key];
+        }
+    }
+    if (log) {
+        (0, logger_utils_1.getLogger)().info({
+            label,
+            memoryBefore: beforeMemory,
+            memoryAfter: afterMemory,
+            memoryDiff: diff
+        }, `Memory usage for ${label}`);
+    }
+    return {
+        result,
+        memoryUsage: {
+            before: beforeMemory,
+            after: afterMemory,
+            diff
+        }
+    };
+}
+//# sourceMappingURL=performance.utils.js.map

package/build/src/utils/performance.utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"performance.utils.js","sourceRoot":"","sources":["../../../src/utils/performance.utils.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;;AAkDH,4BA6CC;AAoBD,8BAgDC;AAkBD,sBAsCC;AAqBD,0BAoCC;AASD,4CAgDC;AA3UD,+CAAyC;AACzC,iDAA2C;AA8B3C;;;;;;;;;;;;;;;;GAgBG;AACH,SAAgB,QAAQ,CAAI,EAAW,EAAE,UAAyB,EAAE;IAClE,MAAM,EAAE,KAAK,GAAG,EAAE,CAAC,IAAI,IAAI,oBAAoB,EAAE,GAAG,GAAG,KAAK,EAAE,QAAQ,GAAG,OAAO,EAAE,GAAG,OAAO,CAAC;IAE7F,MAAM,SAAS,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;IACpC,MAAM,MAAM,GAAG,EAAE,EAAE,CAAC;IACpB,MAAM,OAAO,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;IAElC,MAAM,UAAU,GAAG,OAAO,GAAG,SAAS,CAAC;IACvC,MAAM,WAAW,GAAG,UAAU,GAAG,IAAI,CAAC;IAEtC,MAAM,MAAM,GAAiB;QAC3B,UAAU;QACV,WAAW;QACX,SAAS;QACT,OAAO;QACP,KAAK;KACN,CAAC;IAEF,IAAI,GAAG,EAAE,CAAC;QACR,MAAM,MAAM,GAAG,IAAA,wBAAS,GAAE,CAAC;QAC3B,MAAM,OAAO,GAAG,GAAG,KAAK,iBAAiB,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC;QAEnE,QAAQ,QAAQ,EAAE,CAAC;YACjB,KAAK,OAAO;gBACV,MAAM,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;gBAClC,MAAM;YACR,KAAK,OAAO;gBACV,MAAM,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;gBAClC,MAAM;YACR,KAAK,MAAM;gBACT,MAAM,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;gBACjC,MAAM;YACR,KAAK,MAAM;gBACT,MAAM,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;gBACjC,MAAM;YACR,KAAK,OAAO;gBACV,MAAM,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;gBAClC,MAAM;YACR;gBACE,MAAM,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;gBAClC,MAAM;QACV,CAAC;IACH,CAAC;IAED,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;AAC5B,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACI,KAAK,UAAU,SAAS,CAC7B,EAAoB,EACpB,UAAyB,EAAE;IAE3B,MAAM,EAAE,KAAK,GAAG,EAAE,CAAC,IAAI,IAAI,0BAA0B,EAAE,GAAG,GAAG,KAAK,EAAE,QAAQ,GAAG,OAAO,EAAE,GAAG,OAAO,CAAC;IAEnG,MAAM,SAAS,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;IACpC,MAAM,MAAM,GAAG,MAAM,EAAE,EAAE,CAAC;IAC1B,MAAM,OAAO,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;IAElC,MAAM,UAAU,GAAG,OAAO,GAAG,SAAS,CAAC;IACvC,MAAM,WAAW,GAAG,UAAU,GAAG,IAAI,CAAC;IAEtC,MAAM,MAAM,GAAiB;QAC3B,UAAU;QACV,WAAW;QACX,SAAS;QACT,OAAO;QACP,KAAK;KACN,CAAC;IAEF,IAAI,GAAG,EAAE,CAAC;QACR,MAAM,MAAM,GAAG,IAAA,wBAAS,GAAE,CAAC;QAC3B,MAAM,OAAO,GAAG,GAAG,KAAK,iBAAiB,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC;QAEnE,QAAQ,QAAQ,EAAE,CAAC;YACjB,KAAK,OAAO;gBACV,MAAM,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;gBAClC,MAAM;YACR,KAAK,OAAO;gBACV,MAAM,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;gBAClC,MAAM;YACR,KAAK,MAAM;gBACT,MAAM,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;gBACjC,MAAM;YACR,KAAK,MAAM;gBACT,MAAM,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;gBACjC,MAAM;YACR,KAAK,OAAO;gBACV,MAAM,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;gBAClC,MAAM;YACR;gBACE,MAAM,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;gBAClC,MAAM;QACV,CAAC;IACH,CAAC;IAED,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;AAC5B,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,KAAK,CAAC,UAAyB,EAAE;IAC/C,OAAO,UAAU,MAAW,EAAE,oBAA2C,EAAE,UAA+B;QACxG,IAAI,WAA4B,CAAC;QACjC,IAAI,gBAAoC,CAAC;QAEzC,sDAAsD;QACtD,IAAI,OAAO,oBAAoB,KAAK,QAAQ,IAAI,oBAAoB,KAAK,IAAI,IAAI,MAAM,IAAI,oBAAoB,EAAE,CAAC;YAChH,WAAW,GAAG,oBAAoB,CAAC,IAAI,CAAC;YACxC,gBAAgB,GAAG,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,MAAM,CAAC,wBAAwB,CAAC,MAAM,EAAE,WAAW,CAAE,CAAC;QACzF,CAAC;aAAM,CAAC;YACN,oDAAoD;YACpD,WAAW,GAAG,oBAAoB,CAAC;YACnC,gBAAgB,GAAG,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,MAAM,CAAC,wBAAwB,CAAC,MAAM,EAAE,WAAW,CAAE,CAAC;QACzF,CAAC;QAED,MAAM,cAAc,GAAG,gBAAgB,CAAC,KAAK,CAAC;QAE9C,gBAAgB,CAAC,KAAK,GAAG,UAAU,GAAG,IAAW;YAC/C,MAAM,aAAa,mCACd,OAAO,KACV,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,GAAG,MAAM,CAAC,WAAW,CAAC,IAAI,IAAI,MAAM,CAAC,WAAW,CAAC,EAAE,GAC5E,CAAC;YAEF,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,KAAK,eAAe,EAAE,CAAC;gBACxD,OAAO,SAAS,CAAC,GAAG,EAAE,CAAC,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,aAAa,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC;YACvG,CAAC;iBAAM,CAAC;gBACN,OAAO,QAAQ,CAAC,GAAG,EAAE,CAAC,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,aAAa,CAAC,CAAC,MAAM,CAAC;YAChF,CAAC;QACH,CAAC,CAAC;QAEF,mDAAmD;QACnD,IAAI,UAAU,EAAE,CAAC;YACf,UAAU,CAAC,KAAK,GAAG,gBAAgB,CAAC,KAAK,CAAC;QAC5C,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,WAAW,EAAE,gBAAgB,CAAC,CAAC;QAC/D,CAAC;QACD,yCAAyC;IAC3C,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,SAAgB,OAAO,CACrB,EAAwB,EACxB,UASI,EAAE;IAEN,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,aAAa,EAAE,QAAQ,GAAG,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,GAAG,OAAO,CAAC;IAE9F,iDAAiD;IACjD,MAAM,KAAK,GAAG,IAAI,sBAAQ,CAAY;QACpC,KAAK,EAAE,GAAG;QACV,OAAO,EAAE,OAAO;QAChB,aAAa,EAAE,aAAa;KAC7B,CAAC,CAAC;IAEH,OAAO,UAAU,GAAG,IAAU;QAC5B,MAAM,GAAG,GAAG,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC;QAE9B,uEAAuE;QACvE,MAAM,WAAW,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACnC,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;YAC9B,OAAO,WAAW,CAAC;QACrB,CAAC;QAED,6DAA6D;QAC7D,MAAM,KAAK,GAAG,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC;QAC1B,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACtB,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,gBAAgB,CAC9B,EAAW,EACX,UAKI,EAAE;IAEN,MAAM,EAAE,GAAG,GAAG,KAAK,EAAE,KAAK,GAAG,EAAE,CAAC,IAAI,IAAI,oBAAoB,EAAE,GAAG,OAAO,CAAC;IAEzE,8CAA8C;IAC9C,IAAI,MAAM,CAAC,EAAE,EAAE,CAAC;QACd,MAAM,CAAC,EAAE,EAAE,CAAC;IACd,CAAC;IAED,MAAM,YAAY,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IAC3C,MAAM,MAAM,GAAG,EAAE,EAAE,CAAC;IACpB,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IAE1C,wBAAwB;IACxB,MAAM,IAAI,GAA2B,EAAE,CAAC;IACxC,KAAK,MAAM,GAAG,IAAI,WAAW,EAAE,CAAC;QAC9B,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,EAAE,GAAG,CAAC,EAAE,CAAC;YAC3D,IAAI,CAAC,GAAG,CAAC,GAAI,WAAmB,CAAC,GAAG,CAAC,GAAI,YAAoB,CAAC,GAAG,CAAC,CAAC;QACrE,CAAC;IACH,CAAC;IAED,IAAI,GAAG,EAAE,CAAC;QACR,IAAA,wBAAS,GAAE,CAAC,IAAI,CACd;YACE,KAAK;YACL,YAAY,EAAE,YAAY;YAC1B,WAAW,EAAE,WAAW;YACxB,UAAU,EAAE,IAAI;SACjB,EACD,oBAAoB,KAAK,EAAE,CAC5B,CAAC;IACJ,CAAC;IAED,OAAO;QACL,MAAM;QACN,WAAW,EAAE;YACX,MAAM,EAAE,YAAY;YACpB,KAAK,EAAE,WAAW;YAClB,IAAI;SACL;KACF,CAAC;AACJ,CAAC","sourcesContent":["/*\n * The MIT License\n *\n * Copyright (c) 2025 Catbee Technologies\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 { TTLCache } from './cache.utils';\nimport { getLogger } from './logger.utils';\n\n/**\n * Options for timing function execution.\n */\nexport interface TimingOptions {\n  /** Optional label for the timing (defaults to function name) */\n  label?: string;\n  /** Whether to log the timing (default: false) */\n  log?: boolean;\n  /** Log level to use if logging is enabled (default: 'debug') */\n  logLevel?: 'trace' | 'debug' | 'info' | 'warn' | 'error';\n}\n\n/**\n * Result of a timing operation.\n */\nexport interface TimingResult {\n  /** Duration in milliseconds */\n  durationMs: number;\n  /** Duration in seconds */\n  durationSec: number;\n  /** Start timestamp */\n  startTime: number;\n  /** End timestamp */\n  endTime: number;\n  /** Label used for the timing */\n  label: string;\n}\n\n/**\n * Measure the execution time of a synchronous function.\n *\n * @param fn - Function to measure\n * @param options - Timing options\n * @returns Result containing the return value and timing information\n *\n * @example\n * ```typescript\n * const { result, timing } = timeSync(() => {\n *   // Some expensive operation\n *   return computeResult();\n * }, { label: 'Computation', log: true });\n *\n * console.log(`Result: ${result}, took ${timing.durationMs}ms`);\n * ```\n */\nexport function timeSync<T>(fn: () => T, options: TimingOptions = {}): { result: T; timing: TimingResult } {\n  const { label = fn.name || 'anonymous function', log = false, logLevel = 'debug' } = options;\n\n  const startTime = performance.now();\n  const result = fn();\n  const endTime = performance.now();\n\n  const durationMs = endTime - startTime;\n  const durationSec = durationMs / 1000;\n\n  const timing: TimingResult = {\n    durationMs,\n    durationSec,\n    startTime,\n    endTime,\n    label\n  };\n\n  if (log) {\n    const logger = getLogger();\n    const message = `${label} completed in ${durationMs.toFixed(2)}ms`;\n\n    switch (logLevel) {\n      case 'trace':\n        logger.trace({ timing }, message);\n        break;\n      case 'debug':\n        logger.debug({ timing }, message);\n        break;\n      case 'info':\n        logger.info({ timing }, message);\n        break;\n      case 'warn':\n        logger.warn({ timing }, message);\n        break;\n      case 'error':\n        logger.error({ timing }, message);\n        break;\n      default:\n        logger.debug({ timing }, message);\n        break;\n    }\n  }\n\n  return { result, timing };\n}\n\n/**\n * Measure the execution time of an asynchronous function.\n *\n * @param fn - Async function to measure\n * @param options - Timing options\n * @returns Promise resolving to result and timing information\n *\n * @example\n * ```typescript\n * const { result, timing } = await timeAsync(async () => {\n *   // Some expensive async operation\n *   const data = await fetchData();\n *   return processData(data);\n * }, { label: 'API Request', log: true });\n *\n * console.log(`Fetched ${result.length} items in ${timing.durationSec.toFixed(2)}s`);\n * ```\n */\nexport async function timeAsync<T>(\n  fn: () => Promise<T>,\n  options: TimingOptions = {}\n): Promise<{ result: T; timing: TimingResult }> {\n  const { label = fn.name || 'anonymous async function', log = false, logLevel = 'debug' } = options;\n\n  const startTime = performance.now();\n  const result = await fn();\n  const endTime = performance.now();\n\n  const durationMs = endTime - startTime;\n  const durationSec = durationMs / 1000;\n\n  const timing: TimingResult = {\n    durationMs,\n    durationSec,\n    startTime,\n    endTime,\n    label\n  };\n\n  if (log) {\n    const logger = getLogger();\n    const message = `${label} completed in ${durationMs.toFixed(2)}ms`;\n\n    switch (logLevel) {\n      case 'trace':\n        logger.trace({ timing }, message);\n        break;\n      case 'debug':\n        logger.debug({ timing }, message);\n        break;\n      case 'info':\n        logger.info({ timing }, message);\n        break;\n      case 'warn':\n        logger.warn({ timing }, message);\n        break;\n      case 'error':\n        logger.error({ timing }, message);\n        break;\n      default:\n        logger.debug({ timing }, message);\n        break;\n    }\n  }\n\n  return { result, timing };\n}\n\n/**\n * Create a timing decorator for class methods.\n *\n * @param options - Timing options\n * @returns Method decorator\n *\n * @example\n * ```typescript\n * class DataService {\n *   @timed({ log: true, logLevel: 'info' })\n *   async fetchData() {\n *     // ...implementation\n *   }\n * }\n * ```\n */\nexport function timed(options: TimingOptions = {}) {\n  return function (target: any, propertyKeyOrContext: string | symbol | any, descriptor?: PropertyDescriptor): void {\n    let propertyKey: string | symbol;\n    let actualDescriptor: PropertyDescriptor;\n\n    // ESNext decorator: second argument is context object\n    if (typeof propertyKeyOrContext === 'object' && propertyKeyOrContext !== null && 'name' in propertyKeyOrContext) {\n      propertyKey = propertyKeyOrContext.name;\n      actualDescriptor = descriptor ?? Object.getOwnPropertyDescriptor(target, propertyKey)!;\n    } else {\n      // Legacy decorator: second argument is property key\n      propertyKey = propertyKeyOrContext;\n      actualDescriptor = descriptor ?? Object.getOwnPropertyDescriptor(target, propertyKey)!;\n    }\n\n    const originalMethod = actualDescriptor.value;\n\n    actualDescriptor.value = function (...args: any[]) {\n      const methodOptions = {\n        ...options,\n        label: options.label || `${target.constructor.name}.${String(propertyKey)}`\n      };\n\n      if (originalMethod.constructor.name === 'AsyncFunction') {\n        return timeAsync(() => originalMethod.apply(this, args), methodOptions).then(({ result }) => result);\n      } else {\n        return timeSync(() => originalMethod.apply(this, args), methodOptions).result;\n      }\n    };\n\n    // For legacy decorators, assign the new descriptor\n    if (descriptor) {\n      descriptor.value = actualDescriptor.value;\n    } else {\n      Object.defineProperty(target, propertyKey, actualDescriptor);\n    }\n    // No return needed for method decorators\n  };\n}\n\n/**\n * Memoize function results with optional TTL and max cache size.\n *\n * @param fn - Function to memoize\n * @param options - Memoization options\n * @returns Memoized function\n *\n * @example\n * ```typescript\n * // Cache results for 30 seconds, with a maximum of 100 entries\n * const cachedFetch = memoize(\n *   async (url) => {\n *     const response = await fetch(url);\n *     return response.json();\n *   },\n *   { ttl: 30000, maxSize: 100, cacheKey: (url) => url }\n * );\n * ```\n */\nexport function memoize<T, Args extends any[]>(\n  fn: (...args: Args) => T,\n  options: {\n    /** Time-to-live in milliseconds (default: indefinite) */\n    ttl?: number;\n    /** Maximum cache size (default: unlimited) */\n    maxSize?: number;\n    /** Function to generate a cache key from arguments */\n    cacheKey?: (...args: Args) => string;\n    /** Auto-cleanup interval in milliseconds (default: disabled) */\n    autoCleanupMs?: number;\n  } = {}\n) {\n  const { ttl, maxSize, autoCleanupMs, cacheKey = (...args) => JSON.stringify(args) } = options;\n\n  // Create a properly configured TTLCache instance\n  const cache = new TTLCache<string, T>({\n    ttlMs: ttl,\n    maxSize: maxSize,\n    autoCleanupMs: autoCleanupMs\n  });\n\n  return function (...args: Args): T {\n    const key = cacheKey(...args);\n\n    // Try to get from cache first - TTLCache handles expiration internally\n    const cachedValue = cache.get(key);\n    if (cachedValue !== undefined) {\n      return cachedValue;\n    }\n\n    // Calculate the value and store in cache with configured TTL\n    const value = fn(...args);\n    cache.set(key, value);\n    return value;\n  };\n}\n\n/**\n * Track memory usage for a function execution.\n *\n * @param fn - Function to track\n * @param options - Memory tracking options\n * @returns Result and memory usage information\n */\nexport function trackMemoryUsage<T>(\n  fn: () => T,\n  options: {\n    /** Whether to log the memory usage (default: false) */\n    log?: boolean;\n    /** Label for the memory tracking (default: function name) */\n    label?: string;\n  } = {}\n): { result: T; memoryUsage: { before: NodeJS.MemoryUsage; after: NodeJS.MemoryUsage; diff: Record<string, number> } } {\n  const { log = false, label = fn.name || 'anonymous function' } = options;\n\n  // Collect garbage before measuring (optional)\n  if (global.gc) {\n    global.gc();\n  }\n\n  const beforeMemory = process.memoryUsage();\n  const result = fn();\n  const afterMemory = process.memoryUsage();\n\n  // Calculate differences\n  const diff: Record<string, number> = {};\n  for (const key in afterMemory) {\n    if (Object.prototype.hasOwnProperty.call(afterMemory, key)) {\n      diff[key] = (afterMemory as any)[key] - (beforeMemory as any)[key];\n    }\n  }\n\n  if (log) {\n    getLogger().info(\n      {\n        label,\n        memoryBefore: beforeMemory,\n        memoryAfter: afterMemory,\n        memoryDiff: diff\n      },\n      `Memory usage for ${label}`\n    );\n  }\n\n  return {\n    result,\n    memoryUsage: {\n      before: beforeMemory,\n      after: afterMemory,\n      diff\n    }\n  };\n}\n"]}

package/build/src/utils/request.utils.d.ts

@@ -1,3 +1,5 @@
+import { Request } from 'express';
+import { WithPagination } from '../types/api-response';
 /**
  * Options for parsing and validating request parameters.
  */
@@ -22,6 +24,13 @@ export interface ValidationResult<T> {
     /** Error message if validation failed */
     error?: string;
 }
+/**
+ * Extracts pagination, sorting, and optional search params from a request.
+ *
+ * @param req - Express request
+ * @returns Object containing validated pagination, sorting, and additional query params
+ */
+export declare const getPaginationParams: <T = {}>(req: Request) => WithPagination<T>;
 /**
  * Safely parses a string parameter to a number.
  *

package/build/src/utils/request.utils.js

@@ -1,10 +1,53 @@
 "use strict";
+/*
+ * The MIT License
+ *
+ * Copyright (c) 2025 Catbee Technologies
+ *
+ * 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.getPaginationParams = void 0;
 exports.parseNumberParam = parseNumberParam;
 exports.parseBooleanParam = parseBooleanParam;
 exports.extractPaginationParams = extractPaginationParams;
 exports.extractSortParams = extractSortParams;
 exports.extractFilterParams = extractFilterParams;
+const exception_utils_1 = require("./exception.utils");
+/**
+ * Extracts pagination, sorting, and optional search params from a request.
+ *
+ * @param req - Express request
+ * @returns Object containing validated pagination, sorting, and additional query params
+ */
+const getPaginationParams = (req) => {
+    const query = req.query;
+    // Extract page & limit
+    const { page, limit } = extractPaginationParams(query, 1, 20, 100);
+    const { sortBy, sortOrder } = extractSortParams(query, []);
+    // Optional search param
+    const search = typeof query.search === 'string' ? query.search : undefined;
+    return Object.assign(Object.assign({}, query), { page,
+        limit,
+        sortBy, sortOrder: sortOrder, search });
+};
+exports.getPaginationParams = getPaginationParams;
 /**
  * Safely parses a string parameter to a number.
  *
@@ -19,7 +62,7 @@ function parseNumberParam(value, options = {}) {
         if (required) {
             const error = `Required number parameter is missing`;
             if (throwOnError)
-                throw new Error(error);
+                throw new exception_utils_1.BadRequestException(error);
             return { isValid: false, value: null, error };
         }
         return {
@@ -32,7 +75,7 @@ function parseNumberParam(value, options = {}) {
     const num = Number(value);
     if (isNaN(num)) {
         if (throwOnError)
-            throw new Error(errorMessage);
+            throw new exception_utils_1.BadRequestException(errorMessage);
         return { isValid: false, value: null, error: errorMessage };
     }
     return { isValid: true, value: num };
@@ -51,7 +94,7 @@ function parseBooleanParam(value, options = {}) {
         if (required) {
             const error = `Required boolean parameter is missing`;
             if (throwOnError)
-                throw new Error(error);
+                throw new exception_utils_1.BadRequestException(error);
             return { isValid: false, value: null, error };
         }
         return {
@@ -69,7 +112,7 @@ function parseBooleanParam(value, options = {}) {
         return { isValid: true, value: false };
     }
     if (throwOnError)
-        throw new Error(errorMessage);
+        throw new exception_utils_1.BadRequestException(errorMessage);
     return { isValid: false, value: null, error: errorMessage };
 }
 /**
@@ -127,7 +170,7 @@ function extractSortParams(query, allowedFields, defaultSort = { sortBy: 'create
         }
     }
     // Validate field
-    if (!allowedFields.includes(sortBy)) {
+    if (allowedFields.length && !allowedFields.includes(sortBy)) {
         sortBy = defaultSort.sortBy;
     }
     return { sortBy, sortOrder };

package/build/src/utils/request.utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"request.utils.js","sourceRoot":"","sources":["../../../src/utils/request.utils.ts"],"names":[],"mappings":";;AAsCA,4CA0BC;AASD,8CAiCC;AAWD,0DAoBC;AAUD,8CAmCC;AASD,kDAcC;AA9KD;;;;;;GAMG;AACH,SAAgB,gBAAgB,CAAC,KAAyB,EAAE,UAA6B,EAAE;IACzF,MAAM,EAAE,YAAY,GAAG,KAAK,EAAE,YAAY,GAAG,0BAA0B,EAAE,YAAY,EAAE,QAAQ,GAAG,KAAK,EAAE,GAAG,OAAO,CAAC;IAEpH,wBAAwB;IACxB,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,IAAI,QAAQ,EAAE,CAAC;YACb,MAAM,KAAK,GAAG,sCAAsC,CAAC;YACrD,IAAI,YAAY;gBAAE,MAAM,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC;YACzC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;QAChD,CAAC;QAED,OAAO;YACL,OAAO,EAAE,YAAY,KAAK,SAAS;YACnC,KAAK,EAAE,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI;YACvD,KAAK,EAAE,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,mCAAmC,CAAC,CAAC,CAAC,SAAS;SACpF,CAAC;IACJ,CAAC;IAED,gCAAgC;IAChC,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IAC1B,IAAI,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;QACf,IAAI,YAAY;YAAE,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;QAChD,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC;IAC9D,CAAC;IAED,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC;AACvC,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,iBAAiB,CAC/B,KAAyB,EACzB,UAA6B,EAAE;IAE/B,MAAM,EAAE,YAAY,GAAG,KAAK,EAAE,YAAY,GAAG,2BAA2B,EAAE,YAAY,EAAE,QAAQ,GAAG,KAAK,EAAE,GAAG,OAAO,CAAC;IAErH,wBAAwB;IACxB,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,IAAI,QAAQ,EAAE,CAAC;YACb,MAAM,KAAK,GAAG,uCAAuC,CAAC;YACtD,IAAI,YAAY;gBAAE,MAAM,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC;YACzC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;QAChD,CAAC;QAED,OAAO;YACL,OAAO,EAAE,YAAY,KAAK,SAAS;YACnC,KAAK,EAAE,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI;YACvD,KAAK,EAAE,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,mCAAmC,CAAC,CAAC,CAAC,SAAS;SACpF,CAAC;IACJ,CAAC;IAED,uDAAuD;IACvD,MAAM,cAAc,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;IAC3C,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC;QAC5D,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;IACxC,CAAC;IAED,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC;QAC5D,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;IACzC,CAAC;IAED,IAAI,YAAY;QAAE,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;IAChD,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC;AAC9D,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,uBAAuB,CACrC,KAAwC,EACxC,cAAsB,CAAC,EACvB,eAAuB,EAAE,EACzB,eAAuB,GAAG;IAE1B,uBAAuB;IACvB,MAAM,SAAS,GAAG,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;IAC1E,MAAM,UAAU,GAAG,gBAAgB,CAAC,SAAS,EAAE,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC,CAAC;IAE9E,wBAAwB;IACxB,MAAM,UAAU,GAAG,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;IAC7E,MAAM,WAAW,GAAG,gBAAgB,CAAC,UAAU,EAAE,EAAE,YAAY,EAAE,YAAY,EAAE,CAAC,CAAC;IAEjF,uDAAuD;IACvD,MAAM,IAAI,GAAG,UAAU,CAAC,KAAK,IAAI,UAAU,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,WAAW,CAAC;IAEvF,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,IAAI,WAAW,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC;IAEpH,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;AACzB,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,iBAAiB,CAC/B,KAAwC,EACxC,aAAuB,EACvB,cAA6D,EAAE,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,EAAE;IAEvG,IAAI,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC;IAChC,IAAI,SAAS,GAAmB,WAAW,CAAC,SAAS,CAAC;IAEtD,kCAAkC;IAClC,IAAI,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;QACrC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;IACxB,CAAC;SAAM,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;QACvC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAC3B,CAAC;SAAM,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC1C,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC;QACvE,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC;IAC1D,CAAC;SAAM,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QACrC,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAChF,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC;IAC7D,CAAC;IAED,uDAAuD;IACvD,IAAI,OAAO,KAAK,CAAC,SAAS,KAAK,QAAQ,EAAE,CAAC;QACxC,MAAM,KAAK,GAAG,KAAK,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC;QAC5C,IAAI,KAAK,KAAK,KAAK,IAAI,KAAK,KAAK,MAAM,EAAE,CAAC;YACxC,SAAS,GAAG,KAAK,CAAC;QACpB,CAAC;IACH,CAAC;IAED,iBAAiB;IACjB,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QACpC,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC;IAC9B,CAAC;IAED,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;AAC/B,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,mBAAmB,CACjC,KAAwC,EACxC,cAAwB;IAExB,MAAM,OAAO,GAAsC,EAAE,CAAC;IAEtD,sCAAsC;IACtC,KAAK,MAAM,KAAK,IAAI,cAAc,EAAE,CAAC;QACnC,IAAI,KAAK,IAAI,KAAK,EAAE,CAAC;YACnB,OAAO,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;IACH,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC","sourcesContent":["/**\n * Options for parsing and validating request parameters.\n */\nexport interface ValidationOptions {\n  /** Whether to throw an error on validation failure */\n  throwOnError?: boolean;\n\n  /** Custom error message for validation failures */\n  errorMessage?: string;\n\n  /** Default value to use if parameter is missing */\n  defaultValue?: any;\n\n  /** Whether the parameter is required */\n  required?: boolean;\n}\n\n/**\n * Result of a parameter validation operation.\n */\nexport interface ValidationResult<T> {\n  /** Whether validation was successful */\n  isValid: boolean;\n\n  /** The validated and potentially transformed value */\n  value: T | null;\n\n  /** Error message if validation failed */\n  error?: string;\n}\n\n/**\n * Safely parses a string parameter to a number.\n *\n * @param value - String value to parse\n * @param options - Validation options\n * @returns Validation result containing the parsed number or error\n */\nexport function parseNumberParam(value: string | undefined, options: ValidationOptions = {}): ValidationResult<number> {\n  const { throwOnError = false, errorMessage = 'Invalid number parameter', defaultValue, required = false } = options;\n\n  // Handle undefined case\n  if (value === undefined) {\n    if (required) {\n      const error = `Required number parameter is missing`;\n      if (throwOnError) throw new Error(error);\n      return { isValid: false, value: null, error };\n    }\n\n    return {\n      isValid: defaultValue !== undefined,\n      value: defaultValue !== undefined ? defaultValue : null,\n      error: defaultValue === undefined ? 'Missing parameter with no default' : undefined\n    };\n  }\n\n  // Parse and validate the number\n  const num = Number(value);\n  if (isNaN(num)) {\n    if (throwOnError) throw new Error(errorMessage);\n    return { isValid: false, value: null, error: errorMessage };\n  }\n\n  return { isValid: true, value: num };\n}\n\n/**\n * Safely parses a string parameter to a boolean.\n *\n * @param value - String value to parse\n * @param options - Validation options\n * @returns Validation result containing the parsed boolean or error\n */\nexport function parseBooleanParam(\n  value: string | undefined,\n  options: ValidationOptions = {}\n): ValidationResult<boolean> {\n  const { throwOnError = false, errorMessage = 'Invalid boolean parameter', defaultValue, required = false } = options;\n\n  // Handle undefined case\n  if (value === undefined) {\n    if (required) {\n      const error = `Required boolean parameter is missing`;\n      if (throwOnError) throw new Error(error);\n      return { isValid: false, value: null, error };\n    }\n\n    return {\n      isValid: defaultValue !== undefined,\n      value: defaultValue !== undefined ? defaultValue : null,\n      error: defaultValue === undefined ? 'Missing parameter with no default' : undefined\n    };\n  }\n\n  // Parse the boolean value with various allowed formats\n  const lowercaseValue = value.toLowerCase();\n  if (['true', 't', 'yes', 'y', '1'].includes(lowercaseValue)) {\n    return { isValid: true, value: true };\n  }\n\n  if (['false', 'f', 'no', 'n', '0'].includes(lowercaseValue)) {\n    return { isValid: true, value: false };\n  }\n\n  if (throwOnError) throw new Error(errorMessage);\n  return { isValid: false, value: null, error: errorMessage };\n}\n\n/**\n * Extracts pagination parameters from request query parameters.\n *\n * @param query - Query parameters object\n * @param defaultPage - Default page number if not specified (defaults to 1)\n * @param defaultLimit - Default per page size if not specified (defaults to 20)\n * @param maxLimitSize - Maximum allowed per page size (defaults to 100)\n * @returns Object containing validated page and limit\n */\nexport function extractPaginationParams(\n  query: Record<string, string | string[]>,\n  defaultPage: number = 1,\n  defaultLimit: number = 20,\n  maxLimitSize: number = 100\n): { page: number; limit: number } {\n  // Parse page parameter\n  const pageParam = typeof query.page === 'string' ? query.page : undefined;\n  const pageResult = parseNumberParam(pageParam, { defaultValue: defaultPage });\n\n  // Parse limit parameter\n  const limitParam = typeof query.limit === 'string' ? query.limit : undefined;\n  const limitResult = parseNumberParam(limitParam, { defaultValue: defaultLimit });\n\n  // Ensure valid values (handle 0 → fallback to default)\n  const page = pageResult.value && pageResult.value > 0 ? pageResult.value : defaultPage;\n\n  const limit = limitResult.value && limitResult.value > 0 ? Math.min(limitResult.value, maxLimitSize) : defaultLimit;\n\n  return { page, limit };\n}\n\n/**\n * Extracts sorting parameters from request query parameters.\n *\n * @param query - Query parameters object\n * @param allowedFields - Array of field names that are allowed to be sorted\n * @param defaultSort - Default sort configuration if not specified\n * @returns Object containing sort field and direction\n */\nexport function extractSortParams(\n  query: Record<string, string | string[]>,\n  allowedFields: string[],\n  defaultSort: { sortBy: string; sortOrder: 'asc' | 'desc' } = { sortBy: 'createdAt', sortOrder: 'desc' }\n): { sortBy: string; sortOrder: 'asc' | 'desc' } {\n  let sortBy = defaultSort.sortBy;\n  let sortOrder: 'asc' | 'desc' = defaultSort.sortOrder;\n\n  // Extract from `sortBy` or `sort`\n  if (typeof query.sortBy === 'string') {\n    sortBy = query.sortBy;\n  } else if (Array.isArray(query.sortBy)) {\n    sortBy = query.sortBy[0];\n  } else if (typeof query.sort === 'string') {\n    sortBy = query.sort.startsWith('-') ? query.sort.slice(1) : query.sort;\n    sortOrder = query.sort.startsWith('-') ? 'desc' : 'asc';\n  } else if (Array.isArray(query.sort)) {\n    sortBy = query.sort[0].startsWith('-') ? query.sort[0].slice(1) : query.sort[0];\n    sortOrder = query.sort[0].startsWith('-') ? 'desc' : 'asc';\n  }\n\n  // Explicit sortOrder (overrides inferred one if valid)\n  if (typeof query.sortOrder === 'string') {\n    const order = query.sortOrder.toLowerCase();\n    if (order === 'asc' || order === 'desc') {\n      sortOrder = order;\n    }\n  }\n\n  // Validate field\n  if (!allowedFields.includes(sortBy)) {\n    sortBy = defaultSort.sortBy;\n  }\n\n  return { sortBy, sortOrder };\n}\n\n/**\n * Extracts filter parameters from query parameters based on allowed filter fields.\n *\n * @param query - Query parameters object\n * @param allowedFilters - Array of field names that are allowed to be used as filters\n * @returns Object containing the filters as key-value pairs\n */\nexport function extractFilterParams(\n  query: Record<string, string | string[]>,\n  allowedFilters: string[]\n): Record<string, string | string[]> {\n  const filters: Record<string, string | string[]> = {};\n\n  // Find filter parameters in the query\n  for (const field of allowedFilters) {\n    if (field in query) {\n      filters[field] = query[field];\n    }\n  }\n\n  return filters;\n}\n"]}
+{"version":3,"file":"request.utils.js","sourceRoot":"","sources":["../../../src/utils/request.utils.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;;;AAsEH,4CA0BC;AASD,8CAiCC;AAWD,0DAoBC;AAUD,8CAmCC;AASD,kDAcC;AAzOD,uDAAwD;AAiCxD;;;;;GAKG;AACI,MAAM,mBAAmB,GAAG,CAAS,GAAY,EAAqB,EAAE;IAC7E,MAAM,KAAK,GAAG,GAAG,CAAC,KAA0C,CAAC;IAE7D,uBAAuB;IACvB,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,uBAAuB,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,EAAE,GAAG,CAAC,CAAC;IACnE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,iBAAiB,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IAE3D,wBAAwB;IACxB,MAAM,MAAM,GAAG,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;IAE3E,uCACM,KAAW,KACf,IAAI;QACJ,KAAK;QACL,MAAM,EACN,SAAS,EAAE,SAA0B,EACrC,MAAM,IACN;AACJ,CAAC,CAAC;AAlBW,QAAA,mBAAmB,uBAkB9B;AAEF;;;;;;GAMG;AACH,SAAgB,gBAAgB,CAAC,KAAyB,EAAE,UAA6B,EAAE;IACzF,MAAM,EAAE,YAAY,GAAG,KAAK,EAAE,YAAY,GAAG,0BAA0B,EAAE,YAAY,EAAE,QAAQ,GAAG,KAAK,EAAE,GAAG,OAAO,CAAC;IAEpH,wBAAwB;IACxB,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,IAAI,QAAQ,EAAE,CAAC;YACb,MAAM,KAAK,GAAG,sCAAsC,CAAC;YACrD,IAAI,YAAY;gBAAE,MAAM,IAAI,qCAAmB,CAAC,KAAK,CAAC,CAAC;YACvD,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;QAChD,CAAC;QAED,OAAO;YACL,OAAO,EAAE,YAAY,KAAK,SAAS;YACnC,KAAK,EAAE,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI;YACvD,KAAK,EAAE,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,mCAAmC,CAAC,CAAC,CAAC,SAAS;SACpF,CAAC;IACJ,CAAC;IAED,gCAAgC;IAChC,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IAC1B,IAAI,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;QACf,IAAI,YAAY;YAAE,MAAM,IAAI,qCAAmB,CAAC,YAAY,CAAC,CAAC;QAC9D,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC;IAC9D,CAAC;IAED,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC;AACvC,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,iBAAiB,CAC/B,KAAyB,EACzB,UAA6B,EAAE;IAE/B,MAAM,EAAE,YAAY,GAAG,KAAK,EAAE,YAAY,GAAG,2BAA2B,EAAE,YAAY,EAAE,QAAQ,GAAG,KAAK,EAAE,GAAG,OAAO,CAAC;IAErH,wBAAwB;IACxB,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,IAAI,QAAQ,EAAE,CAAC;YACb,MAAM,KAAK,GAAG,uCAAuC,CAAC;YACtD,IAAI,YAAY;gBAAE,MAAM,IAAI,qCAAmB,CAAC,KAAK,CAAC,CAAC;YACvD,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;QAChD,CAAC;QAED,OAAO;YACL,OAAO,EAAE,YAAY,KAAK,SAAS;YACnC,KAAK,EAAE,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI;YACvD,KAAK,EAAE,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,mCAAmC,CAAC,CAAC,CAAC,SAAS;SACpF,CAAC;IACJ,CAAC;IAED,uDAAuD;IACvD,MAAM,cAAc,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;IAC3C,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC;QAC5D,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;IACxC,CAAC;IAED,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC;QAC5D,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;IACzC,CAAC;IAED,IAAI,YAAY;QAAE,MAAM,IAAI,qCAAmB,CAAC,YAAY,CAAC,CAAC;IAC9D,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC;AAC9D,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,uBAAuB,CACrC,KAAwC,EACxC,cAAsB,CAAC,EACvB,eAAuB,EAAE,EACzB,eAAuB,GAAG;IAE1B,uBAAuB;IACvB,MAAM,SAAS,GAAG,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;IAC1E,MAAM,UAAU,GAAG,gBAAgB,CAAC,SAAS,EAAE,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC,CAAC;IAE9E,wBAAwB;IACxB,MAAM,UAAU,GAAG,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;IAC7E,MAAM,WAAW,GAAG,gBAAgB,CAAC,UAAU,EAAE,EAAE,YAAY,EAAE,YAAY,EAAE,CAAC,CAAC;IAEjF,uDAAuD;IACvD,MAAM,IAAI,GAAG,UAAU,CAAC,KAAK,IAAI,UAAU,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,WAAW,CAAC;IAEvF,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,IAAI,WAAW,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC;IAEpH,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;AACzB,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,iBAAiB,CAC/B,KAAwC,EACxC,aAAuB,EACvB,cAA6D,EAAE,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,EAAE;IAEvG,IAAI,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC;IAChC,IAAI,SAAS,GAAmB,WAAW,CAAC,SAAS,CAAC;IAEtD,kCAAkC;IAClC,IAAI,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;QACrC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;IACxB,CAAC;SAAM,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;QACvC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAC3B,CAAC;SAAM,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC1C,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC;QACvE,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC;IAC1D,CAAC;SAAM,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QACrC,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAChF,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC;IAC7D,CAAC;IAED,uDAAuD;IACvD,IAAI,OAAO,KAAK,CAAC,SAAS,KAAK,QAAQ,EAAE,CAAC;QACxC,MAAM,KAAK,GAAG,KAAK,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC;QAC5C,IAAI,KAAK,KAAK,KAAK,IAAI,KAAK,KAAK,MAAM,EAAE,CAAC;YACxC,SAAS,GAAG,KAAK,CAAC;QACpB,CAAC;IACH,CAAC;IAED,iBAAiB;IACjB,IAAI,aAAa,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QAC5D,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC;IAC9B,CAAC;IAED,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;AAC/B,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,mBAAmB,CACjC,KAAwC,EACxC,cAAwB;IAExB,MAAM,OAAO,GAAsC,EAAE,CAAC;IAEtD,sCAAsC;IACtC,KAAK,MAAM,KAAK,IAAI,cAAc,EAAE,CAAC;QACnC,IAAI,KAAK,IAAI,KAAK,EAAE,CAAC;YACnB,OAAO,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;IACH,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC","sourcesContent":["/*\n * The MIT License\n *\n * Copyright (c) 2025 Catbee Technologies\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 { Request } from 'express';\nimport { SortDirection, WithPagination } from '../types/api-response';\nimport { BadRequestException } from './exception.utils';\n\n/**\n * Options for parsing and validating request parameters.\n */\nexport interface ValidationOptions {\n  /** Whether to throw an error on validation failure */\n  throwOnError?: boolean;\n\n  /** Custom error message for validation failures */\n  errorMessage?: string;\n\n  /** Default value to use if parameter is missing */\n  defaultValue?: any;\n\n  /** Whether the parameter is required */\n  required?: boolean;\n}\n\n/**\n * Result of a parameter validation operation.\n */\nexport interface ValidationResult<T> {\n  /** Whether validation was successful */\n  isValid: boolean;\n\n  /** The validated and potentially transformed value */\n  value: T | null;\n\n  /** Error message if validation failed */\n  error?: string;\n}\n\n/**\n * Extracts pagination, sorting, and optional search params from a request.\n *\n * @param req - Express request\n * @returns Object containing validated pagination, sorting, and additional query params\n */\nexport const getPaginationParams = <T = {}>(req: Request): WithPagination<T> => {\n  const query = req.query as Record<string, string | string[]>;\n\n  // Extract page & limit\n  const { page, limit } = extractPaginationParams(query, 1, 20, 100);\n  const { sortBy, sortOrder } = extractSortParams(query, []);\n\n  // Optional search param\n  const search = typeof query.search === 'string' ? query.search : undefined;\n\n  return {\n    ...(query as T),\n    page,\n    limit,\n    sortBy,\n    sortOrder: sortOrder as SortDirection,\n    search\n  };\n};\n\n/**\n * Safely parses a string parameter to a number.\n *\n * @param value - String value to parse\n * @param options - Validation options\n * @returns Validation result containing the parsed number or error\n */\nexport function parseNumberParam(value: string | undefined, options: ValidationOptions = {}): ValidationResult<number> {\n  const { throwOnError = false, errorMessage = 'Invalid number parameter', defaultValue, required = false } = options;\n\n  // Handle undefined case\n  if (value === undefined) {\n    if (required) {\n      const error = `Required number parameter is missing`;\n      if (throwOnError) throw new BadRequestException(error);\n      return { isValid: false, value: null, error };\n    }\n\n    return {\n      isValid: defaultValue !== undefined,\n      value: defaultValue !== undefined ? defaultValue : null,\n      error: defaultValue === undefined ? 'Missing parameter with no default' : undefined\n    };\n  }\n\n  // Parse and validate the number\n  const num = Number(value);\n  if (isNaN(num)) {\n    if (throwOnError) throw new BadRequestException(errorMessage);\n    return { isValid: false, value: null, error: errorMessage };\n  }\n\n  return { isValid: true, value: num };\n}\n\n/**\n * Safely parses a string parameter to a boolean.\n *\n * @param value - String value to parse\n * @param options - Validation options\n * @returns Validation result containing the parsed boolean or error\n */\nexport function parseBooleanParam(\n  value: string | undefined,\n  options: ValidationOptions = {}\n): ValidationResult<boolean> {\n  const { throwOnError = false, errorMessage = 'Invalid boolean parameter', defaultValue, required = false } = options;\n\n  // Handle undefined case\n  if (value === undefined) {\n    if (required) {\n      const error = `Required boolean parameter is missing`;\n      if (throwOnError) throw new BadRequestException(error);\n      return { isValid: false, value: null, error };\n    }\n\n    return {\n      isValid: defaultValue !== undefined,\n      value: defaultValue !== undefined ? defaultValue : null,\n      error: defaultValue === undefined ? 'Missing parameter with no default' : undefined\n    };\n  }\n\n  // Parse the boolean value with various allowed formats\n  const lowercaseValue = value.toLowerCase();\n  if (['true', 't', 'yes', 'y', '1'].includes(lowercaseValue)) {\n    return { isValid: true, value: true };\n  }\n\n  if (['false', 'f', 'no', 'n', '0'].includes(lowercaseValue)) {\n    return { isValid: true, value: false };\n  }\n\n  if (throwOnError) throw new BadRequestException(errorMessage);\n  return { isValid: false, value: null, error: errorMessage };\n}\n\n/**\n * Extracts pagination parameters from request query parameters.\n *\n * @param query - Query parameters object\n * @param defaultPage - Default page number if not specified (defaults to 1)\n * @param defaultLimit - Default per page size if not specified (defaults to 20)\n * @param maxLimitSize - Maximum allowed per page size (defaults to 100)\n * @returns Object containing validated page and limit\n */\nexport function extractPaginationParams(\n  query: Record<string, string | string[]>,\n  defaultPage: number = 1,\n  defaultLimit: number = 20,\n  maxLimitSize: number = 100\n): { page: number; limit: number } {\n  // Parse page parameter\n  const pageParam = typeof query.page === 'string' ? query.page : undefined;\n  const pageResult = parseNumberParam(pageParam, { defaultValue: defaultPage });\n\n  // Parse limit parameter\n  const limitParam = typeof query.limit === 'string' ? query.limit : undefined;\n  const limitResult = parseNumberParam(limitParam, { defaultValue: defaultLimit });\n\n  // Ensure valid values (handle 0 → fallback to default)\n  const page = pageResult.value && pageResult.value > 0 ? pageResult.value : defaultPage;\n\n  const limit = limitResult.value && limitResult.value > 0 ? Math.min(limitResult.value, maxLimitSize) : defaultLimit;\n\n  return { page, limit };\n}\n\n/**\n * Extracts sorting parameters from request query parameters.\n *\n * @param query - Query parameters object\n * @param allowedFields - Array of field names that are allowed to be sorted\n * @param defaultSort - Default sort configuration if not specified\n * @returns Object containing sort field and direction\n */\nexport function extractSortParams(\n  query: Record<string, string | string[]>,\n  allowedFields: string[],\n  defaultSort: { sortBy: string; sortOrder: 'asc' | 'desc' } = { sortBy: 'createdAt', sortOrder: 'desc' }\n): { sortBy: string; sortOrder: 'asc' | 'desc' } {\n  let sortBy = defaultSort.sortBy;\n  let sortOrder: 'asc' | 'desc' = defaultSort.sortOrder;\n\n  // Extract from `sortBy` or `sort`\n  if (typeof query.sortBy === 'string') {\n    sortBy = query.sortBy;\n  } else if (Array.isArray(query.sortBy)) {\n    sortBy = query.sortBy[0];\n  } else if (typeof query.sort === 'string') {\n    sortBy = query.sort.startsWith('-') ? query.sort.slice(1) : query.sort;\n    sortOrder = query.sort.startsWith('-') ? 'desc' : 'asc';\n  } else if (Array.isArray(query.sort)) {\n    sortBy = query.sort[0].startsWith('-') ? query.sort[0].slice(1) : query.sort[0];\n    sortOrder = query.sort[0].startsWith('-') ? 'desc' : 'asc';\n  }\n\n  // Explicit sortOrder (overrides inferred one if valid)\n  if (typeof query.sortOrder === 'string') {\n    const order = query.sortOrder.toLowerCase();\n    if (order === 'asc' || order === 'desc') {\n      sortOrder = order;\n    }\n  }\n\n  // Validate field\n  if (allowedFields.length && !allowedFields.includes(sortBy)) {\n    sortBy = defaultSort.sortBy;\n  }\n\n  return { sortBy, sortOrder };\n}\n\n/**\n * Extracts filter parameters from query parameters based on allowed filter fields.\n *\n * @param query - Query parameters object\n * @param allowedFilters - Array of field names that are allowed to be used as filters\n * @returns Object containing the filters as key-value pairs\n */\nexport function extractFilterParams(\n  query: Record<string, string | string[]>,\n  allowedFilters: string[]\n): Record<string, string | string[]> {\n  const filters: Record<string, string | string[]> = {};\n\n  // Find filter parameters in the query\n  for (const field of allowedFilters) {\n    if (field in query) {\n      filters[field] = query[field];\n    }\n  }\n\n  return filters;\n}\n"]}

package/build/src/utils/response.utils.d.ts

@@ -1,4 +1,5 @@
-import { ApiResponse } from '../types/api-response';
+import { Request } from 'express';
+import { ApiErrorResponse, ApiResponse } from '../types/api-response';
 /**
  * Standard HTTP response wrapper for successful responses.
  * Implements the `ApiResponse<T>` interface and sets default values.
@@ -128,6 +129,19 @@ export declare function createSuccessResponse<T>(data: T, message?: string): Suc
  * @returns {ErrorResponse} A properly formatted error response.
  */
 export declare function createErrorResponse(message: string, statusCode?: number): ErrorResponse;
+/**
+ * Creates a final error response with request information.
+ *
+ * @param req - The original request object.
+ * @param status - The HTTP status code.
+ * @param message - The error message.
+ * @param error - The original error object (optional).
+ * @param options - Additional options for the response (optional).
+ * @returns A properly formatted final error response.
+ */
+export declare function createFinalErrorResponse(req: Request, status: number, message: string, error?: any, options?: {
+    includeDetails?: boolean;
+}): ApiErrorResponse;
 /**
  * Creates a paginated response from array data.
  *

package/build/src/utils/response.utils.js

@@ -1,11 +1,36 @@
 "use strict";
+/*
+ * The MIT License
+ *
+ * Copyright (c) 2025 Catbee Technologies
+ *
+ * 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.RedirectResponse = exports.NoContentResponse = exports.PaginatedResponse = exports.ErrorResponse = exports.SuccessResponse = void 0;
 exports.createSuccessResponse = createSuccessResponse;
 exports.createErrorResponse = createErrorResponse;
+exports.createFinalErrorResponse = createFinalErrorResponse;
 exports.createPaginatedResponse = createPaginatedResponse;
 exports.sendResponse = sendResponse;
 const context_store_utils_1 = require("./context-store.utils");
+const env_utils_1 = require("./env.utils");
 const id_utils_1 = require("./id.utils");
 /**
  * Standard HTTP response wrapper for successful responses.
@@ -148,6 +173,33 @@ function createSuccessResponse(data, message = 'Success') {
 function createErrorResponse(message, statusCode = 500) {
     return new ErrorResponse(message, statusCode);
 }
+/**
+ * Creates a final error response with request information.
+ *
+ * @param req - The original request object.
+ * @param status - The HTTP status code.
+ * @param message - The error message.
+ * @param error - The original error object (optional).
+ * @param options - Additional options for the response (optional).
+ * @returns A properly formatted final error response.
+ */
+function createFinalErrorResponse(req, status, message, error, options) {
+    const isDev = env_utils_1.Env.isDev();
+    const includeDetails = (options === null || options === void 0 ? void 0 : options.includeDetails) && isDev;
+    const response = {
+        error: true,
+        message,
+        timestamp: new Date().toISOString(),
+        requestId: (error === null || error === void 0 ? void 0 : error.requestId) || (req === null || req === void 0 ? void 0 : req.id) || (0, id_utils_1.uuid)(),
+        status,
+        path: req.originalUrl || req.url
+    };
+    // Include stack trace in development mode if requested
+    if (includeDetails && (error === null || error === void 0 ? void 0 : error.stack)) {
+        response.stack = error.stack.split('\n').map((line) => line.trim());
+    }
+    return response;
+}
 /**
  * Creates a paginated response from array data.
  *