@kronos-integration/endpoint 9.5.1 → 9.5.3

package/README.md

@@ -53,47 +53,50 @@ Named communication (end)-points inside of kronos
     *   [openConnections](#openconnections)
     *   [closeConnections](#closeconnections)
     *   [connections](#connections)
-    *   [getConnectionState](#getconnectionstate)
+    *   [addConnection](#addconnection)
         *   [Parameters](#parameters-6)
-    *   [setConnectionState](#setconnectionstate)
+    *   [getConnectionState](#getconnectionstate)
         *   [Parameters](#parameters-7)
+    *   [setConnectionState](#setconnectionstate)
+        *   [Parameters](#parameters-8)
 *   [isEndpoint](#isendpoint)
-    *   [Parameters](#parameters-8)
-*   [instanciateInterceptors](#instanciateinterceptors)
     *   [Parameters](#parameters-9)
-*   [MultiConnectionEndpoint](#multiconnectionendpoint)
+*   [instanciateInterceptors](#instanciateinterceptors)
     *   [Parameters](#parameters-10)
+*   [MultiConnectionEndpoint](#multiconnectionendpoint)
+    *   [Parameters](#parameters-11)
     *   [getConnectionState](#getconnectionstate-1)
-        *   [Parameters](#parameters-11)
-    *   [setConnectionState](#setconnectionstate-1)
         *   [Parameters](#parameters-12)
-    *   [isConnected](#isconnected-1)
+    *   [setConnectionState](#setconnectionstate-1)
         *   [Parameters](#parameters-13)
+    *   [isConnected](#isconnected-1)
+        *   [Parameters](#parameters-14)
     *   [connections](#connections-1)
 *   [connections](#connections-2)
 *   [MultiSendEndpoint](#multisendendpoint)
-    *   [Parameters](#parameters-14)
+    *   [Parameters](#parameters-15)
     *   [isOut](#isout-1)
 *   [ReceivableEndpoint](#receivableendpoint)
-    *   [Parameters](#parameters-15)
+    *   [Parameters](#parameters-16)
     *   [isIn](#isin-2)
     *   [receive](#receive-1)
     *   [receive](#receive-2)
-        *   [Parameters](#parameters-16)
+        *   [Parameters](#parameters-17)
 *   [ReceiveEndpointDefault](#receiveendpointdefault)
     *   [isDefault](#isdefault-1)
 *   [ReceiveEndpointSelfConnectedDefault](#receiveendpointselfconnecteddefault)
     *   [removeConnection](#removeconnection)
-        *   [Parameters](#parameters-17)
+        *   [Parameters](#parameters-18)
 *   [ReceiveEndpoint](#receiveendpoint)
-    *   [Parameters](#parameters-18)
+    *   [Parameters](#parameters-19)
     *   [isIn](#isin-3)
 *   [SendEndpointDefault](#sendendpointdefault)
     *   [isDefault](#isdefault-2)
 *   [SendEndpoint](#sendendpoint)
-    *   [Parameters](#parameters-19)
+    *   [Parameters](#parameters-20)
     *   [isOut](#isout-2)
-*   [isIn](#isin-4)
+*   [SendReceiveEndpoint](#sendreceiveendpoint)
+    *   [isIn](#isin-4)
 
 ## DummyReceiveEndpoint
 
@@ -246,6 +249,12 @@ Closes all connections.
 
 Returns **Iterable\<any>**&#x20;
 
+### addConnection
+
+#### Parameters
+
+*   `connection` **any**&#x20;
+
 ### getConnectionState
 
 Deliver state for a given connection.
@@ -281,7 +290,7 @@ Instanciate interceptors from its definitions.
 
 ### Parameters
 
-*   `interceptors` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\<Interceptor> | [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\<Class> | [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>)**&#x20;
+*   `interceptors` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\<Interceptor> | [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>)**&#x20;
 *   `owner` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
 
 Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\<Interceptor>**&#x20;
@@ -475,7 +484,13 @@ We are always *out*
 
 Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** always true
 
-## isIn
+## SendReceiveEndpoint
+
+**Extends SendEndpoint**
+
+bi directional endpint
+
+### isIn
 
 Always receiving.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kronos-integration/endpoint",
-  "version": "9.5.1",
+  "version": "9.5.3",
   "publishConfig": {
     "access": "public",
     "provenance": true
@@ -8,8 +8,8 @@
   "types": "./types/module.d.mts",
   "exports": {
     ".": {
-      "types": "./types/module.d.mts",
-      "default": "./src/module.mjs"
+      "default": "./src/module.mjs",
+      "types": "./types/module.d.mts"
     }
   },
   "description": "named communication (end)-points inside of kronos",
@@ -28,7 +28,7 @@
   ],
   "license": "BSD-2-Clause",
   "scripts": {
-    "prepare": "tsc --allowJs --declaration --emitDeclarationOnly --declarationDir types -t esnext -m esnext --module nodenext --moduleResolution nodenext ./src**/*.mjs",
+    "prepare": "tsc --allowJs --declaration --emitDeclarationOnly --declarationDir types -t esnext -m esnext --module nodenext --moduleResolution nodenext --rootDir src ./src**/*.mjs",
     "test": "npm 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",
@@ -41,14 +41,14 @@
     "@kronos-integration/interceptor": "^10.3.0"
   },
   "devDependencies": {
-    "ava": "^6.1.1",
+    "ava": "^6.1.2",
     "c8": "^9.1.0",
     "documentation": "^14.0.3",
     "semantic-release": "^23.0.2",
     "typescript": "^5.3.3"
   },
   "engines": {
-    "node": ">=20.11.0"
+    "node": ">=20.11.1"
   },
   "repository": {
     "type": "git",

package/src/endpoint.mjs

@@ -6,13 +6,16 @@ import { Interceptor } from "@kronos-integration/interceptor";
 
 /**
  * Connection endpoint.
- * @param {string} name endpoint name
- * @param {Object} owner of the endpoint (service)
- * @param {Object} options
- * @param {Function} [options.didConnect] called after receiver is present
- * @param {Interceptor|Object[]} [options.interceptors] interceptors
  */
+
 export class Endpoint {
+  /**
+   * @param {string} name endpoint name
+   * @param {Object} owner of the endpoint (service)
+   * @param {Object} options
+   * @param {function(Endpoint,Endpoint):void} [options.didConnect] called after receiver is present
+   * @param {Interceptor[]|string[]} [options.interceptors] interceptors
+   */
   constructor(name, owner, options) {
     this.name = name;
     this.owner = owner;
@@ -62,7 +65,7 @@ export class Endpoint {
   }
 
   /**
-   * 
+   *
    * @param {Object} options
    */
   connectionNamesWithStates(options = { includeRuntimeInfo: true }) {
@@ -276,7 +279,7 @@ export class Endpoint {
   /**
    * Actually stop the communication.
    * @param {Endpoint} other
-   * @param {boolean?} backpointer true if this is the call from back call from the other side
+   * @param {boolean} [backpointer] true if this is the call from back call from the other side
    */
   closeConnection(other, backpointer) {
     if (other !== undefined) {
@@ -311,18 +314,27 @@ export class Endpoint {
   }
 
   /**
-   * @return {Iterable<any>}
+   * @return {Iterable<Endpoint>}
    */
   *connections() {}
 
-  addConnection() {}
+  /**
+   *
+   * @param {Endpoint} connection
+   */
+  addConnection(connection) {}
 
-  removeConnection() {}
+  /**
+   * Actually stop the communication.
+   * @param {Endpoint} other
+   * @param {boolean?} backpointer true if this is the call form back call from the other side
+   */
+  removeConnection(other, backpointer) {}
 
   /**
    * Deliver state for a given connection.
    * @param {Endpoint} other
-   * @return {ConnectionState} 
+   * @return {ConnectionState}
    */
   getConnectionState(other) {}
 
@@ -333,7 +345,12 @@ export class Endpoint {
    */
   setConnectionState(other, state) {}
 
-  didConnect(a,b) {}
+  /**
+   *
+   * @param {Endpoint} endpoint
+   * @param {Endpoint} other
+   */
+  didConnect(endpoint, other) {}
 
   get receivingInterceptors() {
     return [];
@@ -351,7 +368,7 @@ export function isEndpoint(object) {
 
 /**
  * Instanciate interceptors from its definitions.
- * @param {Interceptor[]|Class[]|String[]} interceptors
+ * @param {Interceptor[]|string[]|undefined} interceptors
  * @param {Object} owner
  * @return {Interceptor[]}
  */

package/src/multi-connection-endpoint.mjs

@@ -51,6 +51,11 @@ export class MultiConnectionEndpoint extends ReceivableEndpoint {
     }
   }
 
+   /**
+   * Actually stop the communication.
+   * @param {Endpoint} other
+   * @param {boolean?} backpointer true if this is the call form back call from the other side
+   */
   removeConnection(other, backpointer) {
     this.closeConnection(other);
     this.#connections.delete(other);

package/src/multi-send-endpoint.mjs

@@ -12,7 +12,6 @@ import { Endpoint } from "./endpoint.mjs";
  * @param {Function} [options.didConnect] called after receiver is present
  */
 export class MultiSendEndpoint extends MultiConnectionEndpoint {
-
   /**
    * We are always _out_
    * @return {boolean} always true
@@ -30,7 +29,8 @@ export class MultiSendEndpoint extends MultiConnectionEndpoint {
 
         const next = async (...args) =>
           c >= interceptors.length
-            ? connection.receive(...args)
+            ? // @ts-ignore
+              connection.receive(...args)
             : interceptors[c++].receive(this, next, ...args);
 
         next(...args);
@@ -38,7 +38,7 @@ export class MultiSendEndpoint extends MultiConnectionEndpoint {
     }
   }
 
-  async * sendAndReceive(...args) {
+  async *sendAndReceive(...args) {
     const interceptors = this.interceptors;
 
     for (const connection of this.connections()) {
@@ -47,7 +47,8 @@ export class MultiSendEndpoint extends MultiConnectionEndpoint {
 
         const next = async (...args) =>
           c >= interceptors.length
-            ? connection.receive(...args)
+            ? // @ts-ignore
+              connection.receive(...args)
             : interceptors[c++].receive(this, next, ...args);
 
         yield next(...args);

package/src/receive-endpoint-self-connected-default.mjs

@@ -27,6 +27,7 @@ export class ReceiveEndpointSelfConnectedDefault extends ReceiveEndpointDefault
    * @param {boolean?} backpointer true if this is the call form back call from the other side
    */
   removeConnection(other, backpointer) {
+    // @ts-ignore
     if (other === this) {
       return;
     }

package/src/send-endpoint.mjs

@@ -74,6 +74,11 @@ export class SendEndpoint extends ReceivableEndpoint {
     }
   }
 
+  /**
+   * Actually stop the communication.
+   * @param {Endpoint} other
+   * @param {boolean?} backpointer true if this is the call form back call from the other side
+   */
   removeConnection(other, backpointer) {
     this.closeConnection(other);
 

package/src/send-receive-endpoint.mjs

@@ -1,5 +1,8 @@
 import { SendEndpoint } from "./send-endpoint.mjs";
 
+/**
+ * bi directional endpint
+ */
 export class SendReceiveEndpoint extends SendEndpoint {
 
   /**

package/types/endpoint.d.mts

@@ -6,27 +6,37 @@
 export function isEndpoint(object: any): boolean;
 /**
  * Instanciate interceptors from its definitions.
- * @param {Interceptor[]|Class[]|String[]} interceptors
+ * @param {Interceptor[]|string[]|undefined} interceptors
  * @param {Object} owner
  * @return {Interceptor[]}
  */
-export function instanciateInterceptors(interceptors: Interceptor[] | Class[] | string[], owner: any): Interceptor[];
+export function instanciateInterceptors(interceptors: Interceptor[] | string[] | undefined, owner: any): Interceptor[];
 /**
  * @typedef {Object} ConnectionState
  */
 /**
  * Connection endpoint.
- * @param {string} name endpoint name
- * @param {Object} owner of the endpoint (service)
- * @param {Object} options
- * @param {Function} [options.didConnect] called after receiver is present
- * @param {Interceptor|Object[]} [options.interceptors] interceptors
  */
 export class Endpoint {
-    constructor(name: any, owner: any, options: any);
-    name: any;
+    /**
+     * @param {string} name endpoint name
+     * @param {Object} owner of the endpoint (service)
+     * @param {Object} options
+     * @param {function(Endpoint,Endpoint):void} [options.didConnect] called after receiver is present
+     * @param {Interceptor[]|string[]} [options.interceptors] interceptors
+     */
+    constructor(name: string, owner: any, options: {
+        didConnect?: (arg0: Endpoint, arg1: Endpoint) => void;
+        interceptors?: Interceptor[] | string[];
+    });
+    name: string;
     owner: any;
-    didConnect(a: any, b: any): void;
+    /**
+     *
+     * @param {Endpoint} endpoint
+     * @param {Endpoint} other
+     */
+    didConnect(endpoint: Endpoint, other: Endpoint): void;
     interceptors: Interceptor[];
     /**
      * Name as presented for humans.
@@ -54,9 +64,9 @@ export class Endpoint {
      *
      * @param {Object} options
      */
-    connectionNamesWithStates(options?: any): any[];
-    toString(): any;
-    get identifier(): any;
+    connectionNamesWithStates(options?: any): string[];
+    toString(): string;
+    get identifier(): string;
     /**
      * @return {boolean} false
      */
@@ -75,7 +85,7 @@ export class Endpoint {
         out: boolean;
         open: boolean;
         dummy: boolean;
-        connected: any;
+        connected: string | string[];
         interceptors: any[];
     };
     /**
@@ -87,7 +97,7 @@ export class Endpoint {
         out: boolean;
         open: boolean;
         dummy: boolean;
-        connected: any;
+        connected: string | string[];
         interceptors: any[];
     };
     /**
@@ -121,9 +131,9 @@ export class Endpoint {
     /**
      * Actually stop the communication.
      * @param {Endpoint} other
-     * @param {boolean?} backpointer true if this is the call from back call from the other side
+     * @param {boolean} [backpointer] true if this is the call from back call from the other side
      */
-    closeConnection(other: Endpoint, backpointer: boolean | null): void;
+    closeConnection(other: Endpoint, backpointer?: boolean): void;
     /**
      * Opens all connections.
      */
@@ -133,11 +143,20 @@ export class Endpoint {
      */
     closeConnections(): void;
     /**
-     * @return {Iterable<any>}
+     * @return {Iterable<Endpoint>}
+     */
+    connections(): Iterable<Endpoint>;
+    /**
+     *
+     * @param {Endpoint} connection
+     */
+    addConnection(connection: Endpoint): void;
+    /**
+     * Actually stop the communication.
+     * @param {Endpoint} other
+     * @param {boolean?} backpointer true if this is the call form back call from the other side
      */
-    connections(): Iterable<any>;
-    addConnection(): void;
-    removeConnection(): void;
+    removeConnection(other: Endpoint, backpointer: boolean | null): void;
     /**
      * Deliver state for a given connection.
      * @param {Endpoint} other

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

@@ -4,7 +4,6 @@
  */
 export class MultiConnectionEndpoint extends ReceivableEndpoint {
     addConnection(other: any, backpointer: any): void;
-    removeConnection(other: any, backpointer: any): void;
     /**
      * All connections
      */

package/types/receivable-endpoint.d.mts

@@ -6,6 +6,7 @@
  * @param {Function} [options.receivingInterceptors]
  */
 export class ReceivableEndpoint extends Endpoint {
+    constructor(name: any, owner: any, options: any);
     /**
      * Set the receive function.
      * @param {Function} receive

package/types/receive-endpoint-self-connected-default.d.mts

@@ -3,14 +3,7 @@
  */
 export class ReceiveEndpointSelfConnectedDefault extends ReceiveEndpointDefault {
     connections(): any;
-    /**
-     * Actually stop the communication.
-     * @param {Endpoint} other
-     * @param {boolean?} backpointer true if this is the call form back call from the other side
-     */
-    removeConnection(other: Endpoint, backpointer: boolean | null): void;
     isConnected(other: any): boolean;
     send(...args: any[]): Promise<any>;
 }
 import { ReceiveEndpointDefault } from "./receive-endpoint-default.mjs";
-import { Endpoint } from "./endpoint.mjs";

package/types/send-endpoint.d.mts

@@ -12,7 +12,6 @@ export class SendEndpoint extends ReceivableEndpoint {
     getConnectionState(other: any): any;
     setConnectionState(other: any, state: any): void;
     addConnection(other: any, backpointer: any): void;
-    removeConnection(other: any, backpointer: any): void;
     connections(): Generator<any, void, unknown>;
     send(...args: any[]): Promise<any>;
     #private;

package/types/send-receive-endpoint.d.mts

@@ -1,3 +1,6 @@
+/**
+ * bi directional endpint
+ */
 export class SendReceiveEndpoint extends SendEndpoint {
 }
 import { SendEndpoint } from "./send-endpoint.mjs";