@kronos-integration/service 10.4.54 → 10.4.56

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2015-2023 darlenya & arlac77
+Copyright (c) 2015-2024 darlenya & arlac77
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

package/README.md

@@ -1,5 +1,6 @@
 [![npm](https://img.shields.io/npm/v/@kronos-integration/service.svg)](https://www.npmjs.com/package/@kronos-integration/service)
 [![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
+[![Typed with TypeScript](https://flat.badgen.net/badge/icon/Typed?icon=typescript\&label\&labelColor=blue\&color=555555)](https://typescriptlang.org)
 [![bundlejs](https://deno.bundlejs.com/?q=@kronos-integration/service\&badge=detailed)](https://bundlejs.com/?q=@kronos-integration/service)
 [![downloads](http://img.shields.io/npm/dm/@kronos-integration/service.svg?style=flat-square)](https://npmjs.org/package/@kronos-integration/service)
 [![GitHub Issues](https://img.shields.io/github/issues/Kronos-Integration/service.svg?style=flat-square)](https://github.com/Kronos-Integration/service/issues)
@@ -82,9 +83,7 @@ Manages endpoints in a container.
 
 ### Parameters
 
-*   `superclass` **Class** class to be extended
-
-Returns **Class** extended class
+*   `superclass`  
 
 ## endpoints
 
@@ -97,8 +96,8 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
 **Extends Service**
 
 Config providing service.
-Dispatches config requests to services;
-or preserves them until a maching service becomes avaliable.
+Dispatches config requests to services.
+Also preserves them until a maching service becomes avaliable.
 
 ### Properties
 
@@ -111,7 +110,7 @@ Deliver configuration for a given service.
 #### Parameters
 
 *   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** service name
-*   `config` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
+*   `config` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
 
 ### clearPreserved
 

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@kronos-integration/service",
-  "version": "10.4.54",
+  "version": "10.4.56",
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "provenance": true
   },
   "exports": {
     ".": "./src/module.mjs"
@@ -24,29 +25,31 @@
     "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": "npm run lint:docs",
-    "lint:docs": "documentation lint ./src/**/*.mjs"
+    "lint": "npm run lint:docs && npm run lint:tsc",
+    "lint:docs": "documentation lint ./src/**/*.mjs",
+    "lint:tsc": "tsc --allowJs --checkJs --noEmit -t esnext -m esnext --module nodenext --moduleResolution nodenext ./src**/*.mjs"
   },
   "dependencies": {
-    "@kronos-integration/endpoint": "^9.4.44",
-    "@kronos-integration/interceptor": "^10.2.37",
-    "loglevel-mixin": "^7.1.0",
+    "@kronos-integration/endpoint": "^9.5.0",
+    "@kronos-integration/interceptor": "^10.2.38",
+    "loglevel-mixin": "^7.2.1",
     "model-attributes": "^4.2.2",
-    "remove-sensible-values": "^1.2.3",
-    "statetransition-mixin": "^8.0.5"
+    "remove-sensible-values": "^1.3.1",
+    "statetransition-mixin": "^8.1.0"
   },
   "devDependencies": {
-    "ava": "^6.0.1",
-    "c8": "^8.0.1",
-    "documentation": "^14.0.2",
-    "semantic-release": "^22.0.10"
+    "ava": "^6.1.1",
+    "c8": "^9.1.0",
+    "documentation": "^14.0.3",
+    "semantic-release": "^23.0.2",
+    "typescript": "^5.3.3"
   },
   "engines": {
-    "node": ">=20.10.0"
+    "node": ">=20.11.0"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/Kronos-Integration/service"
+    "url": "git+https://github.com/Kronos-Integration/service.git"
   },
   "bugs": {
     "url": "https://github.com/Kronos-Integration/service/issues"
@@ -55,7 +58,8 @@
   "template": {
     "inheritFrom": [
       "arlac77/template-arlac77-github",
-      "arlac77/template-kronos-component"
+      "arlac77/template-kronos-component",
+      "arlac77/template-typescript"
     ]
   }
 }

package/src/endpoints-mixin.mjs

@@ -1,4 +1,5 @@
 import {
+  Endpoint,
   SendEndpoint,
   SendEndpointDefault,
   SendReceiveEndpoint,
@@ -7,12 +8,13 @@ import {
   ReceiveEndpointDefault,
   ReceiveEndpointSelfConnectedDefault
 } from "@kronos-integration/endpoint";
+import { InitializationContext } from "./initialization-context.mjs";
 
 /**
  * Endpoint accessor mixin.
  * Manages endpoints in a container.
- * @param {Class} superclass class to be extended
- * @return {Class} extended class
+ * @param {new() => superclass} superclass class to be extended
+ * @return {new() => superclass} extended class
  */
 export function EndpointsMixin(superclass) {
   return class EndpointsMixin extends superclass {
@@ -41,6 +43,7 @@ export function EndpointsMixin(superclass) {
      * @param {string} name of the endpoint
      * @param {Object} definition endpoints definition
      * @param {string|Function} definition.receive name of method or property
+     * @param {Endpoint} definition.connected
      * @param {InitializationContext} ic
      * @return {Object} suitable to pass as options to the endpoint factory
      */
@@ -75,6 +78,8 @@ export function EndpointsMixin(superclass) {
      * @param {any} definition.receive defined will result in a ReceiveEndpoint
      * @param {boolean} definition.out true will result in a SendEndpoint
      * @param {boolean} definition.default true will result in a (Send|Receive)DefaultEndpoint
+     * @param {boolean} definition.multi true will result in a MultiSendEndpoint
+     * @param {Endpoint[]|string} definition.connected true will result in a MultiSendEndpoint
      * @param {InitializationContext} ic
      * @return {Object} endpoint factory
      */

package/src/initialization-context.mjs

@@ -21,9 +21,9 @@ export const InitializationContext = LogLevelMixin(
    */
   class InitializationContext {
 
-    outstandingServices = new Map();
-    outstandingFactories = new Map();
-    outstandingEndpointConnections = new Map();
+    /** @type {Map<string,Promise<Service>>} */ outstandingServices = new Map();
+    /** @type {Map<string,Promise<Function>>} */ outstandingFactories = new Map();
+    /** @type {Map<string,Promise<Endpoint>>} */ outstandingEndpointConnections = new Map();
 
     constructor(serviceProvider, options) {
       this.serviceProvider = serviceProvider;
@@ -32,7 +32,7 @@ export const InitializationContext = LogLevelMixin(
     /**
      * Forward to the serviceProvider.
      * @param {string} level the log level
-     * @param {Object} arg log content
+     * @param {Object} args log content
      */
     log(level, ...args) {
       if (this.serviceProvider) {
@@ -162,7 +162,7 @@ export const InitializationContext = LogLevelMixin(
 
     /**
      *
-     * @param {string|class} type name if type
+     * @param {string|(new() => type)} type name if type
      */
     async getServiceFactory(type) {
       const sp = this.serviceProvider;
@@ -230,7 +230,7 @@ export const InitializationContext = LogLevelMixin(
      * - otherwise declare this action as a new outstanding service declaration
      * @param {Object} config
      * @param {string} name service name
-     * @return {Service}
+     * @return {Promise<Service|undefined>}
      */
     async declareService(config, name) {      
       const sp = this.serviceProvider;

package/src/service-config.mjs

@@ -4,8 +4,8 @@ import { keyValue2Object } from "./util.mjs";
 
 /**
  * Config providing service.
- * Dispatches config requests to services;
- * or preserves them until a maching service becomes avaliable.
+ * 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 {
@@ -25,7 +25,7 @@ export class ServiceConfig extends Service {
   /**
    * Deliver configuration for a given service.
    * @param {string} name service name
-   * @param {object} config
+   * @param {Object} config
    */
   async configFor(name, config) {
     this.trace(`configFor ${name}`);

package/src/service-provider-mixin.mjs

@@ -9,8 +9,8 @@ import { InitializationContext } from "./initialization-context.mjs";
  * By default a service provider has two build in services
  * 'logger' and 'config'.
  *
- * @param {Class} serviceLoggerClass where the logging houtd go
- * @param {Class} serviceConfigClass where the config comes from
+ * @param {new(Object,InitializationContext) => serviceLoggerClass} serviceLoggerClass where the logging houtd go
+ * @param {new(Object,InitializationContext) => serviceConfigClass} serviceConfigClass where the config comes from
  */
 export function ServiceProviderMixin(
   superclass,
@@ -106,8 +106,8 @@ export function ServiceProviderMixin(
      * Registers a interceptor factory for later use by
      * @see {instantiateInterceptor}.
      *
-     * @param {Class} factory
-     * @returns {Class} factory
+     * @param {new() => factory} factory
+     * @returns {new() => factory} factory
      */
     registerInterceptorFactory(factory) {
       this.interceptorFactories[factory.name] = factory;
@@ -181,7 +181,7 @@ export function ServiceProviderMixin(
      * 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} config with
+     * @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

package/src/service.mjs

@@ -6,6 +6,7 @@ import {
   setAttributes
 } from "model-attributes";
 import { EndpointsMixin } from "./endpoints-mixin.mjs";
+import { InitializationContext } from "./initialization-context.mjs";
 
 const _ca = createAttributes({
   description: {
@@ -78,6 +79,8 @@ const ssfDefault = {
  * @param {string} config.description human readable description
  * @param {Object} config.endpoints will be merged with the build in ones
  * @param {InitializationContext} ic
+ * 
+ * @property {Object} endpoints
  */
 export class Service extends EndpointsMixin(
   StateTransitionMixin(