node-opcua-address-space 2.164.2 → 2.165.0

package/dist/src/base_node_impl.js

@@ -1,4 +1,7 @@
 "use strict";
+/**
+ * @module node-opcua-address-space
+ */
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -6,13 +9,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseNodeImpl = void 0;
 exports.makeAttributeEventName = makeAttributeEventName;
 exports.getReferenceType = getReferenceType;
-/**
- * @module node-opcua-address-space
- */
-const events_1 = require("events");
+const node_events_1 = require("node:events");
 const chalk_1 = __importDefault(require("chalk"));
 const lodash_1 = require("lodash");
 const node_opcua_assert_1 = require("node-opcua-assert");
+const node_opcua_constants_1 = require("node-opcua-constants");
 const node_opcua_data_model_1 = require("node-opcua-data-model");
 const node_opcua_data_value_1 = require("node-opcua-data-value");
 const node_opcua_debug_1 = require("node-opcua-debug");
@@ -21,7 +22,6 @@ const node_opcua_status_code_1 = require("node-opcua-status-code");
 const node_opcua_types_1 = require("node-opcua-types");
 const node_opcua_utils_1 = require("node-opcua-utils");
 const node_opcua_variant_1 = require("node-opcua-variant");
-const node_opcua_constants_1 = require("node-opcua-constants");
 const dump_tools_1 = require("../source/helpers/dump_tools");
 const session_context_1 = require("../source/session_context");
 const address_space_change_event_tools_1 = require("./address_space_change_event_tools");
@@ -37,11 +37,11 @@ const errorLog = (0, node_opcua_debug_1.make_errorLog)(__filename);
 const debugLog = (0, node_opcua_debug_1.make_debugLog)(__filename);
 const HasEventSourceReferenceType = (0, node_opcua_nodeid_1.resolveNodeId)("HasEventSource");
 const HasNotifierReferenceType = (0, node_opcua_nodeid_1.resolveNodeId)("HasNotifier");
-function defaultBrowseFilterFunc(context) {
+function defaultBrowseFilterFunc(_context) {
     return true;
 }
 function _get_QualifiedBrowseName(browseName) {
-    return (0, node_opcua_data_model_1.coerceQualifiedName)(browseName);
+    return (0, node_opcua_data_model_1.coerceQualifiedName)(browseName) || "";
 }
 function _is_valid_BrowseDirection(browseDirection) {
     return (browseDirection === node_opcua_data_model_1.BrowseDirection.Forward ||
@@ -50,7 +50,7 @@ function _is_valid_BrowseDirection(browseDirection) {
 }
 function makeAttributeEventName(attributeId) {
     const attributeName = node_opcua_data_model_1.attributeNameById[attributeId];
-    return attributeName + "_changed";
+    return `${attributeName}_changed`;
 }
 /**
  * Base class for all Node classes
@@ -69,7 +69,7 @@ function makeAttributeEventName(attributeId) {
  *
  *
  */
-class BaseNodeImpl extends events_1.EventEmitter {
+class BaseNodeImpl extends node_events_1.EventEmitter {
     static makeAttributeEventName(attributeId) {
         return makeAttributeEventName(attributeId);
     }
@@ -80,7 +80,7 @@ class BaseNodeImpl extends events_1.EventEmitter {
         const _private = (0, base_node_private_1.BaseNode_getPrivate)(this);
         // c8 ignore next
         if (!_private) {
-            throw new Error("Internal error , cannot extract private data from " + this.browseName.toString());
+            throw new Error(`Internal error , cannot extract private data from ${this.browseName.toString()}`);
         }
         return _private.__address_space;
     }
@@ -88,7 +88,7 @@ class BaseNodeImpl extends events_1.EventEmitter {
         const _private = (0, base_node_private_1.BaseNode_getPrivate)(this);
         // c8 ignore next
         if (!_private) {
-            throw new Error("Internal error , cannot extract private data from " + this.browseName.toString());
+            throw new Error(`Internal error , cannot extract private data from ${this.browseName.toString()}`);
         }
         return _private.__address_space;
     }
@@ -98,7 +98,8 @@ class BaseNodeImpl extends events_1.EventEmitter {
     }
     setDisplayName(value) {
         if (!Array.isArray(value)) {
-            return this.setDisplayName([value]);
+            this.setDisplayName([value]);
+            return;
         }
         this._setDisplayName(value);
         /**
@@ -110,7 +111,7 @@ class BaseNodeImpl extends events_1.EventEmitter {
     }
     get description() {
         const _private = (0, base_node_private_1.BaseNode_getPrivate)(this);
-        return _private._description;
+        return _private._description || new node_opcua_data_model_1.LocalizedText({ text: "" });
     }
     setDescription(value) {
         this._setDescription(value);
@@ -224,11 +225,11 @@ class BaseNodeImpl extends events_1.EventEmitter {
          */
         this.browseName = _get_QualifiedBrowseName(options.browseName);
         // re-use browseName as displayName if displayName is missing
-        options.displayName = options.displayName || this.browseName.name.toString();
+        options.displayName = options.displayName || this.browseName.name?.toString();
         if (options.description === undefined) {
             options.description = null;
         }
-        this._setDisplayName(options.displayName);
+        this._setDisplayName(options.displayName || "");
         this._setDescription(options.description);
         // user defined filter function for browsing
         const _browseFilter = options.browseFilter || defaultBrowseFilterFunc;
@@ -244,9 +245,9 @@ class BaseNodeImpl extends events_1.EventEmitter {
         this._accessRestrictions = options.accessRestrictions;
         this._rolePermissions = (0, role_permissions_1.coerceRolePermissions)(options.rolePermissions);
     }
-    getDisplayName(locale) {
+    getDisplayName(_locale) {
         const _private = (0, base_node_private_1.BaseNode_getPrivate)(this);
-        return _private._displayName[0].text;
+        return _private._displayName[0].text || "";
     }
     get namespace() {
         return this.addressSpacePrivate.getNamespace(this.nodeId.namespace);
@@ -308,11 +309,11 @@ class BaseNodeImpl extends events_1.EventEmitter {
         _cache._ref = _cache._ref || new Map();
         const hash = `r|${referenceTypeNode.nodeId.toString()}|${isForward ? "f" : "b"}`;
         if (_cache._ref.has(hash)) {
-            return _cache._ref.get(hash);
+            return _cache._ref.get(hash) || [];
         }
         // c8 ignore next
         if (doDebug && !this.addressSpace.findReferenceType(referenceTypeNode.nodeId)) {
-            throw new Error("expecting valid reference name " + referenceType);
+            throw new Error(`expecting valid reference name ${referenceType}`);
         }
         const result = this.findReferences_no_cache(referenceTypeNode, isForward);
         _cache._ref.set(hash, result);
@@ -358,7 +359,6 @@ class BaseNodeImpl extends events_1.EventEmitter {
         if (!_cache._children) {
             _cache._children = this.findReferencesExAsObject(BaseNodeImpl._hasChild, node_opcua_data_model_1.BrowseDirection.Forward);
         }
-        ;
         return _cache._children;
     }
     /**
@@ -460,7 +460,7 @@ class BaseNodeImpl extends events_1.EventEmitter {
                 options.value = { dataType: node_opcua_variant_1.DataType.NodeId, value: this.nodeId };
                 break;
             case node_opcua_data_model_1.AttributeIds.NodeClass: // NodeClass
-                (0, node_opcua_assert_1.assert)(isFinite(this.nodeClass));
+                (0, node_opcua_assert_1.assert)(Number.isFinite(this.nodeClass));
                 options.value = { dataType: node_opcua_variant_1.DataType.Int32, value: this.nodeClass };
                 break;
             case node_opcua_data_model_1.AttributeIds.BrowseName: // QualifiedName
@@ -500,10 +500,12 @@ class BaseNodeImpl extends events_1.EventEmitter {
         if (writeValue.attributeId === undefined ||
             writeValue.attributeId <= 0 ||
             writeValue.attributeId > node_opcua_data_model_1.AttributeIds.AccessLevelEx) {
-            return callback(null, node_opcua_status_code_1.StatusCodes.BadAttributeIdInvalid);
+            callback(null, node_opcua_status_code_1.StatusCodes.BadAttributeIdInvalid);
+            return;
         }
         if (!this.canUserWriteAttribute(context, writeValue.attributeId)) {
-            return callback(null, node_opcua_status_code_1.StatusCodes.BadUserAccessDenied);
+            callback(null, node_opcua_status_code_1.StatusCodes.BadUserAccessDenied);
+            return;
         }
         // by default Node is read-only,
         // this method needs to be overridden to change the behavior
@@ -514,10 +516,10 @@ class BaseNodeImpl extends events_1.EventEmitter {
             const parent = this.addressSpace.findNode(this.parentNodeId);
             // c8 ignore next
             if (parent) {
-                return parent.fullName() + "." + this.browseName.toString() + "";
+                return `${parent.fullName()}.${this.browseName.toString()}`;
             }
             else {
-                return "NOT YET REGISTERED" + this.parentNodeId.toString() + "." + this.browseName.toString() + "";
+                return `NOT YET REGISTERED${this.parentNodeId.toString()}.${this.browseName.toString()}`;
             }
         }
         return this.browseName.toString();
@@ -542,7 +544,7 @@ class BaseNodeImpl extends events_1.EventEmitter {
         // The current path cannot be followed any further if no targets with the specified BrowseName exist.
         (0, node_opcua_assert_1.assert)(relativePathElement.targetName instanceof node_opcua_data_model_1.QualifiedName);
         (0, node_opcua_assert_1.assert)(relativePathElement.targetName.namespaceIndex >= 0);
-        (0, node_opcua_assert_1.assert)(relativePathElement.targetName.name.length > 0);
+        (0, node_opcua_assert_1.assert)((relativePathElement.targetName.name?.length || 0) > 0);
         // The type of reference to follow from the current node.
         // The current path cannot be followed any further if the referenceTypeId is not available on the Node instance.
         // If not specified then all References are included and the parameter includeSubtypes is ignored.
@@ -586,7 +588,7 @@ class BaseNodeImpl extends events_1.EventEmitter {
             const obj = resolveReferenceNode(this.addressSpace, reference);
             // c8 ignore next
             if (!obj) {
-                throw new Error(" cannot find node with id " + reference.nodeId.toString());
+                throw new Error(` cannot find node with id ${reference.nodeId.toString()}`);
             }
             if ((0, lodash_1.isEqual)(obj.browseName, relativePathElement.targetName)) {
                 // compare QualifiedName
@@ -616,7 +618,7 @@ class BaseNodeImpl extends events_1.EventEmitter {
      *
      */
     browseNode(browseDescription, context) {
-        (0, node_opcua_assert_1.assert)(isFinite(browseDescription.nodeClassMask));
+        (0, node_opcua_assert_1.assert)(Number.isFinite(browseDescription.nodeClassMask));
         const do_debug = false;
         const _private = (0, base_node_private_1.BaseNode_getPrivate)(this);
         const addressSpace = this.addressSpace;
@@ -667,7 +669,7 @@ class BaseNodeImpl extends events_1.EventEmitter {
         const referenceNode = this.__addReference(reference);
         const addressSpace = this.addressSpace;
         if (!resolveReferenceType(addressSpace, referenceNode)) {
-            throw new Error("BaseNode#addReference : invalid reference  " + reference.toString());
+            throw new Error(`BaseNode#addReference : invalid reference  ${reference.toString()}`);
         }
         _propagate_ref.call(this, addressSpace, referenceNode);
         this.install_extra_properties();
@@ -679,9 +681,13 @@ class BaseNodeImpl extends events_1.EventEmitter {
         // xx isForward is optional : assert(Object.prototype.hasOwnProperty.call(reference,"isForward"));
         (0, node_opcua_assert_1.assert)(Object.prototype.hasOwnProperty.call(referenceOpts, "nodeId"));
         const addressSpace = this.addressSpace;
-        const reference = addressSpace.normalizeReferenceTypes([referenceOpts])[0];
+        const reference = addressSpace.normalizeReferenceTypes([referenceOpts])?.[0];
         const h = reference.hash;
         const relatedNode = addressSpace.findNode(reference.nodeId);
+        // c8 ignore next
+        if (!relatedNode) {
+            return;
+        }
         const backwardReference = new reference_impl_1.ReferenceImpl({
             isForward: !reference.isForward,
             nodeId: this.nodeId,
@@ -695,10 +701,10 @@ class BaseNodeImpl extends events_1.EventEmitter {
             this._clear_caches();
         }
         else if (_private._back_referenceIdx.has(h)) {
-            return relatedNode.removeReference(backwardReference);
+            relatedNode.removeReference(backwardReference);
         }
         else {
-            warningLog("Cannot find reference to remove: " + reference.toString());
+            warningLog(`Cannot find reference to remove: ${reference.toString()}`);
         }
     }
     /**
@@ -748,12 +754,12 @@ class BaseNodeImpl extends events_1.EventEmitter {
             });
         }
         const childNode = resolveReferenceNode(addressSpace, reference);
-        const name = (0, node_opcua_utils_1.lowerFirstLetter)(childNode.browseName.name.toString());
+        const name = (0, node_opcua_utils_1.lowerFirstLetter)(childNode.browseName.name || "");
         if (Object.prototype.hasOwnProperty.call(reservedNames, name)) {
             // c8 ignore next
             if (doDebug) {
                 // tslint:disable-next-line:no-console
-                debugLog(chalk_1.default.bgWhite.red("Ignoring reserved keyword                                     " + name));
+                debugLog(chalk_1.default.bgWhite.red(`Ignoring reserved keyword  ${name}`));
             }
             return;
         }
@@ -810,11 +816,11 @@ class BaseNodeImpl extends events_1.EventEmitter {
     findHierarchicalReferences() {
         return this.findReferencesEx("HierarchicalReferences", node_opcua_data_model_1.BrowseDirection.Forward);
     }
-    // 
+    //
     getChildByName(browseName, namespaceIndex) {
         var childrenMap = (0, base_node_private_1._get_HierarchicalReference)(this);
         const select = _select_by_browse_name(childrenMap, browseName, namespaceIndex);
-        if (select.length == 0) {
+        if (select.length === 0) {
             return null;
         }
         const ref = select[0];
@@ -826,7 +832,7 @@ class BaseNodeImpl extends events_1.EventEmitter {
             return null; // too early, bmy be namespace 0 is still loading
         }
         if (r.isSubtypeOf(hasChild)) {
-            return ref.node;
+            return ref.node || null;
         }
         return null;
     }
@@ -843,7 +849,7 @@ class BaseNodeImpl extends events_1.EventEmitter {
     get nodeVersion() {
         return this.getNodeVersion() || undefined;
     }
-    set nodeVersion(n) {
+    set nodeVersion(_n) {
         (0, node_opcua_assert_1.assert)(false);
     }
     get toStateNode() {
@@ -884,10 +890,10 @@ class BaseNodeImpl extends events_1.EventEmitter {
         this.removeAllListeners();
         this._clear_caches();
         const _private = (0, base_node_private_1.BaseNode_getPrivate)(this);
-        for (let ref of _private._back_referenceIdx.values()) {
+        for (const ref of _private._back_referenceIdx.values()) {
             ref.dispose();
         }
-        for (let ref of _private._referenceIdx.values()) {
+        for (const ref of _private._referenceIdx.values()) {
             ref.dispose();
         }
         (0, base_node_private_1.BaseNode_removePrivate)(this);
@@ -931,7 +937,7 @@ class BaseNodeImpl extends events_1.EventEmitter {
             return;
         }
         function chain(f1, f2) {
-            return function chaiFunc(...args) {
+            return function chainingFunc(...args) {
                 if (f1) {
                     f1.apply(this, args);
                 }
@@ -953,10 +959,10 @@ class BaseNodeImpl extends events_1.EventEmitter {
         newCache._versionNode = tmpV;
         newCache._children = tmpC;
         if (newCache._children) {
-            newCache._children.push(childNode);
+            newCache._children?.push(childNode);
         }
     }
-    _on_child_removed(obj) {
+    _on_child_removed(_obj) {
         // obj; // unused;
         this._clear_caches();
     }
@@ -968,13 +974,13 @@ class BaseNodeImpl extends events_1.EventEmitter {
         base_node_private_1.BaseNode_add_backward_reference.call(this, reference);
     }
     _coerceReferenceType(referenceType) {
-        let result;
+        let result = null;
         if (typeof referenceType === "string") {
             result = this.addressSpace.findReferenceType(referenceType);
             /* c8 ignore next */
             if (!result) {
                 errorLog("referenceType ", referenceType, " cannot be found");
-                throw new Error("Cannot coerce reference with name " + referenceType);
+                throw new Error(`Cannot coerce reference with name ${referenceType}`);
             }
         }
         else if (referenceType instanceof node_opcua_nodeid_1.NodeId) {
@@ -1015,7 +1021,7 @@ class BaseNodeImpl extends events_1.EventEmitter {
     _setDescription(description) {
         const __description = (0, node_opcua_data_model_1.coerceLocalizedText)(description);
         const _private = (0, base_node_private_1.BaseNode_getPrivate)(this);
-        _private._description = __description;
+        _private._description = __description || new node_opcua_data_model_1.LocalizedText({ text: "" });
     }
     _notifyAttributeChange(attributeId) {
         const event_name = BaseNodeImpl.makeAttributeEventName(attributeId);
@@ -1040,7 +1046,7 @@ class BaseNodeImpl extends events_1.EventEmitter {
         }
         return context.checkPermission(this, node_opcua_types_1.PermissionType.WriteAttribute);
     }
-    _readAccessRestrictions(context) {
+    _readAccessRestrictions(_context) {
         // https://reference.opcfoundation.org/v104/Core/docs/Part3/8.56/
         if (this.accessRestrictions === undefined) {
             return new node_opcua_data_value_1.DataValue({ statusCode: node_opcua_status_code_1.StatusCodes.BadAttributeIdInvalid });
@@ -1160,7 +1166,7 @@ function toString_ReferenceDescription(ref, options) {
     const addressSpace = options.addressSpace;
     const refNode = addressSpace.findNode(ref.referenceType);
     if (!refNode) {
-        return "Unknown Ref : " + ref;
+        return `Unknown Ref : ${ref}`;
     }
     const r = new reference_impl_1.ReferenceImpl({
         isForward: ref.isForward,
@@ -1208,7 +1214,7 @@ function toObject(addressSpace, reference) {
     return obj;
 }
 function _asObject(references, addressSpace) {
-    return references.map((a) => toObject(addressSpace, a)).filter((o) => o != null && o != undefined);
+    return references.map((a) => toObject(addressSpace, a)).filter((o) => !!o);
 }
 function _select_by_browse_name(map, browseName, namespaceIndex) {
     if ((namespaceIndex === null || namespaceIndex === undefined) && typeof browseName === "string") {
@@ -1223,14 +1229,18 @@ function _select_by_browse_name(map, browseName, namespaceIndex) {
     }
     else {
         const _browseName = (0, node_opcua_data_model_1.coerceQualifiedName)(typeof browseName === "string" ? { name: browseName, namespaceIndex } : browseName);
+        // c8 ignore next
+        if (!_browseName) {
+            return [];
+        }
         const result = map.get(_browseName.name || "");
         if (result) {
             if (Array.isArray(result)) {
                 // only select the one with the matching namepsace index
-                return result.filter((t) => t.node.browseName.namespaceIndex == _browseName.namespaceIndex);
+                return result.filter((t) => t.node.browseName.namespaceIndex === _browseName.namespaceIndex);
             }
             else {
-                if (result.node.browseName.namespaceIndex == _browseName.namespaceIndex) {
+                if (result.node.browseName.namespaceIndex === _browseName.namespaceIndex) {
                     return [result];
                 }
                 return [];
@@ -1249,6 +1259,9 @@ function _filter_by_browse_name(components, browseName, namespaceIndex) {
     }
     else {
         const _browseName = (0, node_opcua_data_model_1.coerceQualifiedName)(typeof browseName === "string" ? { name: browseName, namespaceIndex } : browseName);
+        if (!_browseName) {
+            return [];
+        }
         select = components.filter((c) => c.browseName.name === _browseName.name && c.browseName.namespaceIndex === _browseName.namespaceIndex);
     }
     return select;
@@ -1343,7 +1356,7 @@ function _filter_by_referenceType(browseDescription, references, referenceTypeId
             const ref = resolveReferenceType(this.addressSpace, reference);
             // c8 ignore next
             if (!ref) {
-                throw new Error("Cannot find reference type " + reference.toString());
+                throw new Error(`Cannot find reference type ${reference.toString()}`);
             }
             // unknown type ... this may happen when the address space is not fully build
             (0, node_opcua_assert_1.assert)(ref.nodeClass === node_opcua_data_model_1.NodeClass.ReferenceType);
@@ -1392,7 +1405,7 @@ function _filter_by_context(node, references, context) {
     return references.filter((reference) => !context.isBrowseAccessRestricted(resolveReferenceNode(addressSpace, reference)));
 }
 function _filter_by_nodeClass(references, nodeClassMask) {
-    (0, node_opcua_assert_1.assert)(isFinite(nodeClassMask));
+    (0, node_opcua_assert_1.assert)(Number.isFinite(nodeClassMask));
     if (nodeClassMask === 0) {
         return references;
     }
@@ -1450,18 +1463,20 @@ function install_components_as_object_properties(parentObj) {
             continue;
         }
         // assumption: we ignore namespace here .
-        const name = (0, node_opcua_utils_1.lowerFirstLetter)(child.browseName.name.toString());
+        const name = (0, node_opcua_utils_1.lowerFirstLetter)(child.browseName.name || "");
         if (Object.prototype.hasOwnProperty.call(reservedNames, name)) {
             // ignore reserved names
             if (doDebug) {
-                debugLog(chalk_1.default.bgWhite.red("Ignoring reserved keyword                                               " + name));
+                debugLog(chalk_1.default.bgWhite.red(`Ignoring reserved keyword                                               ${name}`));
             }
             continue;
         }
         // ignore reserved names
-        doDebug && debugLog("Installing property " + name, " on ", parentObj.browseName.toString());
+        doDebug && debugLog(`Installing property ${name}`, " on ", parentObj.browseName.toString());
         const hasProperty = Object.prototype.hasOwnProperty.call(parentObj, name);
-        if (hasProperty && parentObj[name] !== null && parentObj[name] !== undefined) {
+        if (hasProperty &&
+            parentObj[name] !== null &&
+            parentObj[name] !== undefined) {
             continue;
         }
         Object.defineProperty(parentObj, name, {
@@ -1476,6 +1491,11 @@ function install_components_as_object_properties(parentObj) {
     }
 }
 function getReferenceType(reference) {
-    return reference._referenceType;
+    const r = reference._referenceType;
+    // c8 ignore next
+    if (!r) {
+        throw new Error("Internal error : cannot find referenceType");
+    }
+    return r;
 }
 //# sourceMappingURL=base_node_impl.js.map