@catbee/utils 0.0.7 → 0.0.8-next.0

package/build/esm/utils/middleware.utils.d.ts

@@ -1,83 +0,0 @@
-import type { Request, Response, NextFunction } from 'express';
-export type Middleware = (req: Request, res: Response, next: NextFunction) => void | Promise<void>;
-/**
- * Attaches a unique request ID to each request.
- * Useful for request tracing and correlation between logs.
- *
- * @param {object} [options] - Configuration options
- * @param {string} [options.headerName='X-Request-ID'] - Header name for request ID
- * @param {boolean} [options.exposeHeader=true] - Whether to expose the header in response
- * @param {() => string} [options.generator] - Custom ID generator function
- * @returns {Middleware} Express-compatible middleware
- */
-export declare function requestId(options?: {
-    headerName?: string;
-    exposeHeader?: boolean;
-    generator?: () => string;
-}): Middleware;
-/**
- * Measures request processing time and logs or adds it to response headers.
- *
- * @param {object} [options] - Configuration options
- * @param {boolean} [options.addHeader=true] - Whether to add X-Response-Time header
- * @param {boolean} [options.logOnComplete=false] - Whether to log timing info
- * @returns {Middleware} Express-compatible middleware
- */
-export declare function responseTime(options?: {
-    addHeader?: boolean;
-    logOnComplete?: boolean;
-}): (req: Request, res: Response, next: NextFunction) => void;
-/**
- * Request timeout middleware.
- * Aborts requests that take too long to process.
- *
- * @param {number} [timeoutMs=30000] - Timeout in milliseconds
- * @returns {Middleware} Express-compatible middleware
- */
-export declare function timeout(timeoutMs?: number): Middleware;
-/**
- * Creates an Express middleware that initializes a per-request context.
- *
- * @param {object} [options] - Optional configuration
- * @param {string} [options.headerName='x-request-id'] - Header to look for request ID
- * @param {boolean} [options.autoLog=true] - Whether to log automatically when context is initialized
- * @returns {(req: Request, res: Response, next: NextFunction) => void} Express middleware function
- */
-export declare function setupRequestContext(options?: {
-    headerName?: string;
-    autoLog?: boolean;
-}): Middleware;
-export interface ErrorHandlerOptions {
-    /** Whether to log errors (default: true) */
-    logErrors?: boolean;
-    /** Whether to include error details in non-production (default: false) */
-    includeDetails?: boolean;
-}
-/**
- * Global error handling middleware with enhanced features.
- *
- * @param {ErrorHandlerOptions} options - Error handler options
- * @param {boolean} [options.logErrors=true] - Whether to log errors
- * @param {boolean} [options.includeDetails=false] - Whether to include error details in non-production
- * @returns Error middleware
- *
- * @example
- * import express from 'express';
- * import { errorHandler } from '@catbee/utils';
- *
- * const app = express();
- *
- * // Your routes
- * app.get('/ping', (req, res) => {
- *   throw new Error('Something went wrong');
- * });
- *
- * // Error handler (must be last middleware)
- * app.use(errorHandler({ includeDetails: true }));
- *
- * app.listen(3000, () => {
- *   console.log('Server running on port 3000');
- * });
- */
-export declare function errorHandler(options?: ErrorHandlerOptions): (err: any, req: Request, res: Response, _next: NextFunction) => Response<any, Record<string, any>>;
-//# sourceMappingURL=middleware.utils.d.ts.map

package/build/esm/utils/middleware.utils.js

@@ -1,206 +0,0 @@
-/*
- * 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.
- */
-import { uuid } from './id.utils';
-import { HttpStatusCodes } from './http-status-codes';
-import { createFinalErrorResponse, ErrorResponse } from './response.utils';
-import { getLogger } from './logger.utils';
-import { ContextStore, StoreKeys } from './context-store.utils';
-import { RequestTimeoutException } from './exception.utils';
-/**
- * Attaches a unique request ID to each request.
- * Useful for request tracing and correlation between logs.
- *
- * @param {object} [options] - Configuration options
- * @param {string} [options.headerName='X-Request-ID'] - Header name for request ID
- * @param {boolean} [options.exposeHeader=true] - Whether to expose the header in response
- * @param {() => string} [options.generator] - Custom ID generator function
- * @returns {Middleware} Express-compatible middleware
- */
-export function requestId(options) {
-    var headerName = (options === null || options === void 0 ? void 0 : options.headerName) || 'X-Request-ID';
-    var exposeHeader = (options === null || options === void 0 ? void 0 : options.exposeHeader) !== false;
-    var generateId = (options === null || options === void 0 ? void 0 : options.generator) || uuid;
-    return function (req, res, next) {
-        // Use existing request ID from header or generate a new one
-        var existingId = req.headers[headerName.toLowerCase()];
-        var id = existingId || generateId();
-        // Attach ID to request object
-        req.id = id;
-        // Add ID to response headers
-        if (exposeHeader) {
-            res.setHeader(headerName, id);
-        }
-        next();
-    };
-}
-/**
- * Measures request processing time and logs or adds it to response headers.
- *
- * @param {object} [options] - Configuration options
- * @param {boolean} [options.addHeader=true] - Whether to add X-Response-Time header
- * @param {boolean} [options.logOnComplete=false] - Whether to log timing info
- * @returns {Middleware} Express-compatible middleware
- */
-export function responseTime(options) {
-    var addHeader = (options === null || options === void 0 ? void 0 : options.addHeader) !== false;
-    var logOnComplete = (options === null || options === void 0 ? void 0 : options.logOnComplete) === true;
-    return function (req, res, next) {
-        var start = process.hrtime();
-        // Function to calculate duration
-        var getDuration = function () {
-            var diff = process.hrtime(start);
-            return (diff[0] * 1e3 + diff[1] * 1e-6).toFixed(2);
-        };
-        if (addHeader) {
-            // Ensure header is set before response is sent
-            var originalWriteHead_1 = res.writeHead;
-            res.writeHead = function () {
-                var args = [];
-                for (var _i = 0; _i < arguments.length; _i++) {
-                    args[_i] = arguments[_i];
-                }
-                res.setHeader('X-Response-Time', "".concat(getDuration(), "ms"));
-                return originalWriteHead_1.apply(this, args);
-            };
-        }
-        if (logOnComplete) {
-            res.on('finish', function () {
-                getLogger().info("".concat(req.method, " ").concat(req.url, " - ").concat(getDuration(), "ms"));
-            });
-        }
-        next();
-    };
-}
-/**
- * Request timeout middleware.
- * Aborts requests that take too long to process.
- *
- * @param {number} [timeoutMs=30000] - Timeout in milliseconds
- * @returns {Middleware} Express-compatible middleware
- */
-export function timeout(timeoutMs) {
-    if (timeoutMs === void 0) { timeoutMs = 30000; }
-    return function (_req, res, next) {
-        // Set timeout for the request
-        var timer = setTimeout(function () {
-            var response = new RequestTimeoutException('Request timed out');
-            res.status(HttpStatusCodes.REQUEST_TIMEOUT).json(response);
-        }, timeoutMs);
-        // Clear timeout when response is sent
-        res.on('finish', function () {
-            clearTimeout(timer);
-        });
-        next();
-    };
-}
-/**
- * Creates an Express middleware that initializes a per-request context.
- *
- * @param {object} [options] - Optional configuration
- * @param {string} [options.headerName='x-request-id'] - Header to look for request ID
- * @param {boolean} [options.autoLog=true] - Whether to log automatically when context is initialized
- * @returns {(req: Request, res: Response, next: NextFunction) => void} Express middleware function
- */
-export function setupRequestContext(options) {
-    if (options === void 0) { options = {}; }
-    var _a = options.headerName, headerName = _a === void 0 ? 'x-request-id' : _a, _b = options.autoLog, autoLog = _b === void 0 ? true : _b;
-    return function (req, _res, next) {
-        var _a;
-        // Generate or use existing request ID
-        var requestId = req.headers[headerName] || (req === null || req === void 0 ? void 0 : req['id']) || uuid();
-        ContextStore.run((_a = {}, _a[StoreKeys.REQUEST_ID] = requestId, _a), function () {
-            // Create a child logger for this request
-            var childLogger = getLogger().child({
-                requestId: requestId,
-                method: req.method,
-                url: req.originalUrl || req.url
-            });
-            req.logger = childLogger;
-            // Store logger in context
-            ContextStore.set(StoreKeys.LOGGER, childLogger);
-            if (autoLog) {
-                req.logger.info('Request context initialized');
-            }
-            next();
-        });
-    };
-}
-/**
- * Global error handling middleware with enhanced features.
- *
- * @param {ErrorHandlerOptions} options - Error handler options
- * @param {boolean} [options.logErrors=true] - Whether to log errors
- * @param {boolean} [options.includeDetails=false] - Whether to include error details in non-production
- * @returns Error middleware
- *
- * @example
- * import express from 'express';
- * import { errorHandler } from '@catbee/utils';
- *
- * const app = express();
- *
- * // Your routes
- * app.get('/ping', (req, res) => {
- *   throw new Error('Something went wrong');
- * });
- *
- * // Error handler (must be last middleware)
- * app.use(errorHandler({ includeDetails: true }));
- *
- * app.listen(3000, () => {
- *   console.log('Server running on port 3000');
- * });
- */
-export function errorHandler(options) {
-    var logErrors = (options === null || options === void 0 ? void 0 : options.logErrors) !== false;
-    var includeDetails = (options === null || options === void 0 ? void 0 : options.includeDetails) === true;
-    return function (err, req, res, _next) {
-        // Determine status code
-        var status = (err === null || err === void 0 ? void 0 : err.status) || (err === null || err === void 0 ? void 0 : err.statusCode) || HttpStatusCodes.INTERNAL_SERVER_ERROR;
-        // Log error if enabled
-        if (logErrors) {
-            getLogger().error({ err: err }, "".concat(err.message || 'Unknown error'));
-        }
-        // Handle ErrorResponse instances (our custom error class)
-        if (err instanceof ErrorResponse) {
-            var result = {
-                error: true,
-                message: err.message,
-                timestamp: err.timestamp,
-                requestId: (err === null || err === void 0 ? void 0 : err.requestId) || (req === null || req === void 0 ? void 0 : req.id) || uuid(),
-                status: status,
-                path: req.originalUrl || req.url
-            };
-            if (includeDetails && (err === null || err === void 0 ? void 0 : err.stack)) {
-                result.stack = err.stack.split('\n').map(function (line) { return line.trim(); });
-            }
-            return res.status(status).json(result);
-        }
-        // Handle any other errors
-        return res
-            .status(status)
-            .json(createFinalErrorResponse(req, status, (err === null || err === void 0 ? void 0 : err.message) || 'Internal Server Error', err, { includeDetails: includeDetails }));
-    };
-}
-//# sourceMappingURL=middleware.utils.js.map

package/build/esm/utils/middleware.utils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"middleware.utils.js","sourceRoot":"","sources":["../../../src/utils/middleware.utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAClC,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAE,wBAAwB,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAC3E,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAChE,OAAO,EAAE,uBAAuB,EAAE,MAAM,mBAAmB,CAAC;AAK5D;;;;;;;;;GASG;AACH,MAAM,UAAU,SAAS,CAAC,OAIzB;IACC,IAAM,UAAU,GAAG,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,UAAU,KAAI,cAAc,CAAC;IACzD,IAAM,YAAY,GAAG,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,YAAY,MAAK,KAAK,CAAC;IACrD,IAAM,UAAU,GAAG,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS,KAAI,IAAI,CAAC;IAE9C,OAAO,UAAC,GAAG,EAAE,GAAG,EAAE,IAAI;QACpB,4DAA4D;QAC5D,IAAM,UAAU,GAAG,GAAG,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC;QACzD,IAAM,EAAE,GAAI,UAAqB,IAAI,UAAU,EAAE,CAAC;QAElD,8BAA8B;QAC9B,GAAG,CAAC,EAAE,GAAG,EAAE,CAAC;QAEZ,6BAA6B;QAC7B,IAAI,YAAY,EAAE,CAAC;YACjB,GAAG,CAAC,SAAS,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;QAChC,CAAC;QAED,IAAI,EAAE,CAAC;IACT,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,YAAY,CAAC,OAA0D;IACrF,IAAM,SAAS,GAAG,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS,MAAK,KAAK,CAAC;IAC/C,IAAM,aAAa,GAAG,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,aAAa,MAAK,IAAI,CAAC;IAEtD,OAAO,UAAC,GAAY,EAAE,GAAa,EAAE,IAAkB;QACrD,IAAM,KAAK,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;QAE/B,iCAAiC;QACjC,IAAM,WAAW,GAAG;YAClB,IAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACnC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QACrD,CAAC,CAAC;QAEF,IAAI,SAAS,EAAE,CAAC;YACd,+CAA+C;YAC/C,IAAM,mBAAiB,GAAG,GAAG,CAAC,SAAS,CAAC;YACxC,GAAG,CAAC,SAAS,GAAG;gBAAU,cAAc;qBAAd,UAAc,EAAd,qBAAc,EAAd,IAAc;oBAAd,yBAAc;;gBACtC,GAAG,CAAC,SAAS,CAAC,iBAAiB,EAAE,UAAG,WAAW,EAAE,OAAI,CAAC,CAAC;gBACvD,OAAO,mBAAiB,CAAC,KAAK,CAAC,IAAI,EAAE,IAAW,CAAC,CAAC;YACpD,CAAC,CAAC;QACJ,CAAC;QAED,IAAI,aAAa,EAAE,CAAC;YAClB,GAAG,CAAC,EAAE,CAAC,QAAQ,EAAE;gBACf,SAAS,EAAE,CAAC,IAAI,CAAC,UAAG,GAAG,CAAC,MAAM,cAAI,GAAG,CAAC,GAAG,gBAAM,WAAW,EAAE,OAAI,CAAC,CAAC;YACpE,CAAC,CAAC,CAAC;QACL,CAAC;QAED,IAAI,EAAE,CAAC;IACT,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,OAAO,CAAC,SAAyB;IAAzB,0BAAA,EAAA,iBAAyB;IAC/C,OAAO,UAAC,IAAI,EAAE,GAAG,EAAE,IAAI;QACrB,8BAA8B;QAC9B,IAAM,KAAK,GAAG,UAAU,CAAC;YACvB,IAAM,QAAQ,GAAG,IAAI,uBAAuB,CAAC,mBAAmB,CAAC,CAAC;YAClE,GAAG,CAAC,MAAM,CAAC,eAAe,CAAC,eAAe,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC7D,CAAC,EAAE,SAAS,CAAC,CAAC;QAEd,sCAAsC;QACtC,GAAG,CAAC,EAAE,CAAC,QAAQ,EAAE;YACf,YAAY,CAAC,KAAK,CAAC,CAAC;QACtB,CAAC,CAAC,CAAC;QAEH,IAAI,EAAE,CAAC;IACT,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,mBAAmB,CAAC,OAAwD;IAAxD,wBAAA,EAAA,YAAwD;IAClF,IAAA,KAAgD,OAAO,WAA5B,EAA3B,UAAU,mBAAG,cAAc,KAAA,EAAE,KAAmB,OAAO,QAAZ,EAAd,OAAO,mBAAG,IAAI,KAAA,CAAa;IAChE,OAAO,UAAC,GAAG,EAAE,IAAI,EAAE,IAAI;;QACrB,sCAAsC;QACtC,IAAM,SAAS,GAAI,GAAG,CAAC,OAAO,CAAC,UAAU,CAAY,KAAI,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAG,IAAI,CAAC,CAAA,IAAI,IAAI,EAAE,CAAC;QAE/E,YAAY,CAAC,GAAG,WAAG,GAAC,SAAS,CAAC,UAAU,IAAG,SAAS,OAAI;YACtD,yCAAyC;YACzC,IAAM,WAAW,GAAG,SAAS,EAAE,CAAC,KAAK,CAAC;gBACpC,SAAS,WAAA;gBACT,MAAM,EAAE,GAAG,CAAC,MAAM;gBAClB,GAAG,EAAE,GAAG,CAAC,WAAW,IAAI,GAAG,CAAC,GAAG;aAChC,CAAC,CAAC;YAEH,GAAG,CAAC,MAAM,GAAG,WAAW,CAAC;YAEzB,0BAA0B;YAC1B,YAAY,CAAC,GAAG,CAAC,SAAS,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;YAEhD,IAAI,OAAO,EAAE,CAAC;gBACZ,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;YACjD,CAAC;YAED,IAAI,EAAE,CAAC;QACT,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC;AASD;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,UAAU,YAAY,CAAC,OAA6B;IACxD,IAAM,SAAS,GAAG,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS,MAAK,KAAK,CAAC;IAC/C,IAAM,cAAc,GAAG,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,cAAc,MAAK,IAAI,CAAC;IAExD,OAAO,UAAC,GAAQ,EAAE,GAAY,EAAE,GAAa,EAAE,KAAmB;QAChE,wBAAwB;QACxB,IAAM,MAAM,GAAG,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,MAAM,MAAI,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,UAAU,CAAA,IAAI,eAAe,CAAC,qBAAqB,CAAC;QAEvF,uBAAuB;QACvB,IAAI,SAAS,EAAE,CAAC;YACd,SAAS,EAAE,CAAC,KAAK,CAAC,EAAE,GAAG,KAAA,EAAE,EAAE,UAAG,GAAG,CAAC,OAAO,IAAI,eAAe,CAAE,CAAC,CAAC;QAClE,CAAC;QAED,0DAA0D;QAC1D,IAAI,GAAG,YAAY,aAAa,EAAE,CAAC;YACjC,IAAM,MAAM,GAAqB;gBAC/B,KAAK,EAAE,IAAI;gBACX,OAAO,EAAE,GAAG,CAAC,OAAO;gBACpB,SAAS,EAAE,GAAG,CAAC,SAAS;gBACxB,SAAS,EAAE,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,SAAS,MAAI,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,EAAE,CAAA,IAAI,IAAI,EAAE;gBAC9C,MAAM,QAAA;gBACN,IAAI,EAAE,GAAG,CAAC,WAAW,IAAI,GAAG,CAAC,GAAG;aACjC,CAAC;YAEF,IAAI,cAAc,KAAI,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,KAAK,CAAA,EAAE,CAAC;gBACjC,MAAM,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,UAAC,IAAY,IAAK,OAAA,IAAI,CAAC,IAAI,EAAE,EAAX,CAAW,CAAC,CAAC;YAC1E,CAAC;YACD,OAAO,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACzC,CAAC;QAED,0BAA0B;QAC1B,OAAO,GAAG;aACP,MAAM,CAAC,MAAM,CAAC;aACd,IAAI,CAAC,wBAAwB,CAAC,GAAG,EAAE,MAAM,EAAE,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,OAAO,KAAI,uBAAuB,EAAE,GAAG,EAAE,EAAE,cAAc,gBAAA,EAAE,CAAC,CAAC,CAAC;IACnH,CAAC,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 { uuid } from './id.utils';\nimport { HttpStatusCodes } from './http-status-codes';\nimport { createFinalErrorResponse, ErrorResponse } from './response.utils';\nimport { getLogger } from './logger.utils';\nimport type { Request, Response, NextFunction } from 'express';\nimport { ContextStore, StoreKeys } from './context-store.utils';\nimport { RequestTimeoutException } from './exception.utils';\nimport { ApiErrorResponse } from '../types/api-response';\n\nexport type Middleware = (req: Request, res: Response, next: NextFunction) => void | Promise<void>;\n\n/**\n * Attaches a unique request ID to each request.\n * Useful for request tracing and correlation between logs.\n *\n * @param {object} [options] - Configuration options\n * @param {string} [options.headerName='X-Request-ID'] - Header name for request ID\n * @param {boolean} [options.exposeHeader=true] - Whether to expose the header in response\n * @param {() => string} [options.generator] - Custom ID generator function\n * @returns {Middleware} Express-compatible middleware\n */\nexport function requestId(options?: {\n  headerName?: string;\n  exposeHeader?: boolean;\n  generator?: () => string;\n}): Middleware {\n  const headerName = options?.headerName || 'X-Request-ID';\n  const exposeHeader = options?.exposeHeader !== false;\n  const generateId = options?.generator || uuid;\n\n  return (req, res, next) => {\n    // Use existing request ID from header or generate a new one\n    const existingId = req.headers[headerName.toLowerCase()];\n    const id = (existingId as string) || generateId();\n\n    // Attach ID to request object\n    req.id = id;\n\n    // Add ID to response headers\n    if (exposeHeader) {\n      res.setHeader(headerName, id);\n    }\n\n    next();\n  };\n}\n\n/**\n * Measures request processing time and logs or adds it to response headers.\n *\n * @param {object} [options] - Configuration options\n * @param {boolean} [options.addHeader=true] - Whether to add X-Response-Time header\n * @param {boolean} [options.logOnComplete=false] - Whether to log timing info\n * @returns {Middleware} Express-compatible middleware\n */\nexport function responseTime(options?: { addHeader?: boolean; logOnComplete?: boolean }) {\n  const addHeader = options?.addHeader !== false;\n  const logOnComplete = options?.logOnComplete === true;\n\n  return (req: Request, res: Response, next: NextFunction) => {\n    const start = process.hrtime();\n\n    // Function to calculate duration\n    const getDuration = () => {\n      const diff = process.hrtime(start);\n      return (diff[0] * 1e3 + diff[1] * 1e-6).toFixed(2);\n    };\n\n    if (addHeader) {\n      // Ensure header is set before response is sent\n      const originalWriteHead = res.writeHead;\n      res.writeHead = function (...args: any[]) {\n        res.setHeader('X-Response-Time', `${getDuration()}ms`);\n        return originalWriteHead.apply(this, args as any);\n      };\n    }\n\n    if (logOnComplete) {\n      res.on('finish', () => {\n        getLogger().info(`${req.method} ${req.url} - ${getDuration()}ms`);\n      });\n    }\n\n    next();\n  };\n}\n\n/**\n * Request timeout middleware.\n * Aborts requests that take too long to process.\n *\n * @param {number} [timeoutMs=30000] - Timeout in milliseconds\n * @returns {Middleware} Express-compatible middleware\n */\nexport function timeout(timeoutMs: number = 30000): Middleware {\n  return (_req, res, next) => {\n    // Set timeout for the request\n    const timer = setTimeout(() => {\n      const response = new RequestTimeoutException('Request timed out');\n      res.status(HttpStatusCodes.REQUEST_TIMEOUT).json(response);\n    }, timeoutMs);\n\n    // Clear timeout when response is sent\n    res.on('finish', () => {\n      clearTimeout(timer);\n    });\n\n    next();\n  };\n}\n\n/**\n * Creates an Express middleware that initializes a per-request context.\n *\n * @param {object} [options] - Optional configuration\n * @param {string} [options.headerName='x-request-id'] - Header to look for request ID\n * @param {boolean} [options.autoLog=true] - Whether to log automatically when context is initialized\n * @returns {(req: Request, res: Response, next: NextFunction) => void} Express middleware function\n */\nexport function setupRequestContext(options: { headerName?: string; autoLog?: boolean } = {}): Middleware {\n  const { headerName = 'x-request-id', autoLog = true } = options;\n  return (req, _res, next) => {\n    // Generate or use existing request ID\n    const requestId = (req.headers[headerName] as string) || req?.['id'] || uuid();\n\n    ContextStore.run({ [StoreKeys.REQUEST_ID]: requestId }, () => {\n      // Create a child logger for this request\n      const childLogger = getLogger().child({\n        requestId,\n        method: req.method,\n        url: req.originalUrl || req.url\n      });\n\n      req.logger = childLogger;\n\n      // Store logger in context\n      ContextStore.set(StoreKeys.LOGGER, childLogger);\n\n      if (autoLog) {\n        req.logger.info('Request context initialized');\n      }\n\n      next();\n    });\n  };\n}\n\nexport interface ErrorHandlerOptions {\n  /** Whether to log errors (default: true) */\n  logErrors?: boolean;\n  /** Whether to include error details in non-production (default: false) */\n  includeDetails?: boolean;\n}\n\n/**\n * Global error handling middleware with enhanced features.\n *\n * @param {ErrorHandlerOptions} options - Error handler options\n * @param {boolean} [options.logErrors=true] - Whether to log errors\n * @param {boolean} [options.includeDetails=false] - Whether to include error details in non-production\n * @returns Error middleware\n *\n * @example\n * import express from 'express';\n * import { errorHandler } from '@catbee/utils';\n *\n * const app = express();\n *\n * // Your routes\n * app.get('/ping', (req, res) => {\n *   throw new Error('Something went wrong');\n * });\n *\n * // Error handler (must be last middleware)\n * app.use(errorHandler({ includeDetails: true }));\n *\n * app.listen(3000, () => {\n *   console.log('Server running on port 3000');\n * });\n */\nexport function errorHandler(options?: ErrorHandlerOptions) {\n  const logErrors = options?.logErrors !== false;\n  const includeDetails = options?.includeDetails === true;\n\n  return (err: any, req: Request, res: Response, _next: NextFunction) => {\n    // Determine status code\n    const status = err?.status || err?.statusCode || HttpStatusCodes.INTERNAL_SERVER_ERROR;\n\n    // Log error if enabled\n    if (logErrors) {\n      getLogger().error({ err }, `${err.message || 'Unknown error'}`);\n    }\n\n    // Handle ErrorResponse instances (our custom error class)\n    if (err instanceof ErrorResponse) {\n      const result: ApiErrorResponse = {\n        error: true,\n        message: err.message,\n        timestamp: err.timestamp,\n        requestId: err?.requestId || req?.id || uuid(),\n        status,\n        path: req.originalUrl || req.url\n      };\n\n      if (includeDetails && err?.stack) {\n        result.stack = err.stack.split('\\n').map((line: string) => line.trim());\n      }\n      return res.status(status).json(result);\n    }\n\n    // Handle any other errors\n    return res\n      .status(status)\n      .json(createFinalErrorResponse(req, status, err?.message || 'Internal Server Error', err, { includeDetails }));\n  };\n}\n"]}

package/build/esm/utils/obj.utils.d.ts

@@ -1,124 +0,0 @@
-/**
- * Checks whether the object has no own enumerable properties.
- *
- * @param {Record<any, any>} obj - The object to check.
- * @returns {boolean} True if the object is empty, false otherwise.
- */
-export declare function isObjEmpty(obj: Record<any, any>): boolean;
-/**
- * Returns a new object with only the specified keys picked.
- *
- * @template T
- * @template K
- * @param {T} obj - The source object.
- * @param {K[]} keys - Keys to pick from the object.
- * @returns {Pick<T, K>} New object with picked keys.
- */
-export declare function pick<T extends object, K extends keyof T>(obj: T, keys: K[]): Pick<T, K>;
-/**
- * Returns a new object with the specified keys omitted.
- *
- * @template T
- * @template K
- * @param {T} obj - The source object.
- * @param {K[]} keys - Keys to omit from the object.
- * @returns {Omit<T, K>} New object without omitted keys.
- */
-export declare function omit<T extends object, K extends keyof T>(obj: T, keys: K[]): Omit<T, K>;
-/**
- * Deeply merges multiple objects into the target object (mutates and returns the target object, not pure).
- *
- * @template T
- * @param {T} target - The object to merge into (will be mutated).
- * @param {...any[]} sources - The objects to merge from.
- * @returns {T} The merged object (same as target).
- */
-export declare function deepObjMerge<T extends object>(target: T, ...sources: any[]): T;
-/**
- * Checks if a value is a plain object (i.e., not an array, null, or a built-in object).
- *
- * @param value - The value to check.
- * @returns True if the value is a plain object, false otherwise.
- */
-export declare function isPlainObject(value: any): value is Record<string, any>;
-/**
- * Flattens a nested object using dot notation for keys (e.g., `{a: {b: 1}}` → `{ "a.b": 1 }`).
- *
- * @template T
- * @param {T} obj - The object to flatten.
- * @param {string} [prefix=""] - Optional prefix for nested keys (used internally).
- * @returns {Record<string, any>} A new object with flattened keys.
- */
-export declare function flattenObject<T extends Record<string, any>>(obj: T, prefix?: string): Record<string, any>;
-/**
- * Safely gets the value of a deeply nested key in an object using dot/bracket notation path.
- *
- * @template T
- * @param {T} obj - The object to extract from.
- * @param {string} path - String path using dot and/or bracket notation (e.g., 'user.friends[0].name').
- * @returns {any} The value at the given path, or undefined if not found.
- */
-export declare function getValueByPath<T extends object>(obj: T, path: string): any;
-/**
- * Sets a value at a deeply nested key in an object using dot/bracket notation path.
- * Creates intermediate objects and arrays as needed.
- *
- * @template T
- * @param {T} obj - The object to modify.
- * @param {string} path - String path using dot and/or bracket notation (e.g., 'user.friends[0].name').
- * @param {any} value - The value to set at the path.
- * @returns {T} The modified object.
- */
-export declare function setValueByPath<T extends object>(obj: T, path: string, value: any): T;
-/**
- * Performs a deep equality check between two objects.
- *
- * @param {any} a - First value to compare.
- * @param {any} b - Second value to compare.
- * @returns {boolean} True if values are deeply equal.
- */
-export declare function isEqual(a: any, b: any): boolean;
-/**
- * Filters object properties based on a predicate function.
- *
- * @template T
- * @param {T} obj - The source object.
- * @param {(value: any, key: string, obj: T) => boolean} predicate - Filter function.
- * @returns {Partial<T>} New object with filtered properties.
- */
-export declare function filterObject<T extends object>(obj: T, predicate: (value: any, key: string, obj: T) => boolean): Partial<T>;
-/**
- * Maps object values to new values using a mapping function.
- *
- * @template T
- * @template U
- * @param {T} obj - The source object.
- * @param {(value: any, key: string, obj: T) => U} mapFn - Mapping function.
- * @returns {Record<keyof T, U>} New object with mapped values.
- */
-export declare function mapObject<T extends object, U>(obj: T, mapFn: (value: any, key: string, obj: T) => U): Record<keyof T, U>;
-/**
- * Recursively freezes an object and all its properties.
- * Makes an object immutable.
- *
- * @template T
- * @param {T} obj - The object to freeze.
- * @returns {Readonly<T>} The frozen object.
- */
-export declare function deepFreeze<T extends object>(obj: T): Readonly<T>;
-/**
- * Safely checks if a value is an object (not null, not array).
- *
- * @param {unknown} value - Value to check.
- * @returns {boolean} True if value is a non-null, non-array object.
- */
-export declare function isObject(value: unknown): value is Record<string, any>;
-/**
- * Gets all paths in an object using dot notation.
- *
- * @param {Record<string, any>} obj - Object to analyze.
- * @param {string} [parentPath=""] - Internal param for recursion.
- * @returns {string[]} Array of all paths in dot notation.
- */
-export declare function getAllPaths(obj: Record<string, any>, parentPath?: string): string[];
-//# sourceMappingURL=obj.utils.d.ts.map