@kronos-integration/endpoint 9.4.45 → 9.4.47

package/README.md

@@ -1,5 +1,6 @@
 [![npm](https://img.shields.io/npm/v/@kronos-integration/endpoint.svg)](https://www.npmjs.com/package/@kronos-integration/endpoint)
 [![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
+[![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/endpoint\&badge=detailed)](https://bundlejs.com/?q=@kronos-integration/endpoint)
 [![downloads](http://img.shields.io/npm/dm/@kronos-integration/endpoint.svg?style=flat-square)](https://npmjs.org/package/@kronos-integration/endpoint)
 [![GitHub Issues](https://img.shields.io/github/issues/Kronos-Integration/endpoint.svg?style=flat-square)](https://github.com/Kronos-Integration/endpoint/issues)
@@ -26,6 +27,7 @@ Named communication (end)-points inside of kronos
     *   [isIn](#isin)
     *   [isOpen](#isopen)
     *   [isDummy](#isdummy)
+*   [ConnectionState](#connectionstate)
 *   [Endpoint](#endpoint)
     *   [Parameters](#parameters)
     *   [displayName](#displayname)
@@ -50,38 +52,43 @@ Named communication (end)-points inside of kronos
         *   [Parameters](#parameters-5)
     *   [openConnections](#openconnections)
     *   [closeConnections](#closeconnections)
+    *   [getConnectionState](#getconnectionstate)
+        *   [Parameters](#parameters-6)
+    *   [setConnectionState](#setconnectionstate)
+        *   [Parameters](#parameters-7)
 *   [isEndpoint](#isendpoint)
-    *   [Parameters](#parameters-6)
+    *   [Parameters](#parameters-8)
 *   [instanciateInterceptors](#instanciateinterceptors)
-    *   [Parameters](#parameters-7)
+    *   [Parameters](#parameters-9)
 *   [MultiConnectionEndpoint](#multiconnectionendpoint)
-    *   [Parameters](#parameters-8)
-    *   [getConnectionState](#getconnectionstate)
-        *   [Parameters](#parameters-9)
-    *   [setConnectionState](#setconnectionstate)
-        *   [Parameters](#parameters-10)
-    *   [isConnected](#isconnected-1)
+    *   [Parameters](#parameters-10)
+    *   [getConnectionState](#getconnectionstate-1)
         *   [Parameters](#parameters-11)
+    *   [setConnectionState](#setconnectionstate-1)
+        *   [Parameters](#parameters-12)
+    *   [isConnected](#isconnected-1)
+        *   [Parameters](#parameters-13)
     *   [connections](#connections)
+*   [connections](#connections-1)
 *   [MultiSendEndpoint](#multisendendpoint)
-    *   [Parameters](#parameters-12)
+    *   [Parameters](#parameters-14)
     *   [isOut](#isout-1)
 *   [ReceivableEndpoint](#receivableendpoint)
-    *   [Parameters](#parameters-13)
+    *   [Parameters](#parameters-15)
     *   [isIn](#isin-2)
     *   [receive](#receive-1)
     *   [receive](#receive-2)
-        *   [Parameters](#parameters-14)
+        *   [Parameters](#parameters-16)
 *   [ReceiveEndpointDefault](#receiveendpointdefault)
     *   [isDefault](#isdefault-1)
 *   [ReceiveEndpointSelfConnectedDefault](#receiveendpointselfconnecteddefault)
 *   [ReceiveEndpoint](#receiveendpoint)
-    *   [Parameters](#parameters-15)
+    *   [Parameters](#parameters-17)
     *   [isIn](#isin-3)
 *   [SendEndpointDefault](#sendendpointdefault)
     *   [isDefault](#isdefault-2)
 *   [SendEndpoint](#sendendpoint)
-    *   [Parameters](#parameters-16)
+    *   [Parameters](#parameters-18)
     *   [isOut](#isout-2)
 
 ## DummyReceiveEndpoint
@@ -109,6 +116,10 @@ Dummy endpoints are used duiring construction of the endpoint mesh.
 
 Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true
 
+## ConnectionState
+
+Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
+
 ## Endpoint
 
 Connection endpoint.
@@ -227,6 +238,25 @@ Opens all connections.
 
 Closes all connections.
 
+### getConnectionState
+
+Deliver state for a given connection.
+
+#### Parameters
+
+*   `other` **[Endpoint](#endpoint)** 
+
+Returns **[ConnectionState](#connectionstate)** 
+
+### setConnectionState
+
+Set state for a given connection.
+
+#### Parameters
+
+*   `other` **[Endpoint](#endpoint)** 
+*   `state` **[ConnectionState](#connectionstate)** 
+
 ## isEndpoint
 
 Check for Endpoint.
@@ -267,7 +297,7 @@ Deliver connection state.
 
 #### Parameters
 
-*   `other` **Entpoint** 
+*   `other` **[Endpoint](#endpoint)** 
 
 Returns **any** our state for the connection to other
 
@@ -277,7 +307,7 @@ Set connection state.
 
 #### Parameters
 
-*   `other` **Entpoint** 
+*   `other` **[Endpoint](#endpoint)** 
 *   `state` **any** for the connection to other
 
 ### isConnected
@@ -294,6 +324,10 @@ Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
 
 All connections
 
+## connections
+
+Type: [Map](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map)<[Endpoint](#endpoint), any>
+
 ## MultiSendEndpoint
 
 **Extends MultiConnectionEndpoint**

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@kronos-integration/endpoint",
-  "version": "9.4.45",
+  "version": "9.4.47",
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "provenance": true
   },
   "exports": {
     ".": "./src/module.mjs"
@@ -27,24 +28,26 @@
     "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",
-    "lint:docs": "documentation lint ./src/**/*.mjs"
+    "lint": "npm run lint:docs && npm run lint:tsc",
+    "lint:docs": "documentation lint ./src/**/*.mjs",
+    "lint:tsc": "tsc --allowJs --checkJs --noEmit -t esnext -m esnext --module nodenext --moduleResolution nodenext ./src**/*.mjs"
   },
   "dependencies": {
-    "@kronos-integration/interceptor": "^10.2.37"
+    "@kronos-integration/interceptor": "^10.2.38"
   },
   "devDependencies": {
-    "ava": "^6.0.1",
-    "c8": "^9.0.0",
-    "documentation": "^14.0.2",
-    "semantic-release": "^22.0.12"
+    "ava": "^6.1.1",
+    "c8": "^9.1.0",
+    "documentation": "^14.0.3",
+    "semantic-release": "^23.0.2",
+    "typescript": "^5.3.3"
   },
   "engines": {
-    "node": ">=20.10.0"
+    "node": ">=20.11.0"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/Kronos-Integration/endpoint"
+    "url": "git+https://github.com/Kronos-Integration/endpoint.git"
   },
   "bugs": {
     "url": "https://github.com/Kronos-Integration/endpoint/issues"
@@ -53,7 +56,8 @@
   "template": {
     "inheritFrom": [
       "arlac77/template-arlac77-github",
-      "arlac77/template-kronos-component"
+      "arlac77/template-kronos-component",
+      "arlac77/template-typescript"
     ]
   }
 }

package/src/endpoint.mjs

@@ -129,7 +129,7 @@ export class Endpoint {
 
   /**
    * Deliver data flow direction.
-   * @return {string} delivers data flow direction 'in', 'out', 'inout' or undefined
+   * @return {string|undefined} delivers data flow direction 'in', 'out', 'inout' or undefined
    */
   get direction() {
     if (this.isIn) {
@@ -251,7 +251,7 @@ export class Endpoint {
   /**
    * Actually start with the communication.
    * @param {Endpoint} other
-   * @param {boolean} backpointer true if this is the call form 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) {
@@ -276,7 +276,7 @@ export class Endpoint {
   /**
    * Actually stop the communication.
    * @param {Endpoint} other
-   * @param {boolean} backpointer true if this is the call form 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) {
@@ -310,6 +310,9 @@ export class Endpoint {
     }
   }
 
+  /**
+   * @return {Iterable<any>}
+   */
   *connections() {}
 
   addConnection() {}
@@ -330,7 +333,7 @@ export class Endpoint {
    */
   setConnectionState(other, state) {}
 
-  didConnect() {}
+  didConnect(a,b) {}
 
   get receivingInterceptors() {
     return [];

package/src/multi-connection-endpoint.mjs

@@ -1,4 +1,4 @@
-import { isEndpoint } from "./endpoint.mjs";
+import { isEndpoint, Endpoint } from "./endpoint.mjs";
 import { ReceivableEndpoint } from "./receivable-endpoint.mjs";
 
 /**
@@ -7,7 +7,7 @@ import { ReceivableEndpoint } from "./receivable-endpoint.mjs";
  */
 export class MultiConnectionEndpoint extends ReceivableEndpoint {
 
-  #connections = new Map();
+  /** @type {Map<Endpoint,any>} */ #connections = new Map();
    
   constructor(name, owner, options) {
     super(name, owner, options);
@@ -19,7 +19,7 @@ export class MultiConnectionEndpoint extends ReceivableEndpoint {
 
   /**
    * Deliver connection state.
-   * @param {Entpoint} other
+   * @param {Endpoint} other
    * @return {any} our state for the connection to other
    */
   getConnectionState(other) {
@@ -28,7 +28,7 @@ export class MultiConnectionEndpoint extends ReceivableEndpoint {
 
   /**
    * Set connection state.
-   * @param {Entpoint} other
+   * @param {Endpoint} other
    * @param {any} state for the connection to other
    */
   setConnectionState(other, state) {

package/src/multi-send-endpoint.mjs

@@ -1,4 +1,5 @@
 import { MultiConnectionEndpoint } from "./multi-connection-endpoint.mjs";
+import { Endpoint } from "./endpoint.mjs";
 
 /**
  * Multiple Sending Endpoint.

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

@@ -1,4 +1,5 @@
 import { ReceiveEndpointDefault } from "./receive-endpoint-default.mjs";
+import { Endpoint } from "./endpoint.mjs";
 
 /**
  * Receiving endpoint wich can also send to itself.
@@ -20,6 +21,11 @@ export class ReceiveEndpointSelfConnectedDefault extends ReceiveEndpointDefault
     return super.addConnection(other, backpointer);
   }
 
+  /**
+   * 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) {
     if (other === this) {
       return;

package/src/receive-endpoint.mjs

@@ -1,4 +1,5 @@
 import { MultiConnectionEndpoint } from "./multi-connection-endpoint.mjs";
+import { Endpoint } from "./endpoint.mjs";
 
 /**
  * Receiving Endpoint.

package/src/send-endpoint.mjs

@@ -1,4 +1,4 @@
-import { isEndpoint } from "./endpoint.mjs";
+import { isEndpoint, Endpoint} from "./endpoint.mjs";
 import { ReceivableEndpoint } from "./receivable-endpoint.mjs";
 
 /**