node-opcua-address-space 2.179.0 → 2.181.0

package/dist/impl/_instantiate_helpers.js

@@ -0,0 +1,99 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initialize_properties_and_components = initialize_properties_and_components;
+/**
+ * @module node-opcua-address-space
+ */
+const chalk_1 = __importDefault(require("chalk"));
+const node_opcua_address_space_base_1 = require("node-opcua-address-space-base");
+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 make_optionals_map_js_1 = require("../api/helpers/make_optionals_map.js");
+const _mandatory_child_or_requested_optional_filter_js_1 = require("./_mandatory_child_or_requested_optional_filter.js");
+const base_node_private_js_1 = require("./base_node_private.js");
+// const debugLog = make_debugLog("INSTANTIATE");
+// const doDebug = checkDebugFlag("INSTANTIATE");
+const warningLog = (0, node_opcua_debug_1.make_warningLog)("INSTANTIATE");
+const errorLog = (0, node_opcua_debug_1.make_errorLog)("INSTANTIATE");
+const doTrace = (0, node_opcua_debug_1.checkDebugFlag)("INSTANTIATE");
+const traceLog = errorLog;
+// install properties and components on a instantiated Object
+//
+// based on their ModelingRule
+//  => Mandatory                 => Installed
+//  => Optional                  => Not Installed , unless it appear in optionals array
+//  => OptionalPlaceHolder       => Not Installed
+//  => null (no modelling rule ) => Not Installed
+//
+function _initialize_properties_and_components(instance, topMostType, typeDefinitionNode, copyAlsoModellingRules, copyAlsoAllOptionals, optionalsMap, extraInfo, browseNameMap) {
+    if (doTrace) {
+        warningLog("instance browseName =", instance.browseName.toString());
+        warningLog("typeNode            =", typeDefinitionNode.browseName.toString());
+        warningLog("optionalsMap        =", Object.keys(optionalsMap).join(" "));
+        const c = typeDefinitionNode.findReferencesEx("Aggregates");
+        warningLog("typeDefinition aggregates      =", c.map((x) => x.node?.browseName.toString()).join(" "));
+    }
+    optionalsMap = optionalsMap || {};
+    if ((0, node_opcua_nodeid_1.sameNodeId)(topMostType.nodeId, typeDefinitionNode.nodeId)) {
+        return; // nothing to do
+    }
+    const filter = new _mandatory_child_or_requested_optional_filter_js_1.MandatoryChildOrRequestedOptionalFilter(instance, copyAlsoAllOptionals, optionalsMap);
+    doTrace &&
+        traceLog(chalk_1.default.cyan(extraInfo.pad(), "cloning relevant member of typeDefinition class"), `${typeDefinitionNode.browseName.toString()}\n optionals${JSON.stringify(optionalsMap)}`);
+    (0, base_node_private_js_1._clone_hierarchical_references)(typeDefinitionNode, instance, copyAlsoModellingRules, filter, extraInfo, browseNameMap);
+    // now apply recursion on baseTypeDefinition  to get properties and components from base class
+    const baseTypeDefinitionNodeId = typeDefinitionNode.subtypeOf;
+    const baseTypeDefinition = typeDefinitionNode.subtypeOfObj;
+    doTrace &&
+        traceLog(chalk_1.default.cyan(extraInfo.pad(), "now apply recursion on baseTypeDefinition  to get properties and components from base class"), baseTypeDefinition ? baseTypeDefinition.browseName.toString() : "undefined");
+    // c8 ignore next
+    if (!baseTypeDefinition) {
+        throw new Error(chalk_1.default.red("Cannot find object with nodeId ") + baseTypeDefinitionNodeId);
+    }
+    extraInfo.level++;
+    _initialize_properties_and_components(instance, topMostType, baseTypeDefinition, copyAlsoModellingRules, copyAlsoAllOptionals, optionalsMap, extraInfo, browseNameMap);
+    extraInfo.level--;
+}
+function initialize_properties_and_components(instance, topMostType, nodeType, copyAlsoModellingRules, copyAlsoAllOptionals, optionals) {
+    const extraInfo = new node_opcua_address_space_base_1.CloneHelper();
+    extraInfo.pushContext({
+        clonedParent: instance,
+        originalParent: nodeType
+    });
+    extraInfo.registerClonedObject({
+        clonedNode: instance,
+        originalNode: nodeType
+    });
+    const optionalsMap = (0, make_optionals_map_js_1.makeOptionalsMap)(optionals);
+    const browseNameMap = new Set();
+    _initialize_properties_and_components(instance, topMostType, nodeType, copyAlsoModellingRules, copyAlsoAllOptionals, optionalsMap, extraInfo, browseNameMap);
+    // instantiate optionals from interfaces
+    instantiate_interface_children(nodeType, extraInfo, instance, copyAlsoModellingRules, copyAlsoAllOptionals, optionalsMap, browseNameMap);
+    (0, node_opcua_address_space_base_1.reconstructFunctionalGroupType)(extraInfo);
+    (0, node_opcua_address_space_base_1.reconstructNonHierarchicalReferences)(extraInfo);
+}
+function instantiate_interface_children(nodeType, extraInfo, instance, copyAlsoModellingRules, copyAlsoAllOptionals, optionalsMap, browseNameMap) {
+    const interfaces = nodeType.findReferencesEx((0, node_opcua_nodeid_1.resolveNodeId)("HasInterface"), node_opcua_data_model_1.BrowseDirection.Forward);
+    if (interfaces.length === 0) {
+        return;
+    }
+    for (const reference of interfaces) {
+        const interfaceType = reference.node || nodeType.addressSpace.findObjectType(reference.nodeId);
+        if (!interfaceType) {
+            warningLog(" cannot find node ", reference.nodeId.toString());
+            continue;
+        }
+        const topMostTypeBaseInterface = nodeType.addressSpace.findObjectType("BaseInterfaceType");
+        if (!topMostTypeBaseInterface) {
+            throw new Error("cannot find BaseInterfaceType");
+        }
+        doTrace &&
+            traceLog(chalk_1.default.cyan(extraInfo.pad(), "instantiating optionals from interface"), `${interfaceType.browseName.toString()}`);
+        _initialize_properties_and_components(instance, topMostTypeBaseInterface, interfaceType, copyAlsoModellingRules, copyAlsoAllOptionals, optionalsMap, extraInfo, browseNameMap);
+    }
+}
+//# sourceMappingURL=_instantiate_helpers.js.map

package/dist/impl/_instantiate_helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_instantiate_helpers.js","sourceRoot":"","sources":["../../impl/_instantiate_helpers.ts"],"names":[],"mappings":";;;;;AAwGA,oFAmDC;AA3JD;;GAEG;AACH,kDAA0B;AAC1B,iFASuC;AACvC,iEAAwD;AACxD,uDAAkF;AAClF,yDAA8D;AAC9D,gFAA0F;AAC1F,yHAA6G;AAC7G,iEAAwE;AAExE,iDAAiD;AACjD,iDAAiD;AACjD,MAAM,UAAU,GAAG,IAAA,kCAAe,EAAC,aAAa,CAAC,CAAC;AAClD,MAAM,QAAQ,GAAG,IAAA,gCAAa,EAAC,aAAa,CAAC,CAAC;AAE9C,MAAM,OAAO,GAAG,IAAA,iCAAc,EAAC,aAAa,CAAC,CAAC;AAC9C,MAAM,QAAQ,GAAG,QAAQ,CAAC;AAE1B,6DAA6D;AAC7D,EAAE;AACF,8BAA8B;AAC9B,6CAA6C;AAC7C,uFAAuF;AACvF,iDAAiD;AACjD,iDAAiD;AACjD,EAAE;AAEF,SAAS,qCAAqC,CAC1C,QAAW,EACX,WAAc,EACd,kBAAqB,EACrB,sBAA+B,EAC/B,oBAA6B,EAC7B,YAAyB,EACzB,SAAsB,EACtB,aAA0B;IAE1B,IAAI,OAAO,EAAE,CAAC;QACV,UAAU,CAAC,uBAAuB,EAAE,QAAQ,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC;QACpE,UAAU,CAAC,uBAAuB,EAAE,kBAAkB,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC9E,UAAU,CAAC,uBAAuB,EAAE,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QAEzE,MAAM,CAAC,GAAG,kBAAkB,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC;QAC5D,UAAU,CAAC,kCAAkC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IAC1G,CAAC;IACD,YAAY,GAAG,YAAY,IAAI,EAAE,CAAC;IAElC,IAAI,IAAA,8BAAU,EAAC,WAAW,CAAC,MAAM,EAAE,kBAAkB,CAAC,MAAM,CAAC,EAAE,CAAC;QAC5D,OAAO,CAAC,gBAAgB;IAC5B,CAAC;IAED,MAAM,MAAM,GAAG,IAAI,0FAAuC,CAAC,QAAQ,EAAE,oBAAoB,EAAE,YAAY,CAAC,CAAC;IAEzG,OAAO;QACH,QAAQ,CACJ,eAAK,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,EAAE,iDAAiD,CAAC,EAC9E,GAAG,kBAAkB,CAAC,UAAU,CAAC,QAAQ,EAAE,eAAe,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE,CAC3F,CAAC;IAEN,IAAA,qDAA8B,EAAC,kBAAkB,EAAE,QAAQ,EAAE,sBAAsB,EAAE,MAAM,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC;IAEvH,8FAA8F;IAE9F,MAAM,wBAAwB,GAAG,kBAAkB,CAAC,SAAS,CAAC;IAC9D,MAAM,kBAAkB,GAAG,kBAAkB,CAAC,YAAY,CAAC;IAE3D,OAAO;QACH,QAAQ,CACJ,eAAK,CAAC,IAAI,CACN,SAAS,CAAC,GAAG,EAAE,EACf,6FAA6F,CAChG,EACD,kBAAkB,CAAC,CAAC,CAAC,kBAAkB,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,WAAW,CAC9E,CAAC;IAEN,iBAAiB;IACjB,IAAI,CAAC,kBAAkB,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CAAC,eAAK,CAAC,GAAG,CAAC,iCAAiC,CAAC,GAAG,wBAAwB,CAAC,CAAC;IAC7F,CAAC;IACD,SAAS,CAAC,KAAK,EAAE,CAAC;IAClB,qCAAqC,CACjC,QAAQ,EACR,WAAW,EACX,kBAAkB,EAClB,sBAAsB,EACtB,oBAAoB,EACpB,YAAY,EACZ,SAAS,EACT,aAAa,CAChB,CAAC;IACF,SAAS,CAAC,KAAK,EAAE,CAAC;AACtB,CAAC;AAED,SAAgB,oCAAoC,CAIhD,QAAW,EACX,WAAc,EACd,QAAW,EACX,sBAA+B,EAC/B,oBAA6B,EAC7B,SAAoB;IAEpB,MAAM,SAAS,GAAG,IAAI,2CAAW,EAAE,CAAC;IAEpC,SAAS,CAAC,WAAW,CAAC;QAClB,YAAY,EAAE,QAAQ;QACtB,cAAc,EAAE,QAAQ;KAC3B,CAAC,CAAC;IACH,SAAS,CAAC,oBAAoB,CAAC;QAC3B,UAAU,EAAE,QAAQ;QACpB,YAAY,EAAE,QAAQ;KACzB,CAAC,CAAC;IAEH,MAAM,YAAY,GAAG,IAAA,wCAAgB,EAAC,SAAS,CAAC,CAAC;IAEjD,MAAM,aAAa,GAAG,IAAI,GAAG,EAAU,CAAC;IAExC,qCAAqC,CACjC,QAAQ,EACR,WAAW,EACX,QAAQ,EACR,sBAAsB,EACtB,oBAAoB,EACpB,YAAY,EACZ,SAAS,EACT,aAAa,CAChB,CAAC;IAEF,wCAAwC;IACxC,8BAA8B,CAC1B,QAAQ,EACR,SAAS,EACT,QAAQ,EACR,sBAAsB,EACtB,oBAAoB,EACpB,YAAY,EACZ,aAAa,CAChB,CAAC;IAEF,IAAA,8DAA8B,EAAC,SAAS,CAAC,CAAC;IAE1C,IAAA,oEAAoC,EAAC,SAAS,CAAC,CAAC;AACpD,CAAC;AAED,SAAS,8BAA8B,CACnC,QAAuC,EACvC,SAAsB,EACtB,QAAW,EACX,sBAA+B,EAC/B,oBAA6B,EAC7B,YAAyB,EACzB,aAA0B;IAE1B,MAAM,UAAU,GAAG,QAAQ,CAAC,gBAAgB,CAAC,IAAA,iCAAa,EAAC,cAAc,CAAC,EAAE,uCAAe,CAAC,OAAO,CAAC,CAAC;IACrG,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO;IACX,CAAC;IACD,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;QACjC,MAAM,aAAa,GAAI,SAAS,CAAC,IAAqB,IAAI,QAAQ,CAAC,YAAY,CAAC,cAAc,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QACjH,IAAI,CAAC,aAAa,EAAE,CAAC;YACjB,UAAU,CAAC,oBAAoB,EAAE,SAAS,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC;YAC9D,SAAS;QACb,CAAC;QACD,MAAM,wBAAwB,GAAG,QAAQ,CAAC,YAAY,CAAC,cAAc,CAAC,mBAAmB,CAAC,CAAC;QAC3F,IAAI,CAAC,wBAAwB,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;QACrD,CAAC;QACD,OAAO;YACH,QAAQ,CACJ,eAAK,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,EAAE,wCAAwC,CAAC,EACrE,GAAG,aAAa,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,CAC3C,CAAC;QACN,qCAAqC,CACjC,QAAQ,EACR,wBAAwB,EACxB,aAAa,EACb,sBAAsB,EACtB,oBAAoB,EACpB,YAAY,EACZ,SAAS,EACT,aAAa,CAChB,CAAC;IACN,CAAC;AACL,CAAC"}

package/dist/impl/_mandatory_child_or_requested_optional_filter.js

@@ -0,0 +1,82 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MandatoryChildOrRequestedOptionalFilter = void 0;
+const node_opcua_address_space_base_1 = require("node-opcua-address-space-base");
+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 debugLog = make_debugLog("_mandatory_child_or_requested_optional_filter");
+const _doDebug = (0, node_opcua_debug_1.checkDebugFlag)("_mandatory_child_or_requested_optional_filter");
+const warningLog = (0, node_opcua_debug_1.make_warningLog)("_mandatory_child_or_requested_optional_filter");
+const errorLog = (0, node_opcua_debug_1.make_errorLog)("_mandatory_child_or_requested_optional_filter");
+const doTrace = (0, node_opcua_debug_1.checkDebugFlag)("INSTANTIATE");
+const traceLog = errorLog;
+class MandatoryChildOrRequestedOptionalFilter {
+    optionalsMap;
+    references;
+    copyAlsoAllOptionals = false;
+    constructor(instance, copyAlsoAllOptionals, optionalsMap) {
+        this.copyAlsoAllOptionals = copyAlsoAllOptionals;
+        // should we clone the node to be a component or propertyOf of a instance
+        (0, node_opcua_assert_1.assert)(null !== instance);
+        this.optionalsMap = optionalsMap;
+        this.references = instance.findReferencesEx("Aggregates", node_opcua_data_model_1.BrowseDirection.Forward);
+    }
+    shouldKeep(node) {
+        const addressSpace = node.addressSpace;
+        const alreadyIn = this.references.filter((r) => {
+            const n = addressSpace.findNode(r.nodeId);
+            // c8 ignore next
+            if (!n) {
+                warningLog(" cannot find node ", r.nodeId.toString());
+                return false;
+            }
+            return n.browseName?.name?.toString() === node.browseName?.name?.toString();
+        });
+        if (alreadyIn.length > 0) {
+            (0, node_opcua_assert_1.assert)(alreadyIn.length === 1, "Duplication found ?");
+            // a child with the same browse name has already been install
+            // probably from a SuperClass, we should ignore this.
+            return false; // ignore
+        }
+        const modellingRule = node.modellingRule;
+        switch (modellingRule) {
+            case null:
+            case undefined:
+                // c8 ignore next
+                doTrace && traceLog("node ", (0, node_opcua_address_space_base_1.fullPath2)(node), " has no modellingRule ", node ? (0, node_opcua_address_space_base_1.fullPath2)(node) : "");
+                /**
+                 * in some badly generated NodeSet2.xml file, the modellingRule is not specified
+                 *
+                 * but in some other NodeSet2.xml, this means that the data are only attached to the Type node and shall not be
+                 * instantiate in the corresponding instance (example is the state variable of a finite state machine that are only
+                 * defined in the Type node)
+                 *
+                 * we should not consider it as an error, and treat it as not present
+                 */
+                return false;
+            case "Mandatory":
+                return true; // keep;
+            case "Optional":
+                // only if in requested optionals
+                return this.copyAlsoAllOptionals || (node.browseName?.name || "") in this.optionalsMap;
+            case "OptionalPlaceholder":
+                return false; // ignored
+            default:
+                return false; // ignored
+        }
+    }
+    filterFor(childInstance) {
+        const browseName = childInstance.browseName.name || "";
+        let map = Object.create(null);
+        if (browseName in this.optionalsMap) {
+            map = this.optionalsMap[browseName];
+        }
+        // c8 ignore next
+        doTrace && traceLog("filterFor ", browseName, map);
+        const newFilter = new MandatoryChildOrRequestedOptionalFilter(childInstance, false, map);
+        return newFilter;
+    }
+}
+exports.MandatoryChildOrRequestedOptionalFilter = MandatoryChildOrRequestedOptionalFilter;
+//# sourceMappingURL=_mandatory_child_or_requested_optional_filter.js.map

package/dist/impl/_mandatory_child_or_requested_optional_filter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_mandatory_child_or_requested_optional_filter.js","sourceRoot":"","sources":["../../impl/_mandatory_child_or_requested_optional_filter.ts"],"names":[],"mappings":";;;AAAA,iFAQuC;AACvC,yDAA2C;AAC3C,iEAAwD;AACxD,uDAAkF;AAElF,mFAAmF;AACnF,MAAM,QAAQ,GAAG,IAAA,iCAAc,EAAC,+CAA+C,CAAC,CAAC;AACjF,MAAM,UAAU,GAAG,IAAA,kCAAe,EAAC,+CAA+C,CAAC,CAAC;AACpF,MAAM,QAAQ,GAAG,IAAA,gCAAa,EAAC,+CAA+C,CAAC,CAAC;AAChF,MAAM,OAAO,GAAG,IAAA,iCAAc,EAAC,aAAa,CAAC,CAAC;AAC9C,MAAM,QAAQ,GAAG,QAAQ,CAAC;AAK1B,MAAa,uCAAuC;IAC/B,YAAY,CAAc;IAC1B,UAAU,CAAgB;IAC1B,oBAAoB,GAAY,KAAK,CAAC;IAEvD,YAAY,QAAkB,EAAE,oBAA6B,EAAE,YAAyB;QACpF,IAAI,CAAC,oBAAoB,GAAG,oBAAoB,CAAC;QACjD,yEAAyE;QACzE,IAAA,0BAAM,EAAC,IAAI,KAAK,QAAQ,CAAC,CAAC;QAC1B,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,UAAU,GAAG,QAAQ,CAAC,gBAAgB,CAAC,YAAY,EAAE,uCAAe,CAAC,OAAO,CAAC,CAAC;IACvF,CAAC;IAEM,UAAU,CAAC,IAAc;QAC5B,MAAM,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QAEvC,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAc,EAAE,EAAE;YACxD,MAAM,CAAC,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;YAC1C,iBAAiB;YACjB,IAAI,CAAC,CAAC,EAAE,CAAC;gBACL,UAAU,CAAC,oBAAoB,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC;gBACtD,OAAO,KAAK,CAAC;YACjB,CAAC;YACD,OAAO,CAAC,CAAC,UAAU,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,IAAI,CAAC,UAAU,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;QAChF,CAAC,CAAC,CAAC;QAEH,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvB,IAAA,0BAAM,EAAC,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,qBAAqB,CAAC,CAAC;YACtD,6DAA6D;YAC7D,qDAAqD;YACrD,OAAO,KAAK,CAAC,CAAC,SAAS;QAC3B,CAAC;QAED,MAAM,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;QAEzC,QAAQ,aAAa,EAAE,CAAC;YACpB,KAAK,IAAI,CAAC;YACV,KAAK,SAAS;gBACV,iBAAiB;gBACjB,OAAO,IAAI,QAAQ,CAAC,OAAO,EAAE,IAAA,yCAAS,EAAC,IAAI,CAAC,EAAE,wBAAwB,EAAE,IAAI,CAAC,CAAC,CAAC,IAAA,yCAAS,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;gBACrG;;;;;;;;mBAQG;gBACH,OAAO,KAAK,CAAC;YAEjB,KAAK,WAAW;gBACZ,OAAO,IAAI,CAAC,CAAC,QAAQ;YACzB,KAAK,UAAU;gBACX,iCAAiC;gBACjC,OAAO,IAAI,CAAC,oBAAoB,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,IAAI,EAAE,CAAC,IAAI,IAAI,CAAC,YAAY,CAAC;YAC3F,KAAK,qBAAqB;gBACtB,OAAO,KAAK,CAAC,CAAC,UAAU;YAC5B;gBACI,OAAO,KAAK,CAAC,CAAC,UAAU;QAChC,CAAC;IACL,CAAC;IAEM,SAAS,CAAC,aAA+C;QAC5D,MAAM,UAAU,GAAW,aAAa,CAAC,UAAU,CAAC,IAAI,IAAI,EAAE,CAAC;QAE/D,IAAI,GAAG,GAAgB,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAE3C,IAAI,UAAU,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YAClC,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,UAAU,CAAgB,CAAC;QACvD,CAAC;QACD,iBAAiB;QACjB,OAAO,IAAI,QAAQ,CAAC,YAAY,EAAE,UAAU,EAAE,GAAG,CAAC,CAAC;QACnD,MAAM,SAAS,GAAG,IAAI,uCAAuC,CAAC,aAAa,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;QACzF,OAAO,SAAS,CAAC;IACrB,CAAC;CACJ;AA5ED,0FA4EC"}

package/dist/impl/address_space.d.ts

@@ -0,0 +1,379 @@
+/**
+ * @module node-opcua-address-space
+ */
+import type { AddReferenceOpts, BaseNode, IEventData, IHistoricalDataNodeOptions, ISessionContext, MethodCallInterceptor, ShutdownTask, UADataType, UAEventType, UAMethod, UAObject, UAObjectType, UAReference, UAReferenceType, UAVariable, UAVariableType, UAView } from "node-opcua-address-space-base";
+import type { ExtraDataTypeManager } from "node-opcua-client-dynamic-extension-object";
+import { NodeClass } from "node-opcua-data-model";
+import type { ExtensionObject } from "node-opcua-extension-object";
+import { NodeId, type NodeIdLike } from "node-opcua-nodeid";
+import { BrowseResult } from "node-opcua-service-browse";
+import type { BrowseDescription, ModelChangeStructureDataType } from "node-opcua-types";
+import { BrowsePath, BrowsePathResult } from "node-opcua-types";
+import { DataType, type VariantT } from "node-opcua-variant";
+import type { IHistorizerFactory } from "../api/address_space_ts.js";
+import type { ExtensionObjectConstructorFuncWithSchema } from "../api/interfaces/extension_object_constructor.js";
+import type { UARootFolder } from "../api/ua_root_folder.js";
+import type { AddressSpacePrivate } from "./address_space_private.js";
+import { isNonEmptyQualifiedName } from "./namespace_impl.js";
+import type { NamespacePrivate } from "./namespace_private.js";
+import { ReferenceImpl } from "./reference_impl.js";
+/**
+ * returns true if str matches a nodeID, e.g i=123 or ns=...
+ */
+declare function isNodeIdString(str: unknown): boolean;
+/**
+ * The implementation behind `AddressSpace`.
+ *
+ * Consumers reach it as {@link AddressSpace}, whose type shows `create` and
+ * `historizerFactory` and nothing else. Everything here beyond those two is machinery.
+ *
+ * @internal
+ */
+export declare class AddressSpaceImpl implements AddressSpacePrivate {
+    get rootFolder(): UARootFolder;
+    static isNonEmptyQualifiedName: typeof isNonEmptyQualifiedName;
+    /**
+     * Reads and writes reach the module that the historical-access code also reads, so
+     * assigning here actually takes effect. It used to be a plain static, while the code that
+     * consumed it read the static of a different AddressSpace class altogether.
+     */
+    static get historizerFactory(): IHistorizerFactory | undefined;
+    static set historizerFactory(factory: IHistorizerFactory | undefined);
+    static create(): AddressSpaceImpl;
+    private static registry;
+    /***
+     * @internal
+     * @private
+     */
+    suspendBackReference: boolean;
+    isFrugal: boolean;
+    registerChildAccessorNames(browseNames: string[]): void;
+    private readonly _referenceTypeOrdinals;
+    referenceTypeOrdinal(referenceType: NodeId): number;
+    historizingNodes: Set<UAVariable>;
+    _condition_refresh_in_progress: boolean;
+    readonly isNodeIdString: typeof isNodeIdString;
+    private readonly _private_namespaceIndex;
+    private readonly _namespaceArray;
+    private _shutdownTask?;
+    private _eventIdCounter?;
+    $$extraDataTypeManager?: ExtraDataTypeManager;
+    private _modelChangeTransactionCounter;
+    private _modelChanges;
+    _methodCallInterceptors: MethodCallInterceptor[];
+    constructor();
+    toJSON(): Record<string, string | number | undefined>;
+    toString(): string;
+    /**
+     * @internal
+     */
+    getDataTypeManager(): ExtraDataTypeManager;
+    getNamespaceUri(namespaceIndex: number): string;
+    /***
+     */
+    getNamespace(namespaceIndexOrName: string | number): NamespacePrivate;
+    /***
+     * @return  the  default namespace (standard OPCUA namespace)
+     */
+    getDefaultNamespace(): NamespacePrivate;
+    /***
+     *
+     * objects instances managed by the server will be created in this namespace.
+     *
+     * @return  address space own namespace
+     */
+    getOwnNamespace(): NamespacePrivate;
+    /**
+     * @return the namespace index of a namespace given by its namespace uri
+     *
+     */
+    getNamespaceIndex(namespaceUri: string): number;
+    /**
+     *
+     * register a new namespace,
+     * it is OK to call registerNamespace even if namespace has already been registered;
+     * in this case the registerNamespace has no effect and returns the existing namespace.
+     *
+     * @param namespaceUri {string}
+     * @returns {Namespace}
+     */
+    registerNamespace(namespaceUri: string): NamespacePrivate;
+    /***
+     * @return {Namespace[]} the namespace array
+     */
+    getNamespaceArray(): NamespacePrivate[];
+    /**
+     *
+     * @param alias {String} the alias name
+     * @param nodeId {NodeId}
+     * @internal
+     */
+    addAlias(alias: string, nodeId: NodeId): void;
+    /**
+     * find an node by node Id
+     * @param nodeId   a nodeId or a string coerce-able to nodeID, representing the object to find.
+     * @return {BaseNode|null}
+     */
+    findNode(nodeId: NodeIdLike): BaseNode | null;
+    findMethod(nodeId: NodeId | string): UAMethod | null;
+    /**
+     * resolved a string or a nodeId to a nodeID
+     */
+    resolveNodeId(nodeId: NodeIdLike): NodeId;
+    /**
+     *
+     * @param objectType  {String|NodeId|QualifiedName}
+     * @param [namespaceIndex=0 {Number}] an optional namespace index
+     * @return {UAObjectType|null}
+     *
+     * @example
+     *
+     * ```javascript
+     *     const objectType = addressSpace.findObjectType("ns=0;i=58");
+     *     objectType.browseName.toString().should.eql("BaseObjectType");
+     *
+     *     const objectType = addressSpace.findObjectType("BaseObjectType");
+     *     objectType.browseName.toString().should.eql("BaseObjectType");
+     *
+     *     const objectType = addressSpace.findObjectType(resolveNodeId("ns=0;i=58"));
+     *     objectType.browseName.toString().should.eql("BaseObjectType");
+     *
+     *     const objectType = addressSpace.findObjectType("CustomObjectType",36);
+     *     objectType.nodeId.namespace.should.eql(36);
+     *     objectType.browseName.toString().should.eql("BaseObjectType");
+     *
+     *     const objectType = addressSpace.findObjectType("36:CustomObjectType");
+     *     objectType.nodeId.namespace.should.eql(36);
+     *     objectType.browseName.toString().should.eql("BaseObjectType");
+     * ```
+     */
+    findObjectType(objectType: NodeIdLike, namespaceIndex?: number): UAObjectType | null;
+    /**
+     * @param variableType  {String|NodeId}
+     * @param [namespaceIndex=0 {Number}] an optional namespace index
+     * @return {UAObjectType|null}
+     *
+     * @example
+     *
+     * ```javascript
+     *     const objectType = addressSpace.findVariableType("ns=0;i=62");
+     *     objectType.browseName.toString().should.eql("BaseVariableType");
+     *
+     *     const objectType = addressSpace.findVariableType("BaseVariableType");
+     *     objectType.browseName.toString().should.eql("BaseVariableType");
+     *
+     *     const objectType = addressSpace.findVariableType(resolveNodeId("ns=0;i=62"));
+     *     objectType.browseName.toString().should.eql("BaseVariableType");
+     * ```
+     */
+    findVariableType(variableType: string | NodeId, namespaceIndex?: number): UAVariableType | null;
+    /**
+     * Find the DataType node from a NodeId or a browseName
+     * @param dataType {String|NodeId}
+     * @param [namespaceIndex=0 {Number}] an optional namespace index
+     * @return {DataType|null}
+     *
+     *
+     * @example
+     *
+     * ```javascript
+     *      const dataDouble = addressSpace.findDataType("Double");
+     *      const dataDouble = addressSpace.findDataType(resolveNodeId("ns=0;i=3"));
+     * ```
+     */
+    findDataType(dataType: number | string | NodeId | DataType, namespaceIndex?: number): UADataType | null;
+    /**
+     *
+     * @example
+     *
+     *     const dataType = addressSpace.findDataType("ns=0;i=12");
+     *     addressSpace.findCorrespondingBasicDataType(dataType).should.eql(DataType.String);
+     *
+     *     const dataType = addressSpace.findDataType("ServerStatusDataType"); // ServerStatus
+     *     addressSpace.findCorrespondingBasicDataType(dataType).should.eql(DataType.ExtensionObject);
+     *
+     */
+    findCorrespondingBasicDataType(dataTypeNode: NodeIdLike | UADataType): DataType;
+    /**
+     * find a ReferenceType by its inverse name.
+     * @param inverseName  the inverse name of the ReferenceType to find
+     * @deprecated
+     */
+    findReferenceTypeFromInverseName(inverseName: string): UAReferenceType | null;
+    /**
+     * @param refType {String|NodeId}
+     * @param [namespaceIndex=0 {Number}] an optional namespace index
+     * @return {ReferenceType|null}
+     *
+     * refType could be
+     *   - a string representing a nodeid       : e.g.    `i=9004` or ns=1;i=6030
+     *   - a string representing a browse name  : e.g     `"HasTypeDefinition"`.
+     *     In this case it should be in the alias list.
+     *
+     */
+    findReferenceType(refType: NodeIdLike, namespaceIndex?: number): UAReferenceType | null;
+    /**
+     * returns the inverse name of the referenceType.
+     *
+     * @param referenceType {String} : the reference type name
+     * @return {String} the name of the inverse reference type.
+     *
+     * @example
+     *
+     *    ```javascript
+     *    addressSpace.inverseReferenceType("OrganizedBy").should.eql("Organizes");
+     *    addressSpace.inverseReferenceType("Organizes").should.eql("OrganizedBy");
+     *    ```
+     *
+     */
+    inverseReferenceType(referenceType: string): string;
+    /**
+     * find an EventType node in the address space
+     * @param eventTypeId {String|NodeId|UAObjectType} the eventType to find
+     * @param namespaceIndex the namespace index of the event to find
+     * @return {UAObjectType|null} the EventType found or null.
+     *
+     * note:
+     *    - the method with throw an exception if a node is found
+     *      that is not a BaseEventType or a subtype of it.
+     *
+     * @example
+     *
+     *     var evtType = addressSpace.findEventType("AuditEventType");
+     *
+     */
+    findEventType(eventTypeId: NodeIdLike | UAEventType, namespaceIndex?: number): UAEventType | null;
+    /**
+     * EventId is generated by the Server to uniquely identify a particular Event Notification.
+     * @return {Variant}  dataType: "ByteString"
+     */
+    generateEventId(): VariantT<Buffer, DataType.ByteString>;
+    constructEventData(eventTypeId: UAEventType, dataInput: Record<string, unknown>): IEventData;
+    /**
+     * browse some path.
+     *
+     * @param  {BrowsePath} browsePath
+     * @return {BrowsePathResult}
+     *
+     * This service can be used translates one or more browse paths into NodeIds.
+     * A browse path is constructed of a starting Node and a RelativePath. The specified starting Node
+     * identifies the Node from which the RelativePath is based. The RelativePath contains a sequence of
+     * ReferenceTypes and BrowseNames.
+     *
+     *   |StatusCode                    |                                                            |
+     *   |------------------------------|:-----------------------------------------------------------|
+     *   |BadNodeIdUnknown              |                                                            |
+     *   |BadNodeIdInvalid              |                                                            |
+     *   |BadNothingToDo                | - the relative path contains an empty list )               |
+     *   |BadBrowseNameInvalid          | - target name is missing in relative path                  |
+     *   |UncertainReferenceOutOfServer | - The path element has targets which are in another server.|
+     *   |BadTooManyMatches             |                                                            |
+     *   |BadQueryTooComplex            |                                                            |
+     *   |BadNoMatch                    |                                                            |
+     *
+     *
+     *
+     */
+    browsePath(browsePath: BrowsePath): BrowsePathResult;
+    getExtensionObjectConstructor(dataType: NodeId | UADataType): ExtensionObjectConstructorFuncWithSchema;
+    /**
+     * @param dataType
+     * @param [options]
+     * @return the constructed extension object
+     *
+     *
+     * @example
+     *
+     *             // example 1
+     *             var extObj = addressSpace.constructExtensionObject("BuildInfo",{ productName: "PRODUCT_NAME"});
+     *
+     *             // example 2
+     *             serverStatusDataType.nodeClass.should.eql(NodeClass.DataType);
+     *             serverStatusDataType.browseName.toString().should.eql("ServerStatusDataType");
+     *             var serverStatus  = addressSpace.constructExtensionObject(serverStatusDataType);
+     *             serverStatus.should.be.instanceof(ServerStatusDataType);
+     */
+    constructExtensionObject(dataType: UADataType | NodeId, options?: Record<string, unknown>): ExtensionObject;
+    /**
+     * cleanup all resources maintained by this addressSpace.
+     */
+    dispose(): void;
+    /**
+     * register a function that will be called when the server will perform its shut down.
+     */
+    registerShutdownTask(task: ShutdownTask): void;
+    /**
+     * Register a method call interceptor.
+     * Interceptors are called sequentially before each UAMethod.execute().
+     * If any interceptor returns a non-Good StatusCode, the method call
+     * is rejected and subsequent interceptors are skipped.
+     */
+    addMethodCallInterceptor(interceptor: MethodCallInterceptor): void;
+    /**
+     * Remove a previously registered method call interceptor.
+     */
+    removeMethodCallInterceptor(interceptor: MethodCallInterceptor): void;
+    shutdown(): Promise<void>;
+    browseSingleNode(nodeId: NodeIdLike, browseDescription: BrowseDescription, context?: ISessionContext): BrowseResult;
+    /**
+     * @param folder
+     * @private
+     */
+    _coerceFolder(folder: UAObject): BaseNode | null;
+    /**
+     *
+     * @param view
+     * @param modelChange
+     * @private
+     */
+    _collectModelChange(_view: UAView | null, modelChange: ModelChangeStructureDataType): void;
+    /**
+     *
+     * walk up the hierarchy of objects until a view is found
+     * objects may belong to multiples views.
+     * Note: this method doesn't return the main view => Server object.
+     * @param node {BaseNode}
+     * @return {BaseNode[]}
+     */
+    /**
+     *
+     * @param node
+     * @private
+     */
+    extractRootViews(node: UAObject | UAVariable): UAView[];
+    /**
+     *
+     * @param func
+     * @private
+     */
+    modelChangeTransaction(func: () => void): void;
+    /**
+     * normalize the ReferenceType field of the Reference Object
+     * @param params.referenceType  {String|nodeId}
+     * @param params.isForward  {Boolean} default value: true;
+     * @return {Object} a new reference object  with the normalized name { referenceType: <value>, isForward: <flag>}
+     */
+    normalizeReferenceType(params: AddReferenceOpts | ReferenceImpl): UAReference;
+    normalizeReferenceTypes(references?: AddReferenceOpts[] | ReferenceImpl[] | null): UAReference[];
+    /**
+     *
+     * @param node
+     * @param options
+     */
+    installHistoricalDataNode(node: UAVariable, options?: IHistoricalDataNodeOptions): void;
+    /**
+     *
+     */
+    installAlarmsAndConditionsService(): void;
+    _coerceNode(node: string | BaseNode | NodeId): BaseNode | null;
+    _coerce_DataType(dataType: number | NodeId | string | BaseNode): NodeId;
+    _coerceTypeDefinition(typeDefinition: string | NodeId): NodeId;
+    _coerceType<T extends BaseNode>(baseType: string | NodeId | BaseNode, topMostBaseType: string, nodeClass: NodeClass): T;
+    _coerce_VariableTypeIds(dataType: NodeId | string | BaseNode): NodeId;
+    _register(node: BaseNode): void;
+    deleteNode(nodeOrNodeId: NodeId | BaseNode): void;
+    isEnumeration(dataType: NodeId): boolean;
+    private _coerce_Type;
+    private _findReferenceType;
+}
+export {};