@autofleet/nitur 2.2.0-1 → 2.2.0-beta.0

package/lib/health-check/setup.d.cts

@@ -1,69 +0,0 @@
-import { GracefulShutdownConfig, LivenessConfig, ReadinessConfig } from "./types.cjs";
-import { HealthCheckManager } from "./manager.cjs";
-import { LoggerInstanceManager } from "@autofleet/logger";
-import { Server } from "http";
-import { HttpTerminator } from "http-terminator";
-
-//#region src/health-check/setup.d.ts
-
-/**
-* Generic app interface - works for both Express and Fastify
-*/
-interface App {
-  get(path: string, handler: (req: any, res: any) => void | Promise<any>): any;
-}
-/**
-* Configuration for health check setup
-*/
-interface HealthCheckSetupConfig {
-  /**
-  * Application instance (Express or Fastify)
-  */
-  app: App;
-  /**
-  * HTTP server instance
-  */
-  server: Server;
-  /**
-  * Logger instance
-  */
-  logger?: LoggerInstanceManager;
-  /**
-  * Liveness probe configuration
-  */
-  liveness?: LivenessConfig;
-  /**
-  * Readiness probe configuration
-  */
-  readiness?: ReadinessConfig;
-  /**
-  * Graceful shutdown configuration
-  */
-  gracefulShutdown?: GracefulShutdownConfig;
-  /**
-  * Custom endpoint paths
-  */
-  endpoints?: {
-    liveness?: string;
-    readiness?: string;
-  };
-}
-/**
-* Health Check Setup Result
-*/
-interface HealthCheckSetup {
-  healthCheckManager: HealthCheckManager;
-  httpTerminator: HttpTerminator;
-  addShutdownHook: (name: string, hook: () => Promise<void>) => void;
-  checkLiveness: () => Promise<any>;
-  checkReadiness: () => Promise<any>;
-  shutdown: () => Promise<void>;
-}
-/**
-* Setup health checks and graceful shutdown
-* Works with both Express and Fastify
-*/
-declare function setupHealthCheck(config: HealthCheckSetupConfig): HealthCheckSetup;
-//#endregion
-export { HealthCheckSetup, HealthCheckSetupConfig, setupHealthCheck };
-//# sourceMappingURL=setup.d.cts.map

package/lib/health-check/setup.d.ts

@@ -1,69 +0,0 @@
-import { GracefulShutdownConfig, LivenessConfig, ReadinessConfig } from "./types.js";
-import { HealthCheckManager } from "./manager.js";
-import { LoggerInstanceManager } from "@autofleet/logger";
-import { HttpTerminator } from "http-terminator";
-import { Server } from "http";
-
-//#region src/health-check/setup.d.ts
-
-/**
-* Generic app interface - works for both Express and Fastify
-*/
-interface App {
-  get(path: string, handler: (req: any, res: any) => void | Promise<any>): any;
-}
-/**
-* Configuration for health check setup
-*/
-interface HealthCheckSetupConfig {
-  /**
-  * Application instance (Express or Fastify)
-  */
-  app: App;
-  /**
-  * HTTP server instance
-  */
-  server: Server;
-  /**
-  * Logger instance
-  */
-  logger?: LoggerInstanceManager;
-  /**
-  * Liveness probe configuration
-  */
-  liveness?: LivenessConfig;
-  /**
-  * Readiness probe configuration
-  */
-  readiness?: ReadinessConfig;
-  /**
-  * Graceful shutdown configuration
-  */
-  gracefulShutdown?: GracefulShutdownConfig;
-  /**
-  * Custom endpoint paths
-  */
-  endpoints?: {
-    liveness?: string;
-    readiness?: string;
-  };
-}
-/**
-* Health Check Setup Result
-*/
-interface HealthCheckSetup {
-  healthCheckManager: HealthCheckManager;
-  httpTerminator: HttpTerminator;
-  addShutdownHook: (name: string, hook: () => Promise<void>) => void;
-  checkLiveness: () => Promise<any>;
-  checkReadiness: () => Promise<any>;
-  shutdown: () => Promise<void>;
-}
-/**
-* Setup health checks and graceful shutdown
-* Works with both Express and Fastify
-*/
-declare function setupHealthCheck(config: HealthCheckSetupConfig): HealthCheckSetup;
-//#endregion
-export { HealthCheckSetup, HealthCheckSetupConfig, setupHealthCheck };
-//# sourceMappingURL=setup.d.ts.map

package/lib/health-check/setup.js

@@ -1,2 +0,0 @@
-import{logger as e}from"../logger.js";import{HealthCheckManager as t}from"./manager.js";import{createTerminus as n}from"@godaddy/terminus";import{createHttpTerminator as r}from"http-terminator";function i(i){let a=i.logger??e,o=i.endpoints?.liveness||`/health/live`,s=i.endpoints?.readiness||`/health/ready`,c=new t(i.liveness,i.readiness),l=r({server:i.server}),u=i.gracefulShutdown?.shutdownHooks||[],d={signals:i.gracefulShutdown?.signals??[`SIGTERM`,`SIGINT`],timeout:i.gracefulShutdown?.timeout??5e4,useExit0:i.gracefulShutdown?.useExit0??!0,healthChecks:{[o]:async()=>{let e=await c.checkLiveness();if(e.status===`fail`)throw Error(e.checks.filter(e=>e.status===`fail`).map(e=>e.error).join(`, `))},[s]:async()=>{let e=await c.checkReadiness();if(e.status===`fail`)throw Error(e.checks.filter(e=>e.status===`fail`).map(e=>e.error).join(`, `))}},beforeShutdown:async()=>{a.info(`Received shutdown signal`),await new Promise(e=>setTimeout(e,5e3))},onSignal:async()=>{a.info(`Executing shutdown hooks`),await Promise.all(u.map(async({name:e,hook:t})=>{try{a.info(`Running shutdown hook: ${e}`),await t()}catch(t){throw a.error(`Shutdown hook '${e}' failed`,{error:t}),t}}))},onShutdown:async()=>{a.info(`Graceful shutdown completed`)},logger:(e,t)=>{t?a.error(e,{error:t}):a.info(e)}};return n(i.server,d),a.info(`Health checks and graceful shutdown initialized`,{livenessPath:o,readinessPath:s}),{healthCheckManager:c,httpTerminator:l,addShutdownHook:(e,t)=>{u.push({name:e,hook:t})},checkLiveness:()=>c.checkLiveness(),checkReadiness:()=>c.checkReadiness(),shutdown:async()=>{a.info(`Manual shutdown initiated`),await l.terminate()}}}export{i as setupHealthCheck};
-//# sourceMappingURL=setup.js.map

package/lib/health-check/setup.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"setup.js","names":["logger","defaultLogger","shutdownHooks: NamedShutdownHook[]","terminusOptions: TerminusOptions"],"sources":["../../src/health-check/setup.ts"],"sourcesContent":["import type { Server } from 'http';\nimport type { LoggerInstanceManager } from '@autofleet/logger';\nimport { createTerminus, type TerminusOptions } from '@godaddy/terminus';\nimport { createHttpTerminator, type HttpTerminator } from 'http-terminator';\nimport { logger as defaultLogger } from '../logger';\nimport { HealthCheckManager } from './manager';\nimport type {\n  LivenessConfig,\n  ReadinessConfig,\n  GracefulShutdownConfig,\n  NamedShutdownHook,\n} from './types';\n\n/**\n * Generic app interface - works for both Express and Fastify\n */\ninterface App {\n  get(path: string, handler: (req: any, res: any) => void | Promise<any>): any;\n}\n\n/**\n * Configuration for health check setup\n */\nexport interface HealthCheckSetupConfig {\n  /**\n   * Application instance (Express or Fastify)\n   */\n  app: App;\n\n  /**\n   * HTTP server instance\n   */\n  server: Server;\n\n  /**\n   * Logger instance\n   */\n  logger?: LoggerInstanceManager;\n\n  /**\n   * Liveness probe configuration\n   */\n  liveness?: LivenessConfig;\n\n  /**\n   * Readiness probe configuration\n   */\n  readiness?: ReadinessConfig;\n\n  /**\n   * Graceful shutdown configuration\n   */\n  gracefulShutdown?: GracefulShutdownConfig;\n\n  /**\n   * Custom endpoint paths\n   */\n  endpoints?: {\n    liveness?: string;\n    readiness?: string;\n  };\n}\n\n/**\n * Health Check Setup Result\n */\nexport interface HealthCheckSetup {\n  healthCheckManager: HealthCheckManager;\n  httpTerminator: HttpTerminator;\n  addShutdownHook: (name: string, hook: () => Promise<void>) => void;\n  checkLiveness: () => Promise<any>;\n  checkReadiness: () => Promise<any>;\n  shutdown: () => Promise<void>;\n}\n\n/**\n * Setup health checks and graceful shutdown\n * Works with both Express and Fastify\n */\nexport function setupHealthCheck(config: HealthCheckSetupConfig): HealthCheckSetup {\n  const logger = config.logger ?? defaultLogger;\n  const livenessPath = config.endpoints?.liveness || '/health/live';\n  const readinessPath = config.endpoints?.readiness || '/health/ready';\n\n  // Create health check manager\n  const healthCheckManager = new HealthCheckManager(config.liveness, config.readiness);\n\n  // Create http terminator\n  const httpTerminator = createHttpTerminator({ server: config.server });\n\n  // Shutdown hooks\n  const shutdownHooks: NamedShutdownHook[] = config.gracefulShutdown?.shutdownHooks || [];\n\n  // Setup terminus\n  const terminusOptions: TerminusOptions = {\n    signals: config.gracefulShutdown?.signals ?? ['SIGTERM', 'SIGINT'],\n    timeout: config.gracefulShutdown?.timeout ?? 50_000,\n    useExit0: config.gracefulShutdown?.useExit0 ?? true,\n    healthChecks: {\n      [livenessPath]: async () => {\n        const status = await healthCheckManager.checkLiveness();\n        if (status.status === 'fail') {\n          throw new Error(status.checks.filter(c => c.status === 'fail').map(c => c.error).join(', '));\n        }\n      },\n      [readinessPath]: async () => {\n        const status = await healthCheckManager.checkReadiness();\n        if (status.status === 'fail') {\n          throw new Error(status.checks.filter(c => c.status === 'fail').map(c => c.error).join(', '));\n        }\n      },\n    },\n\n    beforeShutdown: async () => {\n      logger.info('Received shutdown signal');\n      // Give load balancers time to remove instance\n      await new Promise(resolve => setTimeout(resolve, 5000));\n    },\n\n    onSignal: async () => {\n      logger.info('Executing shutdown hooks');\n      await Promise.all(shutdownHooks.map(async ({ name, hook }) => {\n        try {\n          logger.info(`Running shutdown hook: ${name}`);\n          await hook();\n        } catch (error) {\n          logger.error(`Shutdown hook '${name}' failed`, { error });\n          throw error;\n        }\n      }));\n    },\n\n    onShutdown: async () => {\n      logger.info('Graceful shutdown completed');\n    },\n\n    logger: (msg, error) => {\n      if (error) {\n        logger.error(msg, { error });\n      } else {\n        logger.info(msg);\n      }\n    },\n  };\n\n  createTerminus(config.server, terminusOptions);\n\n  logger.info('Health checks and graceful shutdown initialized', {\n    livenessPath,\n    readinessPath,\n  });\n\n  return {\n    healthCheckManager,\n    httpTerminator,\n    addShutdownHook: (name: string, hook: () => Promise<void>) => {\n      shutdownHooks.push({ name, hook });\n    },\n    checkLiveness: () => healthCheckManager.checkLiveness(),\n    checkReadiness: () => healthCheckManager.checkReadiness(),\n    shutdown: async () => {\n      logger.info('Manual shutdown initiated');\n      await httpTerminator.terminate();\n    },\n  };\n}\n"],"mappings":"kMA+EA,SAAgB,EAAiB,EAAkD,CACjF,IAAMA,EAAS,EAAO,QAAUC,EAC1B,EAAe,EAAO,WAAW,UAAY,eAC7C,EAAgB,EAAO,WAAW,WAAa,gBAG/C,EAAqB,IAAI,EAAmB,EAAO,SAAU,EAAO,UAAU,CAG9E,EAAiB,EAAqB,CAAE,OAAQ,EAAO,OAAQ,CAAC,CAGhEC,EAAqC,EAAO,kBAAkB,eAAiB,EAAE,CAGjFC,EAAmC,CACvC,QAAS,EAAO,kBAAkB,SAAW,CAAC,UAAW,SAAS,CAClE,QAAS,EAAO,kBAAkB,SAAW,IAC7C,SAAU,EAAO,kBAAkB,UAAY,GAC/C,aAAc,EACX,GAAe,SAAY,CAC1B,IAAM,EAAS,MAAM,EAAmB,eAAe,CACvD,GAAI,EAAO,SAAW,OACpB,MAAU,MAAM,EAAO,OAAO,OAAO,GAAK,EAAE,SAAW,OAAO,CAAC,IAAI,GAAK,EAAE,MAAM,CAAC,KAAK,KAAK,CAAC,GAG/F,GAAgB,SAAY,CAC3B,IAAM,EAAS,MAAM,EAAmB,gBAAgB,CACxD,GAAI,EAAO,SAAW,OACpB,MAAU,MAAM,EAAO,OAAO,OAAO,GAAK,EAAE,SAAW,OAAO,CAAC,IAAI,GAAK,EAAE,MAAM,CAAC,KAAK,KAAK,CAAC,EAGjG,CAED,eAAgB,SAAY,CAC1B,EAAO,KAAK,2BAA2B,CAEvC,MAAM,IAAI,QAAQ,GAAW,WAAW,EAAS,IAAK,CAAC,EAGzD,SAAU,SAAY,CACpB,EAAO,KAAK,2BAA2B,CACvC,MAAM,QAAQ,IAAI,EAAc,IAAI,MAAO,CAAE,OAAM,UAAW,CAC5D,GAAI,CACF,EAAO,KAAK,0BAA0B,IAAO,CAC7C,MAAM,GAAM,OACL,EAAO,CAEd,MADA,EAAO,MAAM,kBAAkB,EAAK,UAAW,CAAE,QAAO,CAAC,CACnD,IAER,CAAC,EAGL,WAAY,SAAY,CACtB,EAAO,KAAK,8BAA8B,EAG5C,QAAS,EAAK,IAAU,CAClB,EACF,EAAO,MAAM,EAAK,CAAE,QAAO,CAAC,CAE5B,EAAO,KAAK,EAAI,EAGrB,CASD,OAPA,EAAe,EAAO,OAAQ,EAAgB,CAE9C,EAAO,KAAK,kDAAmD,CAC7D,eACA,gBACD,CAAC,CAEK,CACL,qBACA,iBACA,iBAAkB,EAAc,IAA8B,CAC5D,EAAc,KAAK,CAAE,OAAM,OAAM,CAAC,EAEpC,kBAAqB,EAAmB,eAAe,CACvD,mBAAsB,EAAmB,gBAAgB,CACzD,SAAU,SAAY,CACpB,EAAO,KAAK,4BAA4B,CACxC,MAAM,EAAe,WAAW,EAEnC"}

package/lib/health-check/types.d.cts

@@ -1,157 +0,0 @@
-import { LoggerInstanceManager } from "@autofleet/logger";
-
-//#region src/health-check/types.d.ts
-
-/**
-* Health check function that returns health status
-* @returns Promise that resolves on success or rejects with error message
-*/
-type HealthCheck = () => Promise<void>;
-/**
-* Named health check with identifier
-*/
-interface NamedHealthCheck {
-  name: string;
-  check: HealthCheck;
-}
-/**
-* Health check result for a single check
-*/
-interface HealthCheckResult {
-  name: string;
-  status: "pass" | "fail";
-  error?: string;
-  duration: number;
-}
-/**
-* Overall health status response
-*/
-interface HealthStatus {
-  status: "pass" | "fail";
-  timestamp: string;
-  checks: HealthCheckResult[];
-  duration: number;
-}
-/**
-* Redis client interface - supports multiple instances
-*/
-interface RedisClient {
-  ping: () => Promise<string | void>;
-}
-/**
-* Sequelize database interface
-*/
-interface SequelizeClient {
-  query(sql: string | {
-    query: string;
-    values: unknown[];
-  }): Promise<any>;
-}
-/**
-* Elasticsearch client interface
-*/
-interface ElasticsearchClient {
-  ping: () => Promise<boolean>;
-}
-/**
-* RabbitMQ client interface
-*/
-interface RabbitMQClient {
-  isConnected: () => Promise<boolean> | boolean;
-}
-/**
-* Configuration for resource checkers
-*/
-interface ResourceCheckConfig {
-  /**
-  * Logger instance for health check operations
-  */
-  logger?: LoggerInstanceManager;
-  /**
-  * Redis instances to check - can be multiple
-  * Key is the instance name, value is the client
-  */
-  redis?: Record<string, RedisClient>;
-  /**
-  * Sequelize database instance to check
-  */
-  sequelize?: SequelizeClient;
-  /**
-  * Elasticsearch instance to check
-  */
-  elasticsearch?: ElasticsearchClient;
-  /**
-  * RabbitMQ instance to check
-  */
-  rabbitmq?: RabbitMQClient;
-  /**
-  * Custom health checks to run
-  */
-  customChecks?: NamedHealthCheck[];
-}
-/**
-* Configuration for liveness probe
-* Liveness indicates if the application is running and not deadlocked
-*/
-interface LivenessConfig extends ResourceCheckConfig {
-  /**
-  * Timeout for liveness checks in milliseconds
-  * @default 5000
-  */
-  timeout?: number;
-}
-/**
-* Configuration for readiness probe
-* Readiness indicates if the application is ready to serve traffic
-*/
-interface ReadinessConfig extends ResourceCheckConfig {
-  /**
-  * Timeout for readiness checks in milliseconds
-  * @default 10000
-  */
-  timeout?: number;
-}
-/**
-* Graceful shutdown hook
-* @returns Promise that resolves when cleanup is complete
-*/
-type ShutdownHook = () => Promise<void>;
-/**
-* Named shutdown hook
-*/
-interface NamedShutdownHook {
-  name: string;
-  hook: ShutdownHook;
-}
-/**
-* Configuration for graceful shutdown
-*/
-interface GracefulShutdownConfig {
-  /**
-  * Logger instance
-  */
-  logger?: LoggerInstanceManager;
-  /**
-  * Timeout before forced shutdown in milliseconds
-  * @default 30000
-  */
-  timeout?: number;
-  /**
-  * Custom shutdown hooks to run on termination
-  */
-  shutdownHooks?: NamedShutdownHook[];
-  /**
-  * Signals to listen for
-  * @default ['SIGTERM', 'SIGINT']
-  */
-  signals?: NodeJS.Signals[];
-  /**
-  * Whether to send failure during shutdown
-  * @default true
-  */
-  sendFailuresDuringShutdown?: boolean;
-  useExit0?: boolean;
-}
-//#endregion
-export { ElasticsearchClient, GracefulShutdownConfig, HealthCheck, HealthCheckResult, HealthStatus, LivenessConfig, NamedHealthCheck, NamedShutdownHook, RabbitMQClient, ReadinessConfig, RedisClient, ResourceCheckConfig, SequelizeClient, ShutdownHook };
-//# sourceMappingURL=types.d.cts.map

package/lib/health-check/types.d.ts

@@ -1,157 +0,0 @@
-import { LoggerInstanceManager } from "@autofleet/logger";
-
-//#region src/health-check/types.d.ts
-
-/**
-* Health check function that returns health status
-* @returns Promise that resolves on success or rejects with error message
-*/
-type HealthCheck = () => Promise<void>;
-/**
-* Named health check with identifier
-*/
-interface NamedHealthCheck {
-  name: string;
-  check: HealthCheck;
-}
-/**
-* Health check result for a single check
-*/
-interface HealthCheckResult {
-  name: string;
-  status: "pass" | "fail";
-  error?: string;
-  duration: number;
-}
-/**
-* Overall health status response
-*/
-interface HealthStatus {
-  status: "pass" | "fail";
-  timestamp: string;
-  checks: HealthCheckResult[];
-  duration: number;
-}
-/**
-* Redis client interface - supports multiple instances
-*/
-interface RedisClient {
-  ping: () => Promise<string | void>;
-}
-/**
-* Sequelize database interface
-*/
-interface SequelizeClient {
-  query(sql: string | {
-    query: string;
-    values: unknown[];
-  }): Promise<any>;
-}
-/**
-* Elasticsearch client interface
-*/
-interface ElasticsearchClient {
-  ping: () => Promise<boolean>;
-}
-/**
-* RabbitMQ client interface
-*/
-interface RabbitMQClient {
-  isConnected: () => Promise<boolean> | boolean;
-}
-/**
-* Configuration for resource checkers
-*/
-interface ResourceCheckConfig {
-  /**
-  * Logger instance for health check operations
-  */
-  logger?: LoggerInstanceManager;
-  /**
-  * Redis instances to check - can be multiple
-  * Key is the instance name, value is the client
-  */
-  redis?: Record<string, RedisClient>;
-  /**
-  * Sequelize database instance to check
-  */
-  sequelize?: SequelizeClient;
-  /**
-  * Elasticsearch instance to check
-  */
-  elasticsearch?: ElasticsearchClient;
-  /**
-  * RabbitMQ instance to check
-  */
-  rabbitmq?: RabbitMQClient;
-  /**
-  * Custom health checks to run
-  */
-  customChecks?: NamedHealthCheck[];
-}
-/**
-* Configuration for liveness probe
-* Liveness indicates if the application is running and not deadlocked
-*/
-interface LivenessConfig extends ResourceCheckConfig {
-  /**
-  * Timeout for liveness checks in milliseconds
-  * @default 5000
-  */
-  timeout?: number;
-}
-/**
-* Configuration for readiness probe
-* Readiness indicates if the application is ready to serve traffic
-*/
-interface ReadinessConfig extends ResourceCheckConfig {
-  /**
-  * Timeout for readiness checks in milliseconds
-  * @default 10000
-  */
-  timeout?: number;
-}
-/**
-* Graceful shutdown hook
-* @returns Promise that resolves when cleanup is complete
-*/
-type ShutdownHook = () => Promise<void>;
-/**
-* Named shutdown hook
-*/
-interface NamedShutdownHook {
-  name: string;
-  hook: ShutdownHook;
-}
-/**
-* Configuration for graceful shutdown
-*/
-interface GracefulShutdownConfig {
-  /**
-  * Logger instance
-  */
-  logger?: LoggerInstanceManager;
-  /**
-  * Timeout before forced shutdown in milliseconds
-  * @default 30000
-  */
-  timeout?: number;
-  /**
-  * Custom shutdown hooks to run on termination
-  */
-  shutdownHooks?: NamedShutdownHook[];
-  /**
-  * Signals to listen for
-  * @default ['SIGTERM', 'SIGINT']
-  */
-  signals?: NodeJS.Signals[];
-  /**
-  * Whether to send failure during shutdown
-  * @default true
-  */
-  sendFailuresDuringShutdown?: boolean;
-  useExit0?: boolean;
-}
-//#endregion
-export { ElasticsearchClient, GracefulShutdownConfig, HealthCheck, HealthCheckResult, HealthStatus, LivenessConfig, NamedHealthCheck, NamedShutdownHook, RabbitMQClient, ReadinessConfig, RedisClient, ResourceCheckConfig, SequelizeClient, ShutdownHook };
-//# sourceMappingURL=types.d.ts.map