@kronos-integration/endpoint 9.5.2 → 9.5.4

package/README.md

@@ -53,47 +53,58 @@ Named communication (end)-points inside of kronos
     *   [openConnections](#openconnections)
     *   [closeConnections](#closeconnections)
     *   [connections](#connections)
-    *   [getConnectionState](#getconnectionstate)
+    *   [addConnection](#addconnection)
         *   [Parameters](#parameters-6)
-    *   [setConnectionState](#setconnectionstate)
+    *   [removeConnection](#removeconnection)
         *   [Parameters](#parameters-7)
+    *   [getConnectionState](#getconnectionstate)
+        *   [Parameters](#parameters-8)
+    *   [setConnectionState](#setconnectionstate)
+        *   [Parameters](#parameters-9)
+    *   [didConnect](#didconnect)
+        *   [Parameters](#parameters-10)
 *   [isEndpoint](#isendpoint)
-    *   [Parameters](#parameters-8)
+    *   [Parameters](#parameters-11)
 *   [instanciateInterceptors](#instanciateinterceptors)
-    *   [Parameters](#parameters-9)
+    *   [Parameters](#parameters-12)
 *   [MultiConnectionEndpoint](#multiconnectionendpoint)
-    *   [Parameters](#parameters-10)
+    *   [Parameters](#parameters-13)
     *   [getConnectionState](#getconnectionstate-1)
-        *   [Parameters](#parameters-11)
+        *   [Parameters](#parameters-14)
     *   [setConnectionState](#setconnectionstate-1)
-        *   [Parameters](#parameters-12)
+        *   [Parameters](#parameters-15)
+    *   [removeConnection](#removeconnection-1)
+        *   [Parameters](#parameters-16)
     *   [isConnected](#isconnected-1)
-        *   [Parameters](#parameters-13)
+        *   [Parameters](#parameters-17)
     *   [connections](#connections-1)
 *   [connections](#connections-2)
 *   [MultiSendEndpoint](#multisendendpoint)
-    *   [Parameters](#parameters-14)
+    *   [Parameters](#parameters-18)
     *   [isOut](#isout-1)
 *   [ReceivableEndpoint](#receivableendpoint)
-    *   [Parameters](#parameters-15)
+    *   [Parameters](#parameters-19)
     *   [isIn](#isin-2)
     *   [receive](#receive-1)
     *   [receive](#receive-2)
-        *   [Parameters](#parameters-16)
+        *   [Parameters](#parameters-20)
 *   [ReceiveEndpointDefault](#receiveendpointdefault)
     *   [isDefault](#isdefault-1)
 *   [ReceiveEndpointSelfConnectedDefault](#receiveendpointselfconnecteddefault)
-    *   [removeConnection](#removeconnection)
-        *   [Parameters](#parameters-17)
+    *   [removeConnection](#removeconnection-2)
+        *   [Parameters](#parameters-21)
 *   [ReceiveEndpoint](#receiveendpoint)
-    *   [Parameters](#parameters-18)
+    *   [Parameters](#parameters-22)
     *   [isIn](#isin-3)
 *   [SendEndpointDefault](#sendendpointdefault)
     *   [isDefault](#isdefault-2)
 *   [SendEndpoint](#sendendpoint)
-    *   [Parameters](#parameters-19)
+    *   [Parameters](#parameters-23)
     *   [isOut](#isout-2)
-*   [isIn](#isin-4)
+    *   [removeConnection](#removeconnection-3)
+        *   [Parameters](#parameters-24)
+*   [SendReceiveEndpoint](#sendreceiveendpoint)
+    *   [isIn](#isin-4)
 
 ## DummyReceiveEndpoint
 
@@ -134,9 +145,6 @@ Connection endpoint.
 *   `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.didConnect` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** called after receiver is present
-    *   `options.interceptors` **(Interceptor | [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)>)?** interceptors
-
 ### displayName
 
 Name as presented for humans.
@@ -244,7 +252,22 @@ Closes all connections.
 
 ### connections
 
-Returns **Iterable\<any>**&#x20;
+Returns **Iterable<[Endpoint](#endpoint)>**&#x20;
+
+### addConnection
+
+#### Parameters
+
+*   `connection` **[Endpoint](#endpoint)**&#x20;
+
+### removeConnection
+
+Actually stop the communication.
+
+#### Parameters
+
+*   `other` **[Endpoint](#endpoint)**&#x20;
+*   `backpointer` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** true if this is the call form back call from the other side
 
 ### getConnectionState
 
@@ -265,6 +288,13 @@ Set state for a given connection.
 *   `other` **[Endpoint](#endpoint)**&#x20;
 *   `state` **[ConnectionState](#connectionstate)**&#x20;
 
+### didConnect
+
+#### Parameters
+
+*   `endpoint` **[Endpoint](#endpoint)**&#x20;
+*   `other` **[Endpoint](#endpoint)**&#x20;
+
 ## isEndpoint
 
 Check for Endpoint.
@@ -281,7 +311,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)> | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))**&#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;
@@ -318,6 +348,15 @@ Set connection state.
 *   `other` **[Endpoint](#endpoint)**&#x20;
 *   `state` **any** for the connection to other
 
+### removeConnection
+
+Actually stop the communication.
+
+#### Parameters
+
+*   `other` **[Endpoint](#endpoint)**&#x20;
+*   `backpointer` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** true if this is the call form back call from the other side
+
 ### isConnected
 
 Check connectivity.
@@ -475,7 +514,22 @@ We are always *out*
 
 Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** always true
 
-## isIn
+### removeConnection
+
+Actually stop the communication.
+
+#### Parameters
+
+*   `other` **[Endpoint](#endpoint)**&#x20;
+*   `backpointer` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** true if this is the call form back call from the other side
+
+## SendReceiveEndpoint
+
+**Extends SendEndpoint**
+
+bi directional endpint
+
+### isIn
 
 Always receiving.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kronos-integration/endpoint",
-  "version": "9.5.2",
+  "version": "9.5.4",
   "publishConfig": {
     "access": "public",
     "provenance": true
@@ -28,14 +28,15 @@
   ],
   "license": "BSD-2-Clause",
   "scripts": {
-    "prepare": "tsc --allowJs --declaration --emitDeclarationOnly --declarationDir types -t esnext -m esnext --module nodenext --moduleResolution nodenext --rootDir src ./src**/*.mjs",
+    "prepare": "npm run prepare:typescript",
+    "prepare:typescript": "tsc --allowJs --declaration --emitDeclarationOnly --declarationDir types --resolveJsonModule -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",
     "docs": "documentation readme --section=API ./src/**/*.mjs",
-    "lint": "npm run lint:docs && npm run lint:tsc",
+    "lint": "npm run lint:docs && npm run lint:typescript",
     "lint:docs": "documentation lint ./src/**/*.mjs",
-    "lint:tsc": "tsc --allowJs --checkJs --noEmit -t esnext -m esnext --module nodenext --moduleResolution nodenext ./src**/*.mjs"
+    "lint:typescript": "tsc --allowJs --checkJs --noEmit --resolveJsonModule -t esnext -m esnext --module nodenext --moduleResolution nodenext ./src**/*.mjs"
   },
   "dependencies": {
     "@kronos-integration/interceptor": "^10.3.0"
@@ -44,11 +45,11 @@
     "ava": "^6.1.2",
     "c8": "^9.1.0",
     "documentation": "^14.0.3",
-    "semantic-release": "^23.0.2",
-    "typescript": "^5.3.3"
+    "semantic-release": "^23.0.8",
+    "typescript": "^5.4.5"
   },
   "engines": {
-    "node": ">=20.11.1"
+    "node": ">=20.12.2"
   },
   "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 }) {
@@ -251,7 +254,7 @@ export class Endpoint {
   /**
    * Actually start with 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
    */
   openConnection(other, backpointer) {
     if (other !== undefined) {
@@ -311,22 +314,28 @@ export class Endpoint {
   }
 
   /**
-   * @return {Iterable<any>}
+   * @return {Iterable<Endpoint>}
    */
   *connections() {}
 
   /**
-   * 
-   * @param {any} connection 
+   *
+   * @param {Endpoint} connection
+   * @param {boolean} [backpointer] true if this is the call form back call from the other side
    */
-  addConnection(connection) {}
+  addConnection(connection, backpointer) {}
 
-  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) {}
 
@@ -337,7 +346,12 @@ export class Endpoint {
    */
   setConnectionState(other, state) {}
 
-  didConnect(a,b) {}
+  /**
+   *
+   * @param {Endpoint} endpoint
+   * @param {Endpoint} other
+   */
+  didConnect(endpoint, other) {}
 
   get receivingInterceptors() {
     return [];
@@ -355,7 +369,7 @@ export function isEndpoint(object) {
 
 /**
  * Instanciate interceptors from its definitions.
- * @param {Interceptor[]|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/send-endpoint.mjs

@@ -1,4 +1,4 @@
-import { isEndpoint, Endpoint} from "./endpoint.mjs";
+import { isEndpoint, Endpoint } from "./endpoint.mjs";
 import { ReceivableEndpoint } from "./receivable-endpoint.mjs";
 
 /**
@@ -12,10 +12,9 @@ import { ReceivableEndpoint } from "./receivable-endpoint.mjs";
  * @param {Function} [options.didConnect] called after receiver is present
  */
 export class SendEndpoint extends ReceivableEndpoint {
-
   #connection;
   #state;
-  
+
   constructor(name, owner, options) {
     super(name, owner, options);
     if (isEndpoint(options?.connected)) {
@@ -45,6 +44,11 @@ export class SendEndpoint extends ReceivableEndpoint {
     }
   }
 
+  /**
+   * Add a connection.
+   * @param {Endpoint} other
+   * @param {boolean} [backpointer] true if this is the call form back call from the other side
+   */
   addConnection(other, backpointer) {
     if (this.#connection === other) {
       return;
@@ -74,6 +78,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/types/endpoint.d.mts

@@ -6,27 +6,37 @@
 export function isEndpoint(object: any): boolean;
 /**
  * Instanciate interceptors from its definitions.
- * @param {Interceptor[]|string[]} interceptors
+ * @param {Interceptor[]|string[]|undefined} interceptors
  * @param {Object} owner
  * @return {Interceptor[]}
  */
-export function instanciateInterceptors(interceptors: Interceptor[] | 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[];
     };
     /**
@@ -115,9 +125,9 @@ export class Endpoint {
     /**
      * Actually start with 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
      */
-    openConnection(other: Endpoint, backpointer: boolean | null): void;
+    openConnection(other: Endpoint, backpointer?: boolean): void;
     /**
      * Actually stop the communication.
      * @param {Endpoint} other
@@ -133,15 +143,21 @@ export class Endpoint {
      */
     closeConnections(): void;
     /**
-     * @return {Iterable<any>}
+     * @return {Iterable<Endpoint>}
      */
-    connections(): Iterable<any>;
+    connections(): Iterable<Endpoint>;
     /**
      *
-     * @param {any} connection
+     * @param {Endpoint} connection
+     * @param {boolean} [backpointer] true if this is the call form back call from the other side
+     */
+    addConnection(connection: Endpoint, backpointer?: boolean): void;
+    /**
+     * Actually stop the communication.
+     * @param {Endpoint} other
+     * @param {boolean} [backpointer] true if this is the call form back call from the other side
      */
-    addConnection(connection: any): void;
-    removeConnection(): void;
+    removeConnection(other: Endpoint, backpointer?: boolean): 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/send-endpoint.d.mts

@@ -11,8 +11,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;