opcua-webapi-ts 1.1.3 → 1.1.4

package/dist/cjs/client/utils/UaNodeReader.js

@@ -565,10 +565,12 @@ class UaNodeChildReader extends UaNodeReaderBase {
 }
 exports.UaNodeChildReader = UaNodeChildReader;
 class UaNodeLinkReader {
-    constructor(nodeIds) {
+    constructor(nodeIds, returnDescription) {
         this._nodesToBrowse = nodeIds;
         this._continuationPointToBrowse = [];
         this._browseResults = [];
+        this._returnDescription = (returnDescription) ? returnDescription : false;
+        this._readResults = null;
     }
     readAll(client) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -588,25 +590,17 @@ class UaNodeLinkReader {
             else if (this._continuationPointToBrowse.length != 0) {
                 yield this._browseContinuationPoints(client);
             }
+            else {
+                this._buildResults();
+                yield this._readDescriptions(client);
+            }
         });
     }
     isFinish() {
-        return this._nodesToBrowse.length == 0 && this._continuationPointToBrowse.length == 0;
+        return null != this._readResults;
     }
     getResults() {
-        let ret = new Map;
-        for (let item of this._browseResults) {
-            let result = ret.get(item.fromNodeId.toString());
-            if (!result) {
-                result = {
-                    nodeId: item.fromNodeId,
-                    links: []
-                };
-                ret.set(item.fromNodeId.toString(), result);
-            }
-            result.links.push(new common_1.UaLink(item.nodeId, item.nodeClass, item.browseName, item.displayName, item.referenceTypeId, item.isForward));
-        }
-        return [...ret.values()];
+        return (this._readResults) ? this._readResults : [];
     }
     _browseNodes(client) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -689,5 +683,48 @@ class UaNodeLinkReader {
             }
         });
     }
+    _buildResults() {
+        if (this._readResults != null)
+            return;
+        this._readResults = [];
+        let ret = new Map;
+        for (let item of this._browseResults) {
+            let result = ret.get(item.fromNodeId.toString());
+            if (!result) {
+                result = {
+                    nodeId: item.fromNodeId,
+                    links: []
+                };
+                ret.set(item.fromNodeId.toString(), result);
+            }
+            result.links.push(new common_1.UaLink(item.nodeId, item.nodeClass, item.browseName, item.displayName, item.referenceTypeId, item.isForward));
+        }
+        this._readResults = Array.from(ret.values());
+    }
+    _readDescriptions(client) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this._returnDescription)
+                return;
+            let linkedNodesToRead = [];
+            for (let item of this._readResults) {
+                for (let link of item.links) {
+                    if (link.nodeClass == opcua_webapi_1.NodeClass.Object)
+                        linkedNodesToRead.push(link);
+                }
+            }
+            if (linkedNodesToRead.length == 0)
+                return;
+            let nodesToRead = [];
+            for (let item of linkedNodesToRead) {
+                nodesToRead.push(new common_1.UaReadValueId(item.targetId, opcua_webapi_1.Attributes.Description));
+            }
+            let dataValues = yield client.read(nodesToRead);
+            for (let i = 0; i < linkedNodesToRead.length; ++i) {
+                if (dataValues[i].statusCode.isGood()) {
+                    linkedNodesToRead[i].description = dataValues[i].value.toLocalizedText();
+                }
+            }
+        });
+    }
 }
 exports.UaNodeLinkReader = UaNodeLinkReader;

package/dist/cjs/common/nodes/UaNode.js

@@ -6,9 +6,11 @@ class UaNode {
         this._nodeId = nodeId;
         this._browseName = browseName;
         this._displayName = displayName;
+        this._description = null;
         this._writeMask = (writeMask) ? writeMask : 0;
         this._parent = null;
         this._children = [];
+        this._refToParent = null;
     }
     get nodeId() {
         return this._nodeId;
@@ -23,13 +25,13 @@ class UaNode {
         return this._writeMask;
     }
     get description() {
-        return (this._description) ? this._description : null;
+        return this._description;
     }
     set description(description) {
         this._description = description;
     }
     get refToParent() {
-        return (this._refToParent) ? this._refToParent : null;
+        return this._refToParent;
     }
     set refToParent(referenceTypeId) {
         this._refToParent = referenceTypeId;

package/dist/cjs/common/types/UaLink.js

@@ -6,6 +6,7 @@ class UaLink {
         this._targetId = targetId;
         this._browseName = browseName;
         this._displayName = displayName;
+        this._description = null;
         this._nodeClass = nodeClass;
         this._referenceTypeId = referenceTypeId;
         this._isForward = isForward;
@@ -19,6 +20,12 @@ class UaLink {
     get displayName() {
         return this._displayName;
     }
+    get description() {
+        return this._description;
+    }
+    set description(description) {
+        this._description = description;
+    }
     get nodeClass() {
         return this._nodeClass;
     }
@@ -28,5 +35,16 @@ class UaLink {
     get isForward() {
         return this._isForward;
     }
+    toJson() {
+        return {
+            targetId: this._targetId.toString(),
+            nodeClass: this._nodeClass,
+            reference: this._referenceTypeId.toString(),
+            isForward: this._isForward,
+            browseName: this._browseName,
+            displayName: this._displayName.text,
+            description: (this._description) ? this._description.text : undefined,
+        };
+    }
 }
 exports.UaLink = UaLink;

package/dist/client/utils/UaNodeReader.d.ts

@@ -73,12 +73,16 @@ export declare class UaNodeLinkReader {
     private _nodesToBrowse;
     private _continuationPointToBrowse;
     private _browseResults;
-    constructor(nodeIds: Array<UaNodeId>);
+    private _returnDescription;
+    private _readResults;
+    constructor(nodeIds: Array<UaNodeId>, returnDescription?: boolean | null);
     readAll(client: UaWebClient): Promise<void>;
     read(client: UaWebClient): Promise<void>;
     isFinish(): boolean;
     getResults(): Array<ReadLinkResult>;
     private _browseNodes;
     private _browseContinuationPoints;
+    private _buildResults;
+    private _readDescriptions;
 }
 export {};

package/dist/client/utils/UaNodeReader.js

@@ -565,10 +565,12 @@ class UaNodeChildReader extends UaNodeReaderBase {
 }
 exports.UaNodeChildReader = UaNodeChildReader;
 class UaNodeLinkReader {
-    constructor(nodeIds) {
+    constructor(nodeIds, returnDescription) {
         this._nodesToBrowse = nodeIds;
         this._continuationPointToBrowse = [];
         this._browseResults = [];
+        this._returnDescription = (returnDescription) ? returnDescription : false;
+        this._readResults = null;
     }
     readAll(client) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -588,25 +590,17 @@ class UaNodeLinkReader {
             else if (this._continuationPointToBrowse.length != 0) {
                 yield this._browseContinuationPoints(client);
             }
+            else {
+                this._buildResults();
+                yield this._readDescriptions(client);
+            }
         });
     }
     isFinish() {
-        return this._nodesToBrowse.length == 0 && this._continuationPointToBrowse.length == 0;
+        return null != this._readResults;
     }
     getResults() {
-        let ret = new Map;
-        for (let item of this._browseResults) {
-            let result = ret.get(item.fromNodeId.toString());
-            if (!result) {
-                result = {
-                    nodeId: item.fromNodeId,
-                    links: []
-                };
-                ret.set(item.fromNodeId.toString(), result);
-            }
-            result.links.push(new common_1.UaLink(item.nodeId, item.nodeClass, item.browseName, item.displayName, item.referenceTypeId, item.isForward));
-        }
-        return [...ret.values()];
+        return (this._readResults) ? this._readResults : [];
     }
     _browseNodes(client) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -689,5 +683,48 @@ class UaNodeLinkReader {
             }
         });
     }
+    _buildResults() {
+        if (this._readResults != null)
+            return;
+        this._readResults = [];
+        let ret = new Map;
+        for (let item of this._browseResults) {
+            let result = ret.get(item.fromNodeId.toString());
+            if (!result) {
+                result = {
+                    nodeId: item.fromNodeId,
+                    links: []
+                };
+                ret.set(item.fromNodeId.toString(), result);
+            }
+            result.links.push(new common_1.UaLink(item.nodeId, item.nodeClass, item.browseName, item.displayName, item.referenceTypeId, item.isForward));
+        }
+        this._readResults = Array.from(ret.values());
+    }
+    _readDescriptions(client) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this._returnDescription)
+                return;
+            let linkedNodesToRead = [];
+            for (let item of this._readResults) {
+                for (let link of item.links) {
+                    if (link.nodeClass == opcua_webapi_1.NodeClass.Object)
+                        linkedNodesToRead.push(link);
+                }
+            }
+            if (linkedNodesToRead.length == 0)
+                return;
+            let nodesToRead = [];
+            for (let item of linkedNodesToRead) {
+                nodesToRead.push(new common_1.UaReadValueId(item.targetId, opcua_webapi_1.Attributes.Description));
+            }
+            let dataValues = yield client.read(nodesToRead);
+            for (let i = 0; i < linkedNodesToRead.length; ++i) {
+                if (dataValues[i].statusCode.isGood()) {
+                    linkedNodesToRead[i].description = dataValues[i].value.toLocalizedText();
+                }
+            }
+        });
+    }
 }
 exports.UaNodeLinkReader = UaNodeLinkReader;

package/dist/common/nodes/UaNode.d.ts

@@ -4,11 +4,11 @@ export declare abstract class UaNode {
     protected _nodeId: UaNodeId;
     protected _browseName: string;
     protected _displayName: UaLocalizedText;
-    protected _description: UaLocalizedText | undefined;
+    protected _description: UaLocalizedText | null;
     protected _writeMask: number;
     protected _parent: UaNode | null;
     protected _children: Array<UaNode>;
-    protected _refToParent: UaNodeId | undefined;
+    protected _refToParent: UaNodeId | null;
     constructor(nodeId: UaNodeId, browseName: string, displayName: UaLocalizedText, writeMask?: number | null);
     abstract get nodeClass(): NodeClass;
     get nodeId(): UaNodeId;
@@ -16,9 +16,9 @@ export declare abstract class UaNode {
     get displayName(): UaLocalizedText;
     get writeMask(): number;
     get description(): UaLocalizedText | null;
-    set description(description: UaLocalizedText);
+    set description(description: UaLocalizedText | null);
     get refToParent(): UaNodeId | null;
-    set refToParent(referenceTypeId: UaNodeId);
+    set refToParent(referenceTypeId: UaNodeId | null);
     abstract toJson(): any;
 }
 export declare abstract class UaDefintionNode extends UaNode {

package/dist/common/nodes/UaNode.js

@@ -6,9 +6,11 @@ class UaNode {
         this._nodeId = nodeId;
         this._browseName = browseName;
         this._displayName = displayName;
+        this._description = null;
         this._writeMask = (writeMask) ? writeMask : 0;
         this._parent = null;
         this._children = [];
+        this._refToParent = null;
     }
     get nodeId() {
         return this._nodeId;
@@ -23,13 +25,13 @@ class UaNode {
         return this._writeMask;
     }
     get description() {
-        return (this._description) ? this._description : null;
+        return this._description;
     }
     set description(description) {
         this._description = description;
     }
     get refToParent() {
-        return (this._refToParent) ? this._refToParent : null;
+        return this._refToParent;
     }
     set refToParent(referenceTypeId) {
         this._refToParent = referenceTypeId;

package/dist/common/types/UaLink.d.ts

@@ -5,13 +5,17 @@ export declare class UaLink {
     private _nodeClass;
     private _browseName;
     private _displayName;
+    private _description;
     private _referenceTypeId;
     private _isForward;
     constructor(targetId: UaNodeId, nodeClass: number, browseName: string, displayName: UaLocalizedText, referenceTypeId: UaNodeId, isForward: boolean);
     get targetId(): UaNodeId;
     get browseName(): string;
     get displayName(): UaLocalizedText;
+    get description(): UaLocalizedText | null;
+    set description(description: UaLocalizedText | null);
     get nodeClass(): number;
     get referenceTypeId(): UaNodeId;
     get isForward(): boolean;
+    toJson(): any;
 }

package/dist/common/types/UaLink.js

@@ -6,6 +6,7 @@ class UaLink {
         this._targetId = targetId;
         this._browseName = browseName;
         this._displayName = displayName;
+        this._description = null;
         this._nodeClass = nodeClass;
         this._referenceTypeId = referenceTypeId;
         this._isForward = isForward;
@@ -19,6 +20,12 @@ class UaLink {
     get displayName() {
         return this._displayName;
     }
+    get description() {
+        return this._description;
+    }
+    set description(description) {
+        this._description = description;
+    }
     get nodeClass() {
         return this._nodeClass;
     }
@@ -28,5 +35,16 @@ class UaLink {
     get isForward() {
         return this._isForward;
     }
+    toJson() {
+        return {
+            targetId: this._targetId.toString(),
+            nodeClass: this._nodeClass,
+            reference: this._referenceTypeId.toString(),
+            isForward: this._isForward,
+            browseName: this._browseName,
+            displayName: this._displayName.text,
+            description: (this._description) ? this._description.text : undefined,
+        };
+    }
 }
 exports.UaLink = UaLink;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "opcua-webapi-ts",
-  "version": "1.1.3",
+  "version": "1.1.4",
   "description": "Provides OPC UA WebAPI wrapper and client based on opcua-webapi-typescript",
   "author": "DingYan",
   "main": "./dist/cjs/index.js",