node-opcua-address-space 2.180.0 → 2.181.0

package/dist/api/loader/load_nodeset2.js

@@ -0,0 +1,245 @@
+"use strict";
+/**
+ * @module node-opcua-address-space
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NodeSetLoader = void 0;
+const node_util_1 = require("node:util");
+const chalk_1 = __importDefault(require("chalk"));
+const node_opcua_assert_1 = require("node-opcua-assert");
+const node_opcua_debug_1 = require("node-opcua-debug");
+const node_opcua_variant_1 = require("node-opcua-variant");
+const base_node_impl_js_1 = require("../../impl/base_node_impl.js");
+const base_node_private_js_1 = require("../../impl/base_node_private.js");
+const ensure_datatype_extracted_js_1 = require("./ensure_datatype_extracted.js");
+const namespace_post_step_js_1 = require("./namespace_post_step.js");
+const nodeset_record_js_1 = require("./nodeset_record.js");
+const nodeset_record_applier_js_1 = require("./nodeset_record_applier.js");
+const nodeset_xml_producer_js_1 = require("./nodeset_xml_producer.js");
+const doDebug = (0, node_opcua_debug_1.checkDebugFlag)("load_nodeset2");
+const debugLog = (0, node_opcua_debug_1.make_debugLog)("load_nodeset2");
+const errorLog = (0, node_opcua_debug_1.make_errorLog)("load_nodeset2");
+function __make_back_references(namespace, settled) {
+    const namespaceP = namespace;
+    for (const node of namespaceP.nodeIterator()) {
+        if (!settled.has(node)) {
+            node.propagate_back_references_declared_from_both_ends();
+        }
+    }
+    // Children are reached through shared accessors resolved on the child index (see
+    // impl/child_accessors.ts), so there is no per-node property installation to run here any
+    // more: that sweep was four reference scans per node, 12% of a load. What the load may have
+    // left behind is an index built earlier on a node that just gained children, so drop them all;
+    // they are rebuilt on first use.
+    for (const node of namespaceP.nodeIterator()) {
+        (0, base_node_private_js_1.BaseNode_resetChildIndex)(node);
+    }
+}
+/**
+ * the back references of the load: a NodeSet2 file declares most references from both ends, so
+ * only the references a document marked as one-sided are propagated, one by one (see
+ * NodesetReferenceRecord.inverseDeclared); a node whose document said nothing, or that the
+ * applier created through another helper, is propagated whole by the sweep, each of its
+ * references checked against its target
+ */
+function make_back_references(addressSpace, pending) {
+    const addressSpacePrivate = addressSpace;
+    addressSpacePrivate.suspendBackReference = false;
+    // the getters of every browse name the files declared, in one batch (see child_accessors.ts)
+    (0, base_node_impl_js_1.flushSharedChildAccessors)();
+    for (const [node, reference] of pending.references) {
+        node.propagate_back_reference_declared_from_both_ends(reference);
+    }
+    for (const namespace of addressSpace.getNamespaceArray()) {
+        __make_back_references(namespace, pending.settled);
+    }
+}
+const DEFAULT_YIELD_EVERY_BYTES = 8 * 1024 * 1024;
+const yieldToEventLoop = () => new Promise((resolve) => (typeof setImmediate === "function" ? setImmediate(resolve) : setTimeout(resolve, 0)));
+/**
+ * loads NodeSet2 documents into an address space: each document is a stream of records (see
+ * {@link NodesetRecord}) that an applier turns into nodes; `terminate` runs the work deferred
+ * until every document is in
+ */
+class NodeSetLoader {
+    addressSpace;
+    options;
+    queues;
+    applier;
+    yieldEveryBytes;
+    constructor(addressSpace, options) {
+        this.addressSpace = addressSpace;
+        this.addressSpace.suspendBackReference = true;
+        this.options = options || {};
+        this.options.loadDeprecatedNodes = this.options.loadDeprecatedNodes === undefined ? true : this.options.loadDeprecatedNodes;
+        this.options.loadDraftNodes = this.options.loadDraftNodes || false;
+        this.yieldEveryBytes =
+            this.options.yieldEveryBytes === undefined ? DEFAULT_YIELD_EVERY_BYTES : this.options.yieldEveryBytes;
+        this.queues = (0, nodeset_record_applier_js_1.makeLoaderTaskQueues)();
+        this.applier = new nodeset_record_applier_js_1.NodesetRecordApplier(this.addressSpace, this.options, this.queues);
+    }
+    /** load a document given whole */
+    async addNodeSetAsync(xmlData) {
+        await this.addNodeSetStream([xmlData]);
+    }
+    /**
+     * load a document delivered as text chunks; see {@link NodesetSource}. The records a chunk
+     * completes are applied together: one turn of the microtask queue per chunk, not per record
+     */
+    async addNodeSetStream(chunks) {
+        const reader = (0, nodeset_xml_producer_js_1.makeXmlNodesetRecordReader)();
+        try {
+            for await (const chunk of chunks) {
+                await this.applyAll(reader.write(chunk));
+            }
+            await this.applyAll(reader.end());
+        }
+        catch (err) {
+            this.failed();
+            throw err;
+        }
+    }
+    /**
+     * load a document from any producer of records: the XML reader, or a replayed image. A
+     * synchronous iterable (an image given whole) is consumed without a microtask per record.
+     */
+    async addRecords(records) {
+        try {
+            if (Symbol.iterator in records) {
+                await this.applyAll(records);
+                return;
+            }
+            for await (const record of records) {
+                this.applyOne(record);
+                if (this.yieldDue()) {
+                    await yieldToEventLoop();
+                }
+            }
+        }
+        catch (err) {
+            this.failed();
+            throw err;
+        }
+    }
+    sinceLastYield = 0;
+    applyOne(record) {
+        this.applier.apply(record);
+        this.sinceLastYield += record[nodeset_record_js_1.recordBytes] ?? 0;
+    }
+    yieldDue() {
+        if (this.yieldEveryBytes > 0 && this.sinceLastYield >= this.yieldEveryBytes) {
+            this.sinceLastYield = 0;
+            return true;
+        }
+        return false;
+    }
+    async applyAll(records) {
+        for (const record of records) {
+            this.applyOne(record);
+            if (this.yieldDue()) {
+                await yieldToEventLoop();
+            }
+        }
+    }
+    /** the address space holds what was loaded before the failure and must be disposed; it is not left in the middle of a load */
+    failed() {
+        this.addressSpace.suspendBackReference = false;
+    }
+    async terminate() {
+        const addressSpace1 = this.addressSpace;
+        const queues = this.queues;
+        make_back_references(addressSpace1, this.applier.takePendingBackReferences());
+        // setting up Server_NamespaceArray
+        if (addressSpace1.rootFolder?.objects?.server?.namespaceArray) {
+            addressSpace1.rootFolder.objects.server.namespaceArray.setValueFromSource({
+                arrayType: node_opcua_variant_1.VariantArrayType.Array,
+                dataType: node_opcua_variant_1.DataType.String,
+                value: addressSpace1.getNamespaceArray().map((ns) => ns.namespaceUri)
+            });
+            // c8 ignore next
+            if (doDebug) {
+                debugLog("addressSpace NS = ", addressSpace1.rootFolder.objects.server.namespaceArray.readValue().value.value.join(" "));
+            }
+        }
+        doDebug &&
+            debugLog(chalk_1.default.bgGreenBright("Performing post loading tasks -------------------------------------------") +
+                chalk_1.default.green("DONE"));
+        /**
+         * run every queued post-loading task.
+         *
+         * A task that throws (typically: a `<Value>` in a third-party nodeset that does not
+         * match the declared DataType) is logged and skipped — it must NOT abort the remaining
+         * tasks nor the remaining stages of finalSteps(). Previously the failing task was
+         * re-run inside the catch block, the second throw escaped the loop, finalSteps() was
+         * abandoned and `ensureDatatypeExtracted` was never called: the address space was
+         * left half-initialised (no DataTypeManager) and any later use of a structured
+         * DataType failed with an opaque
+         * "Cannot read properties of undefined (reading 'getExtensionObjectConstructorFromDataType')".
+         */
+        async function performPostLoadingTasks(stage, tasks) {
+            for (const task of tasks) {
+                try {
+                    await task(addressSpace1);
+                }
+                catch (err) {
+                    // c8 ignore next
+                    if (node_util_1.types.isNativeError(err)) {
+                        errorLog(`[NODE-OPCUA-W36] generateAddressSpace: post-loading task failed during "${stage}" and was skipped: ${err.message}`);
+                        doDebug && debugLog(err);
+                    }
+                }
+            }
+            tasks.splice(0);
+        }
+        async function finalSteps() {
+            /// ----------------------------------------------------------------------------------------
+            // perform post task
+            doDebug && debugLog(chalk_1.default.bgGreenBright("Performing post loading tasks -------------------------------------------"));
+            await performPostLoadingTasks("post tasks", queues.postTasks);
+            doDebug &&
+                debugLog(chalk_1.default.bgGreenBright("Performing post loading task: Initializing Simple Variables ---------------------"));
+            await performPostLoadingTasks("initializing simple variables", queues.postTasks0_InitializeVariable);
+            doDebug && debugLog(chalk_1.default.bgGreenBright("Performing DataType extraction -------------------------------------------"));
+            (0, node_opcua_assert_1.assert)(!addressSpace1.suspendBackReference);
+            await (0, ensure_datatype_extracted_js_1.ensureDatatypeExtracted)(addressSpace1);
+            const dataTypeManager = addressSpace1.getDataTypeManager();
+            /// ----------------------------------------------------------------------------------------
+            doDebug && debugLog(chalk_1.default.bgGreenBright("DataType extraction done ") + chalk_1.default.green("DONE"));
+            for (const { name: _name, dataTypeNodeId } of queues.pendingSimpleTypeToRegister) {
+                if (dataTypeNodeId.namespace === 0) {
+                    continue;
+                }
+                dataTypeManager.getDataTypeFactoryForNamespace(dataTypeNodeId.namespace);
+            }
+            queues.pendingSimpleTypeToRegister.splice(0);
+            doDebug && debugLog(chalk_1.default.bgGreenBright("Performing post loading task: Decoding Pojo String (parsing XML objects) -"));
+            await performPostLoadingTasks("decoding XML extension objects", queues.postTasks0_DecodePojoString);
+            doDebug &&
+                debugLog(chalk_1.default.bgGreenBright("Performing post loading task: Initializing Complex Variables ---------------------"));
+            await performPostLoadingTasks("initializing complex variables", queues.postTasks1_InitializeVariable);
+            doDebug && debugLog(chalk_1.default.bgGreenBright("Performing post loading tasks: (assigning Extension Object to Variables) -"));
+            await performPostLoadingTasks("assigning extension objects to variables", queues.postTasks2_AssignedExtensionObjectToDataValue);
+            doDebug && debugLog(chalk_1.default.bgGreenBright("Performing post variable initialization ---------------------"));
+            // awaited: a promoter that throws must reject generateAddressSpace, not surface later
+            // as an unhandled rejection once the caller believes the address space is complete
+            await (0, namespace_post_step_js_1.promoteObjectsAndVariables)(addressSpace1);
+        }
+        try {
+            await finalSteps();
+        }
+        catch (err) {
+            // `renderError` was a no-op here, so a failure in the final steps (DataType extraction,
+            // promotion of objects/variables, ...) used to be silently swallowed and the caller was
+            // handed back a half-initialised address space. Surface it: log and re-throw so that
+            // generateAddressSpace() rejects.
+            const message = node_util_1.types.isNativeError(err) ? err.message : String(err);
+            errorLog(`[NODE-OPCUA-E30] generateAddressSpace: final post-loading steps failed: ${message}`);
+            throw err;
+        }
+    }
+}
+exports.NodeSetLoader = NodeSetLoader;
+//# sourceMappingURL=load_nodeset2.js.map

package/dist/api/loader/load_nodeset2.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"load_nodeset2.js","sourceRoot":"","sources":["../../../api/loader/load_nodeset2.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;AAEH,yCAAkC;AAClC,kDAA0B;AAE1B,yDAA2C;AAC3C,uDAAgF;AAChF,2DAAgE;AAEhE,oEAA4F;AAC5F,0EAA2E;AAG3E,iFAAyE;AACzE,qEAAsE;AACtE,2DAA+H;AAE/H,2EAA2H;AAC3H,uEAAuE;AAEvE,MAAM,OAAO,GAAG,IAAA,iCAAc,EAAC,eAAe,CAAC,CAAC;AAChD,MAAM,QAAQ,GAAG,IAAA,gCAAa,EAAC,eAAe,CAAC,CAAC;AAChD,MAAM,QAAQ,GAAG,IAAA,gCAAa,EAAC,eAAe,CAAC,CAAC;AAEhD,SAAS,sBAAsB,CAAC,SAAqB,EAAE,OAAsB;IACzE,MAAM,UAAU,GAAG,SAA6B,CAAC;IACjD,KAAK,MAAM,IAAI,IAAI,UAAU,CAAC,YAAY,EAAE,EAAE,CAAC;QAC3C,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YACpB,IAAqB,CAAC,iDAAiD,EAAE,CAAC;QAC/E,CAAC;IACL,CAAC;IACD,iFAAiF;IACjF,0FAA0F;IAC1F,4FAA4F;IAC5F,+FAA+F;IAC/F,iCAAiC;IACjC,KAAK,MAAM,IAAI,IAAI,UAAU,CAAC,YAAY,EAAE,EAAE,CAAC;QAC3C,IAAA,+CAAwB,EAAC,IAAI,CAAC,CAAC;IACnC,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACH,SAAS,oBAAoB,CAAC,YAA2B,EAAE,OAA8B;IACrF,MAAM,mBAAmB,GAAG,YAAmC,CAAC;IAChE,mBAAmB,CAAC,oBAAoB,GAAG,KAAK,CAAC;IACjD,6FAA6F;IAC7F,IAAA,6CAAyB,GAAE,CAAC;IAC5B,KAAK,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;QAChD,IAAqB,CAAC,gDAAgD,CAAC,SAAS,CAAC,CAAC;IACvF,CAAC;IACD,KAAK,MAAM,SAAS,IAAI,YAAY,CAAC,iBAAiB,EAAE,EAAE,CAAC;QACvD,sBAAsB,CAAC,SAAS,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IACvD,CAAC;AACL,CAAC;AAED,MAAM,yBAAyB,GAAG,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC;AAElD,MAAM,gBAAgB,GAAG,GAAkB,EAAE,CACzC,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,OAAO,YAAY,KAAK,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;AAE1H;;;;GAIG;AACH,MAAa,aAAa;IACL,YAAY,CAAsB;IAClC,OAAO,CAAuB;IAC9B,MAAM,CAAmB;IACzB,OAAO,CAAuB;IAC9B,eAAe,CAAS;IAEzC,YAAY,YAA2B,EAAE,OAA8B;QACnE,IAAI,CAAC,YAAY,GAAG,YAAmC,CAAC;QACxD,IAAI,CAAC,YAAY,CAAC,oBAAoB,GAAG,IAAI,CAAC;QAC9C,IAAI,CAAC,OAAO,GAAG,OAAO,IAAI,EAAE,CAAC;QAC7B,IAAI,CAAC,OAAO,CAAC,mBAAmB,GAAG,IAAI,CAAC,OAAO,CAAC,mBAAmB,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC;QAC5H,IAAI,CAAC,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,cAAc,IAAI,KAAK,CAAC;QACnE,IAAI,CAAC,eAAe;YAChB,IAAI,CAAC,OAAO,CAAC,eAAe,KAAK,SAAS,CAAC,CAAC,CAAC,yBAAyB,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC;QAC1G,IAAI,CAAC,MAAM,GAAG,IAAA,gDAAoB,GAAE,CAAC;QACrC,IAAI,CAAC,OAAO,GAAG,IAAI,gDAAoB,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAC1F,CAAC;IAED,kCAAkC;IAClC,KAAK,CAAC,eAAe,CAAC,OAAe;QACjC,MAAM,IAAI,CAAC,gBAAgB,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;IAC3C,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,gBAAgB,CAAC,MAAgD;QACnE,MAAM,MAAM,GAAG,IAAA,oDAA0B,GAAE,CAAC;QAC5C,IAAI,CAAC;YACD,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;gBAC/B,MAAM,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;YAC7C,CAAC;YACD,MAAM,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC;QACtC,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,IAAI,CAAC,MAAM,EAAE,CAAC;YACd,MAAM,GAAG,CAAC;QACd,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,UAAU,CAAC,OAAwD;QACrE,IAAI,CAAC;YACD,IAAI,MAAM,CAAC,QAAQ,IAAI,OAAO,EAAE,CAAC;gBAC7B,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAkC,CAAC,CAAC;gBACxD,OAAO;YACX,CAAC;YACD,IAAI,KAAK,EAAE,MAAM,MAAM,IAAI,OAAgC,EAAE,CAAC;gBAC1D,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;gBACtB,IAAI,IAAI,CAAC,QAAQ,EAAE,EAAE,CAAC;oBAClB,MAAM,gBAAgB,EAAE,CAAC;gBAC7B,CAAC;YACL,CAAC;QACL,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,IAAI,CAAC,MAAM,EAAE,CAAC;YACd,MAAM,GAAG,CAAC;QACd,CAAC;IACL,CAAC;IAEO,cAAc,GAAG,CAAC,CAAC;IAEnB,QAAQ,CAAC,MAAqB;QAClC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC3B,IAAI,CAAC,cAAc,IAAK,MAAiC,CAAC,+BAAW,CAAC,IAAI,CAAC,CAAC;IAChF,CAAC;IAEO,QAAQ;QACZ,IAAI,IAAI,CAAC,eAAe,GAAG,CAAC,IAAI,IAAI,CAAC,cAAc,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;YAC1E,IAAI,CAAC,cAAc,GAAG,CAAC,CAAC;YACxB,OAAO,IAAI,CAAC;QAChB,CAAC;QACD,OAAO,KAAK,CAAC;IACjB,CAAC;IAEO,KAAK,CAAC,QAAQ,CAAC,OAAgC;QACnD,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC3B,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YACtB,IAAI,IAAI,CAAC,QAAQ,EAAE,EAAE,CAAC;gBAClB,MAAM,gBAAgB,EAAE,CAAC;YAC7B,CAAC;QACL,CAAC;IACL,CAAC;IAED,8HAA8H;IACtH,MAAM;QACV,IAAI,CAAC,YAAY,CAAC,oBAAoB,GAAG,KAAK,CAAC;IACnD,CAAC;IAED,KAAK,CAAC,SAAS;QACX,MAAM,aAAa,GAAG,IAAI,CAAC,YAAY,CAAC;QACxC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,oBAAoB,CAAC,aAAa,EAAE,IAAI,CAAC,OAAO,CAAC,yBAAyB,EAAE,CAAC,CAAC;QAE9E,mCAAmC;QAEnC,IAAI,aAAa,CAAC,UAAU,EAAE,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC;YAC5D,aAAa,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,kBAAkB,CAAC;gBACtE,SAAS,EAAE,qCAAgB,CAAC,KAAK;gBACjC,QAAQ,EAAE,6BAAQ,CAAC,MAAM;gBACzB,KAAK,EAAE,aAAa,CAAC,iBAAiB,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,YAAY,CAAC;aACxE,CAAC,CAAC;YACH,iBAAiB;YACjB,IAAI,OAAO,EAAE,CAAC;gBACV,QAAQ,CACJ,oBAAoB,EACpB,aAAa,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,SAAS,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAC3F,CAAC;YACN,CAAC;QACL,CAAC;QACD,OAAO;YACH,QAAQ,CACJ,eAAK,CAAC,aAAa,CAAC,2EAA2E,CAAC;gBAC5F,eAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAC1B,CAAC;QAEN;;;;;;;;;;;WAWG;QACH,KAAK,UAAU,uBAAuB,CAAC,KAAa,EAAE,KAAa;YAC/D,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;gBACvB,IAAI,CAAC;oBACD,MAAM,IAAI,CAAC,aAAa,CAAC,CAAC;gBAC9B,CAAC;gBAAC,OAAO,GAAG,EAAE,CAAC;oBACX,iBAAiB;oBACjB,IAAI,iBAAK,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC;wBAC3B,QAAQ,CACJ,2EAA2E,KAAK,sBAAsB,GAAG,CAAC,OAAO,EAAE,CACtH,CAAC;wBACF,OAAO,IAAI,QAAQ,CAAC,GAAG,CAAC,CAAC;oBAC7B,CAAC;gBACL,CAAC;YACL,CAAC;YACD,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QACpB,CAAC;QACD,KAAK,UAAU,UAAU;YACrB,4FAA4F;YAC5F,oBAAoB;YACpB,OAAO,IAAI,QAAQ,CAAC,eAAK,CAAC,aAAa,CAAC,2EAA2E,CAAC,CAAC,CAAC;YACtH,MAAM,uBAAuB,CAAC,YAAY,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;YAE9D,OAAO;gBACH,QAAQ,CAAC,eAAK,CAAC,aAAa,CAAC,mFAAmF,CAAC,CAAC,CAAC;YACvH,MAAM,uBAAuB,CAAC,+BAA+B,EAAE,MAAM,CAAC,6BAA6B,CAAC,CAAC;YAErG,OAAO,IAAI,QAAQ,CAAC,eAAK,CAAC,aAAa,CAAC,4EAA4E,CAAC,CAAC,CAAC;YACvH,IAAA,0BAAM,EAAC,CAAC,aAAa,CAAC,oBAAoB,CAAC,CAAC;YAC5C,MAAM,IAAA,sDAAuB,EAAC,aAAa,CAAC,CAAC;YAC7C,MAAM,eAAe,GAAG,aAAa,CAAC,kBAAkB,EAAE,CAAC;YAE3D,4FAA4F;YAC5F,OAAO,IAAI,QAAQ,CAAC,eAAK,CAAC,aAAa,CAAC,2BAA2B,CAAC,GAAG,eAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;YAE5F,KAAK,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,cAAc,EAAE,IAAI,MAAM,CAAC,2BAA2B,EAAE,CAAC;gBAC/E,IAAI,cAAc,CAAC,SAAS,KAAK,CAAC,EAAE,CAAC;oBACjC,SAAS;gBACb,CAAC;gBACD,eAAe,CAAC,8BAA8B,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;YAC7E,CAAC;YACD,MAAM,CAAC,2BAA2B,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YAE7C,OAAO,IAAI,QAAQ,CAAC,eAAK,CAAC,aAAa,CAAC,4EAA4E,CAAC,CAAC,CAAC;YACvH,MAAM,uBAAuB,CAAC,gCAAgC,EAAE,MAAM,CAAC,2BAA2B,CAAC,CAAC;YAEpG,OAAO;gBACH,QAAQ,CAAC,eAAK,CAAC,aAAa,CAAC,oFAAoF,CAAC,CAAC,CAAC;YACxH,MAAM,uBAAuB,CAAC,gCAAgC,EAAE,MAAM,CAAC,6BAA6B,CAAC,CAAC;YAEtG,OAAO,IAAI,QAAQ,CAAC,eAAK,CAAC,aAAa,CAAC,4EAA4E,CAAC,CAAC,CAAC;YACvH,MAAM,uBAAuB,CACzB,0CAA0C,EAC1C,MAAM,CAAC,6CAA6C,CACvD,CAAC;YAEF,OAAO,IAAI,QAAQ,CAAC,eAAK,CAAC,aAAa,CAAC,+DAA+D,CAAC,CAAC,CAAC;YAC1G,sFAAsF;YACtF,mFAAmF;YACnF,MAAM,IAAA,mDAA0B,EAAC,aAAa,CAAC,CAAC;QACpD,CAAC;QAED,IAAI,CAAC;YACD,MAAM,UAAU,EAAE,CAAC;QACvB,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,wFAAwF;YACxF,wFAAwF;YACxF,qFAAqF;YACrF,kCAAkC;YAClC,MAAM,OAAO,GAAG,iBAAK,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACrE,QAAQ,CAAC,2EAA2E,OAAO,EAAE,CAAC,CAAC;YAC/F,MAAM,GAAG,CAAC;QACd,CAAC;IACL,CAAC;CACJ;AA5MD,sCA4MC"}

package/dist/api/loader/make_semver_compatible.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"make_semver_compatible.js","sourceRoot":"","sources":["../../../api/loader/make_semver_compatible.ts"],"names":[],"mappings":";;AAKA,oDAiBC;AAtBD;;;;GAIG;AACH,SAAgB,oBAAoB,CAAC,OAAgB;IACjD,OAAO,GAAG,OAAO,IAAI,OAAO,CAAC;IAE7B,MAAM,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,8BAA8B,CAAC,CAAC;IAC9D,IAAI,CAAC,OAAO,EAAE,CAAC;QACX,OAAO,OAAO,CAAC;IACnB,CAAC;IACD,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IACrB,MAAM,aAAa,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;IAErE,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC7B,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC1B,CAAC;IACD,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC7B,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC1B,CAAC;IACD,OAAO,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC5D,CAAC"}

package/dist/api/loader/make_xml_extension_object_parser.js

@@ -0,0 +1,417 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeXmlExtensionObjectReader = makeXmlExtensionObjectReader;
+const node_opcua_basic_types_1 = require("node-opcua-basic-types");
+const node_opcua_debug_1 = require("node-opcua-debug");
+const node_opcua_nodeid_1 = require("node-opcua-nodeid");
+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_xml2json_1 = require("node-opcua-xml2json");
+const localized_text_parser_js_1 = require("./parsers/localized_text_parser.js");
+const qualified_name_parser_js_1 = require("./parsers/qualified_name_parser.js");
+const variant_parser_js_1 = require("./parsers/variant_parser.js");
+const warningLog = (0, node_opcua_debug_1.make_warningLog)("make_xml_extension_object_parser");
+const debugLog = (0, node_opcua_debug_1.make_debugLog)("make_xml_extension_object_parser");
+const doDebug = (0, node_opcua_debug_1.checkDebugFlag)("make_xml_extension_object_parser");
+// textual form of an ExpandedNodeId, as found in <ExpandedNodeId><Identifier>...</Identifier></ExpandedNodeId>:
+// an optional server index, an optional namespace uri, then a plain nodeId. see OPC UA part 6.
+const regexServerIndex = /^svr=([0-9]+);(.*)$/;
+const regexNamespaceUri = /^nsu=(.*?);(.*)$/;
+function parseExpandedNodeId(text) {
+    let remaining = text.trim();
+    let serverIndex = 0;
+    let namespaceUri = null;
+    const serverIndexMatch = remaining.match(regexServerIndex);
+    if (serverIndexMatch) {
+        serverIndex = parseInt(serverIndexMatch[1], 10);
+        remaining = serverIndexMatch[2];
+    }
+    const namespaceUriMatch = remaining.match(regexNamespaceUri);
+    if (namespaceUriMatch) {
+        namespaceUri = namespaceUriMatch[1];
+        remaining = namespaceUriMatch[2];
+    }
+    const nodeId = (0, node_opcua_nodeid_1.coerceNodeId)(remaining);
+    return new node_opcua_nodeid_1.ExpandedNodeId(nodeId.identifierType, nodeId.value, nodeId.namespace, namespaceUri, serverIndex);
+}
+function clamp(value, minValue, maxValue) {
+    if (value < minValue) {
+        warningLog(`invalid value range : ${value} < ${minValue} but should be [${minValue} , ${maxValue}]`);
+        return minValue;
+    }
+    if (value > maxValue) {
+        warningLog(`invalid value range : ${value} > ${maxValue} but should be [${minValue} , ${maxValue}]`);
+        return maxValue;
+    }
+    return value;
+}
+// <StatusCode><Code>2153644032</Code></StatusCode>
+const statusCode_parser = {
+    init() {
+        this.value = node_opcua_status_code_1.StatusCodes.Good;
+    },
+    parser: {
+        Code: {
+            finish() {
+                this.parent.value = (0, node_opcua_status_code_1.coerceStatusCode)(parseInt(this.text, 10));
+            }
+        }
+    }
+};
+// a DiagnosticInfo field is stored on the enclosing DiagnosticInfo, which is only
+// created when at least one field is present ( <DiagnosticInfo/> stays empty ).
+function _diagnosticInfoField(name, convert) {
+    return {
+        finish() {
+            this.parent.value = this.parent.value || {};
+            this.parent.value[name] = convert(this.text);
+        }
+    };
+}
+// <DiagnosticInfo><SymbolicId>1</SymbolicId>...<InnerDiagnosticInfo>...</InnerDiagnosticInfo></DiagnosticInfo>
+const diagnosticInfo_parser = {
+    init() {
+        this.value = undefined;
+    },
+    parser: {
+        SymbolicId: _diagnosticInfoField("symbolicId", (text) => parseInt(text, 10)),
+        NamespaceUri: _diagnosticInfoField("namespaceUri", (text) => parseInt(text, 10)),
+        Locale: _diagnosticInfoField("locale", (text) => parseInt(text, 10)),
+        LocalizedText: _diagnosticInfoField("localizedText", (text) => parseInt(text, 10)),
+        AdditionalInfo: _diagnosticInfoField("additionalInfo", (text) => text),
+        InnerStatusCode: {
+            ...statusCode_parser,
+            finish() {
+                this.parent.value = this.parent.value || {};
+                this.parent.value.innerStatusCode = this.value;
+            }
+        }
+    }
+};
+// InnerDiagnosticInfo is a DiagnosticInfo in turn: the parser is registered after the
+// fact so that it can refer to the reader being built.
+if (!diagnosticInfo_parser.parser) {
+    throw new Error("internal error: diagnosticInfo_parser.parser must be defined");
+}
+diagnosticInfo_parser.parser.InnerDiagnosticInfo = {
+    ...diagnosticInfo_parser,
+    finish() {
+        this.parent.value = this.parent.value || {};
+        this.parent.value.innerDiagnosticInfo = this.value;
+    }
+};
+const partials = {
+    LocalizedText: localized_text_parser_js_1.localizedText_parser.LocalizedText,
+    QualifiedName: (0, qualified_name_parser_js_1.makeQualifiedNameParser)((nodeId) => (0, node_opcua_nodeid_1.coerceNodeId)(nodeId)).QualifiedName,
+    String: {
+        finish() {
+            this.value = this.text;
+        }
+    },
+    Guid: {
+        parser: {
+            String: {
+                finish() {
+                    this.parent.value = this.text;
+                }
+            }
+        }
+    },
+    Boolean: {
+        finish() {
+            this.value = this.text.toLowerCase() === "true";
+        }
+    },
+    ByteString: {
+        init(_name, _attrs, _parent, _engine) {
+            this.value = null;
+        },
+        finish() {
+            const base64text = this.text;
+            const byteString = Buffer.from(base64text, "base64");
+            this.value = byteString;
+        }
+    },
+    Float: {
+        finish() {
+            this.value = parseFloat(this.text);
+        }
+    },
+    Double: {
+        finish() {
+            this.value = parseFloat(this.text);
+        }
+    },
+    Byte: {
+        finish() {
+            this.value = clamp(parseInt(this.text, 10), 0, 255);
+        }
+    },
+    SByte: {
+        finish() {
+            this.value = clamp(parseInt(this.text, 10), -128, 127);
+        }
+    },
+    Int8: {
+        finish() {
+            this.value = clamp(parseInt(this.text, 10), -128, 127);
+        }
+    },
+    Int16: {
+        finish() {
+            this.value = clamp(parseInt(this.text, 10), -32768, 32767);
+        }
+    },
+    Int32: {
+        finish() {
+            this.value = clamp(parseInt(this.text, 10), -2147483648, 2147483647);
+        }
+    },
+    Int64: {
+        finish() {
+            this.value = (0, node_opcua_basic_types_1.coerceInt64)(parseInt(this.text, 10));
+        }
+    },
+    UInt8: {
+        finish() {
+            this.value = clamp(parseInt(this.text, 10), 0, 255);
+        }
+    },
+    UInt16: {
+        finish() {
+            this.value = clamp(parseInt(this.text, 10), 0, 65535);
+        }
+    },
+    UInt32: {
+        finish() {
+            this.value = clamp(parseInt(this.text, 10), 0, 4294967295);
+        }
+    },
+    UInt64: {
+        finish() {
+            this.value = (0, node_opcua_basic_types_1.coerceUInt64)(parseInt(this.text, 10));
+        }
+    },
+    DateTime: {
+        finish() {
+            // to do check Local or GMT
+            this.value = new Date(this.text);
+        }
+    },
+    Variant: {
+        finish() {
+            /** to do */
+            warningLog(" Missing  Implemntation contact sterfive.com!");
+        }
+    },
+    NodeId: {
+        finish() {
+            // to do check Local or GMT
+            this.value = (0, node_opcua_nodeid_1.coerceNodeId)(this.text);
+        }
+    },
+    StatusCode: statusCode_parser,
+    DiagnosticInfo: diagnosticInfo_parser,
+    // <ExpandedNodeId><Identifier>svr=1;nsu=http://acme.com/UA/;i=42</Identifier></ExpandedNodeId>
+    ExpandedNodeId: {
+        finish() {
+            this.value = parseExpandedNodeId(this.text);
+        }
+    }
+};
+function _clone(a) {
+    if (typeof a === "string" || typeof a === "number" || typeof a === "boolean") {
+        return a;
+    }
+    if (Buffer.isBuffer(a)) {
+        return Buffer.from(a);
+    }
+    if (a instanceof Date) {
+        return new Date(a);
+    }
+    if (Array.isArray(a)) {
+        return a.map((x) => _clone(x));
+    }
+    return { ...a };
+}
+function _makeTypeReader(dataTypeNodeId1, definitionMap, readerMap, translateNodeId) {
+    const n = dataTypeNodeId1;
+    if (n.identifierType === node_opcua_nodeid_1.NodeIdType.NUMERIC && n.namespace === 0 && n.value === 0) {
+        // a generic Extension Object
+        return { name: "Variant", reader: partials.Variant };
+    }
+    if (n.namespace === 0 && n.identifierType === node_opcua_nodeid_1.NodeIdType.NUMERIC && n.value < node_opcua_variant_1.DataType.ExtensionObject) {
+        const name = node_opcua_variant_1.DataType[n.value];
+        const reader = partials[name];
+        return { name, reader };
+    }
+    const { name, definition } = definitionMap.findDefinition(n);
+    const dataTypeName = name;
+    let reader = readerMap.get(dataTypeName);
+    if (reader) {
+        return { name, reader };
+    }
+    reader = {
+        init() {
+            // the same reader instance is used for every element of that data type: the value must be
+            // reset here, or the element being read would inherit the fields of the previously read one
+            // ( or of the enclosing one, when the structure refers to itself ).
+            this.value = undefined;
+        },
+        finish() {
+            /** empty  */
+        },
+        parser: {
+        /** empty  */
+        }
+    };
+    // `reader.parser` is guaranteed defined: it was just set as a literal above, and the
+    // ReaderStateParserLike interface only declares it optional for other unrelated call sites.
+    const readerParser = reader.parser;
+    if (!readerParser) {
+        throw new Error("internal error: reader.parser must be defined");
+    }
+    if (definition instanceof node_opcua_types_1.StructureDefinition) {
+        // the reader must be registered *before* its fields are explored: a structure may refer to
+        // itself, directly or through one of its fields, and the recursion below would never end.
+        // `reader` and `reader.parser` keep their identity while being filled, so a nested reference
+        // that picks the reader up from the map ends up pointing at the completed reader.
+        readerMap.set(dataTypeName, reader);
+        for (const field of definition.fields || []) {
+            const typeReader = _makeTypeReader(field.dataType, definitionMap, readerMap, translateNodeId);
+            const fieldParser = typeReader.reader;
+            const fieldTypename = typeReader.name;
+            // c8 ignore next
+            if (!fieldParser) {
+                throw new Error(` Cannot find reader for dataType ${field.dataType} fieldTypename=${fieldTypename}`);
+            }
+            if (field.valueRank === undefined || field.valueRank === -1) {
+                // scalar
+                const parser = fieldParser;
+                if (!parser) {
+                    throw new Error(`??? ${field.dataType}  ${field.name}`);
+                }
+                readerParser[field.name || ""] = {
+                    parser: fieldParser.parser,
+                    // the field reader borrows the partial's sub-parsers: it must borrow its init
+                    // too, or the state those sub-parsers write into is never set up.
+                    init(elementName, attrs, parent, engine) {
+                        if (fieldParser.init) {
+                            fieldParser.init.call(this, elementName, attrs, parent, engine);
+                        }
+                    },
+                    // endElement: fieldReader.endElement,
+                    finish() {
+                        const elName = (0, node_opcua_utils_1.lowerFirstLetter)(field.name || "");
+                        if (fieldParser.finish) {
+                            fieldParser.finish.call(this);
+                        }
+                        else {
+                            // c8 ignore next
+                            doDebug && debugLog(`xxx check ${fieldTypename}`);
+                        }
+                        this.parent.value = this.parent.value || Object.create(null);
+                        this.parent.value[elName] = _clone(this.value);
+                    }
+                };
+            }
+            else if (field.valueRank === 1) {
+                const listReader = {
+                    init() {
+                        this.value = [];
+                    },
+                    parser: {
+                    /** empty */
+                    },
+                    finish() {
+                        const elName = (0, node_opcua_utils_1.lowerFirstLetter)(this.name || "");
+                        this.parent.value = this.parent.value || Object.create(null);
+                        this.parent.value[elName] = this.value;
+                        this.value = undefined;
+                    },
+                    startElement(_name, _attrs) {
+                        // empty
+                    },
+                    endElement(element) {
+                        this.value.push(_clone(this.parser[element].value));
+                    }
+                };
+                const listReaderParser = listReader.parser;
+                if (!listReaderParser) {
+                    throw new Error("internal error: listReader.parser must be defined");
+                }
+                listReaderParser[fieldTypename] = fieldParser;
+                readerParser[field.name || ""] = listReader;
+            }
+            else {
+                throw new Error("Unsupported ValueRank !");
+            }
+        }
+        return { name, reader };
+    }
+    else if (definition instanceof node_opcua_types_1.EnumDefinition) {
+        const turnToInt = (value) => {
+            // Green_100
+            return parseInt(value.split("_")[1], 10);
+        };
+        return {
+            name,
+            reader: {
+                finish() {
+                    this.value = turnToInt(this.text);
+                }
+            }
+        };
+    }
+    else if (definition?.dataType === node_opcua_variant_1.DataType.Variant) {
+        // <Value><String>Foo</String></Value>
+        let variantOptions = Object.create(null);
+        // an extension object the reader cannot decode inside a Variant field is dropped, as before
+        const variantReader = (0, variant_parser_js_1.makeVariantReader)((_self, data) => (variantOptions = (0, variant_parser_js_1.withoutXmlFragments)(data)), translateNodeId);
+        return {
+            name,
+            reader: {
+                init(_name, _attrs, _parent, _engine) {
+                    this.obj = {};
+                },
+                ...variantReader,
+                finish() {
+                    this.value = new node_opcua_variant_1.Variant(variantOptions);
+                }
+            }
+        };
+    }
+    else {
+        // basic datatype
+        const typeName = node_opcua_variant_1.DataType[definition.dataType];
+        const reader = partials[typeName];
+        // c8 ignore next
+        if (!reader) {
+            throw new Error(`missing parse for ${typeName}`);
+        }
+        return { name, reader };
+    }
+}
+function makeXmlExtensionObjectReader(dataTypeNodeId, definitionMap, readerMap, translateNodeId) {
+    const { name, definition } = definitionMap.findDefinition(dataTypeNodeId);
+    // c8 ignore next
+    if (!(definition instanceof node_opcua_types_1.StructureDefinition)) {
+        throw new Error("Expecting StructureDefinition");
+    }
+    const reader1 = {
+        parser: {},
+        endElement() {
+            this._pojo = this.parser[name].value;
+        }
+    };
+    const { reader } = _makeTypeReader(dataTypeNodeId, definitionMap, readerMap, translateNodeId);
+    const reader1Parser = reader1.parser;
+    if (!reader1Parser) {
+        throw new Error("internal error: reader1.parser must be defined");
+    }
+    reader1Parser[name] = reader;
+    return new node_opcua_xml2json_1.ReaderState(reader1);
+}
+//# sourceMappingURL=make_xml_extension_object_parser.js.map