node-opcua-address-space 2.181.1 → 2.182.2

package/bin/nodeset_tool_common.js

@@ -0,0 +1,72 @@
+/**
+ * What the nodeset command line tools share: resolving the files a document requires, and the
+ * shape of a NodesetSource over a file on disk.
+ */
+const fs = require("node:fs");
+const path = require("node:path");
+const { preLoad } = require("../dist/api/index.js");
+const { readNodeSet2XmlFile } = require("../distNodeJS/index.js");
+
+const kb = (n) => `${(n / 1024).toFixed(0)} KB`;
+
+/** a NodeSet2 file as the loader takes it: named, and read whole when asked for */
+const asFile = (file) => ({ name: file, source: () => [new Uint8Array(fs.readFileSync(file))] });
+
+const imageFileOf = (file, outDir) => {
+    const base = path.basename(file).replace(/\.xml$/i, "");
+    return path.join(outDir ?? path.dirname(file), `${base}.ndjson.gz`);
+};
+
+/** the files `file` requires, in load order, from the node-opcua-nodesets catalog and `requireFiles` */
+async function dependencyChain(file, requireFiles = []) {
+    let catalog = [];
+    let nodesets = {};
+    try {
+        ({ nodesetCatalog: catalog, nodesets } = require("node-opcua-nodesets"));
+    } catch {
+        /* the catalog is optional */
+    }
+    const known = new Map(); // model uri -> file
+    for (const meta of catalog) {
+        if (nodesets[meta.name] && fs.existsSync(nodesets[meta.name])) known.set(meta.uri, nodesets[meta.name]);
+    }
+    for (const required of requireFiles) {
+        const [desc] = await preLoad([required], readNodeSet2XmlFile);
+        for (const model of desc.namespaceModel.models) known.set(model.modelUri, required);
+    }
+    const order = [];
+    const visit = async (f) => {
+        const [desc] = await preLoad([f], readNodeSet2XmlFile);
+        for (const model of desc.namespaceModel.models) {
+            for (const required of model.requiredModel) {
+                const dependency = known.get(required.modelUri);
+                if (!dependency) {
+                    throw new Error(
+                        `${path.basename(f)} requires ${required.modelUri}: not in the catalog, pass it with --require`
+                    );
+                }
+                if (!order.includes(dependency) && dependency !== f) await visit(dependency);
+            }
+        }
+        if (!order.includes(f)) order.push(f);
+    };
+    await visit(file);
+    return order;
+}
+
+/**
+ * the record stream of a document, whichever form it is in. A gzip stream starts `1f 8b`, a
+ * NodeSet2 XML document `<`, and an uncompressed NodeSet-NDJSON document `{`, so the three are
+ * told apart by their first byte with no filename and no metadata to trust.
+ */
+async function recordsOfFile(file) {
+    const { imageNodesetRecords } = require("../dist/api/index.js");
+    const { nodesetFileToImage } = require("../distNodeJS/index.js");
+    const bytes = new Uint8Array(fs.readFileSync(file));
+    const image = bytes[0] === 0x1f && bytes[1] === 0x8b ? bytes : await nodesetFileToImage(file);
+    const out = [];
+    for await (const record of imageNodesetRecords(image)) out.push(record);
+    return out;
+}
+
+module.exports = { asFile, dependencyChain, imageFileOf, kb, recordsOfFile };

package/bin/opcua-nodeset-image.js

@@ -1,53 +1,55 @@
 #!/usr/bin/env node
 /**
- * opcua-nodeset-image: precompiled images of NodeSet2 files, without writing code.
+ * opcua-nodeset-image: everything you can do to a nodeset document without an information model.
+ *
+ * Nothing here builds an address space. A NodeSet2 document and its NodeSet-NDJSON form are two
+ * spellings of the same thing, so converting between them, reading one, or comparing two is a
+ * transcription: no DataType definitions are needed, no dependency chain has to be resolved, and
+ * nothing has to be loaded. That is what keeps this tool cheap, and what makes its answers about
+ * the document rather than about node-opcua. For the few operations that do need a model, and
+ * pay for one, see `opcua-nodeset-live`.
  *
  *   opcua-nodeset-image build <file.xml>... [--out <dir>]
  *       writes <name>.ndjson.gz next to each source, or into --out; prints source size,
- *       image size, node count and elapsed time; exit code 1 when a file fails, the others
- *       are still processed
- *   opcua-nodeset-image verify <file.xml>... [--require <file.xml>]...
- *       loads each file from XML and from its image into two address spaces and compares
- *       them; dependencies come from the node-opcua-nodesets catalog, or from --require
- *   opcua-nodeset-image info <image>
- *       prints the header and the trailer of an image
- *   opcua-nodeset-image export <file.xml>... [--out <image>]
- *       loads the files (dependencies resolved as for verify) and exports the last one's
- *       namespace, from the live address space, to an image: the round-trip fixture
+ *       image size, node count and elapsed time. Exit 1 if a file fails, the others are
+ *       still processed
+ *   opcua-nodeset-image xml <file>... [--out <dir>]
+ *       the other direction: writes <name>.nodeset2.xml from a document in either form
+ *   opcua-nodeset-image records <file>
+ *       the record stream as NDJSON on stdout, one record per line, uncompressed
+ *   opcua-nodeset-image info <file>
+ *       the header and the trailer of an image
+ *   opcua-nodeset-image diff <a> <b>
+ *       the two documents compared record by record; either may be XML or NDJSON
  */
 const fs = require("node:fs");
 const path = require("node:path");
 const { performance } = require("node:perf_hooks");
-const { AddressSpace, generateAddressSpaceRaw, namespaceToImage, preLoad, readNodesetImageInfo } = require("../dist/api/index.js");
-const { addressSpacePackageVersion, digestAddressSpace, nodesetFileToImage, readNodeSet2XmlFile } = require("../distNodeJS/index.js");
+const { readNodesetImageInfo, recordsToNodeset2XML } = require("../dist/api/index.js");
+const { nodesetFileToImage } = require("../distNodeJS/index.js");
+const { imageFileOf, kb, recordsOfFile } = require("./nodeset_tool_common.js");
 
 const usage = () => {
-    console.error("usage: opcua-nodeset-image build <file.xml>... [--out <dir>]");
-    console.error("       opcua-nodeset-image verify <file.xml>... [--require <file.xml>]...");
-    console.error("       opcua-nodeset-image info <image>");
-    console.error("       opcua-nodeset-image export <file.xml>... [--out <image>] [--require <file.xml>]...");
+    console.error("usage: opcua-nodeset-image build   <file.xml>... [--out <dir>]");
+    console.error("       opcua-nodeset-image xml     <file>...     [--out <dir>]");
+    console.error("       opcua-nodeset-image records <file>");
+    console.error("       opcua-nodeset-image info    <file>");
+    console.error("       opcua-nodeset-image diff    <a> <b>");
     process.exit(2);
 };
 
 function parseArgs(argv) {
     const files = [];
-    const options = { out: undefined, require: [] };
+    const options = { out: undefined };
     for (let i = 0; i < argv.length; i++) {
         const arg = argv[i];
         if (arg === "--out") options.out = argv[++i];
-        else if (arg === "--require") options.require.push(argv[++i]);
         else if (arg.startsWith("--")) usage();
         else files.push(arg);
     }
     return { files, options };
 }
 
-const imageFileOf = (file, outDir) => {
-    const base = path.basename(file).replace(/\.xml$/i, "");
-    return path.join(outDir ?? path.dirname(file), `${base}.ndjson.gz`);
-};
-const kb = (n) => `${(n / 1024).toFixed(0)} KB`;
-
 async function build(files, options) {
     let failed = 0;
     for (const file of files) {
@@ -70,60 +72,23 @@ async function build(files, options) {
     return failed > 0 ? 1 : 0;
 }
 
-/** the files a document requires, in load order, from the catalog and the --require files */
-async function dependencyChain(file, requireFiles) {
-    let catalog = [];
-    let nodesets = {};
-    try {
-        ({ nodesetCatalog: catalog, nodesets } = require("node-opcua-nodesets"));
-    } catch {
-        /* the catalog is optional */
-    }
-    const known = new Map(); // model uri -> file
-    for (const meta of catalog) {
-        if (nodesets[meta.name] && fs.existsSync(nodesets[meta.name])) known.set(meta.uri, nodesets[meta.name]);
-    }
-    for (const required of requireFiles) {
-        const [desc] = await preLoad([required], readNodeSet2XmlFile);
-        for (const model of desc.namespaceModel.models) known.set(model.modelUri, required);
-    }
-    const order = [];
-    const visit = async (f) => {
-        const [desc] = await preLoad([f], readNodeSet2XmlFile);
-        for (const model of desc.namespaceModel.models) {
-            for (const required of model.requiredModel) {
-                const dependency = known.get(required.modelUri);
-                if (!dependency) throw new Error(`${path.basename(f)} requires ${required.modelUri}: not in the catalog, pass it with --require`);
-                if (!order.includes(dependency) && dependency !== f) await visit(dependency);
-            }
-        }
-        if (!order.includes(f)) order.push(f);
-    };
-    await visit(file);
-    return order;
-}
-
-async function verify(files, options) {
+async function toXml(files, options) {
     let failed = 0;
     for (const file of files) {
+        const t0 = performance.now();
         try {
-            const chain = await dependencyChain(file, options.require);
-            const image = await nodesetFileToImage(file);
-            const load = async (sources) => {
-                const addressSpace = AddressSpace.create();
-                try {
-                    await generateAddressSpaceRaw(addressSpace, sources, {});
-                    return digestAddressSpace(addressSpace);
-                } finally {
-                    addressSpace.dispose();
-                }
-            };
-            const asFile = (f) => ({ name: f, source: () => [new Uint8Array(fs.readFileSync(f))] });
-            const fromXml = await load(chain.map(asFile));
-            const fromImage = await load(chain.map((f) => (f === file ? { name: `${f} (image)`, source: image } : asFile(f))));
-            const same = fromXml.hash === fromImage.hash && fromXml.nodes === fromImage.nodes && fromXml.references === fromImage.references;
-            console.log(`${path.basename(file)}: ${fromXml.nodes} nodes, ${fromXml.references} references, image ${same ? "identical" : "DIFFERS"}`);
-            if (!same) failed += 1;
+            const records = await recordsOfFile(file);
+            const xml = recordsToNodeset2XML(records);
+            const base = path
+                .basename(file)
+                .replace(/\.ndjson\.gz$/i, "")
+                .replace(/\.xml$/i, "");
+            const target = path.join(options.out ?? path.dirname(file), `${base}.nodeset2.xml`);
+            fs.mkdirSync(path.dirname(target), { recursive: true });
+            fs.writeFileSync(target, xml);
+            console.log(
+                `${path.basename(file)}: ${records.length - 1} nodes -> ${path.basename(target)} ${kb(xml.length)}, ${(performance.now() - t0).toFixed(0)} ms`
+            );
         } catch (err) {
             failed += 1;
             console.error(`${file}: ${err.message}`);
@@ -132,28 +97,13 @@ async function verify(files, options) {
     return failed > 0 ? 1 : 0;
 }
 
-async function exportNamespace(files, options) {
-    const last = files[files.length - 1];
-    const chain = await dependencyChain(last, [...options.require, ...files.slice(0, -1)]);
-    const addressSpace = AddressSpace.create();
-    try {
-        const asFile = (f) => ({ name: f, source: () => [new Uint8Array(fs.readFileSync(f))] });
-        await generateAddressSpaceRaw(addressSpace, chain.map(asFile), {});
-        const [desc] = await preLoad([last], readNodeSet2XmlFile);
-        const modelUri = desc.namespaceModel.models[0]?.modelUri;
-        const namespace = addressSpace.getNamespaceArray().find((n) => n.namespaceUri === modelUri);
-        if (!namespace) throw new Error(`${path.basename(last)}: namespace ${modelUri} not found after loading`);
-        const t0 = performance.now();
-        const image = await namespaceToImage(namespace, { addressSpaceVersion: addressSpacePackageVersion() });
-        const target = options.out ?? imageFileOf(last, undefined).replace(/\.ndjson\.gz$/, ".export.ndjson.gz");
-        fs.mkdirSync(path.dirname(target), { recursive: true });
-        fs.writeFileSync(target, image);
-        const info = await readNodesetImageInfo(image);
-        console.log(`${path.basename(last)}: namespace ${modelUri} -> ${path.basename(target)} ${kb(image.length)}, ${info.trailer.nodes} nodes, ${(performance.now() - t0).toFixed(0)} ms`);
-        return 0;
-    } finally {
-        addressSpace.dispose();
+async function records(files) {
+    for (const file of files) {
+        for (const record of await recordsOfFile(file)) {
+            console.log(JSON.stringify(record));
+        }
     }
+    return 0;
 }
 
 async function info(files) {
@@ -165,6 +115,44 @@ async function info(files) {
     return 0;
 }
 
+/** the key a record is matched on across two documents; the header is one of a kind */
+const keyOf = (record) => (record.kind === "header" ? "header" : record.nodeId.toString());
+
+async function diff(files) {
+    if (files.length !== 2) usage();
+    const [a, b] = await Promise.all(files.map(recordsOfFile));
+    const right = new Map(b.map((r) => [keyOf(r), r]));
+    const seen = new Set();
+    const differences = [];
+    for (const left of a) {
+        const key = keyOf(left);
+        seen.add(key);
+        const other = right.get(key);
+        if (!other) {
+            differences.push(`${key}: only in ${path.basename(files[0])}`);
+            continue;
+        }
+        for (const field of new Set([...Object.keys(left), ...Object.keys(other)])) {
+            const l = JSON.stringify(left[field]);
+            const r = JSON.stringify(other[field]);
+            if (l !== r) {
+                differences.push(`${key}.${field}\n    A ${String(l).slice(0, 200)}\n    B ${String(r).slice(0, 200)}`);
+            }
+        }
+    }
+    for (const record of b) {
+        if (!seen.has(keyOf(record))) differences.push(`${keyOf(record)}: only in ${path.basename(files[1])}`);
+    }
+    for (const line of differences.slice(0, 40)) console.log(line);
+    if (differences.length > 40) console.log(`... and ${differences.length - 40} more`);
+    console.log(
+        differences.length === 0
+            ? `${path.basename(files[0])} and ${path.basename(files[1])}: identical, ${a.length} records`
+            : `${differences.length} difference(s) over ${a.length} records`
+    );
+    return differences.length === 0 ? 0 : 1;
+}
+
 async function main() {
     const [command, ...rest] = process.argv.slice(2);
     const { files, options } = parseArgs(rest);
@@ -172,21 +160,23 @@ async function main() {
     switch (command) {
         case "build":
             return build(files, options);
-        case "verify":
-            return verify(files, options);
+        case "xml":
+            return toXml(files, options);
+        case "records":
+            return records(files);
         case "info":
             return info(files);
-        case "export":
-            return exportNamespace(files, options);
+        case "diff":
+            return diff(files);
         default:
-            usage();
+            return usage();
     }
 }
 
 main().then(
     (code) => process.exit(code),
     (err) => {
-        console.error(err.message);
+        console.error(err.stack || err.message);
         process.exit(1);
     }
 );

package/bin/opcua-nodeset-live.js

@@ -0,0 +1,139 @@
+#!/usr/bin/env node
+/**
+ * opcua-nodeset-live: the nodeset operations that need an information model, and only those.
+ *
+ * Each of these builds a real address space, which means resolving a dependency chain, loading
+ * every namespace a document requires, and paying for the whole of node-opcua. That is the point
+ * of keeping them apart from `opcua-nodeset-image`: converting a document between its two
+ * spellings needs none of it, and a tool that quietly loaded a model to do a transcription would
+ * be answering a different question from the one it was asked.
+ *
+ * What genuinely needs a model:
+ *
+ *   opcua-nodeset-live verify <file.xml>... [--require <file.xml>]...
+ *       loads each file from XML and from its image into two address spaces and compares them.
+ *       The comparison is of models, so there has to be one
+ *   opcua-nodeset-live export <file.xml>... [--out <image>] [--require <file.xml>]...
+ *       loads the files and writes the last one's namespace back out as an image, from the live
+ *       address space. This is how a namespace that was never a document becomes one
+ *   opcua-nodeset-live equivalence <file.xml>... [--require <file.xml>]... [--dump <dir>] [--quiet]
+ *       the full round trip of the RFC, section 9.2: what a *given implementation* loses when it
+ *       loads a document and writes it back. The narrower claim, about the format alone, is
+ *       checked without an address space and lives in test_nodeset_records_to_xml.ts
+ */
+const fs = require("node:fs");
+const path = require("node:path");
+const { performance } = require("node:perf_hooks");
+const { AddressSpace, generateAddressSpaceRaw, namespaceToImage, preLoad, readNodesetImageInfo } = require("../dist/api/index.js");
+const {
+    addressSpacePackageVersion,
+    digestAddressSpace,
+    nodesetFileToImage,
+    readNodeSet2XmlFile
+} = require("../distNodeJS/index.js");
+const { asFile, dependencyChain, imageFileOf, kb } = require("./nodeset_tool_common.js");
+const { equivalence } = require("./nodeset_equivalence.js");
+
+const usage = () => {
+    console.error("usage: opcua-nodeset-live verify      <file.xml>... [--require <file.xml>]...");
+    console.error("       opcua-nodeset-live export      <file.xml>... [--out <image>] [--require <file.xml>]...");
+    console.error("       opcua-nodeset-live equivalence <file.xml>... [--require <file.xml>]... [--dump <dir>] [--quiet]");
+    process.exit(2);
+};
+
+function parseArgs(argv) {
+    const files = [];
+    const options = { out: undefined, require: [] };
+    for (let i = 0; i < argv.length; i++) {
+        const arg = argv[i];
+        if (arg === "--out") options.out = argv[++i];
+        else if (arg === "--require") options.require.push(argv[++i]);
+        else if (arg.startsWith("--")) usage();
+        else files.push(arg);
+    }
+    return { files, options };
+}
+
+async function verify(files, options) {
+    let failed = 0;
+    for (const file of files) {
+        try {
+            const chain = await dependencyChain(file, options.require);
+            const image = await nodesetFileToImage(file);
+            const load = async (sources) => {
+                const addressSpace = AddressSpace.create();
+                try {
+                    await generateAddressSpaceRaw(addressSpace, sources, {});
+                    return digestAddressSpace(addressSpace);
+                } finally {
+                    addressSpace.dispose();
+                }
+            };
+            const fromXml = await load(chain.map(asFile));
+            const fromImage = await load(chain.map((f) => (f === file ? { name: `${f} (image)`, source: image } : asFile(f))));
+            const same =
+                fromXml.hash === fromImage.hash &&
+                fromXml.nodes === fromImage.nodes &&
+                fromXml.references === fromImage.references;
+            console.log(
+                `${path.basename(file)}: ${fromXml.nodes} nodes, ${fromXml.references} references, image ${same ? "identical" : "DIFFERS"}`
+            );
+            if (!same) failed += 1;
+        } catch (err) {
+            failed += 1;
+            console.error(`${file}: ${err.message}`);
+        }
+    }
+    return failed > 0 ? 1 : 0;
+}
+
+async function exportNamespace(files, options) {
+    const last = files[files.length - 1];
+    const chain = await dependencyChain(last, [...options.require, ...files.slice(0, -1)]);
+    const addressSpace = AddressSpace.create();
+    try {
+        await generateAddressSpaceRaw(addressSpace, chain.map(asFile), {});
+        const [desc] = await preLoad([last], readNodeSet2XmlFile);
+        const modelUri = desc.namespaceModel.models[0]?.modelUri;
+        const namespace = addressSpace.getNamespaceArray().find((n) => n.namespaceUri === modelUri);
+        if (!namespace) throw new Error(`${path.basename(last)}: namespace ${modelUri} not found after loading`);
+        const t0 = performance.now();
+        const image = await namespaceToImage(namespace, { addressSpaceVersion: addressSpacePackageVersion() });
+        const target = options.out ?? imageFileOf(last, undefined).replace(/\.ndjson\.gz$/, ".export.ndjson.gz");
+        fs.mkdirSync(path.dirname(target), { recursive: true });
+        fs.writeFileSync(target, image);
+        const info = await readNodesetImageInfo(image);
+        console.log(
+            `${path.basename(last)}: namespace ${modelUri} -> ${path.basename(target)} ${kb(image.length)}, ${info.trailer.nodes} nodes, ${(performance.now() - t0).toFixed(0)} ms`
+        );
+        return 0;
+    } finally {
+        addressSpace.dispose();
+    }
+}
+
+async function main() {
+    const [command, ...rest] = process.argv.slice(2);
+    if (!command) usage();
+    if (command === "equivalence") {
+        return equivalence(rest);
+    }
+    const { files, options } = parseArgs(rest);
+    if (files.length === 0) usage();
+    switch (command) {
+        case "verify":
+            return verify(files, options);
+        case "export":
+            return exportNamespace(files, options);
+        default:
+            return usage();
+    }
+}
+
+main().then(
+    (code) => process.exit(code),
+    (err) => {
+        console.error(err.stack || err.message);
+        process.exit(1);
+    }
+);

package/dist/api/helpers/ensure_secure_access.d.ts

@@ -17,3 +17,23 @@ export interface EnsureObjectIsSecureOptions {
  * @param options `hideStructure` to also hide the nodes from unauthorised sessions
  */
 export declare function ensureObjectIsSecure(node: BaseNode, options?: EnsureObjectIsSecureOptions): void;
+/**
+ * keep the structure of `node` and its aggregates browsable by every session, leaving every
+ * other permission as declared.
+ *
+ * A node whose RolePermissions grant Browse to neither Anonymous nor AuthenticatedUser is
+ * hidden from any session that holds none of the roles it names. Where those roles are ones
+ * the server never assigns, nobody sees the node, and its parent - browsable by everyone -
+ * shows an instance missing the mandatory children of its type. `Opc.Ua.NodeSet2.xml` does
+ * this to eleven nodes under Server/PublishSubscribe (the methods of SecurityGroups and
+ * KeyPushTargets, with their arguments), reserved to the SecurityKeyServerAdmin role
+ * (CTT Base Info Core Structure 002, FEAT-30).
+ *
+ * Such a node gains Browse for Anonymous and AuthenticatedUser, which every session's
+ * permissions are evaluated against; Read, Write and Call stay with the roles it named. A
+ * node without RolePermissions, or that already grants Browse to one of the two, is left as
+ * it is.
+ *
+ * @param node the node whose structure, and whose aggregates' structure, must stay visible
+ */
+export declare function ensureStructureIsBrowsable(node: BaseNode): void;

package/dist/api/helpers/ensure_secure_access.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ensureObjectIsSecure = ensureObjectIsSecure;
+exports.ensureStructureIsBrowsable = ensureStructureIsBrowsable;
 const node_opcua_data_model_1 = require("node-opcua-data-model");
 const node_opcua_types_1 = require("node-opcua-types");
 const session_context_js_1 = require("../session_context.js");
@@ -64,4 +65,42 @@ function ensureObjectIsSecure(node, options = {}) {
         ensureObjectIsSecure(child, options);
     }
 }
+/** the two Roles every Session's permissions are evaluated against, granted Browse and nothing else */
+const browseForEverySession = [
+    { roleId: session_context_js_1.WellKnownRoles.Anonymous, permissions: (0, node_opcua_data_model_1.makePermissionFlag)("Browse") },
+    { roleId: session_context_js_1.WellKnownRoles.AuthenticatedUser, permissions: (0, node_opcua_data_model_1.makePermissionFlag)("Browse") }
+];
+function grantsBrowseToEverySession(rolePermissions) {
+    return rolePermissions.some(({ roleId, permissions }) => (permissions & node_opcua_data_model_1.PermissionFlag.Browse) !== 0 &&
+        roleId.namespace === 0 &&
+        (roleId.value === session_context_js_1.WellKnownRoles.Anonymous || roleId.value === session_context_js_1.WellKnownRoles.AuthenticatedUser));
+}
+/**
+ * keep the structure of `node` and its aggregates browsable by every session, leaving every
+ * other permission as declared.
+ *
+ * A node whose RolePermissions grant Browse to neither Anonymous nor AuthenticatedUser is
+ * hidden from any session that holds none of the roles it names. Where those roles are ones
+ * the server never assigns, nobody sees the node, and its parent - browsable by everyone -
+ * shows an instance missing the mandatory children of its type. `Opc.Ua.NodeSet2.xml` does
+ * this to eleven nodes under Server/PublishSubscribe (the methods of SecurityGroups and
+ * KeyPushTargets, with their arguments), reserved to the SecurityKeyServerAdmin role
+ * (CTT Base Info Core Structure 002, FEAT-30).
+ *
+ * Such a node gains Browse for Anonymous and AuthenticatedUser, which every session's
+ * permissions are evaluated against; Read, Write and Call stay with the roles it named. A
+ * node without RolePermissions, or that already grants Browse to one of the two, is left as
+ * it is.
+ *
+ * @param node the node whose structure, and whose aggregates' structure, must stay visible
+ */
+function ensureStructureIsBrowsable(node) {
+    const rolePermissions = node.rolePermissions;
+    if (rolePermissions && !grantsBrowseToEverySession(rolePermissions)) {
+        node.setRolePermissions([...rolePermissions, ...browseForEverySession]);
+    }
+    for (const child of node.findReferencesExAsObject("Aggregates", node_opcua_data_model_1.BrowseDirection.Forward)) {
+        ensureStructureIsBrowsable(child);
+    }
+}
 //# sourceMappingURL=ensure_secure_access.js.map

package/dist/api/helpers/ensure_secure_access.js.map

@@ -1 +1 @@
-{"version":3,"file":"ensure_secure_access.js","sourceRoot":"","sources":["../../../api/helpers/ensure_secure_access.ts"],"names":[],"mappings":";;AA0DA,oDAmBC;AA5ED,iEAAmI;AACnI,uDAAuD;AACvD,8DAAuD;AAEvD,SAAS,gBAAgB,CAAC,OAAqB;IAC3C,IAAI,OAAO,CAAC,YAAY,KAAK,sCAAmB,CAAC,cAAc,EAAE,CAAC;QAC9D,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AAED;;;;;EAKE;AACF,MAAM,gBAAgB,GAAG;IACrB,EAAE,MAAM,EAAE,mCAAc,CAAC,aAAa,EAAE,WAAW,EAAE,sCAAc,EAAE;IACrE,EAAE,MAAM,EAAE,mCAAc,CAAC,cAAc,EAAE,WAAW,EAAE,sCAAc,EAAE;IACtE,EAAE,MAAM,EAAE,mCAAc,CAAC,UAAU,EAAE,WAAW,EAAE,sCAAc,EAAE;IAClE,EAAE,MAAM,EAAE,mCAAc,CAAC,QAAQ,EAAE,WAAW,EAAE,IAAA,0CAAkB,EAAC,QAAQ,CAAC,EAAE;IAC9E,EAAE,MAAM,EAAE,mCAAc,CAAC,QAAQ,EAAE,WAAW,EAAE,IAAA,0CAAkB,EAAC,QAAQ,CAAC,EAAE;IAC9E,EAAE,MAAM,EAAE,mCAAc,CAAC,QAAQ,EAAE,WAAW,EAAE,IAAA,0CAAkB,EAAC,QAAQ,CAAC,EAAE;CACjF,CAAC;AACF,8EAA8E;AAC9E,mFAAmF;AACnF,oFAAoF;AACpF,4CAA4C;AAC5C,MAAM,qBAAqB,GAAG;IAC1B,GAAG,gBAAgB;IACnB,EAAE,MAAM,EAAE,mCAAc,CAAC,SAAS,EAAE,WAAW,EAAE,IAAA,0CAAkB,EAAC,QAAQ,CAAC,EAAE;IAC/E,EAAE,MAAM,EAAE,mCAAc,CAAC,iBAAiB,EAAE,WAAW,EAAE,IAAA,0CAAkB,EAAC,QAAQ,CAAC,EAAE;CAC1F,CAAC;AACF,iEAAiE;AACjE,MAAM,iBAAiB,GAAG,gBAAgB,CAAC;AAE3C,MAAM,oBAAoB,GAAG,IAAA,kDAA0B,EAAC,sCAAsC,CAAC,CAAC;AAYhG;;;;;;;GAOG;AACH,SAAgB,oBAAoB,CAAC,IAAc,EAAE,UAAuC,EAAE;IAC1F,MAAM,WAAW,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,qBAAqB,CAAC;IACtF,IAAI,CAAC,qBAAqB,CAAC,oBAAoB,CAAC,CAAC;IACjD,IAAI,IAAI,CAAC,SAAS,KAAK,iCAAS,CAAC,QAAQ,EAAE,CAAC;QACxC,MAAM,QAAQ,GAAG,IAAkB,CAAC;QACpC,QAAQ,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC;IAC7C,CAAC;IACD,IAAI,IAAI,CAAC,SAAS,KAAK,iCAAS,CAAC,MAAM,EAAE,CAAC;QACtC,MAAM,MAAM,GAAG,IAAgB,CAAC;QAChC,MAAM,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC;IAC3C,CAAC;IACD,IAAI,IAAI,CAAC,SAAS,KAAK,iCAAS,CAAC,MAAM,EAAE,CAAC;QACtC,MAAM,MAAM,GAAG,IAAgB,CAAC;QAChC,MAAM,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC;IAC3C,CAAC;IACD,MAAM,QAAQ,GAAG,IAAI,CAAC,wBAAwB,CAAC,YAAY,EAAE,uCAAe,CAAC,OAAO,CAAC,CAAC;IACtF,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE,CAAC;QAC3B,oBAAoB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACzC,CAAC;AACL,CAAC"}
+{"version":3,"file":"ensure_secure_access.js","sourceRoot":"","sources":["../../../api/helpers/ensure_secure_access.ts"],"names":[],"mappings":";;AAiEA,oDAmBC;AAoCD,gEAQC;AA/HD,iEAO+B;AAC/B,uDAAgF;AAChF,8DAAuD;AAEvD,SAAS,gBAAgB,CAAC,OAAqB;IAC3C,IAAI,OAAO,CAAC,YAAY,KAAK,sCAAmB,CAAC,cAAc,EAAE,CAAC;QAC9D,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AAED;;;;;EAKE;AACF,MAAM,gBAAgB,GAAG;IACrB,EAAE,MAAM,EAAE,mCAAc,CAAC,aAAa,EAAE,WAAW,EAAE,sCAAc,EAAE;IACrE,EAAE,MAAM,EAAE,mCAAc,CAAC,cAAc,EAAE,WAAW,EAAE,sCAAc,EAAE;IACtE,EAAE,MAAM,EAAE,mCAAc,CAAC,UAAU,EAAE,WAAW,EAAE,sCAAc,EAAE;IAClE,EAAE,MAAM,EAAE,mCAAc,CAAC,QAAQ,EAAE,WAAW,EAAE,IAAA,0CAAkB,EAAC,QAAQ,CAAC,EAAE;IAC9E,EAAE,MAAM,EAAE,mCAAc,CAAC,QAAQ,EAAE,WAAW,EAAE,IAAA,0CAAkB,EAAC,QAAQ,CAAC,EAAE;IAC9E,EAAE,MAAM,EAAE,mCAAc,CAAC,QAAQ,EAAE,WAAW,EAAE,IAAA,0CAAkB,EAAC,QAAQ,CAAC,EAAE;CACjF,CAAC;AACF,8EAA8E;AAC9E,mFAAmF;AACnF,oFAAoF;AACpF,4CAA4C;AAC5C,MAAM,qBAAqB,GAAG;IAC1B,GAAG,gBAAgB;IACnB,EAAE,MAAM,EAAE,mCAAc,CAAC,SAAS,EAAE,WAAW,EAAE,IAAA,0CAAkB,EAAC,QAAQ,CAAC,EAAE;IAC/E,EAAE,MAAM,EAAE,mCAAc,CAAC,iBAAiB,EAAE,WAAW,EAAE,IAAA,0CAAkB,EAAC,QAAQ,CAAC,EAAE;CAC1F,CAAC;AACF,iEAAiE;AACjE,MAAM,iBAAiB,GAAG,gBAAgB,CAAC;AAE3C,MAAM,oBAAoB,GAAG,IAAA,kDAA0B,EAAC,sCAAsC,CAAC,CAAC;AAYhG;;;;;;;GAOG;AACH,SAAgB,oBAAoB,CAAC,IAAc,EAAE,UAAuC,EAAE;IAC1F,MAAM,WAAW,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,qBAAqB,CAAC;IACtF,IAAI,CAAC,qBAAqB,CAAC,oBAAoB,CAAC,CAAC;IACjD,IAAI,IAAI,CAAC,SAAS,KAAK,iCAAS,CAAC,QAAQ,EAAE,CAAC;QACxC,MAAM,QAAQ,GAAG,IAAkB,CAAC;QACpC,QAAQ,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC;IAC7C,CAAC;IACD,IAAI,IAAI,CAAC,SAAS,KAAK,iCAAS,CAAC,MAAM,EAAE,CAAC;QACtC,MAAM,MAAM,GAAG,IAAgB,CAAC;QAChC,MAAM,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC;IAC3C,CAAC;IACD,IAAI,IAAI,CAAC,SAAS,KAAK,iCAAS,CAAC,MAAM,EAAE,CAAC;QACtC,MAAM,MAAM,GAAG,IAAgB,CAAC;QAChC,MAAM,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC;IAC3C,CAAC;IACD,MAAM,QAAQ,GAAG,IAAI,CAAC,wBAAwB,CAAC,YAAY,EAAE,uCAAe,CAAC,OAAO,CAAC,CAAC;IACtF,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE,CAAC;QAC3B,oBAAoB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACzC,CAAC;AACL,CAAC;AAED,uGAAuG;AACvG,MAAM,qBAAqB,GAAG;IAC1B,EAAE,MAAM,EAAE,mCAAc,CAAC,SAAS,EAAE,WAAW,EAAE,IAAA,0CAAkB,EAAC,QAAQ,CAAC,EAAE;IAC/E,EAAE,MAAM,EAAE,mCAAc,CAAC,iBAAiB,EAAE,WAAW,EAAE,IAAA,0CAAkB,EAAC,QAAQ,CAAC,EAAE;CAC1F,CAAC;AAEF,SAAS,0BAA0B,CAAC,eAAqC;IACrE,OAAO,eAAe,CAAC,IAAI,CACvB,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,EAAE,EAAE,CACxB,CAAC,WAAW,GAAG,sCAAc,CAAC,MAAM,CAAC,KAAK,CAAC;QAC3C,MAAM,CAAC,SAAS,KAAK,CAAC;QACtB,CAAC,MAAM,CAAC,KAAK,KAAK,mCAAc,CAAC,SAAS,IAAI,MAAM,CAAC,KAAK,KAAK,mCAAc,CAAC,iBAAiB,CAAC,CACvG,CAAC;AACN,CAAC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,SAAgB,0BAA0B,CAAC,IAAc;IACrD,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC;IAC7C,IAAI,eAAe,IAAI,CAAC,0BAA0B,CAAC,eAAe,CAAC,EAAE,CAAC;QAClE,IAAI,CAAC,kBAAkB,CAAC,CAAC,GAAG,eAAe,EAAE,GAAG,qBAAqB,CAAC,CAAC,CAAC;IAC5E,CAAC;IACD,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,wBAAwB,CAAC,YAAY,EAAE,uCAAe,CAAC,OAAO,CAAC,EAAE,CAAC;QACvF,0BAA0B,CAAC,KAAK,CAAC,CAAC;IACtC,CAAC;AACL,CAAC"}

package/dist/api/index.d.ts

@@ -92,14 +92,19 @@ export * from "./interfaces/state_machine/ua_transition_ex.js";
 export * from "./interfaces/ua_subscription_diagnostics_variable_ex.js";
 export { ensureDatatypeExtracted, ensureDatatypeExtractedWithCallback } from "./loader/ensure_datatype_extracted.js";
 export * from "./loader/generateAddressSpaceRaw.js";
-export { imageLinesToRecords, imageNodesetRecords, inflatedImageLines, isNodesetImage, NodesetImageError, type NodesetImageHeader, type NodesetImageTrailer, NodesetImageWriter, type NodesetImageWriterOptions, nodesetImageProblem, type ReadNodesetImageOptions, readNodesetImageInfo, setImageInflater } from "./loader/nodeset_image.js";
+export { type NarrowedDataType, narrowInstanceDataTypes } from "./loader/narrow_instance_datatypes.js";
+export { isNdjsonHeaderLine, NDJSON_IMAGE_FORMAT, NODESET2_XML_FORMAT, registerBuiltinNodesetFormats } from "./loader/nodeset_builtin_formats.js";
+export { findNodesetFormat, type NodesetDocument, type NodesetFormat, type NodesetHead, type NodesetModel, type NodesetModelInfo, nodesetFormatByName, nodesetFormats, registerNodesetFormat } from "./loader/nodeset_format.js";
+export { type ImageDeflater, imageLinesToRecords, imageNodesetRecords, inflatedImageLines, isNodesetImage, NodesetImageError, type NodesetImageHeader, type NodesetImageTrailer, NodesetImageWriter, type NodesetImageWriterOptions, nodesetImageProblem, type ReadNodesetImageOptions, readNodesetImageInfo, setImageDeflater, setImageInflater } from "./loader/nodeset_image.js";
 export { decodeValue, encodeValue, type JsonNodeId, type JsonQualifiedName, type JsonValue } from "./loader/nodeset_image_codec.js";
 export { MemoryNodesetImageStore, type NodesetImageStore, nodesetImageKey, sharedMemoryNodesetImageStore } from "./loader/nodeset_image_store.js";
 export { NODESET_RECORD_SCHEMA, type NodesetDataTypeDefinitionRecord, type NodesetDefinitionField, type NodesetHeaderRecord, type NodesetModelRecord, type NodesetNodeRecord, type NodesetRecord, type NodesetRecordConsumer, type NodesetRecordProducer, type NodesetReferenceRecord, type NodesetRolePermissionRecord, recordBytes, XmlExtensionObjectFragment } from "./loader/nodeset_record.js";
-export type { NamedNodesetSource, NodesetChunk, NodesetChunkStream, NodesetSource } from "./loader/nodeset_source.js";
+export { type RecordsToNodeset2XMLOptions, recordsToNodeset2XML } from "./loader/nodeset_records_to_xml.js";
+export type { NamedNodesetSource, NodesetChunk, NodesetChunkStream, NodesetContainer, NodesetSource, NodesetSourceKind } from "./loader/nodeset_source.js";
 export { sha256Hex } from "./loader/nodeset_source.js";
 export * from "./loader/nodeset_source_helpers.js";
 export { type NodesetToImageOptions, nodesetToImage } from "./loader/nodeset_to_image.js";
+export { headerComplete, parseDependencies, sliceHeader } from "./loader/nodeset_xml_header.js";
 export { makeXmlNodesetRecordReader, type XmlNodesetRecordReader, xmlNodesetRecords } from "./loader/nodeset_xml_producer.js";
 export * from "./loader/register_node_promoter.js";
 export * from "./namespace.js";