@catbee/utils 1.0.2 → 1.0.4

package/README.md

@@ -20,9 +20,8 @@ A modular, production-grade utility toolkit for Node.js and TypeScript, designed
   <img src="https://img.shields.io/npm/v/@catbee/utils/next" alt="NPM Next Version" /> -->
   <img src="https://img.shields.io/npm/dt/@catbee/utils" alt="NPM Downloads" />
   <img src="https://img.shields.io/npm/types/@catbee/utils" alt="TypeScript Types" />
-  <img src="https://img.shields.io/librariesio/release/npm/@catbee%2Futils" alt="Dependencies" />
   <img src="https://img.shields.io/maintenance/yes/2025" alt="Maintenance" />
-  <img src="https://snyk.io/test/github/<owner>/<repo>/badge.svg" alt="Snyk Vulnerabilities" />
+  <img src="https://snyk.io/test/github/catbee-technologies/catbee-utils/badge.svg" alt="Snyk Vulnerabilities" />
   <img src="https://sonarcloud.io/api/project_badges/measure?project=catbee-technologies_catbee-utils&metric=alert_status&token=93da835f2d48d37b41fa628cc7fc764c873bd700" alt="Quality Gate Status" />
   <img src="https://sonarcloud.io/api/project_badges/measure?project=catbee-technologies_catbee-utils&metric=ncloc&token=93da835f2d48d37b41fa628cc7fc764c873bd700" alt="Lines of Code" />
   <img src="https://sonarcloud.io/api/project_badges/measure?project=catbee-technologies_catbee-utils&metric=security_rating&token=93da835f2d48d37b41fa628cc7fc764c873bd700" alt="Security Rating" />

package/build/index.cjs

@@ -402,17 +402,17 @@ var Env = class _Env {
   *
   * @typeParam T - The allowed value type (string literal types).
   * @param {string} key - The environment variable key.
-  * @param {T[]} allowedValues - Array of accepted string values.
   * @param {T} [defaultValue] - Optional fallback value.
+  * @param {T[]} allowedValues - Array of accepted string values.
   * @returns {T} The validated environment value.
   * @throws {Error} If missing or invalid.
   *
   * @example
   * // If LOG_LEVEL=debug
-  * const level = Env.getEnum('LOG_LEVEL', ['debug', 'info', 'warn', 'error'] as const, 'info');
+  * const level = Env.getEnum('LOG_LEVEL', 'info', ['debug', 'info', 'warn', 'error'] as const);
   * // 'debug' (typed as 'debug' | 'info' | 'warn' | 'error')
   */
-  static getEnum(key, allowedValues, defaultValue) {
+  static getEnum(key, defaultValue, allowedValues) {
     const value = process.env[key];
     if (!value) {
       return defaultValue;
@@ -426,15 +426,15 @@ var Env = class _Env {
   * Retrieves an enum-like numeric environment variable.
   *
   * @param {string} key - The environment variable key.
-  * @param {number[]} allowedValues - Array of accepted values.
   * @param {number} defaultValue - Default value if not present.
+  * @param {number[]} allowedValues - Array of accepted values.
   * @returns {number} The validated value.
   *
   * @example
   * // If NODE_VERSION=16
-  * const version = Env.getNumberEnum('NODE_VERSION', [14, 16, 18], 16);
+  * const version = Env.getNumberEnum('NODE_VERSION', 16, [14, 16, 18]);
   */
-  static getNumberEnum(key, allowedValues, defaultValue) {
+  static getNumberEnum(key, defaultValue, allowedValues) {
     const value = _Env.getNumber(key, defaultValue);
     if (!allowedValues.includes(value)) {
       throw new Error(`Environment variable '${key}' must be one of: ${allowedValues.join(", ")}. Received: ${value}`);
@@ -1073,6 +1073,10 @@ var config = {
     */
     pretty: Env.getBoolean("LOGGER_PRETTY", true),
     /**
+    * Enables colorized output for pretty-print (default: true)
+    */
+    colorize: Env.getBoolean("LOGGER_PRETTY_COLORIZE", true),
+    /**
     * Single line output for pretty-print (default: false)
     */
     singleLine: Env.getBoolean("LOGGER_PRETTY_SINGLE_LINE", false)
@@ -1082,6 +1086,20 @@ var config = {
     * Default TTL (time to live) for cache entries in seconds
     */
     defaultTtl: Env.getNumber("CACHE_DEFAULT_TTL_SECONDS", 3600) * 1e3
+  },
+  server: {
+    /**
+    * Skip healthz endpoint even if health checks are configured
+    * Default: false
+    * Set to true to return 200 OK for /healthz without checks
+    * Useful in environments where a simple liveness probe is needed
+    * without performing actual health checks
+    * Example: Kubernetes liveness probe
+    * Note: This does not disable the health check functionality itself
+    *       Health checks can still be performed programmatically
+    *       or via other endpoints if needed
+    */
+    skipHealthz: Env.getBoolean("SERVER_SKIP_HEALTHZ", false)
   }
 };
 var defaultServerConfig = {
@@ -1685,10 +1703,10 @@ function setupLogger(isGlobal = true) {
     },
     timestamp: pino.stdTimeFunctions.isoTime
   };
-  const logger2 = config.logger.pretty && Env.isDev() ? pino__default.default(logParams, pino__default.default.transport({
+  const logger2 = config.logger.pretty ? pino__default.default(logParams, pino__default.default.transport({
     target: "pino-pretty",
     options: {
-      colorize: true,
+      colorize: config.logger.colorize,
       translateTime: "SYS:standard",
       ignore: "pid,hostname",
       singleLine: config.logger.singleLine,
@@ -6800,7 +6818,7 @@ var ExpressServer = class _ExpressServer {
     const healthCheckPath = this.normalizePath(this.config.healthCheck?.path || "/healthz", this.config.healthCheck?.withGlobalPrefix);
     this.app.get(healthCheckPath, async (_req, res) => {
       try {
-        if (!this.healthChecks.length) {
+        if (!this.healthChecks.length || config.server.skipHealthz) {
           return res.status(HttpStatusCodes.OK).json(new SuccessResponse("OK"));
         }
         const checkResults = await Promise.allSettled(this.healthChecks.map(async ({ name, check }) => {

package/build/index.d.ts

@@ -229,6 +229,10 @@ declare let config: {
          * Has no effect in production.
          */
         pretty: boolean;
+        /**
+         * Enables colorized output for pretty-print (default: true)
+         */
+        colorize: boolean;
         /**
          * Single line output for pretty-print (default: false)
          */
@@ -240,6 +244,20 @@ declare let config: {
          */
         defaultTtl: number;
     };
+    server: {
+        /**
+         * Skip healthz endpoint even if health checks are configured
+         * Default: false
+         * Set to true to return 200 OK for /healthz without checks
+         * Useful in environments where a simple liveness probe is needed
+         * without performing actual health checks
+         * Example: Kubernetes liveness probe
+         * Note: This does not disable the health check functionality itself
+         *       Health checks can still be performed programmatically
+         *       or via other endpoints if needed
+         */
+        skipHealthz: boolean;
+    };
 };
 /**
  * Update the @catbee/utils configuration.
@@ -2419,30 +2437,30 @@ declare class Env {
      *
      * @typeParam T - The allowed value type (string literal types).
      * @param {string} key - The environment variable key.
-     * @param {T[]} allowedValues - Array of accepted string values.
      * @param {T} [defaultValue] - Optional fallback value.
+     * @param {T[]} allowedValues - Array of accepted string values.
      * @returns {T} The validated environment value.
      * @throws {Error} If missing or invalid.
      *
      * @example
      * // If LOG_LEVEL=debug
-     * const level = Env.getEnum('LOG_LEVEL', ['debug', 'info', 'warn', 'error'] as const, 'info');
+     * const level = Env.getEnum('LOG_LEVEL', 'info', ['debug', 'info', 'warn', 'error'] as const);
      * // 'debug' (typed as 'debug' | 'info' | 'warn' | 'error')
      */
-    static getEnum<T extends string>(key: string, allowedValues: readonly T[], defaultValue: T): T;
+    static getEnum<T extends string>(key: string, defaultValue: T, allowedValues: readonly T[]): T;
     /**
      * Retrieves an enum-like numeric environment variable.
      *
      * @param {string} key - The environment variable key.
-     * @param {number[]} allowedValues - Array of accepted values.
      * @param {number} defaultValue - Default value if not present.
+     * @param {number[]} allowedValues - Array of accepted values.
      * @returns {number} The validated value.
      *
      * @example
      * // If NODE_VERSION=16
-     * const version = Env.getNumberEnum('NODE_VERSION', [14, 16, 18], 16);
+     * const version = Env.getNumberEnum('NODE_VERSION', 16, [14, 16, 18]);
      */
-    static getNumberEnum(key: string, allowedValues: number[], defaultValue: number): number;
+    static getNumberEnum(key: string, defaultValue: number, allowedValues: number[]): number;
     /**
      * Retrieves a URL environment variable and validates it.
      *

package/build/index.mjs

@@ -390,17 +390,17 @@ var Env = class _Env {
   *
   * @typeParam T - The allowed value type (string literal types).
   * @param {string} key - The environment variable key.
-  * @param {T[]} allowedValues - Array of accepted string values.
   * @param {T} [defaultValue] - Optional fallback value.
+  * @param {T[]} allowedValues - Array of accepted string values.
   * @returns {T} The validated environment value.
   * @throws {Error} If missing or invalid.
   *
   * @example
   * // If LOG_LEVEL=debug
-  * const level = Env.getEnum('LOG_LEVEL', ['debug', 'info', 'warn', 'error'] as const, 'info');
+  * const level = Env.getEnum('LOG_LEVEL', 'info', ['debug', 'info', 'warn', 'error'] as const);
   * // 'debug' (typed as 'debug' | 'info' | 'warn' | 'error')
   */
-  static getEnum(key, allowedValues, defaultValue) {
+  static getEnum(key, defaultValue, allowedValues) {
     const value = process.env[key];
     if (!value) {
       return defaultValue;
@@ -414,15 +414,15 @@ var Env = class _Env {
   * Retrieves an enum-like numeric environment variable.
   *
   * @param {string} key - The environment variable key.
-  * @param {number[]} allowedValues - Array of accepted values.
   * @param {number} defaultValue - Default value if not present.
+  * @param {number[]} allowedValues - Array of accepted values.
   * @returns {number} The validated value.
   *
   * @example
   * // If NODE_VERSION=16
-  * const version = Env.getNumberEnum('NODE_VERSION', [14, 16, 18], 16);
+  * const version = Env.getNumberEnum('NODE_VERSION', 16, [14, 16, 18]);
   */
-  static getNumberEnum(key, allowedValues, defaultValue) {
+  static getNumberEnum(key, defaultValue, allowedValues) {
     const value = _Env.getNumber(key, defaultValue);
     if (!allowedValues.includes(value)) {
       throw new Error(`Environment variable '${key}' must be one of: ${allowedValues.join(", ")}. Received: ${value}`);
@@ -1061,6 +1061,10 @@ var config = {
     */
     pretty: Env.getBoolean("LOGGER_PRETTY", true),
     /**
+    * Enables colorized output for pretty-print (default: true)
+    */
+    colorize: Env.getBoolean("LOGGER_PRETTY_COLORIZE", true),
+    /**
     * Single line output for pretty-print (default: false)
     */
     singleLine: Env.getBoolean("LOGGER_PRETTY_SINGLE_LINE", false)
@@ -1070,6 +1074,20 @@ var config = {
     * Default TTL (time to live) for cache entries in seconds
     */
     defaultTtl: Env.getNumber("CACHE_DEFAULT_TTL_SECONDS", 3600) * 1e3
+  },
+  server: {
+    /**
+    * Skip healthz endpoint even if health checks are configured
+    * Default: false
+    * Set to true to return 200 OK for /healthz without checks
+    * Useful in environments where a simple liveness probe is needed
+    * without performing actual health checks
+    * Example: Kubernetes liveness probe
+    * Note: This does not disable the health check functionality itself
+    *       Health checks can still be performed programmatically
+    *       or via other endpoints if needed
+    */
+    skipHealthz: Env.getBoolean("SERVER_SKIP_HEALTHZ", false)
   }
 };
 var defaultServerConfig = {
@@ -1673,10 +1691,10 @@ function setupLogger(isGlobal = true) {
     },
     timestamp: stdTimeFunctions.isoTime
   };
-  const logger2 = config.logger.pretty && Env.isDev() ? pino(logParams, pino.transport({
+  const logger2 = config.logger.pretty ? pino(logParams, pino.transport({
     target: "pino-pretty",
     options: {
-      colorize: true,
+      colorize: config.logger.colorize,
       translateTime: "SYS:standard",
       ignore: "pid,hostname",
       singleLine: config.logger.singleLine,
@@ -6788,7 +6806,7 @@ var ExpressServer = class _ExpressServer {
     const healthCheckPath = this.normalizePath(this.config.healthCheck?.path || "/healthz", this.config.healthCheck?.withGlobalPrefix);
     this.app.get(healthCheckPath, async (_req, res) => {
       try {
-        if (!this.healthChecks.length) {
+        if (!this.healthChecks.length || config.server.skipHealthz) {
           return res.status(HttpStatusCodes.OK).json(new SuccessResponse("OK"));
         }
         const checkResults = await Promise.allSettled(this.healthChecks.map(async ({ name, check }) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@catbee/utils",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "A modular, production-grade utility toolkit for Node.js and TypeScript, designed for robust, scalable applications (including Express-based services). All utilities are tree-shakable and can be imported independently.",
   "main": "build/index.cjs",
   "module": "build/index.mjs",
@@ -14,14 +14,14 @@
   },
   "license": "MIT",
   "optionalDependencies": {
-    "@scalar/express-api-reference": "^0.8.18",
+    "@scalar/express-api-reference": "^0.8.20",
     "abort-controller": "^3.0.0",
     "compression": "^1.8.1",
     "cookie-parser": "^1.4.7",
     "cors": "^2.8.5",
     "express-rate-limit": "^8.1.0",
     "helmet": "^8.1.0",
-    "pino": "^9.10.0",
+    "pino": "^10.0.0",
     "pino-pretty": "^13.1.1",
     "prom-client": "^15.1.3"
   },