node-opcua-client-proxy 2.177.0 → 2.179.0

package/source/proxy_base_node.ts

@@ -1,16 +1,18 @@
 /**
  * @module node-opcua-client-proxy
  */
-import { EventEmitter } from "events";
+import { EventEmitter } from "node:events";
 import { assert } from "node-opcua-assert";
-import { AttributeIds, NodeClass } from "node-opcua-data-model";
-import { DataValue } from "node-opcua-data-value";
-import { NodeId } from "node-opcua-nodeid";
-import { Argument } from "node-opcua-service-call";
-import { WriteValueOptions } from "node-opcua-service-write";
-import { DataType, Variant } from "node-opcua-variant";
-import { UAProxyManager } from "./proxy_manager";
-import { StatusCode } from "node-opcua-status-code";
+import { AttributeIds, type NodeClass } from "node-opcua-data-model";
+import type { DataValue } from "node-opcua-data-value";
+import type { NodeId } from "node-opcua-nodeid";
+import type { Argument } from "node-opcua-service-call";
+import type { WriteValueOptions } from "node-opcua-service-write";
+import type { StatusCode } from "node-opcua-status-code";
+import type { DataType, Variant } from "node-opcua-variant";
+import type { UAProxyManager } from "./proxy_manager";
+import type { ProxyNode } from "./proxy_transition";
+import type { ProxyVariable } from "./proxy_variable";
 
 export interface ArgumentEx extends Argument {
     _basicDataType: DataType;
@@ -18,7 +20,7 @@ export interface ArgumentEx extends Argument {
 export interface MethodDescription {
     browseName: string;
     executableFlag: boolean;
-    func: (input: Record<string, unknown>, callback: (err: Error | null, output?: Record<string, unknown>) => void) => void;
+    func: (input: Record<string, unknown>) => Promise<{ statusCode: StatusCode; output?: Record<string, unknown> }>;
     nodeId: NodeId; // the method NodeId
     inputArguments: ArgumentEx[];
     outputArguments: ArgumentEx[];
@@ -36,25 +38,25 @@ export class ProxyBaseNode extends EventEmitter {
      * @property $components
      * @type {Array<ProxyBaseNode>}
      */
-    public readonly $components: any[];
+    public readonly $components: ProxyNode[];
     /**
      * the object's properties
      * @property $properties
      * @type {Array<ProxyBaseNode>}
      */
-    public $properties: any[];
+    public $properties: Record<string, ProxyVariable>;
     /**
      * the object's properties
      * @property $methods
      * @type {Array<ProxyBaseNode>}
      */
-    public $methods: MethodDescription[];
+    public $methods: Record<string, MethodDescription>;
     /**
      * the Folder's elements
      * @property $organizes
      * @type {Array<ProxyBaseNode>}
      */
-    public $organizes: any[];
+    public $organizes: ProxyNode[];
     /**
      * the object's description
      * @property description
@@ -72,7 +74,7 @@ export class ProxyBaseNode extends EventEmitter {
      * @property nodeClass
      * @type {NodeClass}
      */
-    public readonly nodeClass: NodeClass;
+    public nodeClass: NodeClass;
 
     private readonly proxyManager: UAProxyManager;
 
@@ -88,8 +90,8 @@ export class ProxyBaseNode extends EventEmitter {
             writable: true
         });
         this.$components = [];
-        this.$properties = [];
-        this.$methods = [];
+        this.$properties = {};
+        this.$methods = {};
         this.$organizes = [];
 
         this.description = "";
@@ -111,7 +113,7 @@ export class ProxyBaseNode extends EventEmitter {
             nodeId: this.nodeId
         };
         const dataValue = await this.proxyManager.session.read(nodeToRead);
-        const data = dataValue!.value;
+        const data = dataValue?.value;
         return data;
     }
 
@@ -130,18 +132,18 @@ export class ProxyBaseNode extends EventEmitter {
             value: dataValue
         };
         const statusCode = await this.proxyManager.session.write(nodeToWrite);
-       
+
         return statusCode;
     }
 
     public toString(): string {
         const str = [];
         str.push(" ProxyObject ");
-        str.push("   browseName     : " + this.browseName.toString());
+        str.push(`   browseName     : ${this.browseName.toString()}`);
         // str.push("   typeDefinition : " + this.typeDefinition.toString());
-        str.push("   $components#   : " + this.$components.length.toString());
-        str.push("   $properties#   : " + this.$properties.length.toString());
+        str.push(`   $components#   : ${this.$components.length.toString()}`);
+        str.push(`   $properties#   : ${Object.keys(this.$properties).length.toString()}`);
 
         return str.join("\n");
     }
-}
+}

package/source/proxy_manager.ts

@@ -1,28 +1,34 @@
 /**
  * @module node-opcua-client-proxy
  */
-// tslint:disable:no-shadowed-variable
-import { EventEmitter } from "events";
+import type { EventEmitter } from "node:events";
 import { assert } from "node-opcua-assert";
 
-import { AttributeIds, NodeClass, coerceAccessLevelFlag } from "node-opcua-data-model";
-import { NodeId, coerceNodeId } from "node-opcua-nodeid";
-import { DataValue, TimestampsToReturn } from "node-opcua-data-value";
-import { NodeIdLike } from "node-opcua-nodeid";
-import { CreateSubscriptionRequestOptions, MonitoringParametersOptions } from "node-opcua-service-subscription";
+import { type AccessLevelFlag, AttributeIds, coerceAccessLevelFlag, NodeClass } from "node-opcua-data-model";
+import { type DataValue, TimestampsToReturn } from "node-opcua-data-value";
+import { checkDebugFlag, make_debugLog } from "node-opcua-debug";
+import { coerceNodeId, NodeId, type NodeIdLike } from "node-opcua-nodeid";
+import type { IBasicSessionAsync, IBasicSessionGetArgumentDefinitionAsync } from "node-opcua-pseudo-session";
+import type { ReadValueIdOptions } from "node-opcua-service-read";
+import type { CreateSubscriptionRequestOptions, MonitoringParametersOptions } from "node-opcua-service-subscription";
 import { StatusCodes } from "node-opcua-status-code";
-import { IBasicSessionAsync, IBasicSessionGetArgumentDefinitionAsync } from "node-opcua-pseudo-session";
-import { ReadValueIdOptions } from "node-opcua-service-read";
-import { Variant } from "node-opcua-variant";
-import { make_debugLog } from "node-opcua-debug";
+import type { Variant } from "node-opcua-variant";
 
 import { readUAStructure } from "./object_explorer";
 import { makeRefId } from "./proxy";
 import { ProxyObject } from "./proxy_object";
+import type { ProxyNode } from "./proxy_transition";
 import { ProxyStateMachineType } from "./state_machine_proxy";
-import { ProxyNode } from "./proxy_transition";
+
+interface ProxyObjectWithDynamicFields extends ProxyObject {
+    dataValue?: DataValue;
+    userAccessLevel?: AccessLevelFlag;
+    accessLevel?: AccessLevelFlag;
+    [dynamicChildName: string]: unknown;
+}
 
 const debugLog = make_debugLog(__filename);
+const doDebug = checkDebugFlag(__filename);
 
 export interface IProxy1 {
     nodeId: NodeId;
@@ -31,14 +37,14 @@ export interface IProxy1 {
     __monitoredItem?: EventEmitter;
 }
 export interface IProxy extends EventEmitter, IProxy1 {
-    dataValue: DataValue;
+    dataValue?: DataValue;
 }
 
 async function internalGetObject(
-    proxyManager: UAProxyManager, 
-    nodeId: NodeIdLike | NodeId, options: any
+    proxyManager: UAProxyManager,
+    nodeId: NodeIdLike | NodeId,
+    _options: { depth?: number }
 ): Promise<ProxyNode> {
-   
     const session = proxyManager.session;
 
     nodeId = coerceNodeId(nodeId) as NodeId;
@@ -62,7 +68,7 @@ async function internalGetObject(
         }
     ];
 
-    async function read_accessLevels(clientObject: any) {
+    async function read_accessLevels(clientObject: ProxyObjectWithDynamicFields) {
         const nodesToRead = [
             {
                 attributeId: AttributeIds.Value,
@@ -81,7 +87,10 @@ async function internalGetObject(
         const dataValues = await session.read(nodesToRead);
 
         if (dataValues[0].statusCode.isGood()) {
-            clientObject.dataValue = dataValues[0].value;
+            // store the full DataValue (statusCode + timestamps + value), consistent with
+            // what _monitor_value's "changed" handler assigns here on later updates —
+            // assigning just the Variant (dataValues[0].value) would be a narrower shape.
+            clientObject.dataValue = dataValues[0];
         }
         if (dataValues[1].statusCode.isGood()) {
             clientObject.userAccessLevel = coerceAccessLevelFlag(dataValues[1].value.value);
@@ -91,15 +100,15 @@ async function internalGetObject(
         }
     }
 
-    let clientObject: any;
+    let clientObject: ProxyObjectWithDynamicFields;
 
     const dataValues = await session.read(nodesToRead);
 
     if (dataValues[0].statusCode.equals(StatusCodes.BadNodeIdUnknown)) {
-        throw new Error("Invalid Node " + nodeId.toString());
+        throw new Error(`Invalid Node ${nodeId.toString()}`);
     }
 
-    clientObject = new ProxyObject(proxyManager, nodeId as NodeId);
+    clientObject = new ProxyObject(proxyManager, nodeId as NodeId) as ProxyObjectWithDynamicFields;
 
     clientObject.browseName = dataValues[0].value.value;
     clientObject.description = dataValues[1].value ? dataValues[1].value.value : "";
@@ -134,11 +143,10 @@ export interface IBasicSessionWithSubscriptionAsync extends IBasicSessionAsync,
     createSubscription2(options: CreateSubscriptionRequestOptions): Promise<IClientSubscription>;
 }
 
-// tslint:disable-next-line: max-classes-per-file
 export class UAProxyManager {
     public readonly session: IBasicSessionWithSubscriptionAsync;
     public subscription?: IClientSubscription;
-    #_map: any;
+    #_map: Record<string, ProxyNode>;
 
     constructor(session: IBasicSessionWithSubscriptionAsync) {
         this.session = session;
@@ -146,7 +154,6 @@ export class UAProxyManager {
     }
 
     public async start(): Promise<void> {
-
         const createSubscriptionRequest: CreateSubscriptionRequestOptions = {
             maxNotificationsPerPublish: 1000,
             priority: 10,
@@ -157,8 +164,8 @@ export class UAProxyManager {
         };
 
         const subscription = await this.session.createSubscription2(createSubscriptionRequest);
-        this.subscription = subscription!;
-        this.subscription!.on("terminated", () => {
+        this.subscription = subscription;
+        this.subscription?.on("terminated", () => {
             this.subscription = undefined;
         });
     }
@@ -174,13 +181,11 @@ export class UAProxyManager {
 
     // todo: rename getObject as getNode
     public async getObject(nodeId: NodeIdLike): Promise<ProxyNode> {
-        let options: any = {};
-        options = options || {};
-        options.depth = options.depth || 1;
+        const options: { depth: number } = { depth: 1 };
 
         const key = nodeId.toString();
         // the object already exist in the map ?
-        if (Object.prototype.hasOwnProperty.call(this.#_map, key)) {
+        if (Object.hasOwn(this.#_map, key)) {
             return this.#_map[key];
         }
 
@@ -212,12 +217,13 @@ export class UAProxyManager {
         const monitoredItem = await this.subscription.monitor(itemToMonitor, monitoringParameters, requestedParameters);
 
         Object.defineProperty(proxyObject, "__monitoredItem", { value: monitoredItem, enumerable: false });
-        proxyObject.__monitoredItem!.on("changed", (dataValue: DataValue) => {
+        proxyObject.__monitoredItem?.on("changed", (dataValue: DataValue) => {
             proxyObject.dataValue = dataValue;
             proxyObject.emit("value_changed", dataValue);
         });
-        proxyObject.__monitoredItem!.on("err", (err: Error) => {
-            debugLog("Proxy: cannot monitor variable ", itemToMonitor.nodeId?.toString(), err.message);
+        proxyObject.__monitoredItem?.on("err", (err: Error) => {
+            // c8 ignore next
+            doDebug && debugLog("Proxy: cannot monitor variable ", itemToMonitor.nodeId?.toString(), err.message);
         });
     }
 
@@ -250,7 +256,7 @@ export class UAProxyManager {
 
             enumerable: false
         });
-        proxyObject.__monitoredItem_execution_flag!.on("changed", (dataValue: DataValue) => {
+        proxyObject.__monitoredItem_execution_flag?.on("changed", (dataValue: DataValue) => {
             proxyObject.executableFlag = dataValue.value.value;
         });
     }

package/source/proxy_object.ts

@@ -2,9 +2,9 @@
  * @module node-opcua-client-proxy
  */
 import { NodeClass } from "node-opcua-data-model";
-import { NodeId } from "node-opcua-nodeid";
+import type { NodeId } from "node-opcua-nodeid";
 import { ProxyBaseNode } from "./proxy_base_node";
-import { UAProxyManager } from "./proxy_manager";
+import type { UAProxyManager } from "./proxy_manager";
 
 export class ProxyObject extends ProxyBaseNode {
     constructor(proxyManager: UAProxyManager, nodeId: NodeId) {

package/source/proxy_state.ts

@@ -1,11 +1,11 @@
 /**
  * @module node-opcua-client-proxy
  */
-import { NodeId } from "node-opcua-nodeid";
-import { ProxyNode } from "./proxy_transition";
+import type { NodeId } from "node-opcua-nodeid";
+import type { ProxyNode } from "./proxy_transition";
 
 export class ProxyState {
-    private _node: any;
+    private _node: ProxyNode & { stateNumber?: ProxyNode };
 
     constructor(proxyNode: ProxyNode) {
         this._node = proxyNode;
@@ -17,7 +17,7 @@ export class ProxyState {
 
     public get stateNumber(): string {
         // note stateNumber has no real dataValue
-        return this._node.stateNumber.nodeId.value.toString();
+        return this._node.stateNumber?.nodeId.value.toString() || "";
     }
 
     public get nodeId(): NodeId {
@@ -26,7 +26,7 @@ export class ProxyState {
     }
 
     public toString(): string {
-        return "state " + this.browseName + " stateNumber :" + this.stateNumber.toString();
+        return `state ${this.browseName} stateNumber :${this.stateNumber.toString()}`;
     }
 }
 

package/source/proxy_state_machine.ts

@@ -1,10 +1,10 @@
 /**
  * @module node-opcua-client-proxy
  */
-import { EventEmitter } from "events";
+import { EventEmitter } from "node:events";
 import { assert } from "node-opcua-assert";
-import { NodeId } from "node-opcua-nodeid";
-import { UAProxyManager } from "./proxy_manager";
+import type { NodeId } from "node-opcua-nodeid";
+import type { UAProxyManager } from "./proxy_manager";
 
 export class StateMachineProxy extends EventEmitter {
     public nodeId: NodeId;

package/source/proxy_transition.ts

@@ -1,5 +1,5 @@
-import { QualifiedName } from "node-opcua-data-model";
-import { NodeId } from "node-opcua-nodeid";
+import type { QualifiedName } from "node-opcua-data-model";
+import type { NodeId } from "node-opcua-nodeid";
 
 export interface ProxyNode {
     nodeId: NodeId;

package/source/proxy_variable.ts

@@ -2,13 +2,13 @@
  * @module node-opcua-client-proxy
  */
 import { NodeClass } from "node-opcua-data-model";
-import { NodeId } from "node-opcua-nodeid";
-import { ReferenceDescription } from "node-opcua-service-browse";
+import type { NodeId } from "node-opcua-nodeid";
+import type { ReferenceDescription } from "node-opcua-service-browse";
 import { ProxyBaseNode } from "./proxy_base_node";
-import { UAProxyManager } from "./proxy_manager";
+import type { UAProxyManager } from "./proxy_manager";
 
 export class ProxyVariable extends ProxyBaseNode {
-    constructor(proxyManager: UAProxyManager, nodeId: NodeId, reference: ReferenceDescription) {
+    constructor(proxyManager: UAProxyManager, nodeId: NodeId, _reference: ReferenceDescription) {
         super(proxyManager, nodeId, NodeClass.Variable);
     }
 }

package/source/state_machine_proxy.ts

@@ -3,7 +3,7 @@
  */
 import { assert } from "node-opcua-assert";
 import { makeProxyState, ProxyState } from "./proxy_state";
-import { makeProxyTransition, ProxyNode, ProxyTransition } from "./proxy_transition";
+import { makeProxyTransition, type ProxyNode, type ProxyTransition } from "./proxy_transition";
 
 export class ProxyStateMachineType {
     public initialState: ProxyState | undefined;
@@ -11,8 +11,7 @@ export class ProxyStateMachineType {
     public transitions: ProxyTransition[];
 
     constructor(obj: ProxyNode) {
-        
-        const localInitialState = obj.$components.filter((component: any) => {
+        const localInitialState = obj.$components.filter((component: ProxyNode) => {
             if (!component.typeDefinition) {
                 return false;
             }
@@ -27,7 +26,7 @@ export class ProxyStateMachineType {
         }
 
         this.states = obj.$components
-            .filter((component: any) => {
+            .filter((component: ProxyNode) => {
                 if (!component.typeDefinition) {
                     return false;
                 }