@kronos-integration/endpoint 9.4.44 → 9.4.46

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2016-2023 by darlenya & arlac77
+Copyright (c) 2016-2024 by darlenya & arlac77
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

package/README.md

@@ -26,6 +26,7 @@ Named communication (end)-points inside of kronos
     *   [isIn](#isin)
     *   [isOpen](#isopen)
     *   [isDummy](#isdummy)
+*   [ConnectionState](#connectionstate)
 *   [Endpoint](#endpoint)
     *   [Parameters](#parameters)
     *   [displayName](#displayname)
@@ -50,38 +51,42 @@ 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)
 *   [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 +114,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.
@@ -117,7 +126,7 @@ Connection endpoint.
 
 *   `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)**  (optional, default `{}`)
+*   `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
@@ -227,6 +236,25 @@ Opens all connections.
 
 Closes all connections.
 
+### getConnectionState
+
+Deliver state for a given connection.
+
+#### Parameters
+
+*   `other` **[Endpoint](#endpoint)**&#x20;
+
+Returns **[ConnectionState](#connectionstate)**&#x20;
+
+### setConnectionState
+
+Set state for a given connection.
+
+#### Parameters
+
+*   `other` **[Endpoint](#endpoint)**&#x20;
+*   `state` **[ConnectionState](#connectionstate)**&#x20;
+
 ## isEndpoint
 
 Check for Endpoint.
@@ -259,7 +287,7 @@ Can hold several connections.
 
 *   `name` &#x20;
 *   `owner` &#x20;
-*   `options`   (optional, default `{}`)
+*   `options` &#x20;
 
 ### getConnectionState
 
@@ -413,7 +441,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)**  (optional, default `{}`)
+*   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
 
     *   `options.connected` **[Endpoint](#endpoint)?** where te requests are delivered to
     *   `options.didConnect` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** called after receiver is present

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@kronos-integration/endpoint",
-  "version": "9.4.44",
+  "version": "9.4.46",
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "provenance": true
   },
   "exports": {
     ".": "./src/module.mjs"
@@ -34,17 +35,17 @@
     "@kronos-integration/interceptor": "^10.2.37"
   },
   "devDependencies": {
-    "ava": "^5.3.1",
-    "c8": "^8.0.1",
-    "documentation": "^14.0.2",
-    "semantic-release": "^22.0.7"
+    "ava": "^6.1.1",
+    "c8": "^9.1.0",
+    "documentation": "^14.0.3",
+    "semantic-release": "^23.0.2"
   },
   "engines": {
-    "node": ">=20.9.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"

package/src/endpoint.mjs

@@ -1,5 +1,9 @@
 import { Interceptor } from "@kronos-integration/interceptor";
 
+/**
+ * @typedef {Object} ConnectionState
+ */
+
 /**
  * Connection endpoint.
  * @param {string} name endpoint name
@@ -10,19 +14,13 @@ import { Interceptor } from "@kronos-integration/interceptor";
  */
 export class Endpoint {
   constructor(name, owner, options) {
-    const properties = {
-      name: { value: name },
-      owner: { value: owner }
-    };
+    this.name = name;
+    this.owner = owner;
 
     if (options?.didConnect !== undefined) {
-      properties.didConnect = {
-        value: options.didConnect
-      };
+      this.didConnect = options.didConnect;
     }
 
-    Object.defineProperties(this, properties);
-
     this.interceptors = instanciateInterceptors(
       options?.interceptors,
       this.owner
@@ -299,7 +297,7 @@ export class Endpoint {
    */
   openConnections() {
     for (const c of this.connections()) {
-      this.openConnection(c);
+      this.openConnection(c, false);
     }
   }
 
@@ -308,7 +306,7 @@ export class Endpoint {
    */
   closeConnections() {
     for (const c of this.connections()) {
-      this.closeConnection(c);
+      this.closeConnection(c, false);
     }
   }
 
@@ -318,9 +316,19 @@ export class Endpoint {
 
   removeConnection() {}
 
-  getConnectionState() {}
+  /**
+   * Deliver state for a given connection.
+   * @param {Endpoint} other
+   * @return {ConnectionState} 
+   */
+  getConnectionState(other) {}
 
-  setConnectionState() {}
+  /**
+   * Set state for a given connection.
+   * @param {Endpoint} other
+   * @param {ConnectionState} state
+   */
+  setConnectionState(other, state) {}
 
   didConnect() {}