@kronos-integration/endpoint 11.0.3 → 11.0.5

package/README.md

@@ -37,68 +37,70 @@ Named communication (end)-points inside of kronos
     *   [isOut](#isout)
     *   [direction](#direction)
     *   [jsonAttributes](#jsonattributes)
+    *   [toJSONWithOptions](#tojsonwithoptions)
+        *   [Parameters](#parameters-2)
     *   [hasInterceptors](#hasinterceptors)
     *   [connectable](#connectable)
-        *   [Parameters](#parameters-2)
+        *   [Parameters](#parameters-3)
     *   [hasConnections](#hasconnections)
     *   [isConnected](#isconnected)
-        *   [Parameters](#parameters-3)
-    *   [openConnection](#openconnection)
         *   [Parameters](#parameters-4)
-    *   [closeConnection](#closeconnection)
+    *   [openConnection](#openconnection)
         *   [Parameters](#parameters-5)
+    *   [closeConnection](#closeconnection)
+        *   [Parameters](#parameters-6)
     *   [openConnections](#openconnections)
     *   [closeConnections](#closeconnections)
     *   [connections](#connections)
     *   [addConnection](#addconnection)
-        *   [Parameters](#parameters-6)
-    *   [removeConnection](#removeconnection)
         *   [Parameters](#parameters-7)
-    *   [getConnectionState](#getconnectionstate)
+    *   [removeConnection](#removeconnection)
         *   [Parameters](#parameters-8)
-    *   [setConnectionState](#setconnectionstate)
+    *   [getConnectionState](#getconnectionstate)
         *   [Parameters](#parameters-9)
-    *   [didConnect](#didconnect)
+    *   [setConnectionState](#setconnectionstate)
         *   [Parameters](#parameters-10)
+    *   [didConnect](#didconnect)
+        *   [Parameters](#parameters-11)
 *   [isEndpoint](#isendpoint)
-    *   [Parameters](#parameters-11)
-*   [instanciateInterceptors](#instanciateinterceptors)
     *   [Parameters](#parameters-12)
-*   [MultiConnectionEndpoint](#multiconnectionendpoint)
+*   [instanciateInterceptors](#instanciateinterceptors)
     *   [Parameters](#parameters-13)
+*   [MultiConnectionEndpoint](#multiconnectionendpoint)
+    *   [Parameters](#parameters-14)
     *   [getConnectionState](#getconnectionstate-1)
-        *   [Parameters](#parameters-14)
-    *   [setConnectionState](#setconnectionstate-1)
         *   [Parameters](#parameters-15)
-    *   [removeConnection](#removeconnection-1)
+    *   [setConnectionState](#setconnectionstate-1)
         *   [Parameters](#parameters-16)
-    *   [isConnected](#isconnected-1)
+    *   [removeConnection](#removeconnection-1)
         *   [Parameters](#parameters-17)
+    *   [isConnected](#isconnected-1)
+        *   [Parameters](#parameters-18)
     *   [connections](#connections-1)
 *   [connections](#connections-2)
 *   [MultiSendEndpoint](#multisendendpoint)
-    *   [Parameters](#parameters-18)
+    *   [Parameters](#parameters-19)
     *   [isOut](#isout-1)
 *   [ReceivableEndpoint](#receivableendpoint)
-    *   [Parameters](#parameters-19)
+    *   [Parameters](#parameters-20)
     *   [isIn](#isin-2)
 *   [ReceiveEndpointDefault](#receiveendpointdefault)
     *   [isDefault](#isdefault-1)
 *   [ReceiveEndpointSelfConnectedDefault](#receiveendpointselfconnecteddefault)
     *   [removeConnection](#removeconnection-2)
-        *   [Parameters](#parameters-20)
+        *   [Parameters](#parameters-21)
 *   [ReceiveEndpoint](#receiveendpoint)
-    *   [Parameters](#parameters-21)
+    *   [Parameters](#parameters-22)
     *   [isIn](#isin-3)
 *   [SendEndpointDefault](#sendendpointdefault)
     *   [isDefault](#isdefault-2)
 *   [SendEndpoint](#sendendpoint)
-    *   [Parameters](#parameters-22)
+    *   [Parameters](#parameters-23)
     *   [isOut](#isout-2)
     *   [addConnection](#addconnection-1)
-        *   [Parameters](#parameters-23)
-    *   [removeConnection](#removeconnection-3)
         *   [Parameters](#parameters-24)
+    *   [removeConnection](#removeconnection-3)
+        *   [Parameters](#parameters-25)
 *   [SendReceiveEndpoint](#sendreceiveendpoint)
     *   [isIn](#isin-4)
 
@@ -173,6 +175,8 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
 
 *   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**  (optional, default `{includeRuntimeInfo:true}`)
 
+    *   `options.includeRuntimeInfo` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** 
+
 ### isIn
 
 Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** false
@@ -191,6 +195,14 @@ Returns **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
 
 Additional attributes to present in json output.
 
+### toJSONWithOptions
+
+#### Parameters
+
+*   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 
+
+Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
+
 ### hasInterceptors
 
 Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if there is at least one interceptor assigned
@@ -405,9 +417,6 @@ Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
 *   `owner` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** of the endpoint (service)
 *   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
 
-    *   `options.receive` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** reciever function
-    *   `options.receivingInterceptors` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** 
-
 ### isIn
 
 Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true is receive function is present
@@ -486,10 +495,7 @@ Back connections to any further endpoints will not be established
 
 *   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** endpoint name
 *   `owner` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** of the endpoint (service)
-*   `options` **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** 
-
-    *   `options.connected` **([Endpoint](#endpoint) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))?** where te requests are delivered to
-    *   `options.didConnect` **([Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))?** called after receiver is present
+*   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
 
 ### isOut
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kronos-integration/endpoint",
-  "version": "11.0.3",
+  "version": "11.0.5",
   "publishConfig": {
     "access": "public",
     "provenance": true
@@ -39,7 +39,7 @@
     "lint:typescript": "tsc --allowJs --checkJs --noEmit --resolveJsonModule --target es2024 --lib es2024 -m esnext --module nodenext --moduleResolution nodenext ./src**/*.mjs"
   },
   "dependencies": {
-    "@kronos-integration/interceptor": "^13.0.3"
+    "@kronos-integration/interceptor": "^13.0.6"
   },
   "devDependencies": {
     "ava": "^6.4.1",
@@ -49,7 +49,7 @@
     "typescript": "^5.9.3"
   },
   "engines": {
-    "node": ">=24.10.0"
+    "node": ">=24.11.1"
   },
   "repository": {
     "type": "git",

package/src/endpoint.mjs

@@ -14,6 +14,8 @@ export class Endpoint {
    * @param {Object} options
    * @param {function(Endpoint,Endpoint):void|undefined} [options.didConnect] called after receiver is present
    * @param {Interceptor[]|string[]|undefined} [options.interceptors] interceptors
+   * @param {Endpoint} [options.connected]
+   * @param {Array<Interceptor>} [options.receivingInterceptors]
    */
   constructor(name, owner, options) {
     this.name = name;
@@ -66,6 +68,7 @@ export class Endpoint {
   /**
    *
    * @param {Object} options
+   * @param {boolean} [options.includeRuntimeInfo]
    */
   connectionNamesWithStates(options = { includeRuntimeInfo: true }) {
     return [...this.connections()]
@@ -157,6 +160,11 @@ export class Endpoint {
     return [];
   }
 
+  /**
+   * 
+   * @param {Object} [options] 
+   * @returns {Object}
+   */
   toJSONWithOptions(options) {
     const json = {};
 

package/src/receivable-endpoint.mjs

@@ -1,4 +1,5 @@
 import { Endpoint, instanciateInterceptors } from "./endpoint.mjs";
+import { Interceptor } from "@kronos-integration/interceptor";
 
 /**
  * @param {string} name endpoint name
@@ -8,6 +9,14 @@ import { Endpoint, instanciateInterceptors } from "./endpoint.mjs";
  * @param {Function} [options.receivingInterceptors]
  */
 export class ReceivableEndpoint extends Endpoint {
+
+    /**
+   * @param {string} name endpoint name
+   * @param {Object} owner of the endpoint (service)
+   * @param {Object} options
+   * @param {Function} [options.receive]
+   * @param {Array<Interceptor>} [options.receivingInterceptors]
+   */
   constructor(name, owner, options) {
     super(name, owner, options);
     if (options?.receive) {

package/src/send-endpoint.mjs

@@ -15,6 +15,12 @@ export class SendEndpoint extends ReceivableEndpoint {
   #connection;
   #state;
 
+  /**
+   * @param {string} name endpoint name
+   * @param {Object} owner of the endpoint (service)
+   * @param {Object} options
+   * @param {Endpoint} [options.connected]
+   */
   constructor(name, owner, options) {
     super(name, owner, options);
     if (isEndpoint(options?.connected)) {

package/types/endpoint.d.mts

@@ -24,10 +24,14 @@ export class Endpoint {
      * @param {Object} options
      * @param {function(Endpoint,Endpoint):void|undefined} [options.didConnect] called after receiver is present
      * @param {Interceptor[]|string[]|undefined} [options.interceptors] interceptors
+     * @param {Endpoint} [options.connected]
+     * @param {Array<Interceptor>} [options.receivingInterceptors]
      */
     constructor(name: string, owner: any, options: {
         didConnect?: (arg0: Endpoint, arg1: Endpoint) => void | undefined;
         interceptors?: Interceptor[] | string[] | undefined;
+        connected?: Endpoint;
+        receivingInterceptors?: Array<Interceptor>;
     });
     name: string;
     owner: any;
@@ -63,8 +67,11 @@ export class Endpoint {
     /**
      *
      * @param {Object} options
+     * @param {boolean} [options.includeRuntimeInfo]
      */
-    connectionNamesWithStates(options?: any): string[];
+    connectionNamesWithStates(options?: {
+        includeRuntimeInfo?: boolean;
+    }): string[];
     toString(): string;
     get identifier(): string;
     /**
@@ -80,26 +87,17 @@ export class Endpoint {
      * @return {string|undefined} delivers data flow direction 'in', 'out', 'inout' or undefined
      */
     get direction(): string | undefined;
-    toJSON(): {
-        in: boolean;
-        out: boolean;
-        open: boolean;
-        dummy: boolean;
-        connected: string | string[];
-        interceptors: any[];
-    };
+    toJSON(): any;
     /**
      * Additional attributes to present in json output.
      */
     get jsonAttributes(): any[];
-    toJSONWithOptions(options: any): {
-        in: boolean;
-        out: boolean;
-        open: boolean;
-        dummy: boolean;
-        connected: string | string[];
-        interceptors: any[];
-    };
+    /**
+     *
+     * @param {Object} [options]
+     * @returns {Object}
+     */
+    toJSONWithOptions(options?: any): any;
     /**
      * @return {boolean} true if there is at least one interceptor assigned
      */

package/types/multi-connection-endpoint.d.mts

@@ -3,6 +3,7 @@
  * Can hold several connections.
  */
 export class MultiConnectionEndpoint extends ReceivableEndpoint {
+    constructor(name: any, owner: any, options: any);
     addConnection(other: any, backpointer: any): void;
     /**
      * All connections

package/types/receivable-endpoint.d.mts

@@ -6,7 +6,18 @@
  * @param {Function} [options.receivingInterceptors]
  */
 export class ReceivableEndpoint extends Endpoint {
-    constructor(name: any, owner: any, options: any);
-    receive: any;
+    /**
+   * @param {string} name endpoint name
+   * @param {Object} owner of the endpoint (service)
+   * @param {Object} options
+   * @param {Function} [options.receive]
+   * @param {Array<Interceptor>} [options.receivingInterceptors]
+   */
+    constructor(name: string, owner: any, options: {
+        receive?: Function;
+        receivingInterceptors?: Array<Interceptor>;
+    });
+    receive: Function;
 }
 import { Endpoint } from "./endpoint.mjs";
+import { Interceptor } from "@kronos-integration/interceptor";

package/types/send-endpoint.d.mts

@@ -9,6 +9,15 @@
  * @param {Function|undefined} [options.didConnect] called after receiver is present
  */
 export class SendEndpoint extends ReceivableEndpoint {
+    /**
+     * @param {string} name endpoint name
+     * @param {Object} owner of the endpoint (service)
+     * @param {Object} options
+     * @param {Endpoint} [options.connected]
+     */
+    constructor(name: string, owner: any, options: {
+        connected?: Endpoint;
+    });
     getConnectionState(other: any): any;
     setConnectionState(other: any, state: any): void;
     connections(): Generator<any, void, unknown>;
@@ -16,3 +25,4 @@ export class SendEndpoint extends ReceivableEndpoint {
     #private;
 }
 import { ReceivableEndpoint } from "./receivable-endpoint.mjs";
+import { Endpoint } from "./endpoint.mjs";