@kronos-integration/service 15.5.4 → 15.6.0

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@kronos-integration/service",
-  "version": "15.5.4",
+  "version": "15.6.0",
   "publishConfig": {
     "access": "public",
     "provenance": true
   },
-  "packageManager": "npm@11.10.0",
+  "packageManager": "npm@11.16.0",
   "types": "./types/module.d.mts",
   "exports": {
     ".": {
@@ -26,32 +26,33 @@
   ],
   "license": "0BSD",
   "scripts": {
-    "prepare": "node --run prepare:typescript",
-    "prepare:typescript": "tsc --allowJs --declaration --emitDeclarationOnly --declarationDir types --resolveJsonModule --target esnext -m esnext --module nodenext --moduleResolution nodenext --rootDir src ./src**/*.mjs",
     "test": "node --run test:ava",
     "test:ava": "ava --timeout 4m tests/*-ava.mjs tests/*-ava-node.mjs",
     "cover": "c8 -x 'tests/**/*' --temp-directory build/tmp ava --timeout 4m tests/*-ava.mjs tests/*-ava-node.mjs && c8 report -r lcov -o build/coverage --temp-directory build/tmp",
     "docs": "documentation readme --section=API ./src**/*.mjs",
-    "lint": "node --run lint:docs && node --run lint:typescript",
-    "lint:docs": "documentation lint ./src**/*.mjs",
-    "lint:typescript": "tsc --allowJs --checkJs --noEmit --resolveJsonModule --target esnext -m esnext --module nodenext --moduleResolution nodenext ./src**/*.mjs"
+    "lint": "node --run lint:docs",
+    "lint:docs": "documentation lint ./src**/*.mjs"
   },
   "dependencies": {
-    "@kronos-integration/endpoint": "^11.0.25",
-    "@kronos-integration/interceptor": "^13.1.30",
+    "@kronos-integration/endpoint": "^11.1.2",
+    "@kronos-integration/interceptor": "^13.2.2",
     "loglevel-mixin": "^7.2.11",
-    "pacc": "^9.2.6",
+    "pacc": "^9.2.13",
     "statetransition-mixin": "^8.1.4"
   },
   "devDependencies": {
-    "ava": "^7.0.0",
+    "ava": "^8.0.1",
     "c8": "^11.0.0",
     "documentation": "^14.0.3",
-    "semantic-release": "^25.0.3",
-    "typescript": "^5.9.3"
+    "semantic-release": "^25.0.3"
+  },
+  "overrides": {
+    "c8": {
+      "yargs": "^18.0.0"
+    }
   },
   "engines": {
-    "node": ">=24.13.1"
+    "node": ">=26.1.0"
   },
   "repository": {
     "type": "git",
@@ -64,8 +65,7 @@
   "template": {
     "inheritFrom": [
       "arlac77/template-arlac77-github",
-      "arlac77/template-kronos-component",
-      "arlac77/template-typescript"
+      "arlac77/template-kronos-component"
     ]
   }
 }

package/src/initialization-context.mjs

@@ -89,7 +89,7 @@ export const InitializationContext = LogLevelMixin(
           new DummyReceiveEndpoint(endpoint.name, endpoint.owner)
         );
 
-        this.addOutstandingEndpointConnection(endpoint, connected);
+      this.outstandingEndpointConnections.set(endpoint, connected);
       }
     }
 
@@ -114,15 +114,6 @@ export const InitializationContext = LogLevelMixin(
       }
     }
 
-    /**
-     *
-     * @param {Endpoint} endpoint
-     * @param {string} connected
-     */
-    addOutstandingEndpointConnection(endpoint, connected) {
-      this.outstandingEndpointConnections.set(endpoint, connected);
-    }
-
     /**
      * Resolve any outstanding centdpoint connections.
      */

package/types/endpoints-mixin.d.mts

@@ -1,7 +0,0 @@
-/**
- * Endpoint accessor mixin.
- * Manages endpoints in a container.
- * @param {new() => superclass} superclass class to be extended
- * @return {new() => superclass} extended class
- */
-export function EndpointsMixin(superclass: new () => new () => /*elided*/ any): new () => new () => /*elided*/ any;

package/types/initialization-context.d.mts

@@ -1,4 +0,0 @@
-/**
- * Keeps track of all in flight object creations and loose ends during config initialization.
- */
-export const InitializationContext: any;

package/types/module.d.mts

@@ -1,8 +0,0 @@
-export * from "./service.mjs";
-export * from "./service-logger.mjs";
-export * from "./service-config.mjs";
-export * from "./service-provider-mixin.mjs";
-export * from "./endpoints-mixin.mjs";
-export * from "./standalone-service-provider.mjs";
-export * from "./service-consumer-mixin.mjs";
-export * from "./initialization-context.mjs";

package/types/service-config.d.mts

@@ -1,41 +0,0 @@
-/**
- * Merge from b into a.
- * When *a* and *b* are arrays of values only the none duplicates are appendend to *a*.
- * @param {any} a
- * @param {any} b
- * @return {any} merged b into a
- */
-export function merge(a: any, b: any): any;
-/**
- * Config providing service.
- * Dispatches config requests to services.
- * Also preserves them until a maching service becomes avaliable.
- * @property {Map<string,Object>} preservedConfigs values for services not already established
- */
-export class ServiceConfig extends Service {
-    preservedConfigs: Map<any, any>;
-    /**
-     * Deliver configuration for a given service.
-     * @param {string} name service name
-     * @param {Object} config
-     * @returns {Promise<Object>}
-     */
-    configFor(name: string, config: any): Promise<any>;
-    /**
-     * Forget about preserved config of a service.
-     * @param {string} name service name
-     */
-    clearPreserved(name: string): void;
-    /**
-     * Set config entry.
-     * @param {string} key path to the value
-     * @param {any} value
-     */
-    configureValue(key: string, value: any): Promise<void>;
-    /**
-     *
-     * @param {Array|Object} config
-     */
-    configure(config: any[] | any): Promise<void>;
-}
-import { Service } from "./service.mjs";

package/types/service-consumer-mixin.d.mts

@@ -1,8 +0,0 @@
-/**
- * Assign services based on a configuration.
- * @param {Object} target object
- * @param {Object} config service defintion
- * @param {Object} provider service provider
- * @param {boolean} waitUntilFactoryPresent
- */
-export function defineServiceConsumerProperties(target: any, config: any, provider: any, waitUntilFactoryPresent: boolean): Promise<any[]>;

package/types/service-logger.d.mts

@@ -1,14 +0,0 @@
-/**
- * Log receiving service.
- */
-export class ServiceLogger extends Service {
-    /**
-     *
-     * @param {Object} entry
-     * @param {string} entry.severity
-     */
-    logEntry(entry: {
-        severity: string;
-    }): Promise<void>;
-}
-import { Service } from "./service.mjs";

package/types/service-provider-mixin.d.mts

@@ -1,168 +0,0 @@
-/**
- * Provide services and hold service configuration.
- * By default a service provider has two build in services
- * 'logger' and 'config'.
- *
- * @param {typeof Service} superclass
- * @param {typeof ServiceLogger} serviceLoggerClass where the logging houtd go
- * @param {typeof ServiceConfig} serviceConfigClass where the config comes from
- */
-export function ServiceProviderMixin(superclass: typeof Service, serviceLoggerClass?: typeof ServiceLogger, serviceConfigClass?: typeof ServiceConfig): {
-    new (config: any, ic?: any): {
-        new (): new () => /*elided*/ any;
-        listeners: {};
-        interceptorFactories: {};
-        serviceFactories: {};
-        /** @typedef {Object} */ services: {};
-        ic: any;
-        /**
-         *
-         * @param {string} name
-         * @param  {...any} args
-         */
-        emit(name: string, ...args: any[]): void;
-        addListener(name: any, listener: any): void;
-        removeListener(name: any, listener: any): void;
-        /**
-         * By default be our own owner.
-         * @return this
-         */
-        get owner(): /*elided*/ any;
-        /**
-         * We are the service provider.
-         * @return {boolean} true
-         */
-        get isServiceProvider(): boolean;
-        serviceInfo(): any;
-        /**
-         * Register service or interceptor factories.
-         *
-         * @param {[typeof Service|string]} factories
-         */
-        registerFactories(factories: [typeof Service | string]): Promise<void>;
-        /**
-         * Registers a interceptor factory for later use by
-         * @see {instantiateInterceptor}.
-         *
-         * @param {typeof Interceptor} factory
-         * @returns {typeof Interceptor} factory
-         */
-        registerInterceptorFactory(factory: typeof Interceptor): typeof Interceptor;
-        /**
-         *
-         * @param {typeof Interceptor} factory
-         */
-        unregisterInterceptorFactory(factory: typeof Interceptor): void;
-        /**
-         * Instanciates an interceptor from its definition data.
-         * @see {interceptorFactories}
-         * @param {Object} definition data
-         * @returns {Interceptor|undefined}
-         */
-        instantiateInterceptor(definition: any): Interceptor | undefined;
-        /**
-         *
-         * @param {Service} service
-         * @param {string} oldState
-         * @param {string} newState
-         */
-        serviceStateChanged(service: Service, oldState: string, newState: string): void;
-        /**
-         *
-         * @param {typeof Service} factory
-         * @returns {Promise<typeof Service>}
-         */
-        registerServiceFactory(factory: typeof Service): Promise<typeof Service>;
-        /**
-         *
-         * @param {typeof Service} factory
-         * @returns {Promise<any>}
-         */
-        unregisterServiceFactory(factory: typeof Service): Promise<any>;
-        /**
-         *
-         * @param {Service} service
-         * @returns {Promise<Service>}
-         */
-        registerService(service: Service): Promise<Service>;
-        /**
-         *
-         * @param {string} serviceName
-         * @returns {Promise<any>}
-         */
-        unregisterService(serviceName: string): Promise<any>;
-        get serviceNames(): string[];
-        /**
-         *
-         * @param {string} name
-         * @returns {Service|undefined}
-         */
-        getService(name: string): Service | undefined;
-        /**
-         *
-         * @param {Object} config
-         * @param {string} config.name
-         * @returns {Promise<Service>}
-         */
-        declareService(config: {
-            name: string;
-        }): Promise<Service>;
-        /**
-         * Add a new service based on its configuration.
-         * If a service for the name is already present and it has a matching type
-         * then its configure() is called and returned.
-         * Otherwise a new service will be created eventually replacing an already existing service with the same name.
-         * @param {object} configs with
-         *     name - the service name
-         *     type - the service factory name - defaults to config.name
-         * @return {Promise<Object>} resolving to the declared services
-         */
-        declareServices(configs: object): Promise<any>;
-        /**
-         * Start all registered services which hanving autostart set.
-         */
-        _start(): Promise<any[]>;
-        /**
-         * Stop all services.
-         * @return {Promise<any>} that resolves when all services are stopped
-         */
-        _stop(): Promise<any>;
-        "__#private@#description": any;
-        readonly attributes: any;
-        get type(): string;
-        description: any;
-        get extendetName(): string;
-        stateChanged(origin: any, oldState: string, newState: string): void;
-        stateTransitionRejection(rejected: any, newState: any): any;
-        rejectWrongState(action: string): Promise<void>;
-        timeoutForTransition(transition: any): number;
-        _restart(): Promise<any>;
-        restartIfRunning(): Promise<any>;
-        get toStringAttributes(): any;
-        toString(): string;
-        toJSON(): any;
-        toJSONWithOptions(options: {
-            includeRuntimeInfo: boolean;
-            includeDefaults: boolean;
-            includeName: boolean;
-            includeConfig: boolean;
-            includePrivate: boolean;
-        }): any;
-        get name(): string;
-        get autostart(): boolean;
-        _configure(config: any): Set<string>;
-        configure(config: any): Promise<undefined>;
-        getCredential(key: string): Promise<string | Uint8Array>;
-        getCredentials(filter?: Function): Promise<any>;
-        storePersistentCredentials(): Promise<undefined>;
-        log(level: string, arg: any): void;
-    };
-    attributes: any;
-    get endpoints(): any;
-    get description(): string;
-    get name(): string;
-};
-import { Service } from "./service.mjs";
-import { ServiceLogger } from "./service-logger.mjs";
-import { ServiceConfig } from "./service-config.mjs";
-import { Interceptor } from "@kronos-integration/interceptor";

package/types/service.d.mts

@@ -1,177 +0,0 @@
-declare const Service_base: new () => new () => /*elided*/ any;
-/**
- * Service
- * The initial state is 'stopped'.
- * All services have at least three endpoints:
- * - log _out_: log events
- * - config _in_: configuration request
- * - command _in_: administrative actions to be executed by the step
- *
- * @property {Object} endpoints
- */
-export class Service extends Service_base {
-    static get description(): string;
-    /**
-     * Meta information for the config attributes.
-     * - default optional default value of the attribute
-     * - needsRestart optional modification requires a service restart
-     * - setter(newValue,attribute) optional function to be used if simple value assignment is not enough
-     * The Service class only defines the logLevel, and start/stop/restart timeout attribute
-     * @return {Object}
-     */
-    static attributes: any;
-    /**
-     * Definition of the predefined endpoints.
-     * - log _out_
-     * - config _in_
-     * @return {Object} predefined endpoints
-     */
-    static get endpoints(): any;
-    /**
-     * @param {Object} config
-     * @param {string} [config.name]
-     * @param {string} [config.logLevel]
-     * @param {boolean} [config.autostart] defaults to false
-     * @param {string} [config.description] human readable description
-     * @param {Object} [config.endpoints] will be merged with the build in ones
-     * @param {InitializationContext} ic
-     */
-    constructor(config: {
-        name?: string;
-        logLevel?: string;
-        autostart?: boolean;
-        description?: string;
-        endpoints?: any;
-    }, ic: any);
-    owner: any;
-    instantiateInterceptor(options: any): any;
-    get attributes(): any;
-    get type(): string;
-    set description(desc: any);
-    get description(): any;
-    /**
-     * Used in human readable state messages.
-     * Besides the actual service name it may contain additional short hints.
-     * @return {string}
-     */
-    get extendetName(): string;
-    /**
-     * Called when the service state changes.
-     * Emits a serviceStateChanged event to the owner.
-     * @param {any} origin
-     * @param {string} oldState
-     * @param {string} newState
-     */
-    stateChanged(origin: any, oldState: string, newState: string): void;
-    stateTransitionRejection(rejected: any, newState: any): any;
-    /**
-     * Called when state transition is not allowed.
-     * @param {string} action originating action name
-     * @throws always
-     */
-    rejectWrongState(action: string): Promise<void>;
-    /**
-     * Deliver transition timeout.
-     * @param {Object} transition
-     * @return {number} milliseconds before throwing for a long running transition
-     */
-    timeoutForTransition(transition: any): number;
-    /**
-     * Opens all endpoint connections.
-     */
-    _start(): Promise<void>;
-    /**
-     * Closes all endpoint connections.
-     */
-    _stop(): Promise<void>;
-    /**
-     * Restart action.
-     * default implementation does a _stop() and a _start()
-     * @return {Promise<any>} fulfills after start
-     */
-    _restart(): Promise<any>;
-    /**
-     * Restarts if in running mode.
-     * Otherwise does nothing.
-     * @returns {Promise<any>} resolves when restart is done (or immediate if no restart triggered)
-     */
-    restartIfRunning(): Promise<any>;
-    /**
-     * Mapping of properties used in toString.
-     * @return {Object}
-     */
-    get toStringAttributes(): any;
-    /**
-     * Base service is not a provider.
-     * @return {boolean} false
-     */
-    get isServiceProvider(): boolean;
-    toJSON(): any;
-    /**
-     * Deliver json representation.
-     * @param {Object} options
-     * @param {boolean} options.includeRuntimeInfo include runtime informtion like state
-     * @param {boolean} options.includeDefaults include default endpoints
-     * @param {boolean} options.includeName include name of the service
-     * @param {boolean} options.includeConfig include config attributes
-     * @param {boolean} options.includePrivate include private config attributes
-     * @return {Object} json representation
-     */
-    toJSONWithOptions(options: {
-        includeRuntimeInfo: boolean;
-        includeDefaults: boolean;
-        includeName: boolean;
-        includeConfig: boolean;
-        includePrivate: boolean;
-    }): any;
-    /**
-     * Should we start when beeing registered.
-     * @return {boolean} false
-     */
-    get autostart(): boolean;
-    /**
-     * Takes attribute values from config parameters
-     * and copies them over to the object.
-     * Copying is done according to attributes.
-     * Which means we loop over all configuration attributes.
-     * and then for each attribute decide if we use the default, call a setter function
-     * or simply assign the attribute value.
-     * @param {Object} config
-     * @return {Set<string>} of modified attributes
-     */
-    _configure(config: any): Set<string>;
-    /**
-     * Use new configuration.
-     * Internally calls _configure(config) as the constructor does.
-     * If attribute with needsRestart are touched the restartIfRunning method
-     * will be called.
-     * @param {Object} config
-     * @return {Promise<undefined>} fillfills when config is applied
-     */
-    configure(config: any): Promise<undefined>;
-    /**
-     *
-     * @param {string} key
-     * @returns {Promise<string|Uint8Array>}
-     */
-    getCredential(key: string): Promise<string | Uint8Array>;
-    /**
-     * Retrieve all (filtered) credential attribute values.
-     * @param {Function} filter
-     * @returns {Promise<Object>}
-     */
-    getCredentials(filter?: Function): Promise<any>;
-    /**
-     * Load and store persistent credentials in the service attributes.
-     * @return {Promise<undefined>}
-     */
-    storePersistentCredentials(): Promise<undefined>;
-    /**
-     * Adds service name to the log event.
-     * @param {string} level the log level
-     * @param {Object} arg log content
-     */
-    log(level: string, arg: any): void;
-    #private;
-}
-export {};

package/types/standalone-service-provider.d.mts

@@ -1,74 +0,0 @@
-declare const StandaloneServiceProvider_base: {
-    new (config: any, ic?: any): {
-        new (): new () => /*elided*/ any;
-        listeners: {};
-        interceptorFactories: {};
-        serviceFactories: {};
-        services: {};
-        ic: any;
-        emit(name: string, ...args: any[]): void;
-        addListener(name: any, listener: any): void;
-        removeListener(name: any, listener: any): void;
-        get owner(): /*elided*/ any;
-        get isServiceProvider(): boolean;
-        serviceInfo(): any;
-        registerFactories(factories: [typeof Service | string]): Promise<void>;
-        registerInterceptorFactory(factory: typeof import("@kronos-integration/interceptor").Interceptor): typeof import("@kronos-integration/interceptor").Interceptor;
-        unregisterInterceptorFactory(factory: typeof import("@kronos-integration/interceptor").Interceptor): void;
-        instantiateInterceptor(definition: any): import("@kronos-integration/interceptor").Interceptor | undefined;
-        serviceStateChanged(service: Service, oldState: string, newState: string): void;
-        registerServiceFactory(factory: typeof Service): Promise<typeof Service>;
-        unregisterServiceFactory(factory: typeof Service): Promise<any>;
-        registerService(service: Service): Promise<Service>;
-        unregisterService(serviceName: string): Promise<any>;
-        get serviceNames(): string[];
-        getService(name: string): Service | undefined;
-        declareService(config: {
-            name: string;
-        }): Promise<Service>;
-        declareServices(configs: object): Promise<any>;
-        _start(): Promise<any[]>;
-        _stop(): Promise<any>;
-        "__#private@#description": any;
-        readonly attributes: any;
-        get type(): string;
-        description: any;
-        get extendetName(): string;
-        stateChanged(origin: any, oldState: string, newState: string): void;
-        stateTransitionRejection(rejected: any, newState: any): any;
-        rejectWrongState(action: string): Promise<void>;
-        timeoutForTransition(transition: any): number;
-        _restart(): Promise<any>;
-        restartIfRunning(): Promise<any>;
-        get toStringAttributes(): any;
-        toString(): string;
-        toJSON(): any;
-        toJSONWithOptions(options: {
-            includeRuntimeInfo: boolean;
-            includeDefaults: boolean;
-            includeName: boolean;
-            includeConfig: boolean;
-            includePrivate: boolean;
-        }): any;
-        get name(): string;
-        get autostart(): boolean;
-        _configure(config: any): Set<string>;
-        configure(config: any): Promise<undefined>;
-        getCredential(key: string): Promise<string | Uint8Array>;
-        getCredentials(filter?: Function): Promise<any>;
-        storePersistentCredentials(): Promise<undefined>;
-        log(level: string, arg: any): void;
-    };
-    attributes: any;
-    get endpoints(): any;
-    get description(): string;
-    get name(): string;
-};
-/**
- * Simple service manager (for examples and testing only).
- */
-export class StandaloneServiceProvider extends StandaloneServiceProvider_base {
-    getCredential(key: any): Promise<void>;
-}
-import { Service } from "./service.mjs";
-export {};

package/types/util.d.mts

@@ -1 +0,0 @@
-export function keyValue2Object(key: any, value: any): {};