@kronos-integration/service 15.3.0 → 15.4.0

package/README.md

@@ -63,19 +63,21 @@ The transitions are:
 *   [defineServiceConsumerProperties](#defineserviceconsumerproperties)
     *   [Parameters](#parameters-6)
 *   [ServiceLogger](#servicelogger)
+    *   [logEntry](#logentry)
+        *   [Parameters](#parameters-7)
     *   [autostart](#autostart-1)
     *   [name](#name-1)
     *   [endpoints](#endpoints-1)
 *   [Service](#service)
-    *   [Parameters](#parameters-7)
+    *   [Parameters](#parameters-8)
     *   [Properties](#properties-1)
     *   [extendetName](#extendetname)
     *   [stateChanged](#statechanged)
-        *   [Parameters](#parameters-8)
-    *   [rejectWrongState](#rejectwrongstate)
         *   [Parameters](#parameters-9)
-    *   [timeoutForTransition](#timeoutfortransition)
+    *   [rejectWrongState](#rejectwrongstate)
         *   [Parameters](#parameters-10)
+    *   [timeoutForTransition](#timeoutfortransition)
+        *   [Parameters](#parameters-11)
     *   [\_start](#_start)
     *   [\_stop](#_stop)
     *   [\_restart](#_restart)
@@ -84,20 +86,20 @@ The transitions are:
     *   [isServiceProvider](#isserviceprovider)
     *   [toString](#tostring)
     *   [toJSONWithOptions](#tojsonwithoptions)
-        *   [Parameters](#parameters-11)
+        *   [Parameters](#parameters-12)
     *   [name](#name-2)
     *   [autostart](#autostart-2)
     *   [\_configure](#_configure)
-        *   [Parameters](#parameters-12)
-    *   [configure](#configure-1)
         *   [Parameters](#parameters-13)
-    *   [getCredential](#getcredential)
+    *   [configure](#configure-1)
         *   [Parameters](#parameters-14)
-    *   [getCredentials](#getcredentials)
+    *   [getCredential](#getcredential)
         *   [Parameters](#parameters-15)
+    *   [getCredentials](#getcredentials)
+        *   [Parameters](#parameters-16)
     *   [storePersistentCredentials](#storepersistentcredentials)
     *   [log](#log)
-        *   [Parameters](#parameters-16)
+        *   [Parameters](#parameters-17)
     *   [attributes](#attributes)
     *   [endpoints](#endpoints-2)
 *   [StandaloneServiceProvider](#standaloneserviceprovider)
@@ -203,6 +205,14 @@ Assign services based on a configuration.
 
 Log receiving service.
 
+### logEntry
+
+#### Parameters
+
+*   `entry` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
+
+    *   `entry.severity` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
+
 ### autostart
 
 We always start immediate.
@@ -310,14 +320,14 @@ Closes all endpoint connections.
 Restart action.
 default implementation does a \_stop() and a \_start()
 
-Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)** fulfills after start
+Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<any>** fulfills after start
 
 ### restartIfRunning
 
 Restarts if in running mode.
 Otherwise does nothing.
 
-Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)** resolves when restart is done (or immediate if no restart triggered)
+Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<any>** resolves when restart is done (or immediate if no restart triggered)
 
 ### toStringAttributes
 
@@ -403,11 +413,11 @@ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
 
 ### getCredentials
 
-Retrieve all credential attribute values.
+Retrieve all (filtered) credential attribute values.
 
 #### Parameters
 
-*   `filter`   (optional, default `(name,attribute)=>attribute.credential`)
+*   `filter` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)**  (optional, default `(name,attribute)=>attribute.credential`)
 
 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;
 
@@ -415,6 +425,8 @@ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
 
 Load and store persistent credentials in the service attributes.
 
+Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined)>**&#x20;
+
 ### log
 
 Adds service name to the log event.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kronos-integration/service",
-  "version": "15.3.0",
+  "version": "15.4.0",
   "publishConfig": {
     "access": "public",
     "provenance": true

package/src/service-provider-mixin.mjs

@@ -27,6 +27,15 @@ export function ServiceProviderMixin(
       superclass.attributes
     );
 
+    static get endpoints() {
+      return {
+        ...super.endpoints,
+        info: {
+          receive: "info"
+        }
+      };
+    }
+
     listeners = {};
     interceptorFactories = {};
     serviceFactories = {};
@@ -105,6 +114,16 @@ export function ServiceProviderMixin(
       return true;
     }
 
+    info() {
+      return this.toJSONWithOptions({
+        includeRuntimeInfo: false,
+        includeDefaults: true,
+        includeName: true,
+        includeConfig: true,
+        includePrivate: false
+      });
+    }
+
     /**
      * Register service or interceptor factories.
      *

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

@@ -33,6 +33,7 @@ export function ServiceProviderMixin(superclass: typeof Service, serviceLoggerCl
          * @return {boolean} true
          */
         get isServiceProvider(): boolean;
+        info(): any;
         /**
          * Register service or interceptor factories.
          *
@@ -157,9 +158,9 @@ export function ServiceProviderMixin(superclass: typeof Service, serviceLoggerCl
         log(level: string, arg: any): void;
     };
     attributes: any;
+    get endpoints(): any;
     get description(): string;
     get name(): string;
-    get endpoints(): any;
 };
 import { Service } from "./service.mjs";
 import { ServiceLogger } from "./service-logger.mjs";

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

@@ -11,6 +11,7 @@ declare const StandaloneServiceProvider_base: {
         removeListener(name: any, listener: any): void;
         get owner(): /*elided*/ any;
         get isServiceProvider(): boolean;
+        info(): 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;
@@ -59,9 +60,9 @@ declare const StandaloneServiceProvider_base: {
         log(level: string, arg: any): void;
     };
     attributes: any;
+    get endpoints(): any;
     get description(): string;
     get name(): string;
-    get endpoints(): any;
 };
 /**
  * Simple service manager (for examples and testing only).