@hkdigital/lib-sveltekit 0.2.11 → 0.2.13

package/dist/classes/services/ServiceBase.d.ts

@@ -1,147 +1,149 @@
 /**
- * Base class for all services
+ * @typedef {import('./typedef.js').ServiceConfig} ServiceConfig
+ * @typedef {import('./typedef.js').ServiceOptions} ServiceOptions
+ * @typedef {import('./typedef.js').StopOptions} StopOptions
+ * @typedef {import('./typedef.js').HealthStatus} HealthStatus
+ * @typedef {import('./typedef.js').StateChangeEvent} StateChangeEvent
+ * @typedef {import('./typedef.js').HealthChangeEvent} HealthChangeEvent
+ * @typedef {import('./typedef.js').ServiceErrorEvent} ServiceErrorEvent
  */
-export default class ServiceBase {
+/**
+ * Base class for all services with lifecycle management
+ * @extends EventEmitter
+ */
+export class ServiceBase extends EventEmitter {
     /**
-     * Create a new service
+     * Create a new service instance
      *
      * @param {string} name - Service name
-     * @param {Object} [options] - Service options
-     * @param {string} [options.logLevel=INFO] - Initial log level
-     */
-    constructor(name: string, options?: {
-        logLevel?: string;
-    });
-    /**
-     * Service name
-     * @type {string}
+     * @param {ServiceOptions} [options={}] - Service options
      */
+    constructor(name: string, options?: ServiceOptions);
+    /** @type {string} */
     name: string;
-    /**
-     * Event emitter for service events
-     * @type {EventEmitter}
-     */
-    events: EventEmitter;
-    /**
-     * Current service state
-     * @type {string}
-     */
+    /** @type {string} */
     state: string;
-    /**
-     * Last error that occurred
-     * @type {Error|null}
-     */
+    /** @type {boolean} */
+    healthy: boolean;
+    /** @type {Error|null} */
     error: Error | null;
-    /**
-     * Last stable state before error
-     * @type {string|null}
-     * @private
-     */
-    private _preErrorState;
-    /**
-     * Service logger
-     * @type {Logger}
-     */
+    /** @type {Logger} */
     logger: Logger;
+    /** @private @type {number} */
+    private _shutdownTimeout;
     /**
-     * Set the service log level
+     * Initialize the service with configuration
      *
-     * @param {string} level - New log level
-     * @returns {boolean} True if level was set, false if invalid
-     */
-    setLogLevel(level: string): boolean;
-    /**
-     * Initialize the service
+     * @param {ServiceConfig} [config={}] - Service-specific configuration
      *
-     * @param {Object} [config] - Service configuration
-     * @returns {Promise<boolean>} True if initialized successfully
+     * @returns {Promise<boolean>} True if initialization succeeded
      */
-    initialize(config?: any): Promise<boolean>;
+    initialize(config?: ServiceConfig): Promise<boolean>;
     /**
      * Start the service
      *
-     * @returns {Promise<boolean>} True if started successfully
+     * @returns {Promise<boolean>} True if the service started successfully
      */
     start(): Promise<boolean>;
     /**
-     * Stop the service
+     * Stop the service with optional timeout
      *
-     * @returns {Promise<boolean>} True if stopped successfully
+     * @param {StopOptions} [options={}] - Stop options
+     *
+     * @returns {Promise<boolean>} True if the service stopped successfully
      */
-    stop(): Promise<boolean>;
+    stop(options?: StopOptions): Promise<boolean>;
     /**
-     * Recover the service
+     * Recover the service from error state
      *
-     * @returns {Promise<boolean>} True if stopped successfully
+     * @returns {Promise<boolean>} True if recovery succeeded
      */
     recover(): Promise<boolean>;
     /**
-     * Destroy the service
+     * Destroy the service and cleanup resources
      *
-     * @returns {Promise<boolean>} True if destroyed successfully
+     * @returns {Promise<boolean>} True if destruction succeeded
      */
     destroy(): Promise<boolean>;
     /**
-     * Add an event listener
+     * Get the current health status of the service
      *
-     * @param {string} eventName - Event name
-     * @param {Function} handler - Event handler
-     * @returns {Function} Unsubscribe function
+     * @returns {Promise<HealthStatus>} Health status object
      */
-    on(eventName: string, handler: Function): Function;
+    getHealth(): Promise<HealthStatus>;
     /**
-     * Emit an event
+     * Set the service log level
      *
-     * @param {string} eventName - Event name
-     * @param {*} data - Event data
-     * @returns {boolean} True if event had listeners
+     * @param {string} level - New log level
+     *
+     * @returns {boolean} True if the level was set successfully
      */
-    emit(eventName: string, data: any): boolean;
+    setLogLevel(level: string): boolean;
     /**
-     * Initialize the service (to be overridden)
+     * Initialize the service (override in subclass)
      *
      * @protected
-     * @param {Object} config - Service configuration
+     * @param {ServiceConfig} config - Service configuration
+     *
      * @returns {Promise<void>}
      */
-    protected _init(config: any): Promise<void>;
+    protected _init(config: ServiceConfig): Promise<void>;
     /**
-     * Start the service (to be overridden)
+     * Start the service (override in subclass)
      *
      * @protected
+     *
      * @returns {Promise<void>}
      */
     protected _start(): Promise<void>;
     /**
-     * Stop the service (to be overridden)
+     * Stop the service (override in subclass)
      *
      * @protected
+     *
      * @returns {Promise<void>}
      */
     protected _stop(): Promise<void>;
     /**
-     * Destroy the service (to be overridden)
+     * Destroy the service (optional override)
      *
      * @protected
+     *
      * @returns {Promise<void>}
      */
     protected _destroy(): Promise<void>;
     /**
-     * Recover the service from an error (to be overridden)
+     * Recover from error state (optional override)
      *
      * @protected
+     *
      * @returns {Promise<void>}
      */
     protected _recover(): Promise<void>;
     /**
-     * Set the service state
+     * Perform health check (optional override)
+     *
+     * @protected
+     *
+     * @returns {Promise<Object>} Additional health information
+     */
+    protected _healthCheck(): Promise<any>;
+    /**
+     * Set the service state and emit event
      *
      * @private
-     * @param {string} state - New state
+     * @param {string} newState - New state value
      */
     private _setState;
     /**
-     * Set an error state
+     * Set the health status and emit event if changed
+     *
+     * @private
+     * @param {boolean} healthy - New health status
+     */
+    private _setHealthy;
+    /**
+     * Set error state and emit error event
      *
      * @private
      * @param {string} operation - Operation that failed
@@ -149,5 +151,13 @@ export default class ServiceBase {
      */
     private _setError;
 }
+export default ServiceBase;
+export type ServiceConfig = import("./typedef.js").ServiceConfig;
+export type ServiceOptions = import("./typedef.js").ServiceOptions;
+export type StopOptions = import("./typedef.js").StopOptions;
+export type HealthStatus = import("./typedef.js").HealthStatus;
+export type StateChangeEvent = import("./typedef.js").StateChangeEvent;
+export type HealthChangeEvent = import("./typedef.js").HealthChangeEvent;
+export type ServiceErrorEvent = import("./typedef.js").ServiceErrorEvent;
 import { EventEmitter } from '../events';
 import { Logger } from '../logging';