@kronos-integration/endpoint 9.4.46 → 9.5.0

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)
@@ -51,6 +52,7 @@ Named communication (end)-points inside of kronos
         *   [Parameters](#parameters-5)
     *   [openConnections](#openconnections)
     *   [closeConnections](#closeconnections)
+    *   [connections](#connections)
     *   [getConnectionState](#getconnectionstate)
         *   [Parameters](#parameters-6)
     *   [setConnectionState](#setconnectionstate)
@@ -67,7 +69,8 @@ Named communication (end)-points inside of kronos
         *   [Parameters](#parameters-12)
     *   [isConnected](#isconnected-1)
         *   [Parameters](#parameters-13)
-    *   [connections](#connections)
+    *   [connections](#connections-1)
+*   [connections](#connections-2)
 *   [MultiSendEndpoint](#multisendendpoint)
     *   [Parameters](#parameters-14)
     *   [isOut](#isout-1)
@@ -80,13 +83,15 @@ Named communication (end)-points inside of kronos
 *   [ReceiveEndpointDefault](#receiveendpointdefault)
     *   [isDefault](#isdefault-1)
 *   [ReceiveEndpointSelfConnectedDefault](#receiveendpointselfconnecteddefault)
+    *   [removeConnection](#removeconnection)
+        *   [Parameters](#parameters-17)
 *   [ReceiveEndpoint](#receiveendpoint)
-    *   [Parameters](#parameters-17)
+    *   [Parameters](#parameters-18)
     *   [isIn](#isin-3)
 *   [SendEndpointDefault](#sendendpointdefault)
     *   [isDefault](#isdefault-2)
 *   [SendEndpoint](#sendendpoint)
-    *   [Parameters](#parameters-18)
+    *   [Parameters](#parameters-19)
     *   [isOut](#isout-2)
 
 ## DummyReceiveEndpoint
@@ -175,7 +180,7 @@ Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
 
 Deliver data flow direction.
 
-Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** delivers data flow direction 'in', 'out', 'inout' or undefined
+Returns **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** delivers data flow direction 'in', 'out', 'inout' or undefined
 
 ### jsonAttributes
 
@@ -217,7 +222,7 @@ Actually start with the communication.
 #### Parameters
 
 *   `other` **[Endpoint](#endpoint)** 
-*   `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
+*   `backpointer` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** true if this is the call from back call from the other side
 
 ### closeConnection
 
@@ -226,7 +231,7 @@ Actually stop the communication.
 #### Parameters
 
 *   `other` **[Endpoint](#endpoint)** 
-*   `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
+*   `backpointer` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** true if this is the call from back call from the other side
 
 ### openConnections
 
@@ -236,6 +241,10 @@ Opens all connections.
 
 Closes all connections.
 
+### connections
+
+Returns **Iterable\<any>**&#x20;
+
 ### getConnectionState
 
 Deliver state for a given connection.
@@ -295,7 +304,7 @@ Deliver connection state.
 
 #### Parameters
 
-*   `other` **Entpoint**&#x20;
+*   `other` **[Endpoint](#endpoint)**&#x20;
 
 Returns **any** our state for the connection to other
 
@@ -305,7 +314,7 @@ Set connection state.
 
 #### Parameters
 
-*   `other` **Entpoint**&#x20;
+*   `other` **[Endpoint](#endpoint)**&#x20;
 *   `state` **any** for the connection to other
 
 ### isConnected
@@ -322,6 +331,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**
@@ -394,6 +407,15 @@ Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
 
 Receiving endpoint wich can also send to itself.
 
+### 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
+
 ## ReceiveEndpoint
 
 **Extends MultiConnectionEndpoint**

package/package.json

@@ -1,12 +1,16 @@
 {
   "name": "@kronos-integration/endpoint",
-  "version": "9.4.46",
+  "version": "9.5.0",
   "publishConfig": {
     "access": "public",
     "provenance": true
   },
+  "types": "./types/module.d.mts",
   "exports": {
-    ".": "./src/module.mjs"
+    ".": {
+      "types": "./types/module.d.mts",
+      "default": "./src/module.mjs"
+    }
   },
   "description": "named communication (end)-points inside of kronos",
   "keywords": [
@@ -24,21 +28,24 @@
   ],
   "license": "BSD-2-Clause",
   "scripts": {
+    "prepare": "tsc --allowJs --declaration --emitDeclarationOnly --declarationDir types -t esnext -m esnext --module nodenext --moduleResolution nodenext ./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",
-    "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.1.1",
     "c8": "^9.1.0",
     "documentation": "^14.0.3",
-    "semantic-release": "^23.0.2"
+    "semantic-release": "^23.0.2",
+    "typescript": "^5.3.3"
   },
   "engines": {
     "node": ">=20.11.0"
@@ -54,7 +61,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-default.mjs

@@ -5,7 +5,7 @@ import { SendEndpoint } from "./send-endpoint.mjs";
  */
 export class SendEndpointDefault extends SendEndpoint {
   /**
-   * We are a default endpoint
+   * We are a default endpoint.
    * @return {boolean} always true
    */
   get isDefault() {

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";
 
 /**

package/src/send-receive-endpoint.mjs

@@ -1,6 +1,11 @@
 import { SendEndpoint } from "./send-endpoint.mjs";
 
 export class SendReceiveEndpoint extends SendEndpoint {
+
+  /**
+   * Always receiving.
+   * @return {boolean} true
+   */
   get isIn() {
     return true;
   }

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

@@ -0,0 +1,11 @@
+/**
+ * Dummy endpoints are used during construction of the endpoint mesh.
+ *
+ */
+export class DummyReceiveEndpoint extends Endpoint {
+    /**
+     * dummy does nothing by intention
+     */
+    receive(): Promise<void>;
+}
+import { Endpoint } from "./endpoint.mjs";

package/types/endpoint.d.mts

@@ -0,0 +1,155 @@
+/**
+ * Check for Endpoint.
+ * @param {any} object to be checked
+ * @return {boolean} true if object is an Endpoint
+ */
+export function isEndpoint(object: any): boolean;
+/**
+ * Instanciate interceptors from its definitions.
+ * @param {Interceptor[]|Class[]|String[]} interceptors
+ * @param {Object} owner
+ * @return {Interceptor[]}
+ */
+export function instanciateInterceptors(interceptors: Interceptor[] | Class[] | string[], 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;
+    owner: any;
+    didConnect(a: any, b: any): void;
+    interceptors: Interceptor[];
+    /**
+     * Name as presented for humans.
+     * @return {string}
+     */
+    get displayName(): string;
+    /**
+     * Indicate whatever we are a default endpoint.
+     * Default means buildin.
+     * @return {boolean} false
+     */
+    get isDefault(): boolean;
+    /**
+     * Indicate whatever we are a dummy endpoint.
+     * Dummy endpoints are used duiring construction of the endpoint mesh.
+     * @return {boolean} false
+     */
+    get isDummy(): boolean;
+    /**
+     * Mapping of properties used in toString.
+     * @return {Object}
+     */
+    get toStringAttributes(): any;
+    /**
+     *
+     * @param {Object} options
+     */
+    connectionNamesWithStates(options?: any): any[];
+    toString(): any;
+    get identifier(): any;
+    /**
+     * @return {boolean} false
+     */
+    get isIn(): boolean;
+    /**
+     * @return {boolean} false
+     */
+    get isOut(): boolean;
+    /**
+     * Deliver data flow direction.
+     * @return {string|undefined} delivers data flow direction 'in', 'out', 'inout' or undefined
+     */
+    get direction(): string;
+    toJSON(): {
+        in: boolean;
+        out: boolean;
+        open: boolean;
+        dummy: boolean;
+        connected: any;
+        interceptors: any[];
+    };
+    /**
+     * Additional attributes to present in json output.
+     */
+    get jsonAttributes(): any[];
+    toJSONWithOptions(options: any): {
+        in: boolean;
+        out: boolean;
+        open: boolean;
+        dummy: boolean;
+        connected: any;
+        interceptors: any[];
+    };
+    /**
+     * @return {boolean} true if there is at least one interceptor assigned
+     */
+    get hasInterceptors(): boolean;
+    get isOpen(): boolean;
+    /**
+     * Can we form a connection to the other side.
+     * in to out and out to in.
+     * @param {Endpoint} other
+     * @return {boolean} true if we can be connected to the other endpoint
+     */
+    connectable(other: Endpoint): boolean;
+    /**
+     * @return {boolean} true if there is at least one connection
+     */
+    get hasConnections(): boolean;
+    /**
+     * Are we connected to a endpoint.
+     * @param {Endpoint} other to check for the connection
+     * @return {boolean} true if there is a connection to the other endpoint
+     */
+    isConnected(other: Endpoint): boolean;
+    /**
+     * Actually start with the communication.
+     * @param {Endpoint} other
+     * @param {boolean?} backpointer true if this is the call from back call from the other side
+     */
+    openConnection(other: Endpoint, backpointer: boolean | null): void;
+    /**
+     * Actually stop the communication.
+     * @param {Endpoint} other
+     * @param {boolean?} backpointer true if this is the call from back call from the other side
+     */
+    closeConnection(other: Endpoint, backpointer: boolean | null): void;
+    /**
+     * Opens all connections.
+     */
+    openConnections(): void;
+    /**
+     * Closes all connections.
+     */
+    closeConnections(): void;
+    /**
+     * @return {Iterable<any>}
+     */
+    connections(): Iterable<any>;
+    addConnection(): void;
+    removeConnection(): void;
+    /**
+     * Deliver state for a given connection.
+     * @param {Endpoint} other
+     * @return {ConnectionState}
+     */
+    getConnectionState(other: Endpoint): ConnectionState;
+    /**
+     * Set state for a given connection.
+     * @param {Endpoint} other
+     * @param {ConnectionState} state
+     */
+    setConnectionState(other: Endpoint, state: ConnectionState): void;
+    get receivingInterceptors(): any[];
+}
+export type ConnectionState = any;

package/types/module.d.mts

@@ -0,0 +1,11 @@
+export * from "./endpoint.mjs";
+export * from "./receivable-endpoint.mjs";
+export * from "./multi-connection-endpoint.mjs";
+export * from "./send-endpoint.mjs";
+export * from "./receive-endpoint.mjs";
+export * from "./send-receive-endpoint.mjs";
+export * from "./dummy-receive-endpoint.mjs";
+export * from "./send-endpoint-default.mjs";
+export * from "./multi-send-endpoint.mjs";
+export * from "./receive-endpoint-default.mjs";
+export * from "./receive-endpoint-self-connected-default.mjs";

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

@@ -0,0 +1,15 @@
+/**
+ * Multiple connection endpoint.
+ * Can hold several connections.
+ */
+export class MultiConnectionEndpoint extends ReceivableEndpoint {
+    addConnection(other: any, backpointer: any): void;
+    removeConnection(other: any, backpointer: any): void;
+    /**
+     * All connections
+     */
+    connections(): Generator<Endpoint, void, undefined>;
+    #private;
+}
+import { ReceivableEndpoint } from "./receivable-endpoint.mjs";
+import { Endpoint } from "./endpoint.mjs";

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

@@ -0,0 +1,15 @@
+/**
+ * Multiple Sending Endpoint.
+ * Can hold several connections.
+ * Back connections to any further endpoints will not be established
+ * @param {string} name endpoint name
+ * @param {Object} owner of the endpoint (service)
+ * @param {Object} options
+ * @param {Endpoint} [options.connected] where te requests are delivered to
+ * @param {Function} [options.didConnect] called after receiver is present
+ */
+export class MultiSendEndpoint extends MultiConnectionEndpoint {
+    send(...args: any[]): void;
+    sendAndReceive(...args: any[]): AsyncGenerator<any, void, unknown>;
+}
+import { MultiConnectionEndpoint } from "./multi-connection-endpoint.mjs";

package/types/receivable-endpoint.d.mts

@@ -0,0 +1,21 @@
+/**
+ * @param {string} name endpoint name
+ * @param {Object} owner of the endpoint (service)
+ * @param {Object} options
+ * @param {Function} [options.receive] reciever function
+ * @param {Function} [options.receivingInterceptors]
+ */
+export class ReceivableEndpoint extends Endpoint {
+    /**
+     * Set the receive function.
+     * @param {Function} receive
+     */
+    set receive(receive: Function);
+    /**
+     * Get the receive function.
+     * @return {Function}
+     */
+    get receive(): Function;
+    #private;
+}
+import { Endpoint } from "./endpoint.mjs";

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

@@ -0,0 +1,6 @@
+/**
+ * Receive Endpoint acting as a default endpoints.
+ */
+export class ReceiveEndpointDefault extends ReceiveEndpoint {
+}
+import { ReceiveEndpoint } from "./receive-endpoint.mjs";

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

@@ -0,0 +1,16 @@
+/**
+ * Receiving endpoint wich can also send to itself.
+ */
+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/receive-endpoint.d.mts

@@ -0,0 +1,13 @@
+/**
+ * Receiving Endpoint.
+ * Can receive from several endpoints.
+ * By default a dummy rejecting receiver is assigned
+ * @param {string} name endpoint name
+ * @param {Object} owner of the endpoint (service)
+ * @param {Object} options
+ * @param {Function} [options.receive] reciever function
+ * @param {Endpoint} [options.connected] sending side
+ */
+export class ReceiveEndpoint extends MultiConnectionEndpoint {
+}
+import { MultiConnectionEndpoint } from "./multi-connection-endpoint.mjs";

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

@@ -0,0 +1,6 @@
+/**
+ * Send Endpoint acting as a default endpoints.
+ */
+export class SendEndpointDefault extends SendEndpoint {
+}
+import { SendEndpoint } from "./send-endpoint.mjs";

package/types/send-endpoint.d.mts

@@ -0,0 +1,20 @@
+/**
+ * Sending Endpoint.
+ * Can only hold one connection.
+ * Back connections to any further endpoints will not be established
+ * @param {string} name endpoint name
+ * @param {Object} owner of the endpoint (service)
+ * @param {Object} options
+ * @param {Endpoint} [options.connected] where te requests are delivered to
+ * @param {Function} [options.didConnect] called after receiver is present
+ */
+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;
+}
+import { ReceivableEndpoint } from "./receivable-endpoint.mjs";

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

@@ -0,0 +1,3 @@
+export class SendReceiveEndpoint extends SendEndpoint {
+}
+import { SendEndpoint } from "./send-endpoint.mjs";