node-opcua-client 2.72.2 → 2.74.0

package/LICENSE

@@ -1,6 +1,8 @@
 The MIT License (MIT)
 
-Copyright (c) 2014-2021 Etienne Rossignon
+Copyright (c) 2022  Sterfive SAS - 833264583 RCS ORLEANS - France (https://www.sterfive.com)
+
+Copyright (c) 2014-2022 Etienne Rossignon
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

package/README.md

@@ -6,3 +6,57 @@ an implementation of a OPC UA stack fully written in javascript and nodejs
 
 see http://node-opcua.github.io/
 
+
+# Documentation
+
+"NodeOPCUA by Example" (https://leanpub.com/node-opcuabyexample) provides a good starting point to understand and start using node-opcua.
+
+More advanced interactive material & documentation is made available online for Registered members of the NodeOPCUA Subscription. Please visit https://support.sterfive.com to apply or contact Sterfive.
+
+
+## Sponsors & Backers 
+
+We appreciate that, once you have evaluated the software you consider supporting our effort by applying to our sponsor program:
+
+  - https://github.com/sponsors/node-opcua
+  - https://opencollective.com/node-opcua
+
+Grants ensure the following:
+
+- 🔨 Long term maintenance of the project
+- ⚙️ maintain the website and continuous integration platform
+- 🛣  Progress on the road-map
+- 🐛 Quick responses to bug reports
+- 🚀 New features & enhancements
+- ⚖️ representing the node-opcua user community at the OPC Foundation
+
+# Support 
+
+Technical Support is exclusively provided to registered members of the NodeOPCUA Subscription (https://support.sterfive.com) or through dedicated Professional Services.
+
+# License
+
+Node-OPCUA is made available to you under the MIT open source license. 
+
+See [LICENSE](./LICENSE) for details.
+
+
+# value-added extensions
+
+Contact Sterfive SAS (mailto:contact@sterfive.com) for additional companion modules that are available to registered members:
+
+ - node-opcua-pub-sub : Part 14 implementation to develop OPC UA PubSub over MQTT applications
+ - node-opcua-webproxy:  to operate node-opcua from within a web browser
+ - node-opcua-optimized-client: super-charge OPC UA Client 
+ - react-components:    a collection of React UI components 
+ - aggregator:  a powerful OPC UA aggregator that can combine and monitored hundred of servers and millions of variables.
+ - node-opcua-gds: a Global Discovery Server (Part 12)
+ - node-opcua-modeler-ex: a powerful NO-GUI OPC UA modeler
+
+
+# Copyright
+
+Copyright (c) 2022  Sterfive SAS
+
+Copyright (c) 2014-2022 Etienne Rossignon
+

package/dist/client_base.d.ts

@@ -36,17 +36,8 @@ export interface FindEndpointResult {
 export declare type FindEndpointCallback = (err: Error | null, result?: FindEndpointResult) => void;
 export interface TransportSettings {
     maxChunkCount?: number;
-    /**
-     * @advanced
-     */
     maxMessageSize?: number;
-    /**
-     * @advanced
-     */
     sendBufferSize?: number;
-    /**
-     * @advanced
-     */
     receiveBufferSize?: number;
 }
 export interface OPCUAClientBaseOptions {
@@ -161,111 +152,102 @@ export interface OPCUAClientBase extends OPCUASecureObject {
 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
      * (advanced use only)
      * @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
      * (advanced use only)
      * @param event
      * @param eventHandler
      */
-    on(event: "receive_chunk", eventHandler: (chunk: Buffer) => void): this;
-    on(event: "send_request", eventHandler: (request: Request) => void): this;
-    on(event: "receive_response", eventHandler: (response: Response) => void): this;
+    on(eventName: "receive_chunk", eventHandler: (chunk: Buffer) => void): this;
+    on(eventName: "send_request", eventHandler: (request: Request) => 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
      * about to expired.
      * @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
      * and renegotiated with the server.to expire
      * @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
      * a Response from the server.
      * @param event
      * @param eventHandler
      */
-    on(event: "timed_out_request", eventHandler: (request: Request) => void): this;
-    on(event: string | symbol, listener: (...args: any[]) => void): this;
+    on(eventName: "timed_out_request", eventHandler: (request: Request) => void): this;
+    on(eventName: string | symbol, listener: (...args: any[]) => void): this;
 }
 export interface OPCUAClientBase {
     readonly endpoint?: EndpointDescription;
@@ -290,5 +272,6 @@ export interface OPCUAClientBase {
 }
 export declare class OPCUAClientBase {
     static registry: ObjectRegistry;
+    static retryDelay: number;
     static create(options: OPCUAClientBaseOptions): OPCUAClientBase;
 }

package/dist/client_base.js

@@ -11,4 +11,5 @@ class OPCUAClientBase {
 }
 exports.OPCUAClientBase = OPCUAClientBase;
 OPCUAClientBase.registry = new node_opcua_object_registry_1.ObjectRegistry();
+OPCUAClientBase.retryDelay = 1000 * 5;
 //# sourceMappingURL=client_base.js.map

package/dist/client_base.js.map

@@ -1 +1 @@
-{"version":3,"file":"client_base.js","sourceRoot":"","sources":["../source/client_base.ts"],"names":[],"mappings":";;;AASA,2EAA4D;AAoV5D,MAAa,eAAe;IAGjB,MAAM,CAAC,MAAM,CAAC,OAA+B;QAChD,yBAAyB;QACzB,OAAO,CAAC;QACR,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACvC,CAAC;;AAPL,0CAQC;AAPiB,wBAAQ,GAAG,IAAI,2CAAc,EAAE,CAAC"}
+{"version":3,"file":"client_base.js","sourceRoot":"","sources":["../source/client_base.ts"],"names":[],"mappings":";;;AASA,2EAA4D;AAkU5D,MAAa,eAAe;IAIjB,MAAM,CAAC,MAAM,CAAC,OAA+B;QAChD,yBAAyB;QACzB,OAAO,CAAC;QACR,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACvC,CAAC;;AARL,0CASC;AARiB,wBAAQ,GAAG,IAAI,2CAAc,EAAE,CAAC;AAChC,0BAAU,GAAG,IAAI,GAAG,CAAC,CAAC"}

package/dist/client_session.d.ts

@@ -24,11 +24,11 @@ import { 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";
@@ -374,7 +374,7 @@ export interface ClientSessionNamespaceService {
     readNamespaceArray(callback: (err: Error | null, namespaceArray?: string[]) => void): void;
 }
 export interface ClientSessionExtensionObjectService {
-    constructExtensionObject(dataType: NodeId, pojo: any): Promise<ExtensionObject>;
+    constructExtensionObject(dataType: NodeId, pojo: Record<string, unknown>): Promise<ExtensionObject>;
     /**
      * @private
      */

package/dist/client_session.js.map

@@ -1 +1 @@
-{"version":3,"file":"client_session.js","sourceRoot":"","sources":["../source/client_session.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AA6DH,yGAAkF;AAAzE,kJAAA,oBAAoB,OAAA;AAC7B,2EAA8D;AAArD,8HAAA,eAAe,OAAA"}
+{"version":3,"file":"client_session.js","sourceRoot":"","sources":["../source/client_session.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AA8DH,yGAAkF;AAAzE,kJAAA,oBAAoB,OAAA;AAE7B,2EAA8D;AAArD,8HAAA,eAAe,OAAA"}

package/dist/private/client_base_impl.d.ts

@@ -11,51 +11,37 @@ import { Request, Response } from "../common";
 import { CreateSecureChannelCallbackFunc, FindServersOnNetworkRequestLike, FindServersRequestLike, GetEndpointsOptions, OPCUAClientBase, OPCUAClientBaseOptions } from "../client_base";
 import { ClientSessionImpl } from "./client_session_impl";
 import { IClientBase } from "./i_private_client";
-declare type InternalClientState = "uninitialized" | "disconnected" | "connecting" | "connected" | "reconnecting" | "disconnecting";
+declare type InternalClientState = "uninitialized" | "disconnected" | "connecting" | "connected" | "reconnecting" | "reconnecting_newchannel_connected" | "disconnecting";
 /**
  * @internal
  */
 export declare class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase, IClientBase {
     /**
      * total number of requests that been canceled due to timeout
-     * @property timedOutRequestCount
-     * @type {Number}
      */
     get timedOutRequestCount(): number;
     /**
      * total number of transactions performed by the client
-     * @property transactionsPerformed
-     * @type {Number}
-     */
+   x  */
     get transactionsPerformed(): number;
     /**
      * is true when the client has already requested the server end points.
-     * @property knowsServerEndpoint
-     * @type boolean
      */
     get knowsServerEndpoint(): boolean;
     /**
      * true if the client is trying to reconnect to the server after a connection break.
-     * @property isReconnecting
-     * @type {Boolean}
      */
     get isReconnecting(): boolean;
     /**
      * true if the connection strategy is set to automatically try to reconnect in case of failure
-     * @property reconnectOnFailure
-     * @type {Boolean}
      */
     get reconnectOnFailure(): boolean;
     /**
      * total number of bytes read by the client
-     * @property bytesRead
-     * @type {Number}
      */
     get bytesRead(): number;
     /**
      * total number of bytes written by the client
-     * @property bytesWritten
-     * @type {Number}
      */
     get bytesWritten(): number;
     securityMode: MessageSecurityMode;
@@ -83,10 +69,11 @@ export declare class ClientBaseImpl extends OPCUASecureObject implements OPCUACl
     private _byteWritten;
     private _timedOutRequestCount;
     private _transactionsPerformed;
-    private reconnectionIsCanceled;
+    private _reconnectionIsCanceled;
     private _clockAdjuster?;
     private _tmpClient?;
     private _instanceNumber;
+    private _transportSettings;
     clientCertificateManager: OPCUACertificateManager;
     protected _setInternalState(internalState: InternalClientState): void;
     emit(eventName: string | symbol, ...others: any[]): boolean;
@@ -156,6 +143,7 @@ export declare class ClientBaseImpl extends OPCUASecureObject implements OPCUACl
     private _destroy_secure_channel;
     private _close_pending_sessions;
     private _install_secure_channel_event_handlers;
+    _inside_repairConnection: boolean;
     private _repairConnection;
     private _finalReconnectionStep;
     /**