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

package/build/cjs/config.d.ts

@@ -0,0 +1,121 @@
+import { Logger, LoggerLevels } from './utils/logger.utils';
+/**
+ * Extends Express Request interface to add request ID tracking.
+ * Added by requestId middleware during request processing.
+ */
+declare global {
+    namespace Express {
+        interface Request {
+            /** Unique request identifier (set by middleware) */
+            id?: string;
+            /** Logger instance for the request (set by middleware) */
+            logger?: Logger;
+            /** User information (set by authentication middleware) */
+            user?: any;
+        }
+    }
+}
+/**
+ * Application runtime configuration loaded from environment variables.
+ */
+export declare let config: {
+    logger: {
+        /**
+         * Logging level (e.g., 'info', 'debug', 'warn', 'error').
+         */
+        level: LoggerLevels;
+        /**
+         * Name of the logger instance (defaults to npm package name).
+         */
+        name: string;
+        /**
+         * Enables pretty-print logging in development.
+         * Has no effect in production.
+         */
+        pretty: boolean;
+        /**
+         * Single line output for pretty-print (default: false)
+         */
+        singleLine: boolean;
+    };
+    cache: {
+        /**
+         * Default TTL (time to live) for cache entries in seconds
+         */
+        defaultTtl: number;
+    };
+};
+export declare const defaultServerConfig: {
+    port: number;
+    host: string;
+    cors: false;
+    helmet: false;
+    compression: false;
+    bodyParser: {
+        json: {
+            limit: string;
+        };
+        urlencoded: {
+            extended: true;
+            limit: string;
+        };
+    };
+    cookieParser: false;
+    isMicroservice: false;
+    appName: string;
+    globalHeaders: {};
+    rateLimit: {
+        enable: false;
+        windowMs: number;
+        max: number;
+        message: string;
+        standardHeaders: true;
+        legacyHeaders: false;
+    };
+    requestLogging: {
+        enable: boolean;
+        ignorePaths: (req: import("express").Request<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>, _res: import("express").Response<any, Record<string, any>>) => boolean;
+        skipNotFoundRoutes: false;
+    };
+    openApi: {
+        enable: false;
+        mountPath: string;
+        verbose: false;
+        withGlobalPrefix: false;
+    };
+    healthCheck: {
+        path: string;
+        detailed: true;
+    };
+    requestTimeout: number;
+    responseTime: {
+        enable: false;
+        addHeader: true;
+        logOnComplete: false;
+    };
+    requestId: {
+        headerName: string;
+        exposeHeader: true;
+        generator: () => string;
+    };
+    metrics: {
+        enable: false;
+        path: string;
+        withGlobalPrefix: false;
+    };
+    serviceVersion: {
+        enable: false;
+        headerName: string;
+        version: string;
+    };
+};
+/**
+ * Update the @catbee/utils configuration.
+ * @param value Partial configuration object.
+ */
+export declare function setConfig(value: Partial<typeof config>): void;
+/**
+ * Get the current @catbee/utils configuration.
+ * @returns The current configuration object.
+ */
+export declare function getConfig(): typeof config;

package/build/cjs/config.js

@@ -0,0 +1,137 @@
+"use strict";
+/*
+ * The MIT License
+ *
+ * Copyright (c) 2025 Catbee Technologies. https://catbee-utils.npm.hprasath.com/license
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultServerConfig = exports.config = void 0;
+exports.setConfig = setConfig;
+exports.getConfig = getConfig;
+const env_utils_1 = require("./utils/env.utils");
+const id_utils_1 = require("./utils/id.utils");
+const obj_utils_1 = require("./utils/obj.utils");
+/**
+ * Application runtime configuration loaded from environment variables.
+ */
+exports.config = {
+    logger: {
+        /**
+         * Logging level (e.g., 'info', 'debug', 'warn', 'error').
+         */
+        level: env_utils_1.Env.get('LOGGER_LEVEL', 'info'),
+        /**
+         * Name of the logger instance (defaults to npm package name).
+         */
+        name: env_utils_1.Env.get('LOGGER_NAME', env_utils_1.Env.get('npm_package_name', '@catbee/utils')),
+        /**
+         * Enables pretty-print logging in development.
+         * Has no effect in production.
+         */
+        pretty: env_utils_1.Env.getBoolean('LOGGER_PRETTY', true),
+        /**
+         * Single line output for pretty-print (default: false)
+         */
+        singleLine: env_utils_1.Env.getBoolean('LOGGER_PRETTY_SINGLE_LINE', false)
+    },
+    cache: {
+        /**
+         * Default TTL (time to live) for cache entries in seconds
+         */
+        defaultTtl: env_utils_1.Env.getNumber('CACHE_DEFAULT_TTL_SECONDS', 3600) * 1000
+    }
+};
+exports.defaultServerConfig = {
+    port: 3000,
+    host: '0.0.0.0',
+    cors: false,
+    helmet: false,
+    compression: false,
+    bodyParser: {
+        json: { limit: '1mb' },
+        urlencoded: { extended: true, limit: '1mb' }
+    },
+    cookieParser: false,
+    isMicroservice: false,
+    appName: 'express_app',
+    globalHeaders: {},
+    rateLimit: {
+        enable: false,
+        windowMs: 15 * 60 * 1000,
+        max: 100,
+        message: 'Too many requests',
+        standardHeaders: true,
+        legacyHeaders: false
+    },
+    requestLogging: {
+        enable: env_utils_1.Env.isDev(),
+        ignorePaths: (req, _res) => {
+            const skipPaths = ['/healthz', '/favicon.ico', '/metrics', '/docs', '/.well-known'];
+            return skipPaths.some(path => req.path.startsWith(path));
+        },
+        skipNotFoundRoutes: false
+    },
+    openApi: {
+        enable: false,
+        mountPath: '/docs',
+        verbose: false,
+        withGlobalPrefix: false
+    },
+    healthCheck: {
+        path: '/healthz',
+        detailed: true
+    },
+    requestTimeout: 30000,
+    responseTime: {
+        enable: false,
+        addHeader: true,
+        logOnComplete: false
+    },
+    requestId: {
+        headerName: 'x-request-id',
+        exposeHeader: true,
+        generator: () => (0, id_utils_1.uuid)()
+    },
+    metrics: {
+        enable: false,
+        path: '/metrics',
+        withGlobalPrefix: false
+    },
+    serviceVersion: {
+        enable: false,
+        headerName: 'x-service-version',
+        version: '0.0.0'
+    }
+};
+/**
+ * Update the @catbee/utils configuration.
+ * @param value Partial configuration object.
+ */
+function setConfig(value) {
+    (0, obj_utils_1.deepObjMerge)(exports.config, value);
+}
+/**
+ * Get the current @catbee/utils configuration.
+ * @returns The current configuration object.
+ */
+function getConfig() {
+    return exports.config;
+}

package/build/cjs/index.d.ts

@@ -0,0 +1,26 @@
+export { setConfig, getConfig } from './config';
+export * from './utils/array.utils';
+export * from './utils/async.utils';
+export * from './utils/cache.utils';
+export * from './utils/context-store.utils';
+export * from './utils/crypto.utils';
+export * from './utils/decorators.utils';
+export * from './utils/dir.utils';
+export * from './utils/env.utils';
+export * from './utils/exception.utils';
+export * from './utils/fs.utils';
+export * from './utils/http-status-codes';
+export * from './utils/id.utils';
+export * from './utils/logger.utils';
+export * from './utils/middleware.utils';
+export * from './utils/obj.utils';
+export * from './utils/request.utils';
+export * from './utils/response.utils';
+export * from './utils/string.utils';
+export * from './utils/url.utils';
+export * from './utils/validate.utils';
+export * from './types/index';
+export * from './types/server';
+export * from './types/api-response';
+export * from './servers/server';
+export * from './servers/server.builder';

package/build/cjs/index.js

@@ -0,0 +1,68 @@
+"use strict";
+/*
+ * The MIT License
+ *
+ * Copyright (c) 2025 Catbee Technologies. https://catbee-utils.npm.hprasath.com/license
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getConfig = exports.setConfig = void 0;
+var config_1 = require("./config");
+Object.defineProperty(exports, "setConfig", { enumerable: true, get: function () { return config_1.setConfig; } });
+Object.defineProperty(exports, "getConfig", { enumerable: true, get: function () { return config_1.getConfig; } });
+__exportStar(require("./utils/array.utils"), exports);
+__exportStar(require("./utils/async.utils"), exports);
+__exportStar(require("./utils/cache.utils"), exports);
+__exportStar(require("./utils/context-store.utils"), exports);
+__exportStar(require("./utils/crypto.utils"), exports);
+__exportStar(require("./utils/decorators.utils"), exports);
+__exportStar(require("./utils/dir.utils"), exports);
+__exportStar(require("./utils/env.utils"), exports);
+__exportStar(require("./utils/exception.utils"), exports);
+__exportStar(require("./utils/fs.utils"), exports);
+__exportStar(require("./utils/http-status-codes"), exports);
+__exportStar(require("./utils/id.utils"), exports);
+__exportStar(require("./utils/logger.utils"), exports);
+__exportStar(require("./utils/middleware.utils"), exports);
+__exportStar(require("./utils/obj.utils"), exports);
+__exportStar(require("./utils/request.utils"), exports);
+__exportStar(require("./utils/response.utils"), exports);
+__exportStar(require("./utils/string.utils"), exports);
+__exportStar(require("./utils/url.utils"), exports);
+__exportStar(require("./utils/validate.utils"), exports);
+__exportStar(require("./types/index"), exports);
+__exportStar(require("./types/server"), exports);
+__exportStar(require("./types/api-response"), exports);
+__exportStar(require("./servers/server"), exports);
+__exportStar(require("./servers/server.builder"), exports);