@hkdigital/lib-core 0.3.10 → 0.3.11

package/dist/services/internal/service-base/constants.js

@@ -1,110 +1,110 @@
-/**
- * @fileoverview Service state constants for the service management system.
- *
- * Defines all possible states a service can be in during its lifecycle.
- * Services transition through these states as they are initialized, started,
- * stopped, and handle errors or recovery.
- *
- * @example
- * // Using state constants in a service
- * import { RUNNING, ERROR } from './service-states.js';
- *
- * class MyService extends ServiceBase {
- *   async doWork() {
- *     if (this.state !== RUNNING) {
- *       throw new Error('Service not running');
- *     }
- *     // ... do work
- *   }
- * }
- *
- * @example
- * // Checking service states
- * import { RUNNING, ERROR, STOPPED } from './service-states.js';
- *
- * const service = serviceManager.get('database');
- *
- * switch (service.state) {
- *   case RUNNING:
- *     console.log('Service is operational');
- *     break;
- *   case ERROR:
- *     console.log('Service has failed');
- *     break;
- *   case STOPPED:
- *     console.log('Service is stopped');
- *     break;
- * }
- */
-
-/**
- * Service has not been created yet
- * @const {string}
- */
-export const NOT_CREATED = 'not-created';
-
-/**
- * Service has been created but not initialized
- * @const {string}
- */
-export const CREATED = 'created';
-
-/**
- * Service is currently initializing
- * @const {string}
- */
-export const INITIALIZING = 'initializing';
-
-/**
- * Service has been initialized and is ready to start
- * @const {string}
- */
-export const INITIALIZED = 'initialized';
-
-/**
- * Service is currently starting up
- * @const {string}
- */
-export const STARTING = 'starting';
-
-/**
- * Service is running and operational
- * @const {string}
- */
-export const RUNNING = 'running';
-
-/**
- * Service is currently shutting down
- * @const {string}
- */
-export const STOPPING = 'stopping';
-
-/**
- * Service has been stopped
- * @const {string}
- */
-export const STOPPED = 'stopped';
-
-/**
- * Service is being destroyed and cleaned up
- * @const {string}
- */
-export const DESTROYING = 'destroying';
-
-/**
- * Service has been destroyed and cannot be used
- * @const {string}
- */
-export const DESTROYED = 'destroyed';
-
-/**
- * Service encountered an error and is not operational
- * @const {string}
- */
-export const ERROR = 'error';
-
-/**
- * Service is attempting to recover from an error
- * @const {string}
- */
-export const RECOVERING = 'recovering';
+/**
+ * @fileoverview Service state constants for the service management system.
+ *
+ * Defines all possible states a service can be in during its lifecycle.
+ * Services transition through these states as they are initialized, started,
+ * stopped, and handle errors or recovery.
+ *
+ * @example
+ * // Using state constants in a service
+ * import { RUNNING, ERROR } from './service-states.js';
+ *
+ * class MyService extends ServiceBase {
+ *   async doWork() {
+ *     if (this.state !== RUNNING) {
+ *       throw new Error('Service not running');
+ *     }
+ *     // ... do work
+ *   }
+ * }
+ *
+ * @example
+ * // Checking service states
+ * import { RUNNING, ERROR, STOPPED } from './service-states.js';
+ *
+ * const service = serviceManager.get('database');
+ *
+ * switch (service.state) {
+ *   case RUNNING:
+ *     console.log('Service is operational');
+ *     break;
+ *   case ERROR:
+ *     console.log('Service has failed');
+ *     break;
+ *   case STOPPED:
+ *     console.log('Service is stopped');
+ *     break;
+ * }
+ */
+
+/**
+ * Service has not been created yet
+ * @const {string}
+ */
+export const NOT_CREATED = 'not-created';
+
+/**
+ * Service has been created but not initialized
+ * @const {string}
+ */
+export const CREATED = 'created';
+
+/**
+ * Service is currently initializing
+ * @const {string}
+ */
+export const INITIALIZING = 'initializing';
+
+/**
+ * Service has been initialized and is ready to start
+ * @const {string}
+ */
+export const INITIALIZED = 'initialized';
+
+/**
+ * Service is currently starting up
+ * @const {string}
+ */
+export const STARTING = 'starting';
+
+/**
+ * Service is running and operational
+ * @const {string}
+ */
+export const RUNNING = 'running';
+
+/**
+ * Service is currently shutting down
+ * @const {string}
+ */
+export const STOPPING = 'stopping';
+
+/**
+ * Service has been stopped
+ * @const {string}
+ */
+export const STOPPED = 'stopped';
+
+/**
+ * Service is being destroyed and cleaned up
+ * @const {string}
+ */
+export const DESTROYING = 'destroying';
+
+/**
+ * Service has been destroyed and cannot be used
+ * @const {string}
+ */
+export const DESTROYED = 'destroyed';
+
+/**
+ * Service encountered an error and is not operational
+ * @const {string}
+ */
+export const ERROR = 'error';
+
+/**
+ * Service is attempting to recover from an error
+ * @const {string}
+ */
+export const RECOVERING = 'recovering';

package/dist/services/internal/service-base/index.js

@@ -1,3 +1,3 @@
-export * from './ServiceBase.js';
-export * from './constants.js';
-export * from './typedef.js';
+export * from './ServiceBase.js';
+export * from './constants.js';
+export * from './typedef.js';

package/dist/services/internal/service-base/typedef.js

@@ -1,101 +1,101 @@
-/**
- * @fileoverview Type definitions for ServiceBase class.
- * 
- * This file contains all TypeScript/JSDoc type definitions used by
- * the ServiceBase class and service implementations.
- * 
- * @example
- * // In your service implementation
- * import { ServiceBase } from './ServiceBase.js';
- * 
- * class MyService extends ServiceBase {
- *   async _init(config) {
- *   }
- *   
- *   async _healthCheck() {
- *     // Return type is HealthStatus
- *     return { latency: 10 };
- *   }
- * }
- */
-
-// ============================================================================
-// PUBLIC TYPES
-// ============================================================================
-
-/**
- * Options for creating a service instance
- *
- * @typedef {Object} ServiceOptions
- * @property {string} [logLevel] - Initial log level for the service
- * @property {number} [shutdownTimeout=5000] - Timeout for graceful shutdown
- */
-
-/**
- * Options for stopping a service
- *
- * @typedef {Object} StopOptions
- * @property {number} [timeout] - Override shutdown timeout
- * @property {boolean} [force=false] - Force stop even if timeout exceeded
- */
-
-/**
- * Health status returned by service health checks
- *
- * @typedef {Object} HealthStatus
- * @property {string} name - Service name
- * @property {string} state - Current service state
- * @property {boolean} healthy - Whether the service is healthy
- * @property {string} [error] - Error message if unhealthy
- * @property {string} [checkError] - Error from health check itself
- * @property {*} [key] - Additional health check properties
- */
-
-/**
- * Base class interface that services must implement
- *
- * @typedef {Object} ServiceInstance
- * @property {string} name - Service name
- * @property {string} state - Current state
- * @property {boolean} healthy - Health status
- * @property {Error|null} error - Last error
- * @property {import('../../../logging/internal/unified-logger').Logger} logger - Service logger
- * @property {(config?: *) => Promise<boolean>} initialize
- * @property {() => Promise<boolean>} start
- * @property {(options?: StopOptions) => Promise<boolean>} stop
- * @property {() => Promise<boolean>} recover
- * @property {() => Promise<boolean>} destroy
- * @property {() => Promise<HealthStatus>} getHealth
- * @property {(level: string) => boolean} setLogLevel
- * @property {(event: string, handler: Function) => Function} on
- * @property {(event: string, data: any) => boolean} emit
- */
-
-// ============================================================================
-// INTERNAL TYPES
-// ============================================================================
-
-/**
- * @typedef {Object} StateChangeEvent
- * @property {string} service - Service name (added by ServiceManager)
- * @property {string} oldState - Previous state
- * @property {string} newState - New state
- */
-
-/**
- * @typedef {Object} HealthChangeEvent
- * @property {string} service - Service name (added by ServiceManager)
- * @property {boolean} healthy - Current health status
- * @property {boolean} [wasHealthy] - Previous health status
- */
-
-/**
- * Event emitted when service encounters an error
- *
- * @typedef {Object} ServiceErrorEvent
- * @property {string} service - Service name
- * @property {string} operation - Operation that failed
- * @property {Error} error - Error that occurred
- */
-
-export {};
+/**
+ * @fileoverview Type definitions for ServiceBase class.
+ * 
+ * This file contains all TypeScript/JSDoc type definitions used by
+ * the ServiceBase class and service implementations.
+ * 
+ * @example
+ * // In your service implementation
+ * import { ServiceBase } from './ServiceBase.js';
+ * 
+ * class MyService extends ServiceBase {
+ *   async _init(config) {
+ *   }
+ *   
+ *   async _healthCheck() {
+ *     // Return type is HealthStatus
+ *     return { latency: 10 };
+ *   }
+ * }
+ */
+
+// ============================================================================
+// PUBLIC TYPES
+// ============================================================================
+
+/**
+ * Options for creating a service instance
+ *
+ * @typedef {Object} ServiceOptions
+ * @property {string} [logLevel] - Initial log level for the service
+ * @property {number} [shutdownTimeout=5000] - Timeout for graceful shutdown
+ */
+
+/**
+ * Options for stopping a service
+ *
+ * @typedef {Object} StopOptions
+ * @property {number} [timeout] - Override shutdown timeout
+ * @property {boolean} [force=false] - Force stop even if timeout exceeded
+ */
+
+/**
+ * Health status returned by service health checks
+ *
+ * @typedef {Object} HealthStatus
+ * @property {string} name - Service name
+ * @property {string} state - Current service state
+ * @property {boolean} healthy - Whether the service is healthy
+ * @property {string} [error] - Error message if unhealthy
+ * @property {string} [checkError] - Error from health check itself
+ * @property {*} [key] - Additional health check properties
+ */
+
+/**
+ * Base class interface that services must implement
+ *
+ * @typedef {Object} ServiceInstance
+ * @property {string} name - Service name
+ * @property {string} state - Current state
+ * @property {boolean} healthy - Health status
+ * @property {Error|null} error - Last error
+ * @property {import('../../../logging/internal/unified-logger').Logger} logger - Service logger
+ * @property {(config?: *) => Promise<boolean>} initialize
+ * @property {() => Promise<boolean>} start
+ * @property {(options?: StopOptions) => Promise<boolean>} stop
+ * @property {() => Promise<boolean>} recover
+ * @property {() => Promise<boolean>} destroy
+ * @property {() => Promise<HealthStatus>} getHealth
+ * @property {(level: string) => boolean} setLogLevel
+ * @property {(event: string, handler: Function) => Function} on
+ * @property {(event: string, data: any) => boolean} emit
+ */
+
+// ============================================================================
+// INTERNAL TYPES
+// ============================================================================
+
+/**
+ * @typedef {Object} StateChangeEvent
+ * @property {string} service - Service name (added by ServiceManager)
+ * @property {string} oldState - Previous state
+ * @property {string} newState - New state
+ */
+
+/**
+ * @typedef {Object} HealthChangeEvent
+ * @property {string} service - Service name (added by ServiceManager)
+ * @property {boolean} healthy - Current health status
+ * @property {boolean} [wasHealthy] - Previous health status
+ */
+
+/**
+ * Event emitted when service encounters an error
+ *
+ * @typedef {Object} ServiceErrorEvent
+ * @property {string} service - Service name
+ * @property {string} operation - Operation that failed
+ * @property {Error} error - Error that occurred
+ */
+
+export {};