node-opcua-client 2.132.0 → 2.134.0

package/source/client_session.ts

@@ -6,11 +6,12 @@ import { EventEmitter } from "events";
 
 import { DateTime, UInt8 } from "node-opcua-basic-types";
 import { ServerState } from "node-opcua-common";
-import { Certificate } from "node-opcua-crypto";
+import { Certificate } from "node-opcua-crypto/web";
 import { LocalizedTextLike } from "node-opcua-data-model";
 import { DataValue, TimestampsToReturn } from "node-opcua-data-value";
 import { NodeId, NodeIdLike } from "node-opcua-nodeid";
 import {
+    CallMethodRequestLike,
     IBasicSession,
     IBasicSessionBrowse,
     IBasicSessionBrowseNext,
@@ -57,6 +58,7 @@ import { ArgumentDefinition, MethodId } from "node-opcua-pseudo-session";
 import { AggregateFunction } from "node-opcua-constants";
 import {
     AggregateConfigurationOptions,
+    CallMethodResult,
     HistoryReadRequest,
     HistoryReadResponse,
     HistoryReadValueIdOptions
@@ -70,7 +72,6 @@ export { ArgumentDefinition, CallMethodRequestLike, MethodId } from "node-opcua-
 
 import { ClientSubscription } from "./client_subscription";
 
-
 export interface MonitoredItemData {
     clientHandles: Uint32Array;
     serverHandles: Uint32Array;
@@ -160,12 +161,10 @@ export interface ClientSessionBrowseService extends IBasicSessionBrowse, IBasicS
      * with browseNext
      */
     requestedMaxReferencesPerNode: number;
-
-  }
+}
 
 // translate browsePathTo NodeId services
-export interface ClientSessionTranslateBrowsePathService extends IBasicSessionTranslateBrowsePath {
-}
+export interface ClientSessionTranslateBrowsePathService extends IBasicSessionTranslateBrowsePath {}
 
 // query services
 export interface ClientSessionQueryService {
@@ -176,66 +175,9 @@ export interface ClientSessionQueryService {
 
 // call services
 export interface ClientSessionCallService extends IBasicSessionCall {
-    /**
-     *
-     * @method call
-     *
-     * @param methodToCall {CallMethodRequest} the call method request
-     * @param callback
-     *
-     * @example :
-     *
-     * ```javascript
-     * const methodToCall = {
-     *     objectId: "ns=2;i=12",
-     *     methodId: "ns=2;i=13",
-     *     inputArguments: [
-     *         new Variant({...}),
-     *         new Variant({...}),
-     *     ]
-     * }
-     * session.call(methodToCall,function(err,callResult) {
-     *    if (!err) {
-     *         console.log(" statusCode = ",callResult.statusCode);
-     *         console.log(" inputArgumentResults[0] = ",callResult.inputArgumentResults[0].toString());
-     *         console.log(" inputArgumentResults[1] = ",callResult.inputArgumentResults[1].toString());
-     *         console.log(" outputArgument[0]       = ",callResult.outputArgument[0].toString()); // array of variant
-     *    }
-     * });
-     * ```
-     *
-     * @method call
-     *
-     * @param methodsToCall {CallMethodRequest[]} the call method request array
-     * @param callback
-     *
-     *
-     * @example :
-     *
-     * ```javascript
-     * const methodsToCall = [ {
-     *     objectId: "ns=2;i=12",
-     *     methodId: "ns=2;i=13",
-     *     inputArguments: [
-     *         new Variant({...}),
-     *         new Variant({...}),
-     *     ]
-     * }];
-     * session.call(methodsToCall,function(err,callResults) {
-     *    if (!err) {
-     *         const callResult = callResults[0];
-     *         console.log(" statusCode = ",rep.statusCode);
-     *         console.log(" inputArgumentResults[0] = ",callResult.inputArgumentResults[0].toString());
-     *         console.log(" inputArgumentResults[1] = ",callResult.inputArgumentResults[1].toString());
-     *         console.log(" outputArgument[0]       = ",callResult.outputArgument[0].toString()); // array of variant
-     *    }
-     * });
-     * ```
-     */
 
 
     getArgumentDefinition(methodId: MethodId): Promise<ArgumentDefinition>;
-
     getArgumentDefinition(methodId: MethodId, callback: (err: Error | null, args?: ArgumentDefinition) => void): void;
 }
 
@@ -252,36 +194,33 @@ export interface ClientSessionRegisterService {
 
 // read services
 export interface ClientSessionReadService extends IBasicSessionRead {
-  
     /**
-     * @deprecated
+     * @deprecated use read() instead
      */
     readVariableValue(nodeId: NodeIdLike, callback: ResponseCallback<DataValue>): void;
     /**
-     * @deprecated
+     * @deprecated use read() instead
      */
     readVariableValue(nodeId: NodeIdLike): Promise<DataValue>;
     /**
-     * @deprecated
+     * @deprecated use read() instead
      */
     readVariableValue(nodeIds: NodeIdLike[], callback: ResponseCallback<DataValue[]>): void;
     /**
-     * @deprecated
+     * @deprecated use read() instead
      */
     readVariableValue(nodeIds: NodeIdLike[]): Promise<DataValue[]>;
 }
 
 // write services
 export interface ClientSessionWriteService extends IBasicSessionWrite {
-
-
     /**
-     * @deprecated
+     * @deprecated use write() instead
      */
     writeSingleNode(nodeToWrite: NodeIdLike, value: Variant): Promise<StatusCode>;
 
     /**
-     * @deprecated
+     * @deprecated use write() instead
      */
     writeSingleNode(nodeToWrite: NodeIdLike, value: Variant, callback: ResponseCallback<StatusCode>): void;
 }
@@ -289,8 +228,6 @@ export interface ClientSessionWriteService extends IBasicSessionWrite {
 // raw subscription services
 export interface ClientSessionRawSubscriptionService {
     /**
-     * @method createSubscription
-     * @async
      *
      * @example
      *
@@ -334,9 +271,7 @@ export interface ClientSessionRawSubscriptionService {
     deleteSubscriptions(options: DeleteSubscriptionsRequestLike): Promise<DeleteSubscriptionsResponse>;
 
     /**
-     *
-     * @method modifyMonitoredItems
-     * @async
+     * modify the monitored item parameters
      */
     modifyMonitoredItems(options: ModifyMonitoredItemsRequestLike, callback?: ResponseCallback<ModifyMonitoredItemsResponse>): void;
 
@@ -425,8 +360,6 @@ export interface ClientSessionReadHistoryService {
     ): Promise<HistoryReadResult>;
 
     /**
-     * @method readAggregateValue
-     * @async
      *
      * @example
      *
@@ -449,7 +382,7 @@ export interface ClientSessionReadHistoryService {
      *   new Date("2015-06-10T09:01:00.000Z"),
      *   AggregateFunction.Average, 3600000);
      * ```
-     * @param nodes   the read value id
+     * @param nodesToRead   the read value id
      * @param startTime   the start time in UTC format
      * @param endTime     the end time in UTC format
      * @param aggregateFn
@@ -569,7 +502,6 @@ export interface ClientSessionDataTypeService {
      *
      * this method is useful to determine which DataType to use when constructing a Variant
      * @param nodeId - the node id of the variable to query
-     * @async
      *
      *
      * @example
@@ -603,7 +535,6 @@ export interface ClientSessionExtensionObjectService {
     constructExtensionObject(dataType: NodeId, pojo: Record<string, unknown>): Promise<ExtensionObject>;
 
     /**
-     * @private
      */
     extractNamespaceDataType(): Promise<ExtraDataTypeManager>;
 }
@@ -616,7 +547,7 @@ export interface ClientSessionConditionService {
     /**
      * helper to add a comment to a condition
      *
-     * The AddComment Method is used to apply a comment to a specific state of a Condition instance.
+     * The addComment Method is used to apply a comment to a specific state of a Condition instance.
      *
      * Normally, the NodeId of the object instance as the ObjectId is passed to the Call Service.
      *
@@ -703,20 +634,19 @@ export interface ClientSessionConditionService {
     acknowledgeCondition(conditionId: NodeId, eventId: Buffer, comment: LocalizedTextLike): Promise<StatusCode>;
 
     /**
-     * @method findMethodId
      *
      * @param nodeId      the nodeId of the parent Object
-     * @param methodName  the method name 
+     * @param methodName  the method name
      * @param callback
-     * 
-     * note: 
+     *
+     * note:
      *   - methodName is a browse name and may therefore be prefixed with a namespace index.
      *   - if method is not found on the object specified by nodeId, then the findMethodId will
-     *     recursively browse up the hierarchy of object typeDefinition Node 
+     *     recursively browse up the hierarchy of object typeDefinition Node
      *     until it reaches the root type. and try to find the first method that matches the
      *     provided name.
-     * 
-     * @deprecated use global findMethodId(session, nodeId, methoName): Promise<NodeId> instead
+     *
+     * @deprecated use global findMethodId(session, nodeId, methodName): Promise<NodeId> instead
      */
     findMethodId(nodeId: NodeIdLike, methodName: string, callback: ResponseCallback<NodeId>): void;
 

package/source/client_session_keepalive_manager.ts

@@ -90,13 +90,11 @@ export class ClientSessionKeepAliveManager extends EventEmitter implements Clien
         });
     }
     /**
-     * @method ping_server
-     * @internal
+     * @private
      * when a session is opened on a server, the client shall send request on a regular basis otherwise the server
      * session object might time out.
      * start_ping make sure that ping_server is called on a regular basis to prevent session to timeout.
      *
-     * @param callback
      */
     private async _ping_server(): Promise<number> {
         const session = this.session;

package/source/client_subscription.ts

@@ -82,7 +82,6 @@ export interface ClientSubscription extends EventEmitter  {
     /**
      * add a monitor item to the subscription
      *
-     * @method monitor
      *
      * Monitoring a simple Value Change
      * ---------------------------------
@@ -193,12 +192,10 @@ export interface ClientSubscription extends EventEmitter  {
     ): void;
 
     /**
-     * @method monitorItems
      * @param itemsToMonitor
      * @param requestedParameters
      * @param timestampsToReturn
      * @return a ClientMonitoredItemGroup
-     * @async
      */
     monitorItems(
         itemsToMonitor: ReadValueIdOptions[],
@@ -207,12 +204,6 @@ export interface ClientSubscription extends EventEmitter  {
     ): Promise<ClientMonitoredItemGroup>;
 
     /**
-     * @method monitorItems
-     * @param itemsToMonitor
-     * @param requestedParameters
-     * @param timestampsToReturn
-     * @param done
-     * @async
      */
     monitorItems(
         itemsToMonitor: ReadValueIdOptions[],

package/source/client_utils.ts

@@ -39,10 +39,7 @@ interface AnalogDataItemSnapshot {
 }
 
 /**
- * @method readUAAnalogItem
- * @param session
- * @param nodeId
- * @param callback
+ *
  */
 export async function readUAAnalogItem(
     session: IBasicSessionTranslateBrowsePathAsyncMultiple & IBasicSessionReadAsyncMultiple,

package/source/index.ts

@@ -31,7 +31,7 @@ export { SecurityPolicy, ClientSecureChannelLayer, ConnectionStrategyOptions } f
 import * as utils1 from "node-opcua-utils";
 export const utils = utils1;
 
-import * as crypto_util1 from "node-opcua-crypto";
+import * as crypto_util1 from "node-opcua-crypto/web";
 export const crypto_utils = crypto_util1;
 
 export { hexDump, LogLevel, setLogLevel, setDebugLogger, setWarningLogger, setErrorLogger } from "node-opcua-debug";

package/source/private/client_base_impl.ts

@@ -9,7 +9,7 @@ import chalk from "chalk";
 import { withLock } from "@ster5/global-mutex";
 import { assert } from "node-opcua-assert";
 import { IOPCUASecureObjectOptions, OPCUASecureObject } from "node-opcua-common";
-import { Certificate, makeSHA1Thumbprint, Nonce, split_der } from "node-opcua-crypto";
+import { Certificate, makeSHA1Thumbprint, Nonce, split_der } from "node-opcua-crypto/web";
 import { installPeriodicClockAdjustment, periodicClockAdjustment, uninstallPeriodicClockAdjustment } from "node-opcua-date-time";
 import { checkDebugFlag, make_debugLog, make_errorLog, make_warningLog } from "node-opcua-debug";
 
@@ -871,7 +871,6 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
 
     /**
      * connect the OPC-UA client to a server end point.
-     * @async
      */
     public connect(endpointUrl: string): Promise<void>;
     public connect(endpointUrl: string, callback: ErrorCallback): void;
@@ -1019,7 +1018,7 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
     /**
      *
      * return the endpoint information matching  security mode and security policy.
-     * @method findEndpoint
+
      */
     public findEndpointForSecurity(
         securityMode: MessageSecurityMode,
@@ -1036,7 +1035,7 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
     /**
      *
      * return the endpoint information matching the specified url , security mode and security policy.
-     * @method findEndpoint
+
      */
     public findEndpoint(
         endpointUrl: string,
@@ -1104,7 +1103,7 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
     }
 
     /**
-     * @method findServers
+
      */
     public findServers(options?: FindServersRequestLike): Promise<ApplicationDescription[]>;
     public findServers(options: FindServersRequestLike, callback: ResponseCallback<ApplicationDescription[]>): void;

package/source/private/client_monitored_item_group_impl.ts

@@ -90,9 +90,7 @@ export class ClientMonitoredItemGroupImpl extends EventEmitter implements Client
     }
 
     /**
-     * @method terminate
      * remove the MonitoredItem from its subscription
-     * @async
      */
     public async terminate(): Promise<void>;
     public terminate(done: ErrorCallback): void;
@@ -111,7 +109,7 @@ export class ClientMonitoredItemGroupImpl extends EventEmitter implements Client
 
     // tslint:disable:unified-signatures
     /**
-     * @method modify
+
      */
     public async modify(parameters: MonitoringParametersOptions): Promise<StatusCode>;
     public async modify(parameters: MonitoringParametersOptions, timestampsToReturn: TimestampsToReturn): Promise<StatusCode>;
@@ -158,7 +156,7 @@ export class ClientMonitoredItemGroupImpl extends EventEmitter implements Client
 
     /**
      * @internal
-     * @method _monitor
+
      * Creates the monitor item (monitoring mode = Reporting)
      * @private
      */

package/source/private/client_monitored_item_impl.ts

@@ -46,10 +46,10 @@ export type PrepareForMonitoringResult =
  * @class ClientMonitoredItem
  * @extends ClientMonitoredItemBase
  *
- * event:
- *    "initialized"
- *    "err"
- *    "changed"
+ * - event:
+ *   - "initialized"
+ *   - "err"
+ *   - "changed"
  *
  *  note: this.monitoringMode = subscription_service.MonitoringMode.Reporting;
  */
@@ -102,8 +102,7 @@ export class ClientMonitoredItemImpl extends EventEmitter implements ClientMonit
     }
 
     /**
-     * remove the MonitoredItem from its subscription
-     * @async
+     * terminate the monitored item by removing the MonitoredItem from its subscription
      */
     public async terminate(): Promise<void>;
     public terminate(done: ErrorCallback): void;

package/source/private/client_publish_engine.ts

@@ -25,10 +25,7 @@ const warningLog = make_warningLog(__filename);
  * Finally, ClientSidePublishEngine dispatch PublishResponse to the correct
  * Subscription id callback
  *
- * @param session {ClientSession} - the client session
- *
- *
- * @constructor
+ * @private
  */
 export class ClientSidePublishEngine {
     public static publishRequestCountInPipeline = 5;
@@ -98,7 +95,7 @@ export class ClientSidePublishEngine {
     }
 
     /**
-     * @method send_publish_request
+     * @private
      */
     public send_publish_request(): void {
         if (this.isSuspended) {
@@ -127,11 +124,17 @@ export class ClientSidePublishEngine {
         }
     }
 
+    /**
+     * @private
+     */
     public terminate(): void {
         debugLog("Terminated ClientPublishEngine ");
         this.session = null;
     }
 
+    /**
+     * @private
+     */
     public registerSubscription(subscription: ClientSubscription): void {
         debugLog("ClientSidePublishEngine#registerSubscription ", subscription.subscriptionId);
 
@@ -152,6 +155,9 @@ export class ClientSidePublishEngine {
         this.replenish_publish_request_queue();
     }
 
+    /**
+     * @private
+     */
     public replenish_publish_request_queue(): void {
         // Spec 1.03 part 4 5.13.5 Publish
         // [..] in high latency networks, the Client may wish to pipeline Publish requests
@@ -168,9 +174,9 @@ export class ClientSidePublishEngine {
     }
 
     /**
-     * @method unregisterSubscription
      *
      * @param subscriptionId
+     * @private
      */
     public unregisterSubscription(subscriptionId: SubscriptionId): void {
         debugLog("ClientSidePublishEngine#unregisterSubscription ", subscriptionId);