node-opcua-address-space 2.98.0 → 2.98.2

package/dist/src/base_node_private.js

@@ -0,0 +1,833 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseNode_add_backward_reference = exports.BaseNode_remove_backward_reference = exports._constructReferenceDescription = exports._handle_HierarchicalReference = exports._clone = exports._clone_non_hierarchical_references = exports._clone_hierarchical_references = exports.VariableOrVariableType_toString = exports.valueRankToString = exports.UAObjectType_toString = exports.UAObject_toString = exports.UAVariable_toString = exports.UAVariableType_toString = exports.BaseNode_References_toString = exports.BaseNode_toString = exports.ToStringBuilder = exports.BaseNode_clearCache = exports.BaseNode_getCache = exports.BaseNode_getPrivate = exports.BaseNode_removePrivate = exports.BaseNode_initPrivate = void 0;
+/**
+ * @module node-opcua-address-space.Private
+ */
+// tslint:disable:no-bitwise
+const chalk = require("chalk");
+const node_opcua_assert_1 = require("node-opcua-assert");
+const node_opcua_data_model_1 = require("node-opcua-data-model");
+const node_opcua_debug_1 = require("node-opcua-debug");
+const node_opcua_nodeid_1 = require("node-opcua-nodeid");
+const node_opcua_types_1 = require("node-opcua-types");
+const node_opcua_constants_1 = require("node-opcua-constants");
+const namespace_private_1 = require("./namespace_private");
+const reference_impl_1 = require("./reference_impl");
+const base_node_impl_1 = require("./base_node_impl");
+const tool_isSubtypeOf_1 = require("./tool_isSubtypeOf");
+// eslint-disable-next-line prefer-const
+const errorLog = (0, node_opcua_debug_1.make_errorLog)(__filename);
+const doTrace = (0, node_opcua_debug_1.checkDebugFlag)("INSTANTIATE");
+const traceLog = errorLog;
+const g_weakMap = new WeakMap();
+const warningLog = (0, node_opcua_debug_1.make_warningLog)(__filename);
+function BaseNode_initPrivate(self) {
+    const _private = {
+        __address_space: null,
+        _referenceIdx: {},
+        _back_referenceIdx: {},
+        _browseFilter: undefined,
+        _cache: {},
+        _description: undefined,
+        _displayName: [],
+        _parent: undefined,
+        _subtype_idx: {},
+        _subtype_idxVersion: 0
+    };
+    g_weakMap.set(self, _private);
+    return _private;
+}
+exports.BaseNode_initPrivate = BaseNode_initPrivate;
+function BaseNode_removePrivate(self) {
+    // there is no need to delete object from weak map
+    // the GC will take care of this in due course
+    // g_weakMap.delete(self);
+    const _private = BaseNode_getPrivate(self);
+    _private._cache = {};
+    _private.__address_space = null;
+    _private._back_referenceIdx = {};
+    _private._referenceIdx = {};
+    _private._description = undefined;
+    _private._displayName = [];
+}
+exports.BaseNode_removePrivate = BaseNode_removePrivate;
+function BaseNode_getPrivate(self) {
+    return g_weakMap.get(self);
+}
+exports.BaseNode_getPrivate = BaseNode_getPrivate;
+function BaseNode_getCache(node) {
+    return BaseNode_getPrivate(node)._cache;
+}
+exports.BaseNode_getCache = BaseNode_getCache;
+function BaseNode_clearCache(node) {
+    const _private = BaseNode_getPrivate(node);
+    if (_private && _private._cache) {
+        _private._cache = {};
+    }
+    (0, tool_isSubtypeOf_1.wipeMemorizedStuff)(node);
+}
+exports.BaseNode_clearCache = BaseNode_clearCache;
+const hasTypeDefinition_ReferenceTypeNodeId = (0, node_opcua_nodeid_1.resolveNodeId)("HasTypeDefinition");
+class ToStringBuilder {
+    constructor() {
+        this.level = 0;
+        this.cycleDetector = {};
+        this.padding = "";
+        this.str = [];
+        //
+        this.str = [];
+    }
+    add(line) {
+        this.str.push(line);
+    }
+    toString() {
+        return this.str.join("\n");
+    }
+    indent(str, padding) {
+        padding = padding || "          ";
+        return str
+            .split("\n")
+            .map((r) => {
+            return padding + r;
+        })
+            .join("\n");
+    }
+}
+exports.ToStringBuilder = ToStringBuilder;
+function set_as_processed(options, nodeId) {
+    options.cycleDetector[nodeId.toString()] = nodeId;
+}
+function is_already_processed(options, nodeId) {
+    return !!options.cycleDetector[nodeId.toString()];
+}
+function BaseNode_toString(options) {
+    options.level = options.level || 1;
+    set_as_processed(options, this.nodeId);
+    options.add("");
+    options.add(options.padding + chalk.yellow("          nodeId              : ") + this.nodeId.toString());
+    options.add(options.padding + chalk.yellow("          nodeClass           : ") + node_opcua_data_model_1.NodeClass[this.nodeClass] + " (" + this.nodeClass + ")");
+    options.add(options.padding + chalk.yellow("          browseName          : ") + this.browseName.toString());
+    options.add(options.padding +
+        chalk.yellow("          displayName         : ") +
+        this.displayName.map((f) => f.locale + " " + f.text).join(" | "));
+    options.add(options.padding + chalk.yellow("          description         : ") + (this.description ? this.description.toString() : ""));
+}
+exports.BaseNode_toString = BaseNode_toString;
+function BaseNode_References_toString(options) {
+    const _private = BaseNode_getPrivate(this);
+    const displayOptions = {
+        addressSpace: this.addressSpace
+    };
+    const addressSpace = this.addressSpace;
+    options.add(options.padding +
+        chalk.yellow("    references                : ") +
+        "  length =" +
+        Object.keys(_private._referenceIdx).length);
+    function dump_reference(follow, reference) {
+        if (!reference) {
+            return;
+        }
+        const o = reference_impl_1.ReferenceImpl.resolveReferenceNode(addressSpace, reference);
+        if (!o) {
+            warningLog("cannot find referece", reference.toString());
+            return;
+        }
+        const name = o.browseName.toString();
+        const modellingRule = o.modellingRule || " ";
+        const extra = modellingRule[0] +
+            (() => {
+                switch (o.nodeClass) {
+                    case node_opcua_data_model_1.NodeClass.Object:
+                        return "[O] ";
+                    case node_opcua_data_model_1.NodeClass.Variable:
+                        return "[V] " + o.dataType.toString(displayOptions).padEnd(10);
+                    case node_opcua_data_model_1.NodeClass.Method:
+                        return "[M] ";
+                    case node_opcua_data_model_1.NodeClass.DataType:
+                        return "[DT]";
+                    case node_opcua_data_model_1.NodeClass.ReferenceType:
+                        return "[RT]";
+                    case node_opcua_data_model_1.NodeClass.ObjectType:
+                        return "[OT]";
+                    case node_opcua_data_model_1.NodeClass.VariableType:
+                        return "[VT]";
+                    case node_opcua_data_model_1.NodeClass.View:
+                        return "[V] ";
+                }
+                return "";
+            })();
+        options.add(options.padding +
+            chalk.yellow("      +-> ") +
+            reference.toString(displayOptions) +
+            " " +
+            chalk.cyan(name.padEnd(25, " ")) +
+            " " +
+            chalk.magentaBright(extra));
+        // ignore HasTypeDefinition as it has been already handled
+        if ((0, node_opcua_nodeid_1.sameNodeId)(reference.referenceType, hasTypeDefinition_ReferenceTypeNodeId) && reference.nodeId.namespace === 0) {
+            return;
+        }
+        if (o) {
+            if (!is_already_processed(options, o.nodeId)) {
+                set_as_processed(options, o.nodeId);
+                if (options.level > 1 && follow) {
+                    const rr = o.toString({
+                        cycleDetector: options.cycleDetector,
+                        level: options.level - 1,
+                        padding: options.padding + "         "
+                    });
+                    options.add(rr);
+                }
+            }
+        }
+    }
+    // direct reference
+    Object.values(_private._referenceIdx).forEach(dump_reference.bind(null, true));
+    const br = Object.values(_private._back_referenceIdx).map((x) => x);
+    options.add(options.padding +
+        chalk.yellow("    back_references                 : ") +
+        chalk.cyan("  length =") +
+        br.length +
+        chalk.grey(" ( references held by other nodes involving this node)"));
+    // backward reference
+    br.forEach(dump_reference.bind(null, false));
+}
+exports.BaseNode_References_toString = BaseNode_References_toString;
+function _UAType_toString(options) {
+    if (this.subtypeOfObj) {
+        options.add(options.padding +
+            chalk.yellow("          subtypeOf           : ") +
+            this.subtypeOfObj.browseName.toString() +
+            " (" +
+            this.subtypeOfObj.nodeId.toString() +
+            ")");
+    }
+}
+function _UAInstance_toString(options) {
+    if (this.typeDefinitionObj) {
+        options.add(options.padding +
+            chalk.yellow("          typeDefinition      : ") +
+            this.typeDefinitionObj.browseName.toString() +
+            " (" +
+            this.typeDefinitionObj.nodeId.toString() +
+            ")");
+    }
+}
+function UAVariableType_toString(options) {
+    BaseNode_toString.call(this, options);
+    _UAType_toString.call(this, options);
+    VariableOrVariableType_toString.call(this, options);
+    BaseNode_References_toString.call(this, options);
+}
+exports.UAVariableType_toString = UAVariableType_toString;
+function UAVariable_toString(options) {
+    BaseNode_toString.call(this, options);
+    _UAInstance_toString.call(this, options);
+    VariableOrVariableType_toString.call(this, options);
+    AccessLevelFlags_toString.call(this, options);
+    BaseNode_References_toString.call(this, options);
+}
+exports.UAVariable_toString = UAVariable_toString;
+function UAObject_toString(options) {
+    BaseNode_toString.call(this, options);
+    _UAInstance_toString.call(this, options);
+    BaseNode_References_toString.call(this, options);
+}
+exports.UAObject_toString = UAObject_toString;
+function UAObjectType_toString(options) {
+    BaseNode_toString.call(this, options);
+    _UAType_toString.call(this, options);
+    BaseNode_References_toString.call(this, options);
+}
+exports.UAObjectType_toString = UAObjectType_toString;
+function valueRankToString(valueRank) {
+    switch (valueRank) {
+        case 1:
+            return "OneDimension (1)";
+        case 0:
+            return "OneOrMoreDimensions (0)"; // The value is an array with one or more dimensions
+        case -1:
+            return "Scalar (-1)";
+        case -2:
+            return "Any (-2)"; // The value can be a scalar or an array with any number of dimensions
+        case -3:
+            return "ScalarOrOneDimension (2)"; // The value can be a scalar or a one dimensional array.
+        default:
+            if (valueRank > 0) {
+                return "" + valueRank + "-Dimensions";
+            }
+            else {
+                return "Invalid (" + valueRank + ")";
+            }
+    }
+}
+exports.valueRankToString = valueRankToString;
+function accessLevelFlagToString(flag) {
+    const str = [];
+    if (flag & node_opcua_data_model_1.AccessLevelFlag.CurrentRead) {
+        str.push("CurrentRead");
+    }
+    if (flag & node_opcua_data_model_1.AccessLevelFlag.CurrentWrite) {
+        str.push("CurrentWrite");
+    }
+    if (flag & node_opcua_data_model_1.AccessLevelFlag.HistoryRead) {
+        str.push("HistoryRead");
+    }
+    if (flag & node_opcua_data_model_1.AccessLevelFlag.HistoryWrite) {
+        str.push("HistoryWrite");
+    }
+    if (flag & node_opcua_data_model_1.AccessLevelFlag.SemanticChange) {
+        str.push("SemanticChange");
+    }
+    if (flag & node_opcua_data_model_1.AccessLevelFlag.StatusWrite) {
+        str.push("StatusWrite");
+    }
+    if (flag & node_opcua_data_model_1.AccessLevelFlag.TimestampWrite) {
+        str.push("TimestampWrite");
+    }
+    return str.join(" | ");
+}
+function AccessLevelFlags_toString(options) {
+    (0, node_opcua_assert_1.assert)(options);
+    options.add(options.padding + chalk.yellow("          accessLevel         : ") + " " + accessLevelFlagToString(this.accessLevel));
+    if (this.userAccessLevel !== undefined) {
+        options.add(options.padding + chalk.yellow("          userAccessLevel     : ") + " " + accessLevelFlagToString(this.userAccessLevel));
+    }
+}
+function VariableOrVariableType_toString(options) {
+    (0, node_opcua_assert_1.assert)(options);
+    if (this.dataType) {
+        const addressSpace = this.addressSpace;
+        const d = addressSpace.findNode(this.dataType);
+        const n = d ? "(" + d.browseName.toString() + ")" : " (???)";
+        options.add(options.padding + chalk.yellow("          dataType            : ") + this.dataType + "  " + n);
+    }
+    if (this.nodeClass === node_opcua_data_model_1.NodeClass.Variable) {
+        const _dataValue = this.$dataValue;
+        if (_dataValue) {
+            options.add(options.padding +
+                chalk.yellow("          value               : ") +
+                "\n" +
+                options.indent(_dataValue.toString(), options.padding + "                        | "));
+        }
+    }
+    if (Object.prototype.hasOwnProperty.call(this, "valueRank")) {
+        if (this.valueRank !== undefined) {
+            options.add(options.padding + chalk.yellow("          valueRank           : ") + " " + valueRankToString(this.valueRank));
+        }
+        else {
+            options.add(options.padding + chalk.yellow("          valueRank           : ") + " undefined");
+        }
+    }
+    if (this.minimumSamplingInterval !== undefined) {
+        options.add(options.padding +
+            chalk.yellow(" minimumSamplingInterval      : ") +
+            " " +
+            this.minimumSamplingInterval.toString() +
+            " ms");
+    }
+    if (this.arrayDimensions) {
+        options.add(options.padding +
+            chalk.yellow(" arrayDimension               : ") +
+            " [" +
+            this.arrayDimensions.join(",").toString() +
+            " ]");
+    }
+}
+exports.VariableOrVariableType_toString = VariableOrVariableType_toString;
+const defaultExtraInfo = {
+    level: 0,
+    pad() {
+        return "";
+    },
+    registerClonedObject(node, node1) {
+        /** */
+    }
+};
+/**
+ *
+ *
+ *    MyDeriveType  ------------------- -> MyBaseType    --------------> TopologyElementType
+ *        |                                   |                                   |
+ *        +- ParamaterSet                     +-> ParameterSet                    +-> ParamaterSet
+ *                 |                                   |
+ *                  +- Foo1                            |
+ *                                                     +- Bar
+ *
+ *    Instance
+ *
+ * @param newParent
+ * @param node
+ * @param copyAlsoModellingRules
+ * @param optionalFilter
+ * @param extraInfo
+ * @param browseNameMap
+ * @returns
+ */
+function _clone_children_on_template(nodeToClone, newParent, node, copyAlsoModellingRules, optionalFilter, extraInfo, browseNameMap) {
+    /**
+     * the type definition node of the node to clone
+     */
+    const nodeToCloneTypeDefinition = nodeToClone.nodeClass === node_opcua_data_model_1.NodeClass.ObjectType || nodeToClone.nodeClass === node_opcua_data_model_1.NodeClass.VariableType
+        ? nodeToClone.subtypeOfObj
+        : null;
+    if (!nodeToCloneTypeDefinition)
+        return;
+    doTrace &&
+        traceLog(extraInfo === null || extraInfo === void 0 ? void 0 : extraInfo.pad(), chalk.green("-------------------- now cloning children on template ", node.browseName.toString(), node.nodeId.toString(), nodeToCloneTypeDefinition.browseName.toString()));
+    const namespace = newParent.namespace;
+    /**
+     * the child node of the new parent that match the node to clone or enrich
+     */
+    const newParentChild = newParent.getChildByName(node.browseName);
+    if (!newParentChild) {
+        return;
+    }
+    // we have found a matching child on the new parent.
+    // the mission is to enrich this child node with components and properties that
+    // exist also in the template
+    let typeDefinitionNode = nodeToCloneTypeDefinition;
+    while (typeDefinitionNode) {
+        doTrace &&
+            traceLog(extraInfo === null || extraInfo === void 0 ? void 0 : extraInfo.pad(), chalk.green("-------------------- now cloning children on ", newParentChild.browseName.toString(), newParentChild.nodeId.toString(), " (child of ", node.browseName.toString(), node.nodeId.toString(), ") from ", typeDefinitionNode.browseName.toString()));
+        const typeDefinitionChild = typeDefinitionNode.getChildByName(node.browseName);
+        if (typeDefinitionChild) {
+            const references = typeDefinitionChild.findReferencesEx("Aggregates", node_opcua_data_model_1.BrowseDirection.Forward);
+            for (const ref of references) {
+                const grandChild = ref.node;
+                if (grandChild.modellingRule === "MandatoryPlaceholder" || grandChild.modellingRule === "OptionalPlaceholder")
+                    continue;
+                // if not already node present in new Parent => just ignore
+                const hasAlready = newParentChild.getChildByName(grandChild.browseName) !== null;
+                if (!hasAlready) {
+                    if (optionalFilter && node && !optionalFilter.shouldKeep(node)) {
+                        doTrace &&
+                            traceLog(extraInfo.pad(), "skipping optional ", node.browseName.toString(), "that doesn't appear in the filter");
+                        continue; // skip this node
+                    }
+                    const options = {
+                        namespace,
+                        references: [
+                            new reference_impl_1.ReferenceImpl({
+                                referenceType: ref.referenceType,
+                                isForward: false,
+                                nodeId: newParentChild.nodeId
+                            })
+                        ],
+                        copyAlsoModellingRules
+                    };
+                    const alreadyCloned = extraInfo.getCloned(grandChild);
+                    if (alreadyCloned) {
+                        alreadyCloned.addReference({
+                            referenceType: ref.referenceType,
+                            isForward: false,
+                            nodeId: newParentChild.nodeId
+                        });
+                    }
+                    else {
+                        const a = grandChild.clone(options, optionalFilter, extraInfo);
+                        extraInfo.registerClonedObject(a, grandChild);
+                    }
+                }
+            }
+        }
+        typeDefinitionNode = typeDefinitionNode.subtypeOfObj;
+    }
+}
+/**
+ * clone properties and methods
+ * @private
+ */
+function _clone_collection_new(nodeToClone, newParent, collectionRef, copyAlsoModellingRules, optionalFilter, extraInfo, browseNameMap) {
+    var _a;
+    const namespace = newParent.namespace;
+    extraInfo = extraInfo || defaultExtraInfo;
+    const addressSpace = newParent.addressSpace;
+    (0, node_opcua_assert_1.assert)(!optionalFilter || (typeof optionalFilter.shouldKeep === "function" && typeof optionalFilter.filterFor === "function"));
+    for (const reference of collectionRef) {
+        const node = reference_impl_1.ReferenceImpl.resolveReferenceNode(addressSpace, reference);
+        // ensure node is of the correct type,
+        // it may happen that the xml nodeset2 file was malformed
+        // istanbul ignore next
+        if (typeof node.clone !== "function") {
+            // tslint:disable-next-line:no-console
+            warningLog(chalk.red("Warning : cannot clone node ") +
+                node.browseName.toString() +
+                " of class " +
+                node_opcua_data_model_1.NodeClass[node.nodeClass].toString() +
+                " while cloning " +
+                newParent.browseName.toString());
+            continue;
+        }
+        if (optionalFilter && node && !optionalFilter.shouldKeep(node)) {
+            doTrace &&
+                traceLog(extraInfo.pad(), "skipping optional ", node.browseName.toString(), "that doesn't appear in the filter");
+            continue; // skip this node
+        }
+        const key = node.browseName.toString();
+        if (browseNameMap === null || browseNameMap === void 0 ? void 0 : browseNameMap.has(key)) {
+            _clone_children_on_template(nodeToClone, newParent, node, copyAlsoModellingRules, optionalFilter, extraInfo, browseNameMap);
+            continue; // skipping node with same browseName
+        }
+        browseNameMap === null || browseNameMap === void 0 ? void 0 : browseNameMap.add(key);
+        // assert(reference.isForward);
+        // assert(reference.referenceType instanceof NodeId, "" + reference.referenceType.toString());
+        const options = {
+            namespace,
+            references: [new reference_impl_1.ReferenceImpl({ referenceType: reference.referenceType, isForward: false, nodeId: newParent.nodeId })],
+            copyAlsoModellingRules
+        };
+        doTrace &&
+            traceLog(extraInfo.pad(), "cloning => ", reference.referenceType.toString({ addressSpace }), "=>", node.browseName.toString(), chalk.magentaBright((_a = node.typeDefinitionObj) === null || _a === void 0 ? void 0 : _a.browseName.toString()));
+        extraInfo.level += 4;
+        const alreadyCloned = extraInfo.getCloned(node);
+        if (alreadyCloned) {
+            alreadyCloned.addReference({
+                referenceType: reference.referenceType,
+                isForward: false,
+                nodeId: newParent.nodeId
+            });
+        }
+        else {
+            const clone = node.clone(options, optionalFilter, extraInfo);
+            extraInfo.level -= 4;
+            doTrace && traceLog(extraInfo.pad(), "cloning => ", node.browseName.toString(), "nodeId", clone.nodeId.toString());
+            extraInfo.level++;
+            _clone_children_on_template(nodeToClone, newParent, node, copyAlsoModellingRules, optionalFilter, extraInfo, browseNameMap);
+            extraInfo.level--;
+            // also clone or instantiate interface members that may be required in the optionals
+            extraInfo.level++;
+            _cloneInterface(nodeToClone, newParent, node, optionalFilter, extraInfo, browseNameMap);
+            extraInfo.level--;
+            extraInfo.registerClonedObject(node, clone);
+        }
+    }
+}
+function _extractInterfaces2(typeDefinitionNode, extraInfo) {
+    if (!typeDefinitionNode ||
+        (typeDefinitionNode.nodeId.namespace === 0 &&
+            (typeDefinitionNode.nodeId.value === node_opcua_constants_1.ObjectTypeIds.BaseObjectType ||
+                typeDefinitionNode.nodeId.value === node_opcua_constants_1.VariableTypeIds.BaseVariableType))) {
+        return [];
+    }
+    const addressSpace = typeDefinitionNode.addressSpace;
+    const hasInterfaceReference = addressSpace.findReferenceType("HasInterface");
+    if (!hasInterfaceReference) {
+        // this version of the standard UA namespace doesn't support Interface yet
+        return [];
+    }
+    // example:
+    // FolderType
+    //   FunctionalGroupType
+    //     MachineryItemIdentificationType     : IMachineryItemVendorNameplateType
+    //       MachineIdentificationType         : IMachineTagNameplateType, IMachineVendorNamePlateType
+    //         MachineToolIdentificationType
+    //
+    //
+    // IMachineTagNameplateType            -subtypeOf-> ITagNameplateType
+    // IMachineVendorNamePlateType         -subtypeOf-> IMachineryItemVendorNamePlateType
+    // IMachineryItemVendorNamePlateType   -subtypeOf-> IVendorNameplateType
+    const interfacesRef = typeDefinitionNode.findReferencesEx("HasInterface", node_opcua_data_model_1.BrowseDirection.Forward);
+    const interfaces = interfacesRef.map((r) => addressSpace.findNode(r.nodeId));
+    const baseInterfaces = [];
+    for (const iface of interfaces) {
+        doTrace &&
+            traceLog(extraInfo.pad(), typeDefinitionNode.browseName.toString(), " - has interface -> ", iface.browseName.toString());
+        baseInterfaces.push(iface);
+        if (iface.subtypeOfObj) {
+            extraInfo.level++;
+            baseInterfaces.push(..._extractInterfaces2(iface.subtypeOfObj, extraInfo));
+            extraInfo.level--;
+        }
+    }
+    interfaces.push(...baseInterfaces);
+    if (typeDefinitionNode.subtypeOfObj) {
+        doTrace &&
+            traceLog(extraInfo.pad(), typeDefinitionNode.browseName.toString(), " - subtypef  -> ", typeDefinitionNode.subtypeOfObj.browseName.toString());
+        extraInfo.level++;
+        interfaces.push(..._extractInterfaces2(typeDefinitionNode.subtypeOfObj, extraInfo));
+        extraInfo.level--;
+    }
+    const dedupedInterfaces = [...new Set(interfaces)];
+    doTrace &&
+        dedupedInterfaces.length &&
+        traceLog(extraInfo.pad(), chalk.yellow("Interface for ", typeDefinitionNode.browseName.toString()), "=", dedupedInterfaces.map((x) => x.browseName.toString()).join(" "));
+    return dedupedInterfaces;
+}
+/*
+
+    // also find all related interfaces
+    if (false && typeDefinitionNode) {
+        dotrace && tracelog("typeDefinitionNode = ", typeDefinitionNode.browseName.toString());
+        const interfaces = _extractInterfaces(typeDefinitionNode);
+        for (const interfaceNode of interfaces) {
+            dotrace && tracelog("   adding member of interface ", interfaceNode.browseName.toString());
+            const fromInterface = interfaceNode.findReferencesEx("Aggregates", BrowseDirection.Forward);
+            dotrace && tracelog(
+                "             B   ",
+                fromInterface.map((r) => r.toString({ addressSpace }) + " " + r.node!.browseName.toString()).join("\n")
+            );
+            add(fromInterface);
+        }
+    }
+    */
+function _crap_extractInterfaces(typeDefinitionNode, extraInfo) {
+    if (typeDefinitionNode.nodeId.namespace === 0 &&
+        (typeDefinitionNode.nodeId.value === node_opcua_constants_1.ObjectTypeIds.BaseObjectType ||
+            typeDefinitionNode.nodeId.value === node_opcua_constants_1.VariableTypeIds.BaseVariableType)) {
+        return [];
+    }
+    const addressSpace = typeDefinitionNode.addressSpace;
+    // example:
+    // FolderType
+    //   (di):FunctionalGroupType
+    //     MachineryItemIdentificationType     : IMachineryItemVendorNameplateType
+    //       MachineIdentificationType         : IMachineTagNameplateType, IMachineVendorNamePlateType
+    //         MachineToolIdentificationType
+    //
+    //
+    // IMachineTagNameplateType            -subtypeOf-> ITagNameplateType
+    // IMachineVendorNamePlateType         -subtypeOf-> IMachineryItemVendorNamePlateType
+    // IMachineryItemVendorNamePlateType   -subtypeOf-> IVendorNameplateType
+    const interfacesRef = typeDefinitionNode.findReferencesEx("HasInterface", node_opcua_data_model_1.BrowseDirection.Forward);
+    const interfaces = interfacesRef.map((r) => r.node);
+    for (const iface of interfaces) {
+        doTrace && traceLog(extraInfo.pad(), "   interface ", iface.browseName.toString());
+    }
+    return interfaces;
+}
+function _cloneInterface(nodeToClone, newParent, node, optionalFilter, extraInfo, browseNameMap) {
+    doTrace &&
+        traceLog(extraInfo === null || extraInfo === void 0 ? void 0 : extraInfo.pad(), chalk.green("-------------------- now cloning interfaces of ", node.browseName.toString(), node.nodeId.toString()));
+    extraInfo = extraInfo || defaultExtraInfo;
+    const addressSpace = node.addressSpace;
+    if (node.nodeClass !== node_opcua_data_model_1.NodeClass.Object && node.nodeClass !== node_opcua_data_model_1.NodeClass.Variable) {
+        return;
+    }
+    const typeDefinitionNode = node.typeDefinitionObj;
+    if (!typeDefinitionNode) {
+        return;
+    }
+    const interfaces = _extractInterfaces2(typeDefinitionNode, extraInfo);
+    if (interfaces.length === 0) {
+        doTrace &&
+            false &&
+            traceLog(extraInfo.pad(), chalk.yellow("No interface for ", node.browseName.toString(), node.nodeId.toString()));
+        return;
+    }
+    doTrace && traceLog(extraInfo === null || extraInfo === void 0 ? void 0 : extraInfo.pad(), chalk.green("-------------------- interfaces are  ", interfaces.length));
+    const localFilter = optionalFilter.filterFor(node);
+    for (const iface of interfaces) {
+        const aggregates = iface.findReferencesEx("Aggregates", node_opcua_data_model_1.BrowseDirection.Forward);
+        doTrace &&
+            traceLog(extraInfo.pad(), chalk.magentaBright("   interface ", iface.browseName.toString()), "\n" + (extraInfo === null || extraInfo === void 0 ? void 0 : extraInfo.pad()), aggregates.map((r) => r.toString({ addressSpace })).join("\n" + (extraInfo === null || extraInfo === void 0 ? void 0 : extraInfo.pad())));
+        _clone_collection_new(nodeToClone, node, aggregates, false, localFilter, extraInfo, browseNameMap);
+    }
+}
+function __clone_organizes_references(node, newParent, copyAlsoModellingRules, optionalFilter, extraInfo, browseNameMap) {
+    // find all references that derives from the Organizes
+    const organizedRef = node.findReferencesEx("Organizes", node_opcua_data_model_1.BrowseDirection.Forward);
+    _clone_collection_new(node, newParent, organizedRef, copyAlsoModellingRules, optionalFilter, extraInfo, browseNameMap);
+}
+function __clone_children_references(node, newParent, copyAlsoModellingRules, optionalFilter, extraInfo, browseNameMap) {
+    // find all references that derives from the Aggregates
+    const aggregatesRef = node.findReferencesEx("Aggregates", node_opcua_data_model_1.BrowseDirection.Forward);
+    _clone_collection_new(node, newParent, aggregatesRef, copyAlsoModellingRules, optionalFilter, extraInfo, browseNameMap);
+}
+function _clone_hierarchical_references(node, newParent, copyAlsoModellingRules, optionalFilter, extraInfo, browseNameMap) {
+    __clone_children_references(node, newParent, copyAlsoModellingRules, optionalFilter, extraInfo, browseNameMap);
+    __clone_organizes_references(node, newParent, copyAlsoModellingRules, optionalFilter, extraInfo, browseNameMap);
+}
+exports._clone_hierarchical_references = _clone_hierarchical_references;
+function _clone_non_hierarchical_references(nodeToClone, newParent, copyAlsoModellingRules, optionalFilter, extraInfo, browseNameMap) {
+    // clone only some non hierarchical_references that we do want to clone
+    // such as:
+    //   HasSubStateMachine
+    //   (may be other as well later ... to do )
+    (0, node_opcua_assert_1.assert)(newParent instanceof base_node_impl_1.BaseNodeImpl);
+    // find all reference that derives from the HasSubStateMachine
+    const references = nodeToClone.findReferencesEx("HasSubStateMachine", node_opcua_data_model_1.BrowseDirection.Forward);
+    _clone_collection_new(nodeToClone, newParent, references, copyAlsoModellingRules, optionalFilter, extraInfo, browseNameMap);
+}
+exports._clone_non_hierarchical_references = _clone_non_hierarchical_references;
+/**
+ * @method _clone
+ * @private
+ */
+function _clone(Constructor, options, optionalFilter, extraInfo) {
+    (0, node_opcua_assert_1.assert)(typeof Constructor === "function");
+    (0, node_opcua_assert_1.assert)(options !== null && typeof options === "object");
+    (0, node_opcua_assert_1.assert)(!extraInfo || (extraInfo !== null && typeof extraInfo === "object" && typeof extraInfo.registerClonedObject === "function"));
+    (0, node_opcua_assert_1.assert)(!this.subtypeOf, "We do not do cloning of Type yet");
+    (0, node_opcua_assert_1.assert)(!extraInfo.getCloned(this), "object has already been cloned");
+    const namespace = options.namespace;
+    const constructorOptions = Object.assign(Object.assign({}, options), { addressSpace: namespace.addressSpace, browseName: this.browseName, description: this.description, displayName: this.displayName, nodeClass: this.nodeClass });
+    constructorOptions.references = options.references || [];
+    if (this.nodeClass === node_opcua_data_model_1.NodeClass.Variable || this.nodeClass === node_opcua_data_model_1.NodeClass.Object) {
+        const voThis = this;
+        if (voThis.typeDefinition) {
+            constructorOptions.references.push(new reference_impl_1.ReferenceImpl({
+                isForward: true,
+                nodeId: voThis.typeDefinition,
+                referenceType: (0, node_opcua_nodeid_1.resolveNodeId)("HasTypeDefinition")
+            }));
+        }
+    }
+    if (!constructorOptions.modellingRule) {
+        if (this.modellingRule && options.copyAlsoModellingRules) {
+            const modellingRuleNode = this.findReferencesAsObject("HasModellingRule", true)[0];
+            (0, node_opcua_assert_1.assert)(modellingRuleNode);
+            constructorOptions.references.push(new reference_impl_1.ReferenceImpl({
+                isForward: true,
+                nodeId: modellingRuleNode.nodeId,
+                referenceType: (0, node_opcua_nodeid_1.resolveNodeId)("HasModellingRule")
+            }));
+        }
+    }
+    else {
+        (0, namespace_private_1.UANamespace_process_modelling_rule)(constructorOptions.references, constructorOptions.modellingRule);
+    }
+    constructorOptions.nodeId = namespace.constructNodeId(constructorOptions);
+    (0, node_opcua_assert_1.assert)(constructorOptions.nodeId instanceof node_opcua_nodeid_1.NodeId);
+    const cloneObj = new Constructor(constructorOptions);
+    this.addressSpace._register(cloneObj);
+    if (!options.ignoreChildren) {
+        // clone children and the rest ....
+        options.copyAlsoModellingRules = options.copyAlsoModellingRules || false;
+        const newFilter = optionalFilter.filterFor(cloneObj);
+        const browseNameMap = new Set();
+        _clone_hierarchical_references(this, cloneObj, options.copyAlsoModellingRules, newFilter, extraInfo, browseNameMap);
+        if (this.nodeClass === node_opcua_data_model_1.NodeClass.Object || this.nodeClass === node_opcua_data_model_1.NodeClass.Variable) {
+            let typeDefinitionNode = this.typeDefinitionObj;
+            while (typeDefinitionNode) {
+                doTrace &&
+                    traceLog(extraInfo === null || extraInfo === void 0 ? void 0 : extraInfo.pad(), chalk.blueBright("---------------------- Exploring ", typeDefinitionNode.browseName.toString()));
+                _clone_hierarchical_references(typeDefinitionNode, cloneObj, options.copyAlsoModellingRules, newFilter, extraInfo, browseNameMap);
+                typeDefinitionNode = typeDefinitionNode.subtypeOfObj;
+            }
+        }
+        _clone_non_hierarchical_references(this, cloneObj, options.copyAlsoModellingRules, newFilter, extraInfo, browseNameMap);
+    }
+    cloneObj.propagate_back_references();
+    cloneObj.install_extra_properties();
+    return cloneObj;
+}
+exports._clone = _clone;
+function _handle_HierarchicalReference(node, reference) {
+    const _cache = BaseNode_getCache(node);
+    if (!reference.isForward)
+        return;
+    if (_cache._childByNameMap) {
+        const addressSpace = node.addressSpace;
+        const referenceType = reference_impl_1.ReferenceImpl.resolveReferenceType(addressSpace, reference);
+        if (referenceType) {
+            const HierarchicalReferencesType = addressSpace.findReferenceType("HierarchicalReferences");
+            if (referenceType.isSubtypeOf(HierarchicalReferencesType)) {
+                (0, node_opcua_assert_1.assert)(reference.isForward);
+                const targetNode = reference_impl_1.ReferenceImpl.resolveReferenceNode(addressSpace, reference);
+                _cache._childByNameMap[targetNode.browseName.name.toString()] = targetNode;
+            }
+        }
+    }
+}
+exports._handle_HierarchicalReference = _handle_HierarchicalReference;
+function _remove_HierarchicalReference(node, reference) {
+    const _cache = BaseNode_getCache(node);
+    if (_cache._childByNameMap) {
+        const addressSpace = node.addressSpace;
+        const referenceType = reference_impl_1.ReferenceImpl.resolveReferenceType(addressSpace, reference);
+        if (referenceType) {
+            const HierarchicalReferencesType = addressSpace.findReferenceType("HierarchicalReferences");
+            if (referenceType.isSubtypeOf(HierarchicalReferencesType)) {
+                (0, node_opcua_assert_1.assert)(reference.isForward);
+                const targetNode = reference_impl_1.ReferenceImpl.resolveReferenceNode(addressSpace, reference);
+                // Xx dotrace && tracelog(" adding object to map");
+                delete _cache._childByNameMap[targetNode.browseName.name.toString()];
+            }
+        }
+    }
+}
+function _makeReferenceDescription(addressSpace, reference, resultMask) {
+    const isForward = reference.isForward;
+    const referenceTypeId = reference_impl_1.ReferenceImpl.resolveReferenceType(addressSpace, reference).nodeId;
+    (0, node_opcua_assert_1.assert)(referenceTypeId instanceof node_opcua_nodeid_1.NodeId);
+    const obj = reference_impl_1.ReferenceImpl.resolveReferenceNode(addressSpace, reference);
+    let data = {};
+    if (!obj) {
+        // cannot find reference node
+        data = {
+            isForward,
+            nodeId: reference.nodeId,
+            referenceTypeId: resultMask & node_opcua_data_model_1.ResultMask.ReferenceType ? referenceTypeId : null,
+            typeDefinition: null
+        };
+    }
+    else {
+        (0, node_opcua_assert_1.assert)(reference.nodeId, " obj.nodeId");
+        data = {
+            browseName: resultMask & node_opcua_data_model_1.ResultMask.BrowseName ? (0, node_opcua_data_model_1.coerceQualifiedName)(obj.browseName) : null,
+            displayName: resultMask & node_opcua_data_model_1.ResultMask.DisplayName ? (0, node_opcua_data_model_1.coerceLocalizedText)(obj.displayName[0]) : null,
+            isForward: resultMask & node_opcua_data_model_1.ResultMask.IsForward ? isForward : false,
+            nodeClass: resultMask & node_opcua_data_model_1.ResultMask.NodeClass ? obj.nodeClass : node_opcua_data_model_1.NodeClass.Unspecified,
+            nodeId: obj.nodeId,
+            referenceTypeId: resultMask & node_opcua_data_model_1.ResultMask.ReferenceType ? referenceTypeId : null,
+            typeDefinition: resultMask & node_opcua_data_model_1.ResultMask.TypeDefinition ? obj.typeDefinition : null
+        };
+    }
+    if (data.typeDefinition === null) {
+        data.typeDefinition = new node_opcua_nodeid_1.NodeId();
+    }
+    const referenceDescription = new node_opcua_types_1.ReferenceDescription(data);
+    return referenceDescription;
+}
+function _constructReferenceDescription(addressSpace, references, resultMask) {
+    (0, node_opcua_assert_1.assert)(Array.isArray(references));
+    return references.map((reference) => _makeReferenceDescription(addressSpace, reference, resultMask));
+}
+exports._constructReferenceDescription = _constructReferenceDescription;
+function BaseNode_remove_backward_reference(reference) {
+    const _private = BaseNode_getPrivate(this);
+    _remove_HierarchicalReference(this, reference);
+    const h = reference.hash;
+    if (_private._back_referenceIdx && _private._back_referenceIdx[h]) {
+        // note : h may not exist in _back_referenceIdx since we are not indexing
+        //        _back_referenceIdx to UAObjectType and UAVariableType for performance reasons
+        _private._back_referenceIdx[h].dispose();
+        delete _private._back_referenceIdx[h];
+    }
+    reference.dispose();
+}
+exports.BaseNode_remove_backward_reference = BaseNode_remove_backward_reference;
+function BaseNode_add_backward_reference(reference) {
+    const _private = BaseNode_getPrivate(this);
+    const h = reference.hash;
+    (0, node_opcua_assert_1.assert)(typeof h === "string");
+    // istanbul ignore next
+    if (_private._referenceIdx[h]) {
+        //  the reference exists already in the forward references
+        //  this append for instance when the XML NotSetFile has redundant <UAReference>
+        //  in this case there is nothing to do
+        return;
+    }
+    // istanbul ignore next
+    if (_private._back_referenceIdx[h]) {
+        const opts = { addressSpace: this.addressSpace };
+        warningLog(" Warning !", this.browseName.toString());
+        warningLog("    ", reference.toString(opts));
+        warningLog(" already found in ===>");
+        warningLog(Object.values(_private._back_referenceIdx).map((c) => c.toString(opts)).join("\n"));
+        // tslint:disable-next-line:no-console
+        warningLog("===>");
+        throw new Error("reference exists already in _back_references");
+    }
+    if (!(0, base_node_impl_1.getReferenceType)(reference)) {
+        const stop_here = 1;
+    }
+    //  assert(reference._referenceType instanceof ReferenceType);
+    _private._back_referenceIdx[h] = reference;
+    _handle_HierarchicalReference(this, reference);
+    this._clear_caches();
+}
+exports.BaseNode_add_backward_reference = BaseNode_add_backward_reference;
+//# sourceMappingURL=base_node_private.js.map