@hkdigital/lib-sveltekit 0.2.13 → 0.2.14

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

@@ -0,0 +1,4 @@
+export { default as ServiceBase } from "./ServiceBase.js";
+export { default as ServiceManager } from "./ServiceManager.js";
+export * from "./service-states.js";
+export * from "./typedef.js";

package/dist/classes/services/index.js

@@ -0,0 +1,5 @@
+export { default as ServiceBase } from './ServiceBase.js';
+export { default as ServiceManager } from './ServiceManager.js';
+
+export * from './service-states.js';
+export * from './typedef.js';

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

@@ -1,40 +1,12 @@
 /**
- * //
+ * Service configuration object passed to service initialization
  */
-export type ServiceConfig = import("./typedef.js").ServiceConfig;
-/**
- * class MyService extends ServiceBase {
- *   async _init(config) {
- *     // config is typed as ServiceConfig
- *   }
- *
- *   async _healthCheck() {
- *     // Return type is HealthStatus
- *     return { latency: 10 };
- *   }
- * }
- */
-export type HealthStatus = import("./typedef.js").HealthStatus;
-/**
- * //
- */
-export type ServiceManagerConfig = import("./typedef.js").ServiceManagerConfig;
-/**
- * const config = {
- *   environment: 'development',
- *   stopTimeout: 5000
- * };
- *
- * const manager = new ServiceManager(config);
- *
- * const options = {
- *   dependencies: ['database'],
- *   tags: ['critical']
- * };
- *
- * manager.register('auth', AuthService, {}, options);
- */
-export type ServiceRegistrationOptions = import("./typedef.js").ServiceRegistrationOptions;
+export type ServiceConfig = {
+    /**
+     * - Service-specific configuration properties
+     */
+    key?: any;
+};
 /**
  * Options for creating a service instance
  */
@@ -61,6 +33,35 @@ export type StopOptions = {
      */
     force?: boolean;
 };
+/**
+ * Health status returned by service health checks
+ */
+export type HealthStatus = {
+    /**
+     * - Service name
+     */
+    name: string;
+    /**
+     * - Current service state
+     */
+    state: string;
+    /**
+     * - Whether the service is healthy
+     */
+    healthy: boolean;
+    /**
+     * - Error message if unhealthy
+     */
+    error?: string;
+    /**
+     * - Error from health check itself
+     */
+    checkError?: string;
+    /**
+     * - Additional health check properties
+     */
+    key?: any;
+};
 /**
  * Event emitted when service state changes
  */
@@ -112,6 +113,48 @@ export type ServiceErrorEvent = {
  * Service class constructor type
  */
 export type ServiceConstructor = new (name: string, options?: ServiceOptions) => ServiceBase;
+/**
+ * Options for registering a service
+ */
+export type ServiceRegistrationOptions = {
+    /**
+     * - Services this service depends on
+     */
+    dependencies?: string[];
+    /**
+     * - Tags for grouping services
+     */
+    tags?: string[];
+    /**
+     * - Startup priority (higher starts first)
+     */
+    priority?: number;
+};
+/**
+ * Configuration for ServiceManager
+ */
+export type ServiceManagerConfig = {
+    /**
+     * - Runtime environment
+     */
+    environment?: string;
+    /**
+     * - Auto-start services on registration
+     */
+    autoStart?: boolean;
+    /**
+     * - Default timeout for stopping services
+     */
+    stopTimeout?: number;
+    /**
+     * - Initial log level for ServiceManager
+     */
+    logLevel?: string;
+    /**
+     * - Logging configuration
+     */
+    logConfig?: LogConfig;
+};
 /**
  * Logging configuration
  */
@@ -168,7 +211,7 @@ export type ServiceEntry = {
  * Result of health check for all services
  */
 export type HealthCheckResult = {
-    [x: string]: any;
+    [x: string]: HealthStatus;
 };
 /**
  * Base class interface that services must implement
@@ -193,7 +236,7 @@ export type ServiceBase = {
     /**
      * - Service logger
      */
-    logger: Logger;
+    logger: import("../logging").Logger;
     initialize: (config?: ServiceConfig) => Promise<boolean>;
     start: () => Promise<boolean>;
     stop: (options?: StopOptions) => Promise<boolean>;

package/dist/classes/services/typedef.js

@@ -9,8 +9,8 @@
  * // In your service implementation
  * import { ServiceBase } from './ServiceBase.js';
  * 
- * // @typedef {import('./typedef.js').ServiceConfig} ServiceConfig
- * // @typedef {import('./typedef.js').HealthStatus} HealthStatus
+ * // @ typedef {import('./typedef.js').ServiceConfig} ServiceConfig
+ * // @ typedef {import('./typedef.js').HealthStatus} HealthStatus
  * 
  * class MyService extends ServiceBase {
  *   async _init(config) {
@@ -27,8 +27,8 @@
  * // When using ServiceManager
  * import { ServiceManager } from './ServiceManager.js';
  * 
- * // @typedef {import('./typedef.js').ServiceManagerConfig} ServiceManagerConfig
- * // @typedef {import('./typedef.js').ServiceRegistrationOptions} ServiceRegistrationOptions
+ * // @ typedef {import('./typedef.js').ServiceManagerConfig} ServiceManagerConfig
+ * // @ typedef {import('./typedef.js').ServiceRegistrationOptions} ServiceRegistrationOptions
  * 
  * const config = {
  *   environment: 'development',
@@ -48,7 +48,7 @@
 /**
  * Service configuration object passed to service initialization
  * @typedef {Object} ServiceConfig
- * @property {*} [*] - Service-specific configuration properties
+ * @property {*} [key] - Service-specific configuration properties
  */
 
 /**
@@ -73,7 +73,7 @@
  * @property {boolean} healthy - Whether the service is healthy
  * @property {string} [error] - Error message if unhealthy
  * @property {string} [checkError] - Error from health check itself
- * @property {*} [*] - Additional health check properties
+ * @property {*} [key] - Additional health check properties
  */
 
 /**
@@ -154,7 +154,7 @@
  * @property {string} state - Current state
  * @property {boolean} healthy - Health status
  * @property {Error|null} error - Last error
- * @property {Logger} logger - Service logger
+ * @property {import('../logging').Logger} logger - Service logger
  * @property {(config?: ServiceConfig) => Promise<boolean>} initialize
  * @property {() => Promise<boolean>} start
  * @property {(options?: StopOptions) => Promise<boolean>} stop

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@hkdigital/lib-sveltekit",
-	"version": "0.2.13",
+	"version": "0.2.14",
 	"author": {
 		"name": "HKdigital",
 		"url": "https://hkdigital.nl"