node-opcua-client 2.77.0 → 2.79.0

package/dist/user_identity_info.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=user_identity_info.js.map

package/dist/user_identity_info.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"user_identity_info.js","sourceRoot":"","sources":["../source/user_identity_info.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "node-opcua-client",
-    "version": "2.77.0",
+    "version": "2.79.0",
     "description": "pure nodejs OPCUA SDK - module -client",
     "scripts": {
         "clean": "npx rimraf node_modules dist *.tsbuildinfo certificates",
@@ -20,43 +20,43 @@
         "callbackify": "^1.1.0",
         "chalk": "4.1.2",
         "node-opcua-assert": "2.77.0",
-        "node-opcua-basic-types": "2.77.0",
+        "node-opcua-basic-types": "2.79.0",
         "node-opcua-buffer-utils": "2.77.0",
         "node-opcua-certificate-manager": "2.77.0",
-        "node-opcua-client-dynamic-extension-object": "2.77.0",
-        "node-opcua-common": "2.77.0",
+        "node-opcua-client-dynamic-extension-object": "2.79.0",
+        "node-opcua-common": "2.79.0",
         "node-opcua-constants": "2.77.0",
         "node-opcua-crypto": "^1.11.0",
-        "node-opcua-data-model": "2.77.0",
-        "node-opcua-data-value": "2.77.0",
+        "node-opcua-data-model": "2.79.0",
+        "node-opcua-data-value": "2.79.0",
         "node-opcua-date-time": "2.77.0",
         "node-opcua-debug": "2.77.0",
-        "node-opcua-extension-object": "2.77.0",
+        "node-opcua-extension-object": "2.79.0",
         "node-opcua-hostname": "2.77.0",
-        "node-opcua-nodeid": "2.77.0",
+        "node-opcua-nodeid": "2.79.0",
         "node-opcua-object-registry": "2.77.0",
         "node-opcua-pki": "^2.17.0",
-        "node-opcua-pseudo-session": "2.77.0",
-        "node-opcua-schemas": "2.77.0",
-        "node-opcua-secure-channel": "2.77.0",
-        "node-opcua-service-browse": "2.77.0",
-        "node-opcua-service-call": "2.77.0",
-        "node-opcua-service-discovery": "2.77.0",
-        "node-opcua-service-endpoints": "2.77.0",
-        "node-opcua-service-filter": "2.77.0",
-        "node-opcua-service-history": "2.77.0",
-        "node-opcua-service-query": "2.77.0",
-        "node-opcua-service-read": "2.77.0",
-        "node-opcua-service-register-node": "2.77.0",
-        "node-opcua-service-secure-channel": "2.77.0",
-        "node-opcua-service-session": "2.77.0",
-        "node-opcua-service-subscription": "2.77.0",
-        "node-opcua-service-translate-browse-path": "2.77.0",
-        "node-opcua-service-write": "2.77.0",
+        "node-opcua-pseudo-session": "2.79.0",
+        "node-opcua-schemas": "2.79.0",
+        "node-opcua-secure-channel": "2.79.0",
+        "node-opcua-service-browse": "2.79.0",
+        "node-opcua-service-call": "2.79.0",
+        "node-opcua-service-discovery": "2.79.0",
+        "node-opcua-service-endpoints": "2.79.0",
+        "node-opcua-service-filter": "2.79.0",
+        "node-opcua-service-history": "2.79.0",
+        "node-opcua-service-query": "2.79.0",
+        "node-opcua-service-read": "2.79.0",
+        "node-opcua-service-register-node": "2.79.0",
+        "node-opcua-service-secure-channel": "2.79.0",
+        "node-opcua-service-session": "2.79.0",
+        "node-opcua-service-subscription": "2.79.0",
+        "node-opcua-service-translate-browse-path": "2.79.0",
+        "node-opcua-service-write": "2.79.0",
         "node-opcua-status-code": "2.77.0",
-        "node-opcua-types": "2.77.0",
+        "node-opcua-types": "2.79.0",
         "node-opcua-utils": "2.77.0",
-        "node-opcua-variant": "2.77.0",
+        "node-opcua-variant": "2.79.0",
         "once": "^1.4.0",
         "thenify": "^3.3.1"
     },
@@ -64,14 +64,14 @@
         "@types/underscore": "^1.11.4",
         "dequeue": "^1.0.5",
         "mocha": "^10.0.0",
-        "node-opcua-address-space": "2.77.0",
+        "node-opcua-address-space": "2.79.0",
         "node-opcua-binary-stream": "2.77.0",
-        "node-opcua-factory": "2.77.0",
+        "node-opcua-factory": "2.79.0",
         "node-opcua-leak-detector": "2.77.0",
         "node-opcua-nodesets": "2.77.0",
         "should": "^13.2.3",
         "sinon": "^14.0.0",
-        "underscore": "^1.13.4"
+        "underscore": "^1.13.6"
     },
     "eslintConfig": {
         "env": {
@@ -93,5 +93,5 @@
         "internet of things"
     ],
     "homepage": "http://node-opcua.github.io/",
-    "gitHead": "5c8d45772d786fa4ba59369dd26679353ab5482b"
+    "gitHead": "1a6d41827954dccf2c2cdff9344cc11fc99767f3"
 }

package/source/client_monitored_item_group.ts

@@ -20,6 +20,10 @@ export interface ClientMonitoredItemGroup extends EventEmitter, ClientMonitoredI
     on(event: "initialized", eventHandler: () => void): this;
 }
 
+export interface ClientMonitoredItemGroup {
+    monitoredItems: ClientMonitoredItemBase[];
+}
+
 export class ClientMonitoredItemGroup {
     public static create(
         subscription: ClientSubscription,

package/source/client_session.ts

@@ -56,10 +56,16 @@ 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 { IBasicSessionChangeUser } from "node-opcua-pseudo-session";
 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 {
+    AggregateConfigurationOptions,
+    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";
@@ -418,6 +424,10 @@ export interface ClientSessionSubscriptionService {
     ): void;
 }
 
+export interface ClientSessionChangeUser extends IBasicSessionChangeUser {
+    /* */
+}
+
 export interface HistoryReadValueIdOptions2 extends HistoryReadValueIdOptions {
     nodeId: NodeIdLike; // nodeId is mandatory here
 }
@@ -505,6 +515,43 @@ export interface ClientSessionReadHistoryService {
      * @param aggregateFn
      * @param processingInterval in milliseconds
      * @param callback
+     *
+     *
+     * aggregateConfiguration contains additional parameters
+     *
+     * - The TreatUncertainAsBad Variable indicates how the Server treats data returned with a
+     *   StatusCode severity Uncertain with respect to Aggregate calculations. A value of True
+     *   indicates the Server considers the severity equivalent to Bad, a value of False indicates
+     *   the Server considers the severity equivalent to Good, unless the Aggregate definition says
+     *   otherwise. The default value is True. Note that the value is still treated as Uncertain when
+     *   the StatusCode for the result is calculated.
+     *
+     * - The PercentDataBad Variable indicates the minimum percentage of Bad data in a given interval
+     *   required for the StatusCode for the given interval for processed data request to be set to Bad.
+     *   (Uncertain is treated as defined above.) Refer to 5.4.3 for details on using this Variable when
+     *   assigning StatusCodes. For details on which Aggregates use the PercentDataBad Variable, see the
+     *   definition of each Aggregate. The default value is 100.
+     *
+     * - The PercentDataGood Variable indicates the minimum percentage of Good data in a given interval
+     *   required for the StatusCode for the given interval for the processed data requests to be set to
+     *   Good. Refer to 5.4.3 for details on using this Variable when assigning StatusCodes. For details
+     *   on which Aggregates use the PercentDataGood Variable, see the definition of each Aggregate.
+     *   The default value is 100.
+     *
+     * - The PercentDataGood and PercentDataBad shall follow the following relationship
+     *         PercentDataGood ≥ (100 – PercentDataBad).
+     *   If they are equal the result of the PercentDataGood calculation is used. If the values
+     *   entered for PercentDataGood and PercentDataBad do not result in a valid calculation
+     *   (e.g. Bad = 80; Good = 0) the result will have a StatusCode of Bad_AggregateInvalidInputs
+     *   The StatusCode Bad_AggregateInvalidInputs will be returned if the value of PercentDataGood
+     *   or PercentDataBad exceed 100.
+     *
+     * - The UseSlopedExtrapolation Variable indicates how the Server interpolates data when no boundary
+     *   value exists (i.e. extrapolating into the future from the last known value). A value of False
+     *   indicates that the Server will use a SteppedExtrapolation format, and hold the last known value
+     *   constant. A value of True indicates the Server will project the value using UseSlopedExtrapolation
+     *   mode. The default value is False. For SimpleBounds this value is ignored.
+     *
      */
     readAggregateValue(
         nodesToRead: HistoryReadValueIdOptions[],
@@ -536,6 +583,40 @@ export interface ClientSessionReadHistoryService {
         aggregateFn: AggregateFunction,
         processingInterval: number
     ): Promise<HistoryReadResult>;
+    readAggregateValue(
+        nodesToRead: HistoryReadValueIdOptions[],
+        startTime: DateTime,
+        endTime: DateTime,
+        aggregateFn: AggregateFunction[],
+        processingInterval: number,
+        aggregateConfiguration: AggregateConfigurationOptions,
+        callback: Callback<HistoryReadResult[]>
+    ): void;
+    readAggregateValue(
+        nodesToRead: HistoryReadValueIdOptions[],
+        startTime: DateTime,
+        endTime: DateTime,
+        aggregateFn: AggregateFunction[],
+        processingInterval: number,
+        aggregateConfiguration: AggregateConfigurationOptions
+    ): Promise<HistoryReadResult[]>;
+    readAggregateValue(
+        nodeToRead: HistoryReadValueIdOptions,
+        startTime: DateTime,
+        endTime: DateTime,
+        aggregateFn: AggregateFunction,
+        processingInterval: number,
+        aggregateConfiguration: AggregateConfigurationOptions,
+        callback: Callback<HistoryReadResult>
+    ): void;
+    readAggregateValue(
+        nodeToRead: HistoryReadValueIdOptions,
+        startTime: DateTime,
+        endTime: DateTime,
+        aggregateFn: AggregateFunction,
+        processingInterval: number,
+        aggregateConfiguration: AggregateConfigurationOptions
+    ): Promise<HistoryReadResult>;
 
     historyRead(request: HistoryReadRequest, callback: Callback<HistoryReadResponse>): void;
     historyRead(request: HistoryReadRequest): Promise<HistoryReadResponse>;
@@ -701,17 +782,18 @@ export interface ClientSessionPublishService {
 
 export interface ClientSession
     extends ClientSessionTranslateBrowsePathService,
-    ClientSessionQueryService,
-    ClientSessionBrowseService,
-    // ClientSessionRawSubscriptionService,
-    ClientSessionSubscriptionService,
-    ClientSessionCallService,
-    ClientSessionRegisterService,
-    ClientSessionReadService,
-    // ClientSessionWriteService,
-    ClientSessionReadHistoryService,
-    ClientSessionConditionService,
-    ClientSessionExtensionObjectService,
-    ClientSessionNamespaceService,
-    ClientSessionDataTypeService,
-    IBasicSession { }
+        ClientSessionQueryService,
+        ClientSessionBrowseService,
+        // ClientSessionRawSubscriptionService,
+        ClientSessionSubscriptionService,
+        ClientSessionCallService,
+        ClientSessionRegisterService,
+        ClientSessionReadService,
+        // ClientSessionWriteService,
+        ClientSessionReadHistoryService,
+        ClientSessionConditionService,
+        ClientSessionExtensionObjectService,
+        ClientSessionNamespaceService,
+        ClientSessionDataTypeService,
+        ClientSessionChangeUser,
+        IBasicSession {}

package/source/index.ts

@@ -20,6 +20,7 @@ export * from "./tools/findservers";
 export * from "./tools/read_history_server_capabilities";
 export * from "./client_utils";
 export * from "./verify";
+export * from "./user_identity_info";
 
 export { assert } from "node-opcua-assert";
 export * from "node-opcua-utils";

package/source/opcua_client.ts

@@ -8,29 +8,14 @@ import { ConnectionStrategyOptions, Message, SecurityPolicy } from "node-opcua-s
 import { ApplicationDescription, EndpointDescription, UserTokenType } from "node-opcua-service-endpoints";
 import { MessageSecurityMode } from "node-opcua-service-secure-channel";
 import { X509IdentityTokenOptions } from "node-opcua-types";
-import { ErrorCallback } from "node-opcua-status-code";
+import { CallbackT, ErrorCallback, StatusCode } from "node-opcua-status-code";
 import { FindServersRequestLike, GetEndpointsOptions, OPCUAClientBase, OPCUAClientBaseOptions } from "./client_base";
 
 import { ClientSession, ResponseCallback } from "./client_session";
 import { ClientSubscription, ClientSubscriptionOptions } from "./client_subscription";
 import { OPCUAClientImpl } from "./private/opcua_client_impl";
+import { UserIdentityInfo } from "./user_identity_info";
 
-export interface UserIdentityInfoUserName {
-    type: UserTokenType.UserName;
-    userName: string;
-    password: string;
-}
-
-export interface UserIdentityInfoX509 extends X509IdentityTokenOptions {
-    type: UserTokenType.Certificate;
-    certificateData: ByteString;
-    privateKey: PrivateKeyPEM;
-}
-export interface AnonymousIdentity {
-    type: UserTokenType.Anonymous;
-}
-
-export type UserIdentityInfo = AnonymousIdentity | UserIdentityInfoX509 | UserIdentityInfoUserName;
 
 export interface OPCUAClientOptions extends OPCUAClientBaseOptions {
     /**
@@ -136,9 +121,9 @@ export interface OPCUAClient extends OPCUAClientBase {
 
     createSession2(callback: (err: Error | null, session?: ClientSession) => void): void;
 
-    changeSessionIdentity(session: ClientSession, userIdentityInfo: UserIdentityInfo): Promise<void>;
-
-    changeSessionIdentity(session: ClientSession, userIdentityInfo: UserIdentityInfo, callback: (err?: Error) => void): void;
+    /** @deprecated */
+    changeSessionIdentity(session: ClientSession, userIdentityInfo: UserIdentityInfo): Promise<StatusCode>;
+    changeSessionIdentity(session: ClientSession, userIdentityInfo: UserIdentityInfo, callback: CallbackT<StatusCode>): void;
 
     closeSession(session: ClientSession, deleteSubscriptions: boolean): Promise<void>;
 

package/source/private/client_base_impl.ts

@@ -64,6 +64,7 @@ import {
     OPCUAClientBaseOptions,
     TransportSettings
 } from "../client_base";
+import { UserIdentityInfo } from "../user_identity_info";
 import { performCertificateSanityCheck } from "../verify";
 import { ClientSessionImpl } from "./client_session_impl";
 import { IClientBase } from "./i_private_client";
@@ -1646,7 +1647,11 @@ export class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase
     ): void {
         throw new Error("Please override");
     }
-    public _activateSession(session: ClientSessionImpl, callback: (err: Error | null, session?: ClientSessionImpl) => void): void {
+    public _activateSession(
+        session: ClientSessionImpl,
+        userIdentity: UserIdentityInfo,
+        callback: (err: Error | null, session?: ClientSessionImpl) => void
+    ): void {
         throw new Error("Please override");
     }
 }

package/source/private/client_monitored_item_impl.ts

@@ -193,8 +193,11 @@ export class ClientMonitoredItemImpl extends EventEmitter implements ClientMonit
         try {
             this.emit("changed", value);
         } catch (err) {
-            debugLog("Exception raised inside the event handler called by ClientMonitoredItem.on('change')", err);
-            debugLog("Please verify the application using this node-opcua client");
+            warningLog(
+                "[NODE-OPCUA-W28] Exception raised inside the event handler called by ClientMonitoredItem.on('change')",
+                err
+            );
+            warningLog("                 Please verify the application using this node-opcua client");
         }
     }
 
@@ -217,8 +220,11 @@ export class ClientMonitoredItemImpl extends EventEmitter implements ClientMonit
         try {
             this.emit("changed", eventFields);
         } catch (err) {
-            warningLog("Exception raised inside the event handler called by ClientMonitoredItem.on('change')", err);
-            warningLog("Please verify the application using this node-opcua client");
+            warningLog(
+                "[NODE-OPCUA-W29] Exception raised inside the event handler called by ClientMonitoredItem.on('change')",
+                err
+            );
+            warningLog("                 Please verify the application using this node-opcua client");
         }
     }
 

package/source/private/client_session_impl.ts

@@ -83,10 +83,11 @@ import { WriteRequest, WriteResponse, WriteValue } from "node-opcua-service-writ
 import { StatusCode, StatusCodes, Callback, CallbackT } from "node-opcua-status-code";
 import { ErrorCallback } from "node-opcua-status-code";
 import {
+    AggregateConfigurationOptions,
     BrowseNextRequest,
     BrowseNextResponse,
     HistoryReadValueIdOptions,
-    ServiceFault,
+    UserTokenType,
     WriteValueOptions
 } from "node-opcua-types";
 import { buffer_ellipsis, getFunctionParameterNames, isNullOrUndefined, lowerFirstLetter } from "node-opcua-utils";
@@ -117,6 +118,7 @@ import { ClientSessionKeepAliveManager } from "../client_session_keepalive_manag
 import { ClientSubscription } from "../client_subscription";
 import { Request, Response } from "../common";
 import { repair_client_session } from "../reconnection";
+import { UserIdentityInfo } from "../user_identity_info";
 
 import { ClientSidePublishEngine } from "./client_publish_engine";
 import { ClientSubscriptionImpl } from "./client_subscription_impl";
@@ -238,6 +240,7 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession {
     public lastRequestSentTime: Date;
     public lastResponseReceivedTime: Date;
     public serverCertificate: Certificate;
+    public userIdentityInfo?: UserIdentityInfo;
     public name = "";
 
     public serverNonce?: Nonce;
@@ -312,6 +315,29 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession {
         return this._publishEngine!;
     }
 
+    public changeUser(userIdentityInfo: UserIdentityInfo): Promise<StatusCode>;
+    public changeUser(userIdentityInfo: UserIdentityInfo, callback: CallbackT<StatusCode>): void;
+    public changeUser(userIdentityInfo: UserIdentityInfo, callback?: CallbackT<StatusCode>): any {
+        userIdentityInfo = userIdentityInfo || {
+            type: UserTokenType.Anonymous
+        };
+        if (!this._client || !this.userIdentityInfo) {
+            warningLog("changeUser: invalid session");
+            return callback!(null, StatusCodes.BadInternalError);
+        }
+
+        const old_userIdentity: UserIdentityInfo = this.userIdentityInfo;
+ 
+        this._client._activateSession(this, userIdentityInfo, (err1: Error | null, session2?: ClientSessionImpl) => {
+            if (err1) {
+                this.userIdentityInfo = old_userIdentity;
+                console.log("err1  = ", err1.message);
+                return callback!(null, StatusCodes.BadUserAccessDenied);
+            }
+            this.userIdentityInfo = userIdentityInfo;
+            callback!(null, StatusCodes.Good);
+        });
+    }
     /**
      * @method browse
      * @async
@@ -763,6 +789,40 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession {
         aggregateFn: AggregateFunction,
         processingInterval: number
     ): Promise<HistoryReadResult>;
+    public readAggregateValue(
+        nodesToRead: HistoryReadValueIdOptions[],
+        startTime: DateTime,
+        endTime: DateTime,
+        aggregateFn: AggregateFunction[],
+        processingInterval: number,
+        aggregateConfiguration: AggregateConfigurationOptions,
+        callback: Callback<HistoryReadResult[]>
+    ): void;
+    public async readAggregateValue(
+        nodesToRead: HistoryReadValueIdOptions[],
+        startTime: DateTime,
+        endTime: DateTime,
+        aggregateFn: AggregateFunction[],
+        processingInterval: number,
+        aggregateConfiguration: AggregateConfigurationOptions
+    ): Promise<HistoryReadResult[]>;
+    public readAggregateValue(
+        nodeToRead: HistoryReadValueIdOptions,
+        startTime: DateTime,
+        endTime: DateTime,
+        aggregateFn: AggregateFunction,
+        processingInterval: number,
+        aggregateConfiguration: AggregateConfigurationOptions,
+        callback: Callback<HistoryReadResult>
+    ): void;
+    public async readAggregateValue(
+        nodeToRead: HistoryReadValueIdOptions,
+        startTime: DateTime,
+        endTime: DateTime,
+        aggregateFn: AggregateFunction,
+        processingInterval: number,
+        aggregateConfiguration: AggregateConfigurationOptions
+    ): Promise<HistoryReadResult>;
 
     public readAggregateValue(
         arg0: HistoryReadValueIdOptions[] | HistoryReadValueIdOptions,
@@ -772,8 +832,16 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession {
         processingInterval: number,
         ...args: any[]
     ): any {
-        const callback = args[0];
+        const callback = typeof args[0] === "function" ? args[0] : args[1];
         assert(typeof callback === "function");
+        const defaultAggregateFunction = {
+            percentDataBad: 100,
+            percentDataGood: 100,
+            treatUncertainAsBad: true,
+            useServerCapabilitiesDefaults: true,
+            useSlopedExtrapolation: false
+        };
+        const aggregateConfiguration = typeof args[0] === "function" ? defaultAggregateFunction : args[0];
 
         const isArray = Array.isArray(arg0);
 
@@ -791,7 +859,8 @@ export class ClientSessionImpl extends EventEmitter implements ClientSession {
             aggregateType: aggregateFns,
             endTime,
             processingInterval,
-            startTime
+            startTime,
+            aggregateConfiguration
         });
 
         const request = new HistoryReadRequest({
@@ -2277,3 +2346,4 @@ ClientSessionImpl.prototype.unregisterNodes = thenify.withCallback(ClientSession
 ClientSessionImpl.prototype.readNamespaceArray = thenify.withCallback(ClientSessionImpl.prototype.readNamespaceArray, opts);
 ClientSessionImpl.prototype.getBuiltInDataType = thenify.withCallback(ClientSessionImpl.prototype.getBuiltInDataType, opts);
 ClientSessionImpl.prototype.constructExtensionObject = callbackify(ClientSessionImpl.prototype.constructExtensionObject);
+ClientSessionImpl.prototype.changeUser = thenify.withCallback(ClientSessionImpl.prototype.changeUser, opts);

package/source/private/i_private_client.ts

@@ -2,11 +2,16 @@ import { ClientSecureChannelLayer } from "node-opcua-secure-channel";
 import { EndpointDescription } from "node-opcua-service-endpoints";
 import { ClientSession, ResponseCallback } from "../client_session";
 import { Request, Response } from "../common";
+import { UserIdentityInfo } from "../user_identity_info";
 import { ClientSessionImpl } from "./client_session_impl";
 
 export interface IClientBase {
     __createSession_step2(session: ClientSessionImpl, callback: (err: Error | null, session?: ClientSessionImpl) => void): void;
-    _activateSession(session: ClientSessionImpl, callback: (err: Error | null, session?: ClientSessionImpl) => void): void;
+    _activateSession(
+        session: ClientSessionImpl,
+        userIdentity: UserIdentityInfo,
+        callback: (err: Error | null, session?: ClientSessionImpl) => void
+    ): void;
     _removeSession(session: ClientSessionImpl): void;
     closeSession(session: ClientSession, deleteSubscription: any, arg2: (err?: Error | undefined) => void): void;