node-opcua-client 2.132.0 → 2.134.0

package/source/private/client_session_impl.ts

@@ -15,7 +15,7 @@ import {
     promoteOpaqueStructure,
     PseudoDataValue
 } from "node-opcua-client-dynamic-extension-object";
-import { Certificate, Nonce } from "node-opcua-crypto";
+import { Certificate, Nonce } from "node-opcua-crypto/web";
 import { BrowseDirection, LocalizedTextLike } from "node-opcua-data-model";
 import { DataValue } from "node-opcua-data-value";
 import { checkDebugFlag, make_debugLog, make_errorLog, make_warningLog } from "node-opcua-debug";
@@ -190,9 +190,6 @@ export interface Reconnectable {
 
 /**
  * @class ClientSession
- * @param client {OPCUAClientImpl}
- * @constructor
- * @private
  */
 export class ClientSessionImpl extends EventEmitter implements ClientSession, Reconnectable {
     static reconnectingElement: WeakMap<ClientSessionImpl, Reconnectable> = new WeakMap();
@@ -305,8 +302,6 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession, Re
         });
     }
     /**
-     * @method browse
-     * @async
      *
      * @example
      *
@@ -410,8 +405,8 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession, Re
                     if (r.references && r.references.length > this.requestedMaxReferencesPerNode) {
                         warningLog(
                             chalk.yellow("warning") +
-                            " BrowseResponse : the server didn't take into" +
-                            " account our requestedMaxReferencesPerNode "
+                                " BrowseResponse : the server didn't take into" +
+                                " account our requestedMaxReferencesPerNode "
                         );
                         warningLog("        this.requestedMaxReferencesPerNode= " + this.requestedMaxReferencesPerNode);
                         warningLog("        got " + r.references.length + "for " + nodesToBrowse[i].nodeId.toString());
@@ -420,7 +415,7 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession, Re
                 }
             }
             for (const r of results) {
-                r.references = r.references || /* istanbul ignore next */[];
+                r.references = r.references || /* istanbul ignore next */ [];
             }
             assert(results[0] instanceof BrowseResult);
             return callback(null, isArray ? results : results[0]);
@@ -476,8 +471,6 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession, Re
     }
 
     /**
-     * @method readVariableValue
-     * @async
      *
      * @example
      *
@@ -560,8 +553,6 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession, Re
     }
 
     /**
-     * @method readHistoryValue
-     * @async
      *
      * @example
      *
@@ -719,7 +710,7 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession, Re
                 return callback(new Error(response.responseHeader.serviceResult.toString()));
             }
 
-            response.results = response.results || /* istanbul ignore next */[];
+            response.results = response.results || /* istanbul ignore next */ [];
             callback(null, response);
         });
     }
@@ -851,7 +842,7 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession, Re
                 return callback(new Error(response.responseHeader.serviceResult.toString()));
             }
 
-            response.results = response.results || /* istanbul ignore next */[];
+            response.results = response.results || /* istanbul ignore next */ [];
 
             assert(nodesToRead.length === response.results.length);
 
@@ -861,12 +852,11 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession, Re
 
     /**
      *
-     * @method write
+
      * @param nodesToWrite {WriteValue[]}  - the array of value to write. One or more elements.
      * @param {Function} callback -   the callback function
      * @param callback.err {object|null} the error if write has failed or null if OK
      * @param callback.statusCodes {StatusCode[]} - an array of status code of each write
-     * @async
      *
      * @example
      *
@@ -899,12 +889,11 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession, Re
      *       //
      *     });
      *
-     * @method write
+
      * @param nodeToWrite {WriteValue}  - the value to write
      * @param callback -   the callback function
      * @param callback.err {object|null} the error if write has failed or null if OK
      * @param callback.statusCode {StatusCodes} - the status code of the write
-     * @async
      *
      * @example
      *
@@ -925,10 +914,9 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession, Re
      *     });
      *
      *
-     * @method write
+
      * @param nodeToWrite {WriteValue}  - the value to write
      * @return {Promise<StatusCode>}
-     * @async
      *
      * @example
      *
@@ -942,10 +930,9 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession, Re
      *   const statusCode = await session.write(nodeToWrite);
      * ```
      *
-     * @method write
+
      * @param nodesToWrite {Array<WriteValue>}  - the value to write
      * @return {Promise<Array<StatusCode>>}
-     * @async
      *
      * @example
      * ```javascript
@@ -994,29 +981,25 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession, Re
             if (response.responseHeader.serviceResult.isNot(StatusCodes.Good)) {
                 return callback(new Error(response.responseHeader.serviceResult.toString()));
             }
-            response.results = response.results || /* istanbul ignore next */[];
+            response.results = response.results || /* istanbul ignore next */ [];
             assert(nodesToWrite.length === response.results.length);
             callback(null, isArray ? response.results : response.results[0]);
         });
     }
 
     /**
+     * @deprecated use session.write instead
      *
-     * @method writeSingleNode
-     * @async
      * @param nodeId  {NodeId}  - the node id of the node to write
      * @param value   {Variant} - the value to write
      * @param callback   {Function}
      * @param callback.err {object|null} the error if write has failed or null if OK
      * @param callback.statusCode {StatusCode} - the status code of the write
      *
-     * @method writeSingleNode
-     * @async
      * @param nodeId  {NodeId}  - the node id of the node to write
      * @param value   {Variant} - the value to write
      * @return {Promise<StatusCode>} - the status code of the write
      *
-     * @deprecated use session.write instead
      *
      * @example
      *     // please use session.write instead of session.writeSingleNode
@@ -1065,7 +1048,7 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession, Re
     }
 
     /**
-     * @method readAllAttributes
+
      *
      * @example
      *
@@ -1081,7 +1064,6 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession, Re
      *  });
      *  ```
      *
-     * @async
      * @param nodes  array of nodeId to read
      * @param node  nodeId to read
      * @param callback
@@ -1099,9 +1081,7 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession, Re
     }
 
     /**
-     * @method read (form1)
      *
-     * @async
      *
      * @example
      *
@@ -1124,13 +1104,12 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession, Re
      *    ```
      *
      *
-     * @method read (form2)
+
      * @param nodesToRead               {Array<ReadValueId>} - an array of nodeId to read or a ReadValueId
      * @param [maxAge]                 {Number}
      * @param callback                 {Function}                - the callback function
      * @param callback.err             {Error|null}              - the error or null if the transaction was OK}
      * @param callback.dataValues       {Array<DataValue>}
-     * @async
      *
      * @example
      *
@@ -1197,7 +1176,7 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession, Re
                 warningLog(
                     chalk.yellow(
                         "please make sure to refactor your code and check that " +
-                        "the second argument of your callback function is named"
+                            "the second argument of your callback function is named"
                     ),
                     chalk.cyan("dataValue" + (isArray ? "s" : ""))
                 );
@@ -1230,7 +1209,7 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession, Re
 
             // perform ExtensionObject resolution
             promoteOpaqueStructureWithCallback(this, response.results!, () => {
-                response.results = response.results || /* istanbul ignore next */[];
+                response.results = response.results || /* istanbul ignore next */ [];
                 return callback(null, isArray ? response.results : response.results[0]);
             });
         });
@@ -1252,7 +1231,7 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession, Re
     }
 
     /**
-     * @method createSubscription2
+
      * @param createSubscriptionRequest
      * @param callback
      *
@@ -1301,8 +1280,6 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession, Re
     }
 
     /**
-     * @method transferSubscriptions
-     * @async
      */
     public transferSubscriptions(
         options: TransferSubscriptionsRequestLike,
@@ -1327,12 +1304,6 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession, Re
 
     /**
      *
-     * @method modifySubscription
-     * @async
-     * @param options {ModifySubscriptionRequest}
-     * @param callback {Function}
-     * @param callback.err {Error|null}   - the Error if the async method has failed
-     * @param callback.response {ModifySubscriptionResponse} - the response
      */
     public modifySubscription(
         options: ModifySubscriptionRequestLike,
@@ -1346,13 +1317,6 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession, Re
     }
 
     /**
-     *
-     * @method publish
-     * @async
-     * @param options  {PublishRequest}
-     * @param callback {Function}
-     * @param callback.err {Error|null}   - the Error if the async method has failed
-     * @param callback.response {PublishResponse} - the response
      */
     public publish(options: PublishRequest, callback: (err: Error | null, response?: PublishResponse) => void): void {
         this._defaultRequest(PublishRequest, PublishResponse, options, callback);
@@ -1360,10 +1324,6 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession, Re
 
     /**
      *
-     * @method republish
-     * @async
-     * @param options  {RepublishRequest}
-     * @param callback the callback
      */
     public republish(options: RepublishRequest, callback: (err: Error | null, response?: RepublishResponse) => void): void {
         this._defaultRequest(RepublishRequest, RepublishResponse, options, callback);
@@ -1371,11 +1331,6 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession, Re
 
     /**
      *
-     * @method deleteMonitoredItems
-     * @async
-     * @param options  {DeleteMonitoredItemsRequest}
-     * @param callback {Function}
-     * @param callback.err {Error|null}   - the Error if the async method has failed
      */
     public deleteMonitoredItems(
         options: DeleteMonitoredItemsRequestLike,
@@ -1386,8 +1341,6 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession, Re
 
     /**
      *
-     * @method setPublishingMode
-     * @async
      */
     public setPublishingMode(publishingEnabled: boolean, subscriptionId: SubscriptionId): Promise<StatusCode>;
     public setPublishingMode(publishingEnabled: boolean, subscriptionIds: SubscriptionId[]): Promise<StatusCode[]>;
@@ -1431,22 +1384,13 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession, Re
                 if (!response) {
                     return callback(new Error("Internal Error"));
                 }
-                response.results = response.results || /* istanbul ignore next */[];
+                response.results = response.results || /* istanbul ignore next */ [];
                 callback(err, isArray ? response.results : response.results[0]);
             }
         );
     }
 
     /**
-     *
-     * @method translateBrowsePath
-     * @async
-     * @param browsePath {BrowsePath|Array<BrowsePath>}
-     * @param callback {Function}
-     * @param callback.err {Error|null}
-     * @param callback.response {BrowsePathResult|Array<BrowsePathResult>}
-     *
-     *
      *
      */
     public translateBrowsePath(browsePath: BrowsePath, callback: ResponseCallback<BrowsePathResult>): void;
@@ -1476,7 +1420,7 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession, Re
             if (!response || !(response instanceof TranslateBrowsePathsToNodeIdsResponse)) {
                 return callback(new Error("Internal Error"));
             }
-            response.results = response.results || /* istanbul ignore next */[];
+            response.results = response.results || /* istanbul ignore next */ [];
 
             callback(null, isArray ? response.results : response.results[0]);
         });
@@ -1501,7 +1445,11 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession, Re
             // session may have been closed by user ... but is still in used !!
             return callback(new Error("Session has been closed and should not be used to perform a transaction anymore"));
         }
-        if (request instanceof PublishRequest || request instanceof ActivateSessionRequest || request instanceof CloseSessionRequest) {
+        if (
+            request instanceof PublishRequest ||
+            request instanceof ActivateSessionRequest ||
+            request instanceof CloseSessionRequest
+        ) {
             return this._performMessageTransaction(request, callback);
         }
 
@@ -1538,17 +1486,29 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession, Re
         }
         this.#reprocessRequest(0, request, callback);
     }
-    #reprocessRequest = (attemptCount: number, request: Request, callback: (err: Error | null, response?: Response) => void): void => {
-
-        (attemptCount>0) && warningLog("reprocessRequest => ", request.constructor.name, this._reconnecting.pendingTransactions.length);
+    #reprocessRequest = (
+        attemptCount: number,
+        request: Request,
+        callback: (err: Error | null, response?: Response) => void
+    ): void => {
+        attemptCount > 0 &&
+            warningLog("reprocessRequest => ", request.constructor.name, this._reconnecting.pendingTransactions.length);
         this._performMessageTransaction(request, (err: null | Error, response?: Response) => {
             if (err && err.message.match(/BadSessionIdInvalid/) && request.constructor.name !== "ActivateSessionRequest") {
-                warningLog("Transaction on Invalid Session ", request.constructor.name, err.message, "isReconnecting?=", this.isReconnecting, "q=", this._reconnecting.pendingTransactions.length);
+                warningLog(
+                    "Transaction on Invalid Session ",
+                    request.constructor.name,
+                    err.message,
+                    "isReconnecting?=",
+                    this.isReconnecting,
+                    "q=",
+                    this._reconnecting.pendingTransactions.length
+                );
                 request.requestHeader.requestHandle = requestHandleNotSetValue;
                 if (this.isReconnecting) {
                     this.once("session_restored", () => {
                         warningLog("redoing", request.constructor.name, this.isReconnecting);
-                        this.#reprocessRequest(attemptCount+1,request, callback);
+                        this.#reprocessRequest(attemptCount + 1, request, callback);
                     });
                 } else {
                     this.#_recreate_session_and_reperform_transaction(request, callback);
@@ -1613,9 +1573,9 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession, Re
             if (response.responseHeader.serviceResult.isNot(StatusCodes.Good)) {
                 err = new Error(
                     " ServiceResult is " +
-                    response.responseHeader.serviceResult.toString() +
-                    " request was " +
-                    request.constructor.name
+                        response.responseHeader.serviceResult.toString() +
+                        " request was " +
+                        request.constructor.name
                 );
 
                 if (response && response.responseHeader.serviceDiagnostics) {
@@ -1669,10 +1629,6 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession, Re
 
     /**
      *
-     * @method close
-     * @async
-     * @param [deleteSubscription=true] {Boolean}
-     * @param callback {Function}
      */
     public close(callback: ErrorCallback): void;
 
@@ -1710,7 +1666,7 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession, Re
     }
 
     /**
-     * @method hasBeenClosed
+
      * @return {Boolean}
      */
     public hasBeenClosed(): boolean {
@@ -1759,7 +1715,7 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession, Re
     }
 
     /**
-     * @method getMonitoredItems
+
      * @param subscriptionId {UInt32} the subscription Id to return
      * @param callback {Function}
      * @param callback.err {Error}
@@ -1821,10 +1777,6 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession, Re
     }
 
     /**
-     * @method getArgumentDefinition
-     *    extract the argument definition of a method
-     * @param methodId the method nodeId to get argument definition from
-     * @async
      *
      */
     public async getArgumentDefinition(methodId: MethodId): Promise<ArgumentDefinition>;
@@ -1868,7 +1820,7 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession, Re
                 return callback(new Error("Internal Error"));
             }
 
-            response.registeredNodeIds = response.registeredNodeIds || /* istanbul ignore next */[];
+            response.registeredNodeIds = response.registeredNodeIds || /* istanbul ignore next */ [];
 
             callback(null, response.registeredNodeIds);
         });
@@ -2092,10 +2044,9 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession, Re
         return getExtensionObjectConstructor(this, dataTypeNodeId);
     }
     /**
-     *
+     * construct a Extension object from a DataType and a pojo
      * @param dataType
      * @param pojo
-     * @async
      */
     public async constructExtensionObject(dataType: NodeId, pojo: Record<string, any>): Promise<ExtensionObject> {
         const Constructor = await this.getExtensionObjectConstructor(dataType);
@@ -2173,10 +2124,7 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession, Re
             callback(null, response);
         });
     }
-    #_recreate_session_and_reperform_transaction(
-        request: Request,
-        callback: (err: Error | null, response?: Response) => void
-    ) {
+    #_recreate_session_and_reperform_transaction(request: Request, callback: (err: Error | null, response?: Response) => void) {
         warningLog("attempt to recreate session to reperform a transaction ", request.constructor.name);
         if (this.recursive_repair_detector >= 1) {
             // tslint:disable-next-line: no-console
@@ -2195,7 +2143,6 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession, Re
             this._performMessageTransaction(request, callback);
         });
     }
-
 }
 
 type promoteOpaqueStructure3WithCallbackFunc = (

package/source/private/client_subscription_impl.ts

@@ -286,7 +286,7 @@ export class ClientSubscriptionImpl extends EventEmitter implements ClientSubscr
     }
 
     /**
-     * @method nextClientHandle
+
      */
     public nextClientHandle(): number {
         this._nextClientHandle += 1;

package/source/private/opcua_client_impl.ts

@@ -15,7 +15,7 @@ import {
     PrivateKey,
     Nonce,
     toPem
-} from "node-opcua-crypto";
+} from "node-opcua-crypto/web";
 
 import { LocalizedText } from "node-opcua-data-model";
 import { checkDebugFlag, make_debugLog, make_errorLog, make_warningLog } from "node-opcua-debug";
@@ -418,8 +418,6 @@ export class OPCUAClientImpl extends ClientBaseImpl implements OPCUAClient {
 
     /**
      * create and activate a new session
-     * @async
-     * @method createSession
      *
      *
      * @example
@@ -530,17 +528,13 @@ export class OPCUAClientImpl extends ClientBaseImpl implements OPCUAClient {
     }
 
     /**
-     *
-     * @method closeSession
-     * @async
-     * @param session - the created client session
-     * @param deleteSubscriptions  - whether to delete subscriptions or not
+     * close a session
      */
     public closeSession(session: ClientSession, deleteSubscriptions: boolean): Promise<void>;
     public closeSession(session: ClientSession, deleteSubscriptions: boolean, callback: (err?: Error) => void): void;
+ 
     /**
-     * @internals
-     * @param args
+     * @internal
      */
     public closeSession(...args: any[]): any {
         if (this._retryCreateSessionTimer) {
@@ -677,7 +671,7 @@ export class OPCUAClientImpl extends ClientBaseImpl implements OPCUAClient {
 
     /**
      * transfer session to this client
-     * @method reactivateSession
+
      * @param session
      * @param callback
      * @return {*}
@@ -1222,8 +1216,7 @@ export class OPCUAClientImpl extends ClientBaseImpl implements OPCUAClient {
 // tslint:disable:max-line-length
 const thenify = require("thenify");
 /**
- * @method createSession
- * @async
+
  *
  * @example
  *     // create a anonymous session
@@ -1242,13 +1235,9 @@ const thenify = require("thenify");
 OPCUAClientImpl.prototype.createSession = thenify.withCallback(OPCUAClientImpl.prototype.createSession);
 OPCUAClientImpl.prototype.createSession2 = thenify.withCallback(OPCUAClientImpl.prototype.createSession2);
 /**
- * @method changeSessionIdentity
- * @async
  */
 OPCUAClientImpl.prototype.changeSessionIdentity = thenify.withCallback(OPCUAClientImpl.prototype.changeSessionIdentity);
 /**
- * @method closeSession
- * @async
  * @example
  *    const session  = await client.createSession();
  *    await client.closeSession(session);

package/source/private/reconnection/client_subscription_reconnection.ts

@@ -37,7 +37,7 @@ async function adjustMonitoredItemNodeIds(subscription: ClientSubscription, oldM
 }
 /**
  *  utility function to recreate new subscription
- *  @method recreateSubscriptionAndMonitoredItem
+
  */
 export async function recreateSubscriptionAndMonitoredItem(_subscription: ClientSubscription): Promise<void> {
     debugLog("recreateSubscriptionAndMonitoredItem", _subscription.subscriptionId.toString());

package/source/tools/findservers.ts

@@ -14,10 +14,6 @@ export interface FindServerResults {
 }
 /**
  * extract the server endpoints exposed by a discovery server
- * @method findServers
- * @async
- * @param discoveryServerEndpointUri
- * @param callback
  */
 export function findServers(
     discoveryServerEndpointUri: string,

package/source/verify.ts

@@ -6,7 +6,7 @@ import {
     exploreCertificate,
     explorePrivateKey,
     publicKeyAndPrivateKeyMatches
-} from "node-opcua-crypto";
+} from "node-opcua-crypto/web";
 import { checkDebugFlag, make_debugLog, make_errorLog, make_warningLog } from "node-opcua-debug";
 import { VerifyCertificateOptions } from "node-opcua-pki";
 

package/dist/alarms_and_conditions/client_alarm.d.ts

@@ -1,49 +0,0 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import { EventEmitter } from "events";
-import { NodeId } from "node-opcua-nodeid";
-import { StatusCode } from "node-opcua-status-code";
-import { Variant } from "node-opcua-variant";
-import { ClientSession } from "../client_session";
-export interface TVariant<T> extends Variant {
-    value: T;
-}
-export interface TTwoStateStatus extends TVariant<string> {
-    id: TVariant<boolean>;
-}
-export interface EventStuff {
-    conditionId: TVariant<NodeId>;
-    eventType: TVariant<NodeId>;
-    eventId: TVariant<Buffer>;
-    retain: TVariant<boolean>;
-    activeState: TTwoStateStatus;
-    ackedState: TTwoStateStatus;
-    confirmedState: TTwoStateStatus;
-    conditionName?: TVariant<string>;
-}
-export interface ClientAlarm {
-    conditionId: NodeId;
-    eventType: NodeId;
-    fields: EventStuff;
-    on(eventName: "changed", eventHandler: () => void): this;
-    acknowledge(session: ClientSession, comment: string): Promise<StatusCode>;
-    getField(fieldName: string): Variant | null;
-}
-/**
- * describes a OPCUA Alarm as seen in the client side
- */
-export declare class ClientAlarm extends EventEmitter {
-    conditionId: NodeId;
-    eventType: NodeId;
-    eventId: Buffer;
-    fields: EventStuff;
-    constructor(eventFields: EventStuff);
-    confirm(session: ClientSession, comment: string): Promise<StatusCode>;
-    update(eventFields: EventStuff): void;
-    getRetain(): boolean;
-    toString(): string;
-}
-/**
- * @private
- */
-export declare function fieldsToJson(fields: string[], eventFields: Variant[], flat?: boolean): EventStuff;