@hkdigital/lib-core 0.3.3 → 0.3.5

package/dist/classes/services/typedef.js

@@ -1,179 +0,0 @@
-/**
- * @fileoverview Type definitions for the service management system.
- * 
- * This file contains all TypeScript/JSDoc type definitions used throughout
- * the service management system. Import these types in your service
- * implementations and when using the ServiceManager.
- * 
- * @example
- * // In your service implementation
- * import { ServiceBase } from './ServiceBase.js';
- * 
- * // @ typedef {import('./typedef.js').ServiceConfig} ServiceConfig
- * // @ typedef {import('./typedef.js').HealthStatus} HealthStatus
- * 
- * class MyService extends ServiceBase {
- *   async _init(config) {
- *     // config is typed as ServiceConfig
- *   }
- *   
- *   async _healthCheck() {
- *     // Return type is HealthStatus
- *     return { latency: 10 };
- *   }
- * }
- * 
- * @example
- * // When using ServiceManager
- * import { ServiceManager } from './ServiceManager.js';
- * 
- * // @ typedef {import('./typedef.js').ServiceManagerConfig} ServiceManagerConfig
- * // @ typedef {import('./typedef.js').ServiceRegistrationOptions} ServiceRegistrationOptions
- * 
- * const config = {
- *   environment: 'development',
- *   stopTimeout: 5000
- * };
- * 
- * const manager = new ServiceManager(config);
- * 
- * const options = {
- *   dependencies: ['database'],
- *   tags: ['critical']
- * };
- * 
- * manager.register('auth', AuthService, {}, options);
- */
-
-/**
- * Service configuration object passed to service initialization
- *
- * @typedef {Object} ServiceConfig
- * @property {*} [key] - Service-specific configuration properties
- */
-
-/**
- * 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
- */
-
-/**
- * @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
- */
-
-/**
- * Service class constructor type
- *
- * @typedef {new (name: string, options?: ServiceOptions) => ServiceInstance} ServiceConstructor
- */
-
-/**
- * Options for registering a service
- *
- * @typedef {Object} ServiceRegistrationOptions
- * @property {string[]} [dependencies=[]] - Services this service depends on
- * @property {string[]} [tags=[]] - Tags for grouping services
- * @property {number} [priority=0] - Startup priority (higher starts first)
- */
-
-/**
- * Configuration for ServiceManager
- *
- * @typedef {Object} ServiceManagerConfig
- * @property {boolean} [debug=false] - Debug mode switch
- * @property {boolean} [autoStart=false] - Auto-start services on registration
- * @property {number} [stopTimeout=10000] - Default timeout for stopping services
- * @property {string} [logLevel] - Initial log level for ServiceManager
- * @property {LogConfig} [logConfig={}] - Logging configuration
- */
-
-/**
- * Logging configuration
- *
- * @typedef {Object} LogConfig
- * @property {string} [defaultLevel] - Default log level for services
- * @property {string} [globalLevel] - Override level for all services
- * @property {Object<string, string>} [serviceLevels] - Per-service log levels
- */
-
-/**
- * Internal service registry entry
- *
- * @typedef {Object} ServiceEntry
- * @property {ServiceConstructor} ServiceClass - Service class constructor
- * @property {ServiceInstance|null} instance - Service instance (lazy-created)
- * @property {ServiceConfig} config - Service configuration
- * @property {string[]} dependencies - Service dependencies
- * @property {Set<string>} dependents - Services that depend on this one
- * @property {string[]} tags - Service tags
- * @property {number} priority - Startup priority
- */
-
-/**
- * Result of health check for all services
- * @typedef {Object<string, HealthStatus>} HealthCheckResult
- */
-
-/**
- * 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').Logger} logger - Service logger
- * @property {(config?: ServiceConfig) => 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
- */
-
-export {};

package/dist/features/index.d.ts

@@ -1,11 +0,0 @@
-export { default as ButtonGroup } from "./button-group/ButtonGroup.svelte";
-export { default as CompareLeftRight } from "./compare-left-right/CompareLeftRight.svelte";
-export { default as GameBox } from "./game-box/GameBox.svelte";
-export { default as HkAppLayout } from "./hk-app-layout/HkAppLayout.svelte";
-export { default as ImageBox } from "./image-box/ImageBox.svelte";
-export { default as Presenter } from "./presenter/Presenter.svelte";
-export { default as ImageSlide } from "./presenter/ImageSlide.svelte";
-export { default as VirtualViewport } from "./virtual-viewport/VirtualViewport.svelte";
-export * from "./button-group/typedef.js";
-export * from "./presenter/typedef.js";
-export { createOrGetState as createOrGetAppLayoutState, createState as createAppLayoutState, getState as getAppLayoutState } from "./hk-app-layout/HkAppLayout.state.svelte.js";

package/dist/features/index.js

@@ -1,23 +0,0 @@
-export { default as ButtonGroup } from './button-group/ButtonGroup.svelte';
-export { default as CompareLeftRight } from './compare-left-right/CompareLeftRight.svelte';
-export { default as GameBox } from './game-box/GameBox.svelte';
-
-export {
-  createOrGetState as createOrGetAppLayoutState,
-  createState as createAppLayoutState,
-  getState as getAppLayoutState
-} from './hk-app-layout/HkAppLayout.state.svelte.js';
-
-export { default as HkAppLayout } from './hk-app-layout/HkAppLayout.svelte';
-
-export { default as ImageBox } from './image-box/ImageBox.svelte';
-
-export { default as Presenter } from './presenter/Presenter.svelte';
-export { default as ImageSlide } from './presenter/ImageSlide.svelte';
-
-export { default as VirtualViewport } from './virtual-viewport/VirtualViewport.svelte';
-
-// > Types
-
-export * from './button-group/typedef.js';
-export * from './presenter/typedef.js';

package/dist/logging/constants.d.ts

@@ -1 +0,0 @@
-export * from "../classes/logging/constants.js";

package/dist/logging/constants.js

@@ -1 +0,0 @@
-export * from '../classes/logging/constants.js';

package/dist/server/index.d.ts

@@ -1 +0,0 @@
-export * from "./logger.js";

package/dist/server/index.js

@@ -1 +0,0 @@
-export * from './logger.js';

package/dist/server/logger.d.ts

@@ -1,25 +0,0 @@
-export type LoggerContext = {
-    route?: {
-        id: string;
-    };
-    componentName?: string;
-};
-export type ExtendedLogger = pino.Logger & LoggerExtension;
-export type LoggerExtension = {
-    context: (context: LoggerContext) => ExtendedLogger;
-};
-/**
- * @typedef {object} LoggerContext
- * @property {{ id: string }} [route]
- * @property {string} [componentName]
- */
-/**
- * @typedef {pino.Logger & LoggerExtension} ExtendedLogger
- */
-/**
- * @typedef {Object} LoggerExtension
- * @property {( context: LoggerContext )=> ExtendedLogger} context
- */
-/** @type {pino.Logger & LoggerExtension} */
-export const logger: pino.Logger & LoggerExtension;
-import pino from 'pino';

package/dist/server/logger.js

@@ -1,94 +0,0 @@
-/**
- * @example
- *
- * import { logger } from './logger.js';
- *
- * logger.info('Hello there!');
- * logger.info( { a: 1, b: 2 }, 'Test vars');
- *
- * export function load({ route }) {
- *   logger.context({route}).info('Log');
- * }
- *
- * @note
- * Set a 'handleError' hook to log errors captured by svelte
- *
- * // hooks.server.js
- * export const handleError = ({ status, error, message }) => {
- *	  if (status !== 404) {
- *		  logger.error(error);
- *	  }
- *
- *	  // do not return sensitive data here as it will be sent to the client
- * 	  return { message };
- *  };
- *
- * @see https://kit.svelte.dev/docs/hooks#shared-hooks-handleerror
- * @see https://stolthq.com/blog/structured-logging-sveltekit
- */
-
-import pino from 'pino';
-import { dev } from '$app/environment';
-
-// import { browser, building, dev, version } from '$app/environment';
-
-// > Setup
-
-/** @type {pino.LoggerOptions} */
-let options = {};
-
-if (dev) {
-	options = {
-		level: 'debug',
-		transport: {
-			target: 'pino-pretty',
-			options: {
-				colorize: true
-			}
-		}
-	};
-}
-
-// > Exports
-
-// ?? function routeLogger( ... )
-
-/**
- * @typedef {object} LoggerContext
- * @property {{ id: string }} [route]
- * @property {string} [componentName]
- */
-
-/**
- * @typedef {pino.Logger & LoggerExtension} ExtendedLogger
- */
-
-/**
- * @typedef {Object} LoggerExtension
- * @property {( context: LoggerContext )=> ExtendedLogger} context
- */
-
-/** @type {pino.Logger & LoggerExtension} */
-// @ts-ignore
-const logger = pino(options);
-
-Object.assign(logger, {
-	/**
-	 * @param {LoggerContext} _
-	 *
-	 * @returns {pino.Logger}
-	 */
-	context({ route, componentName }) {
-		if (route) {
-			// @ts-ignore
-			return this.child({ route: route.id });
-		} else if (componentName) {
-			// @ts-ignore
-			return this.child({ componentName });
-		} else {
-			throw new Error(`Missing input parameter`);
-		}
-	}
-});
-
-export { logger };