node-opcua-client 2.72.2 → 2.74.0

package/source/client_base.ts

@@ -41,17 +41,8 @@ export type FindEndpointCallback = (err: Error | null, result?: FindEndpointResu
 
 export interface TransportSettings {
     maxChunkCount?: number;
-    /**
-     * @advanced
-     */
     maxMessageSize?: number;
-    /**
-     * @advanced
-     */
     sendBufferSize?: number;
-    /**
-     * @advanced
-     */
     receiveBufferSize?: number;
 }
 
@@ -200,68 +191,59 @@ export interface OPCUAClientBase extends EventEmitter {
 
     /**
      * this Event is raised when the  initial connection has succeeded
-     * @param event
-     * @param eventHandler
      */
-    on(event: "connected", eventHandler: () => void): this;
+    on(eventName: "connected", eventHandler: () => void): this;
 
     /**
      * this Event is raised when the  initial connection has failed
-     * @param event
-     * @param eventHandler
      */
-    on(event: "connection_failed", eventHandler: (err: Error) => void): this;
+    on(eventName: "connection_failed", eventHandler: (err: Error) => void): this;
 
     /**
      * this Event is raised when a failing connection is about to be tried again
-     * @param event
-     * @param eventHandler
      */
-    on(event: "backoff", eventHandler: (count: number, delay: number) => void): this;
+    on(eventName: "backoff", eventHandler: (count: number, delay: number) => void): this;
 
     /**
      * this event is raised when the client has encountered a connection failure and
      * and is going to reconnection mode.
+     *
+     * It notifies the observer that the OPCUA is now trying to reestablish the connection
+     * after having received a connection break...
+     *
      * You can intercept start_reconnection event to pause your interaction with the remote
      * OPCUA server.
-     * @param event
-     * @param eventHandler
      */
-    on(event: "start_reconnection", eventHandler: () => void): this;
+    on(eventName: "start_reconnection", eventHandler: () => void): this;
 
     /**
      * this event is raised when the client has failed one attempt to reconnect to the server
      * This event will be raised if the socket has successfully being created to the server but
      * if something went wrong during the reconnection process.
-     * @param event
-     * @param eventHandler
      */
-    on(event: "reconnection_attempt_has_failed", eventHandler: (err: Error, message: string) => void): this;
+    on(eventName: "reconnection_attempt_has_failed", eventHandler: (err: Error, message: string) => void): this;
 
     /**
      * this event is raised after the client has successfully managed to re-establish the connection with
      * the remote OPCUA Server.
      * You can intercept after_reconnection event to resume your interaction with the remote
      * OPCUA server.
-     *
-     * @param event
-     * @param eventHandler
      */
-    on(event: "after_reconnection", eventHandler: (err?: Error) => void): this;
+    on(eventName: "after_reconnection", eventHandler: (err?: Error) => void): this;
 
     /**
      * the event is raised when the connection has been aborted by the remote OPCUA Server
      * @param event
      * @param eventHandler
      */
-    on(event: "abort", eventHandler: () => void): this;
+    on(eventName: "abort", eventHandler: () => void): this;
 
     /**
      * this event is raised when the connection is closed
      * @param event
      * @param eventHandler
      */
-    on(event: "close", eventHandler: () => void): this;
+    on(eventName: "close", eventHandler: () => void): this;
 
     /**
      * this event is raised when the client is sending a message chunk to the server
@@ -269,7 +251,7 @@ export interface OPCUAClientBase extends EventEmitter {
      * @param event
      * @param eventHandler
      */
-    on(event: "send_chunk", eventHandler: (chunk: Buffer) => void): this;
+    on(eventName: "send_chunk", eventHandler: (chunk: Buffer) => void): this;
 
     /**
      * this event is raised when the client has received a new message chunk from the servers
@@ -277,11 +259,11 @@ export interface OPCUAClientBase extends EventEmitter {
      * @param event
      * @param eventHandler
      */
-    on(event: "receive_chunk", eventHandler: (chunk: Buffer) => void): this;
+    on(eventName: "receive_chunk", eventHandler: (chunk: Buffer) => void): this;
 
-    on(event: "send_request", eventHandler: (request: Request) => void): this;
+    on(eventName: "send_request", eventHandler: (request: Request) => void): this;
 
-    on(event: "receive_response", eventHandler: (response: Response) => void): this;
+    on(eventName: "receive_response", eventHandler: (response: Response) => void): this;
 
     /**
      * this event is raised when the current security token has reached 75% of its lifetime and is therefore
@@ -289,7 +271,7 @@ export interface OPCUAClientBase extends EventEmitter {
      * @param event
      * @param eventHandler
      */
-    on(event: "lifetime_75", eventHandler: (token: ChannelSecurityToken) => void): this;
+    on(eventName: "lifetime_75", eventHandler: (token: ChannelSecurityToken) => void): this;
 
     /**
      * this event is raised after the (about ) security token as been renewed
@@ -297,21 +279,21 @@ export interface OPCUAClientBase extends EventEmitter {
      * @param event
      * @param eventHandler
      */
-    on(event: "security_token_renewed", eventHandler: () => void): this;
+    on(eventName: "security_token_renewed", eventHandler: () => void): this;
 
     /**
      * this event is raised when the connection has been broken
      * @param event
      * @param eventHandler
      */
-    on(event: "connection_lost", eventHandler: () => void): this;
+    on(eventName: "connection_lost", eventHandler: () => void): this;
 
     /**
      * this event is raised when a broken connection with the remote Server has been reestablished
      * @param event
      * @param eventHandler
      */
-    on(event: "connection_reestablished", eventHandler: () => void): this;
+    on(eventName: "connection_reestablished", eventHandler: () => void): this;
 
     /**
      * This event is raised when a request sent to the remote OPCUA server has reach it's timeout value without
@@ -319,9 +301,9 @@ export interface OPCUAClientBase extends EventEmitter {
      * @param event
      * @param eventHandler
      */
-    on(event: "timed_out_request", eventHandler: (request: Request) => void): this;
+    on(eventName: "timed_out_request", eventHandler: (request: Request) => void): this;
 
-    on(event: string | symbol, listener: (...args: any[]) => void): this;
+    on(eventName: string | symbol, listener: (...args: any[]) => void): this;
 }
 
 export interface OPCUAClientBase {
@@ -349,6 +331,7 @@ export interface OPCUAClientBase {
 
 export class OPCUAClientBase {
     public static registry = new ObjectRegistry();
+    public static retryDelay = 1000 * 5;
 
     public static create(options: OPCUAClientBaseOptions): OPCUAClientBase {
         /* istanbul ignore next*/

package/source/client_session.ts

@@ -56,12 +56,14 @@ import { WriteValue, WriteValueOptions } from "node-opcua-service-write";
 import { StatusCode } from "node-opcua-status-code";
 import { DataType, Variant } from "node-opcua-variant";
 import { Callback } from "node-opcua-status-code";
-import { ExtraDataTypeManager } from "node-opcua-client-dynamic-extension-object";
 import { ExtensionObject } from "node-opcua-extension-object";
 import { ArgumentDefinition, CallMethodRequestLike, MethodId } from "node-opcua-pseudo-session";
 import { AggregateFunction } from "node-opcua-constants";
 import { HistoryReadRequest, HistoryReadResponse, HistoryReadValueIdOptions } from "node-opcua-types";
+
+import { ExtraDataTypeManager } from "node-opcua-client-dynamic-extension-object";
 export { ExtraDataTypeManager } from "node-opcua-client-dynamic-extension-object";
+
 export { ExtensionObject } from "node-opcua-extension-object";
 export { ArgumentDefinition, CallMethodRequestLike, MethodId } from "node-opcua-pseudo-session";
 
@@ -577,7 +579,7 @@ export interface ClientSessionNamespaceService {
 }
 
 export interface ClientSessionExtensionObjectService {
-    constructExtensionObject(dataType: NodeId, pojo: any): Promise<ExtensionObject>;
+    constructExtensionObject(dataType: NodeId, pojo: Record<string, unknown>): Promise<ExtensionObject>;
 
     /**
      * @private