node-opcua-client 2.177.0 → 2.179.0

package/package.json

@@ -1,14 +1,14 @@
 {
     "name": "node-opcua-client",
-    "version": "2.177.0",
+    "version": "2.179.0",
     "description": "pure nodejs OPCUA SDK - module client",
     "scripts": {
         "clean": "npx rimraf -g node_modules dist *.tsbuildinfo certificates",
         "test": "mocha",
         "test:check": "tsc --noEmit -p test/tsconfig.json",
         "build": "tsc -b",
-        "lint": "eslint source test test_helpers",
-        "format": "prettier --write source test test_helpers",
+        "lint": "biome check --no-errors-on-unmatched .",
+        "format": "biome check --write --no-errors-on-unmatched .",
         "doc": "npx typedoc@0.21 --options typedoc.js"
     },
     "main": "./dist/index.js",
@@ -16,56 +16,56 @@
     "dependencies": {
         "@ster5/global-mutex": "^3.3.0",
         "chalk": "4.1.2",
-        "node-opcua-alarm-condition": "2.177.0",
-        "node-opcua-assert": "2.175.6",
-        "node-opcua-basic-types": "2.177.0",
-        "node-opcua-buffer-utils": "2.176.0",
-        "node-opcua-certificate-manager": "2.177.0",
-        "node-opcua-client-dynamic-extension-object": "2.177.0",
-        "node-opcua-common": "2.177.0",
-        "node-opcua-constants": "2.176.0",
-        "node-opcua-crypto": "5.5.0",
-        "node-opcua-data-model": "2.177.0",
-        "node-opcua-data-value": "2.177.0",
-        "node-opcua-date-time": "2.176.0",
-        "node-opcua-debug": "2.175.6",
-        "node-opcua-extension-object": "2.177.0",
-        "node-opcua-hostname": "2.175.1",
-        "node-opcua-nodeid": "2.177.0",
-        "node-opcua-numeric-range": "2.177.0",
-        "node-opcua-object-registry": "2.175.6",
-        "node-opcua-pki": "6.19.1",
-        "node-opcua-pseudo-session": "2.177.0",
-        "node-opcua-schemas": "2.177.0",
-        "node-opcua-secure-channel": "2.177.0",
-        "node-opcua-service-browse": "2.177.0",
-        "node-opcua-service-call": "2.177.0",
-        "node-opcua-service-discovery": "2.177.0",
-        "node-opcua-service-endpoints": "2.177.0",
-        "node-opcua-service-filter": "2.177.0",
-        "node-opcua-service-history": "2.177.0",
-        "node-opcua-service-query": "2.177.0",
-        "node-opcua-service-read": "2.177.0",
-        "node-opcua-service-register-node": "2.177.0",
-        "node-opcua-service-secure-channel": "2.177.0",
-        "node-opcua-service-session": "2.177.0",
-        "node-opcua-service-subscription": "2.177.0",
-        "node-opcua-service-translate-browse-path": "2.177.0",
-        "node-opcua-service-write": "2.177.0",
-        "node-opcua-status-code": "2.176.0",
-        "node-opcua-transport": "2.177.0",
-        "node-opcua-types": "2.177.0",
-        "node-opcua-utils": "2.176.0",
-        "node-opcua-variant": "2.177.0",
+        "node-opcua-alarm-condition": "2.179.0",
+        "node-opcua-assert": "2.179.0",
+        "node-opcua-basic-types": "2.179.0",
+        "node-opcua-buffer-utils": "2.179.0",
+        "node-opcua-certificate-manager": "2.179.0",
+        "node-opcua-client-dynamic-extension-object": "2.179.0",
+        "node-opcua-common": "2.179.0",
+        "node-opcua-constants": "2.179.0",
+        "node-opcua-crypto": "5.9.0",
+        "node-opcua-data-model": "2.179.0",
+        "node-opcua-data-value": "2.179.0",
+        "node-opcua-date-time": "2.179.0",
+        "node-opcua-debug": "2.179.0",
+        "node-opcua-extension-object": "2.179.0",
+        "node-opcua-hostname": "2.179.0",
+        "node-opcua-nodeid": "2.179.0",
+        "node-opcua-numeric-range": "2.179.0",
+        "node-opcua-object-registry": "2.179.0",
+        "node-opcua-pki": "6.21.0",
+        "node-opcua-pseudo-session": "2.179.0",
+        "node-opcua-schemas": "2.179.0",
+        "node-opcua-secure-channel": "2.179.0",
+        "node-opcua-service-browse": "2.179.0",
+        "node-opcua-service-call": "2.179.0",
+        "node-opcua-service-discovery": "2.179.0",
+        "node-opcua-service-endpoints": "2.179.0",
+        "node-opcua-service-filter": "2.179.0",
+        "node-opcua-service-history": "2.179.0",
+        "node-opcua-service-query": "2.179.0",
+        "node-opcua-service-read": "2.179.0",
+        "node-opcua-service-register-node": "2.179.0",
+        "node-opcua-service-secure-channel": "2.179.0",
+        "node-opcua-service-session": "2.179.0",
+        "node-opcua-service-subscription": "2.179.0",
+        "node-opcua-service-translate-browse-path": "2.179.0",
+        "node-opcua-service-write": "2.179.0",
+        "node-opcua-status-code": "2.179.0",
+        "node-opcua-transport": "2.179.0",
+        "node-opcua-types": "2.179.0",
+        "node-opcua-utils": "2.179.0",
+        "node-opcua-variant": "2.179.0",
         "thenify-ex": "4.4.0"
     },
     "devDependencies": {
         "dequeue": "^1.0.5",
-        "node-opcua-address-space": "2.177.0",
-        "node-opcua-binary-stream": "2.176.0",
-        "node-opcua-factory": "2.177.0",
-        "node-opcua-leak-detector": "2.175.6",
-        "node-opcua-nodesets": "2.175.3"
+        "node-opcua-address-space": "2.179.0",
+        "node-opcua-binary-stream": "2.179.0",
+        "node-opcua-factory": "2.179.0",
+        "node-opcua-leak-detector": "2.179.0",
+        "node-opcua-nodesets": "2.179.0"
     },
     "eslintConfig": {
         "env": {
@@ -87,7 +87,7 @@
         "internet of things"
     ],
     "homepage": "http://node-opcua.github.io/",
-    "gitHead": "a00d1d3f4db4522ed6bb2c6104d86c57df79946a",
+    "gitHead": "c78c6ee424bae3c6e851fabd8e144390e2941f8a",
     "files": [
         "dist",
         "source"

package/source/alarms_and_conditions/client_alarm_tools.ts

@@ -116,20 +116,22 @@ export async function installAlarmMonitoring(session: ClientSession): Promise<Cl
         const pojo = fieldsToJson(fields, eventFields);
         const { eventType, eventId, conditionId, conditionName } = pojo;
 
-        debugLog(
-            "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx ---- ALARM RECEIVED " +
-                eventType.value.toString() +
-                " " +
-                eventId.value?.toString("hex")
-        );
+        // c8 ignore next
+        doDebug &&
+            debugLog(
+                "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx ---- ALARM RECEIVED " +
+                    eventType.value.toString() +
+                    " " +
+                    eventId.value?.toString("hex")
+            );
         try {
             if (!conditionId?.value || conditionId.dataType === DataType.Null) {
                 // not a acknowledgeable condition
                 warningLog(
-                    " not acknowledgeable condition ---- " + eventType.value.toString() + " ",
+                    ` not acknowledgeable condition ---- ${eventType.value.toString()} `,
                     conditionId,
                     conditionName?.value,
-                    " " + eventId.value?.toString("hex")
+                    ` ${eventId.value?.toString("hex")}`
                 );
                 return;
             }

package/source/alarms_and_conditions/client_tools.ts

@@ -2,12 +2,12 @@
  * @module node-opcua-client
  */
 
+import { callbackify } from "node:util";
 import { acknowledgeCondition, callMethodCondition, confirmCondition } from "node-opcua-alarm-condition";
 import type { LocalizedTextLike } from "node-opcua-data-model";
 import type { NodeId, NodeIdLike } from "node-opcua-nodeid";
 import { findMethodId, type ResponseCallback } from "node-opcua-pseudo-session";
 import type { Callback, StatusCode } from "node-opcua-status-code";
-import { callbackify } from "util";
 
 import { ClientSessionImpl } from "../private/client_session_impl";
 
@@ -19,57 +19,98 @@ ClientSessionImpl.prototype.enableCondition = () => {
     /** */
 };
 
-ClientSessionImpl.prototype.addCommentCondition = function (
+function addCommentConditionImpl(
     conditionId: NodeIdLike,
     eventId: Buffer,
     comment: LocalizedTextLike,
     callback: Callback<StatusCode>
-) {
+): void;
+function addCommentConditionImpl(conditionId: NodeIdLike, eventId: Buffer, comment: LocalizedTextLike): Promise<StatusCode>;
+function addCommentConditionImpl(
+    this: ClientSessionImpl,
+    conditionId: NodeIdLike,
+    eventId: Buffer,
+    comment: LocalizedTextLike,
+    callback?: Callback<StatusCode>
+): Promise<StatusCode> | undefined {
+    if (!callback) {
+        return callMethodCondition(this, "AddComment", conditionId, eventId, comment);
+    }
     callbackify(callMethodCondition)(this, "AddComment", conditionId, eventId, comment, callback);
-};
+    return undefined;
+}
+ClientSessionImpl.prototype.addCommentCondition = addCommentConditionImpl;
 
 /** @deprecated */
-ClientSessionImpl.prototype.findMethodId = function (nodeId: NodeIdLike, methodName: string, callback: ResponseCallback<NodeId>) {
-    findMethodId(this, nodeId, methodName)
-        .then((data) => {
-            if (data.methodId) {
-                callback(null, data.methodId);
-            } else {
-                callback(data.err);
-            }
-        })
+function findMethodIdImpl(nodeId: NodeIdLike, methodName: string, callback: ResponseCallback<NodeId>): void;
+function findMethodIdImpl(nodeId: NodeIdLike, methodName: string): Promise<NodeId>;
+function findMethodIdImpl(
+    this: ClientSessionImpl,
+    nodeId: NodeIdLike,
+    methodName: string,
+    callback?: ResponseCallback<NodeId>
+): Promise<NodeId> | undefined {
+    const promise = findMethodId(this, nodeId, methodName).then((data) => {
+        if (data.methodId) {
+            return data.methodId;
+        }
+        throw data.err || new Error("findMethodId: method not found");
+    });
+    if (!callback) {
+        return promise;
+    }
+    promise
+        .then((methodId) => callback(null, methodId))
         .catch((err) => {
             callback(err);
         });
-};
+    return undefined;
+}
+ClientSessionImpl.prototype.findMethodId = findMethodIdImpl;
 
-ClientSessionImpl.prototype.confirmCondition = function (
+function confirmConditionImpl(
     conditionId: NodeId,
     eventId: Buffer,
     comment: LocalizedTextLike,
     callback: Callback<StatusCode>
-) {
+): void;
+function confirmConditionImpl(conditionId: NodeId, eventId: Buffer, comment: LocalizedTextLike): Promise<StatusCode>;
+function confirmConditionImpl(
+    this: ClientSessionImpl,
+    conditionId: NodeId,
+    eventId: Buffer,
+    comment: LocalizedTextLike,
+    callback?: Callback<StatusCode>
+): Promise<StatusCode> | undefined {
     // ns=0;i=9113 AcknowledgeableConditionType#Confirm
     // note that confirm method is Optionals on condition
+    if (!callback) {
+        return confirmCondition(this, conditionId, eventId, comment);
+    }
     callbackify(confirmCondition)(this, conditionId, eventId, comment, callback);
-};
+    return undefined;
+}
+ClientSessionImpl.prototype.confirmCondition = confirmConditionImpl;
 
-ClientSessionImpl.prototype.acknowledgeCondition = function (
+function acknowledgeConditionImpl(
     conditionId: NodeId,
     eventId: Buffer,
     comment: LocalizedTextLike,
     callback: Callback<StatusCode>
-) {
+): void;
+function acknowledgeConditionImpl(conditionId: NodeId, eventId: Buffer, comment: LocalizedTextLike): Promise<StatusCode>;
+function acknowledgeConditionImpl(
+    this: ClientSessionImpl,
+    conditionId: NodeId,
+    eventId: Buffer,
+    comment: LocalizedTextLike,
+    callback?: Callback<StatusCode>
+): Promise<StatusCode> | undefined {
     // ns=0;i=9111 AcknowledgeableConditionType#Acknowledge
+    if (!callback) {
+        return acknowledgeCondition(this, conditionId, eventId, comment);
+    }
     callbackify(acknowledgeCondition)(this, conditionId, eventId, comment, callback);
-};
-
-// tslint:disable:no-var-requires
-// tslint:disable:max-line-length
-import { withCallback } from "thenify-ex";
-
-const opts = { multiArgs: false };
-ClientSessionImpl.prototype.addCommentCondition = withCallback(ClientSessionImpl.prototype.addCommentCondition, opts);
-ClientSessionImpl.prototype.findMethodId = withCallback(ClientSessionImpl.prototype.findMethodId, opts);
-ClientSessionImpl.prototype.confirmCondition = withCallback(ClientSessionImpl.prototype.confirmCondition, opts);
-ClientSessionImpl.prototype.acknowledgeCondition = withCallback(ClientSessionImpl.prototype.acknowledgeCondition, opts);
+    return undefined;
+}
+ClientSessionImpl.prototype.acknowledgeCondition = acknowledgeConditionImpl;

package/source/client_base.ts

@@ -1,7 +1,6 @@
 /**
  * @module node-opcua-client
  */
-// tslint:disable:no-unused-expression
 import type { LocaleId } from "node-opcua-basic-types";
 import type { OPCUACertificateManager } from "node-opcua-certificate-manager";
 import type { ICertificateKeyPairProvider, ICertificateStore, OPCUASecureObject } from "node-opcua-common";
@@ -166,6 +165,11 @@ export interface OPCUAClientBaseOptions {
      *     provided by NodeOPCUA as it may interfere.
      *   - ensure that the provided client certificate matches the private pey.
      *
+     * If the key is encrypted, `clientCertificateManager` must be an
+     * `OPCUACertificateManager` constructed with a matching
+     * `privateKeyPassphrase` (or `privateKeyProvider`) — otherwise
+     * `connect()` fails closed.
+     *
      * @default `${clientCertificateManager/rootFolder}/own/private/private_key.pem"
      */
     privateKeyFile?: string;

package/source/client_monitored_item.ts

@@ -10,7 +10,6 @@ import type { Variant } from "node-opcua-variant";
 import type { ClientMonitoredItemBase, ClientMonitoredItemOrGroupAction } from "./client_monitored_item_base";
 import type { ClientSubscription } from "./client_subscription";
 
-// tslint:disable:unified-signatures
 export interface ClientMonitoredItem extends ClientMonitoredItemBase, ClientMonitoredItemOrGroupAction, EventEmitter {
     on(event: "changed", eventHandler: (dataValue: DataValue) => void): this;
     on(event: "changed", eventHandler: (values: Variant[]) => void): this;
@@ -22,15 +21,17 @@ export interface ClientMonitoredItem extends ClientMonitoredItemBase, ClientMoni
     on(event: "err", eventHandler: (message: string) => void): this;
 }
 
-// eslint-disable-next-line @typescript-eslint/no-namespace
 export namespace ClientMonitoredItem {
-    export let create = function(
-        subscription: ClientSubscription,
-        itemToMonitor: ReadValueIdOptions,
-        monitoringParameters: MonitoringParametersOptions,
-        timestampsToReturn: TimestampsToReturn = TimestampsToReturn.Neither
-    ): ClientMonitoredItem {
+    // reassigned in private/client_monitored_item_impl.ts to install the real
+    // implementation; biome's useConst can't see that cross-module write.
+    // biome-ignore lint/style/useConst: intentionally mutable, see above
+    export let create = (
+        _subscription: ClientSubscription,
+        _itemToMonitor: ReadValueIdOptions,
+        _monitoringParameters: MonitoringParametersOptions,
+        _timestampsToReturn: TimestampsToReturn = TimestampsToReturn.Neither
+    ): ClientMonitoredItem => {
         /* c8 ignore next*/
         throw new Error("unimplemented");
-    }
+    };
 }

package/source/client_monitored_item_base.ts

@@ -22,14 +22,8 @@ import type { Variant } from "node-opcua-variant";
 import type { ClientSubscription } from "./client_subscription";
 
 export interface ClientMonitoredItemOrGroupAction {
-    modify(
-        parameters: MonitoringParametersOptions,
-        timestampsToReturn?: TimestampsToReturn
-    ): Promise<MonitoredItemModifyResult>;
-    modify(
-        parameters: MonitoringParametersOptions,
-        callback: Callback<MonitoredItemModifyResult>
-    ): void;
+    modify(parameters: MonitoringParametersOptions, timestampsToReturn?: TimestampsToReturn): Promise<MonitoredItemModifyResult>;
+    modify(parameters: MonitoringParametersOptions, callback: Callback<MonitoredItemModifyResult>): void;
     modify(
         parameters: MonitoringParametersOptions,
         timestampsToReturn: TimestampsToReturn | null,

package/source/client_monitored_item_group.ts

@@ -2,14 +2,14 @@
  * @module node-opcua-client
  */
 
-import type { EventEmitter } from "events";
+import type { EventEmitter } from "node:events";
 import type { DataValue, TimestampsToReturn } from "node-opcua-data-value";
+import type { ReadValueIdOptions } from "node-opcua-service-read";
 import type { MonitoringParametersOptions } from "node-opcua-types";
 
 import type { ClientMonitoredItemBase, ClientMonitoredItemOrGroupAction } from "./client_monitored_item_base";
 import type { ClientSubscription } from "./client_subscription";
 
-// tslint:disable:unified-signatures
 export interface ClientMonitoredItemGroup extends EventEmitter, ClientMonitoredItemOrGroupAction {
     on(event: "changed", eventHandler: (monitoredItem: ClientMonitoredItemBase, dataValue: DataValue, index: number) => void): this;
 
@@ -24,14 +24,17 @@ export interface ClientMonitoredItemGroup {
     monitoredItems: ClientMonitoredItemBase[];
 }
 
-export class ClientMonitoredItemGroup {
-    public static create(
-        subscription: ClientSubscription,
-        itemsToMonitor: any[],
-        monitoringParameters: MonitoringParametersOptions,
-        timestampsToReturn: TimestampsToReturn
-    ): ClientMonitoredItemGroup {
+export namespace ClientMonitoredItemGroup {
+    // reassigned in private/client_monitored_item_group_impl.ts to install the real
+    // implementation; biome's useConst can't see that cross-module write.
+    // biome-ignore lint/style/useConst: intentionally mutable, see above
+    export let create = (
+        _subscription: ClientSubscription,
+        _itemsToMonitor: ReadValueIdOptions[],
+        _monitoringParameters: MonitoringParametersOptions,
+        _timestampsToReturn: TimestampsToReturn
+    ): ClientMonitoredItemGroup => {
         /* c8 ignore next*/
         throw new Error("Not implemented");
-    }
+    };
 }

package/source/client_monitored_item_toolbox.ts

@@ -26,7 +26,7 @@ import type { ClientMonitoredItemImpl } from "./private/client_monitored_item_im
 import type { ClientSessionImpl } from "./private/client_session_impl";
 
 const debugLog = make_debugLog(__filename);
-const _doDebug = checkDebugFlag(__filename);
+const doDebug = checkDebugFlag(__filename);
 
 export interface ClientMonitoredItemBaseEx extends ClientMonitoredItemBase {
     internalSetMonitoringMode(monitoringMode: MonitoringMode): void;
@@ -85,7 +85,9 @@ export namespace ClientMonitoredItemToolbox {
         session.createMonitoredItems(createMonitorItemsRequest, (err?: Error | null, response?: CreateMonitoredItemsResponse) => {
             /* c8 ignore next */
             if (err) {
-                debugLog(chalk.red("ClientMonitoredItemBase#_toolbox_monitor:  ERROR in createMonitoredItems ", err.message));
+                // c8 ignore next
+                doDebug &&
+                    debugLog(chalk.red("ClientMonitoredItemBase#_toolbox_monitor:  ERROR in createMonitoredItems ", err.message));
             } else {
                 /* c8 ignore next */
                 if (!response) {

package/source/client_session.ts

@@ -110,7 +110,14 @@ export interface ClientSessionBase {
      */
     lastRequestSentTime: Date;
     /**
-     * the time of the latest response received by the client
+     * the time of the latest response received by the client from the server.
+     *
+     * this is only updated when the server has actually answered. A transaction that fails
+     * on a timeout or on a broken channel does not update this value, whereas a ServiceFault
+     * does: a fault means the server answered and rejected the request, so the session is
+     * still in contact with it.
+     *
+     * before the first answer, this holds the session creation sentinel rather than a real date.
      */
     lastResponseReceivedTime: Date;
     /**
@@ -183,10 +190,9 @@ export interface ClientSession extends ClientSessionBase {
 }
 // events
 export interface ClientSession extends EventEmitter {
-    // tslint:disable:unified-signatures
     on(event: "keepalive", eventHandler: (lastKnownServerState: ServerState) => void): this;
 
-    on(event: "keepalive_failure", eventHandler: (state: any) => void): this;
+    on(event: "keepalive_failure", eventHandler: () => void): this;
 
     on(event: "session_closed", eventHandler: (statusCode: StatusCode) => void): this;
 
@@ -196,6 +202,7 @@ export interface ClientSession extends EventEmitter {
      */
     on(event: "session_restored", eventHandler: () => void): this;
 
+    // biome-ignore lint/suspicious/noExplicitAny: matches Node's EventEmitter.on catch-all signature; narrowing to unknown[] breaks assignability of specifically-typed listener handlers at call sites
     on(event: string | symbol, listener: (...args: any[]) => void): this;
 }