@kronos-integration/service 15.1.1 → 15.1.3

package/README.md

@@ -1,11 +1,13 @@
+[![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-0BSD-blue.svg)](https://spdx.org/licenses/0BSD.html)
 [![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)
 [![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2FKronos-Integration%2Fservice%2Fbadge\&style=flat)](https://actions-badge.atrox.dev/Kronos-Integration/service/goto)
 [![Styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
 [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
 [![Known Vulnerabilities](https://snyk.io/test/github/Kronos-Integration/service/badge.svg)](https://snyk.io/test/github/Kronos-Integration/service)
-[![Coverage Status](https://coveralls.io/repos/Kronos-Integration/service/badge.svg)](https://coveralls.io/github/Kronos-Integration/service)
 
 # @kronos-integration/service
 
@@ -136,6 +138,8 @@ Deliver configuration for a given service.
 *   `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)** 
 
+Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)>**&#x20;
+
 ### clearPreserved
 
 Forget about preserved config of a service.
@@ -246,12 +250,6 @@ All services have at least three endpoints:
 ### Parameters
 
 *   `config` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
-
-    *   `config.name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
-    *   `config.logLevel` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
-    *   `config.autostart` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** defaults to false
-    *   `config.description` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** human readable description
-    *   `config.endpoints` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** will be merged with the build in ones
 *   `ic` **InitializationContext**&#x20;
 
 ### Properties

package/package.json

@@ -1,15 +1,16 @@
 {
   "name": "@kronos-integration/service",
-  "version": "15.1.1",
+  "version": "15.1.3",
   "publishConfig": {
     "access": "public",
     "provenance": true
   },
+  "packageManager": "npm@11.6.4+sha512.1118cab46a05a50aee6bff5b1b4fa1df18afff89d57465620a3518035026955db87c5bdf9d207b07b7487d99f2490d450cb774655ad63ec2cba7bf1d0ad25d45",
   "types": "./types/module.d.mts",
   "exports": {
     ".": {
-      "default": "./src/module.mjs",
-      "types": "./types/module.d.mts"
+      "types": "./types/module.d.mts",
+      "default": "./src/module.mjs"
     }
   },
   "description": "Base service implementation",
@@ -23,23 +24,23 @@
       "email": "markus.felten@gmx.de"
     }
   ],
-  "license": "BSD-2-Clause",
+  "license": "0BSD",
   "scripts": {
     "prepare": "node --run prepare:typescript",
-    "prepare:typescript": "tsc --allowJs --declaration --emitDeclarationOnly --declarationDir types --resolveJsonModule --target es2024 --lib es2024 -m esnext --module nodenext --moduleResolution nodenext --rootDir src ./src**/*.mjs",
+    "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",
+    "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 es2024 --lib es2024 -m esnext --module nodenext --moduleResolution nodenext ./src**/*.mjs"
+    "lint:docs": "documentation lint ./src**/*.mjs",
+    "lint:typescript": "tsc --allowJs --checkJs --noEmit --resolveJsonModule --target esnext -m esnext --module nodenext --moduleResolution nodenext ./src**/*.mjs"
   },
   "dependencies": {
     "@kronos-integration/endpoint": "^11.0.5",
-    "@kronos-integration/interceptor": "^13.0.6",
+    "@kronos-integration/interceptor": "^13.1.0",
     "loglevel-mixin": "^7.2.6",
-    "pacc": "^5.1.0",
+    "pacc": "^6.1.0",
     "statetransition-mixin": "^8.1.4"
   },
   "devDependencies": {
@@ -66,6 +67,5 @@
       "arlac77/template-kronos-component",
       "arlac77/template-typescript"
     ]
-  },
-  "packageManager": "npm@11.6.4+sha512.1118cab46a05a50aee6bff5b1b4fa1df18afff89d57465620a3518035026955db87c5bdf9d207b07b7487d99f2490d450cb774655ad63ec2cba7bf1d0ad25d45"
+  }
 }

package/src/service-config.mjs

@@ -25,16 +25,14 @@ export class ServiceConfig extends Service {
    * Deliver configuration for a given service.
    * @param {string} name service name
    * @param {Object} config
+   * @returns {Promise<Object>}
    */
   async configFor(name, config) {
-    this.trace(`configFor ${name}`);
-
     await this.start();
 
     const pc = this.preservedConfigs.get(name);
     if (pc !== undefined) {
       config = config === undefined ? pc : merge(config, pc);
-      this.trace(`using preserved config ${name}`);
     }
 
     this.preservedConfigs.set(name, config);

package/src/service.mjs

@@ -7,7 +7,8 @@ import {
   setAttributes,
   description_attribute,
   default_attribute,
-  timeout_attribute
+  timeout_attribute,
+  object_attribute
 } from "pacc";
 import { EndpointsMixin } from "./endpoints-mixin.mjs";
 import { InitializationContext } from "./initialization-context.mjs";
@@ -35,13 +36,6 @@ const ssfDefault = {
  * - log _out_: log events
  * - config _in_: configuration request
  * - command _in_: administrative actions to be executed by the step
- * @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
  *
  * @property {Object} endpoints
  */
@@ -95,6 +89,7 @@ export class Service extends EndpointsMixin(
       get: () => this.logLevel.name
     },
     timeout: {
+      ...object_attribute,
       attributes: {
         start: {
           ...timeout_attribute,
@@ -135,6 +130,15 @@ export class Service extends EndpointsMixin(
 
   #description;
 
+  /**
+   * @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, ic) {
     super();
 

package/types/service-config.d.mts

@@ -18,6 +18,7 @@ export class ServiceConfig extends Service {
      * Deliver configuration for a given service.
      * @param {string} name service name
      * @param {Object} config
+     * @returns {Promise<Object>}
      */
     configFor(name: string, config: any): Promise<any>;
     /**

package/types/service.d.mts

@@ -6,13 +6,6 @@ declare const Service_base: new () => new () => /*elided*/ any;
  * - log _out_: log events
  * - config _in_: configuration request
  * - command _in_: administrative actions to be executed by the step
- * @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
  *
  * @property {Object} endpoints
  */
@@ -34,7 +27,22 @@ export class Service extends Service_base {
      * @return {Object} predefined endpoints
      */
     static get endpoints(): any;
-    constructor(config: any, ic: 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;