node-opcua-address-space 2.179.0 → 2.181.0

package/distNodeJS/generate_address_space.js

@@ -1,28 +1,222 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.readNodeSet2XmlFile = readNodeSet2XmlFile;
+exports.nodesetSourceFromFile = nodesetSourceFromFile;
+exports.nodesetSourceFromGzipFile = nodesetSourceFromGzipFile;
+exports.nodesetSourceFromFileWhole = nodesetSourceFromFileWhole;
+exports.siblingImageFileOf = siblingImageFileOf;
+exports.addressSpacePackageVersion = addressSpacePackageVersion;
 exports.generateAddressSpace = generateAddressSpace;
+exports.nodesetFileToImage = nodesetFileToImage;
 const node_fs_1 = __importDefault(require("node:fs"));
+const node_path_1 = __importDefault(require("node:path"));
+const node_util_1 = require("node:util");
+const node_zlib_1 = __importStar(require("node:zlib"));
 const node_opcua_debug_1 = require("node-opcua-debug");
-const __1 = require("..");
-const _doDebug = (0, node_opcua_debug_1.checkDebugFlag)(__filename);
-const debugLog = (0, node_opcua_debug_1.make_debugLog)(__filename);
-const errorLog = (0, node_opcua_debug_1.make_errorLog)(__filename);
-async function readNodeSet2XmlFile(xmlFile) {
+const index_js_1 = require("../dist/api/index.js");
+const nodeset_image_file_store_js_1 = require("./nodeset_image_file_store.js");
+// an image given whole inflates through zlib here: a third of the cost of DecompressionStream on
+// a 200 KB image, and in the thread pool, so that the XML hash runs alongside
+const gunzipAsync = (0, node_util_1.promisify)(node_zlib_1.gunzip);
+(0, index_js_1.setImageInflater)(async (image) => (await gunzipAsync(image)).toString("utf8"));
+const _doDebug = (0, node_opcua_debug_1.checkDebugFlag)("generate_address_space");
+const debugLog = (0, node_opcua_debug_1.make_debugLog)("generate_address_space");
+const errorLog = (0, node_opcua_debug_1.make_errorLog)("generate_address_space");
+function checkNodeSet2XmlFileExists(xmlFile) {
     // c8 ignore next
     if (!node_fs_1.default.existsSync(xmlFile)) {
         const msg = `[NODE-OPCUA-E02] generateAddressSpace : cannot find nodeset2 xml file at ${xmlFile}`;
         errorLog(msg);
         throw new Error(msg);
     }
-    debugLog(" parsing ", xmlFile);
+}
+async function readNodeSet2XmlFile(xmlFile) {
+    checkNodeSet2XmlFileExists(xmlFile);
+    if (_doDebug) {
+        debugLog(" parsing ", xmlFile);
+    }
     const xmlData = await node_fs_1.default.promises.readFile(xmlFile, "utf-8");
     return xmlData;
 }
+/** the chunk size of a nodeset file stream: a few dozen chunks for the standard nodeset */
+const FILE_CHUNK_SIZE = 256 * 1024;
+/**
+ * a NodeSet2 file as a source the loader reads in chunks, opened when the loader gets to it
+ */
+function nodesetSourceFromFile(xmlFile) {
+    return {
+        name: xmlFile,
+        source: () => {
+            checkNodeSet2XmlFileExists(xmlFile);
+            if (_doDebug) {
+                debugLog(" parsing ", xmlFile);
+            }
+            return node_fs_1.default.createReadStream(xmlFile, { highWaterMark: FILE_CHUNK_SIZE });
+        }
+    };
+}
+/**
+ * a gzip-compressed NodeSet2 file (`<name>.xml.gz`), inflated on the way, opened when the loader
+ * gets to it
+ */
+function nodesetSourceFromGzipFile(gzipFile) {
+    return {
+        name: gzipFile,
+        source: () => {
+            checkNodeSet2XmlFileExists(gzipFile);
+            return node_fs_1.default.createReadStream(gzipFile, { highWaterMark: FILE_CHUNK_SIZE }).pipe(node_zlib_1.default.createGunzip());
+        }
+    };
+}
+/**
+ * a NodeSet2 file read whole: what an image store needs, since the digest of the bytes is the
+ * key and a stream can only be hashed once it has been parsed
+ */
+function nodesetSourceFromFileWhole(xmlFile) {
+    checkNodeSet2XmlFileExists(xmlFile);
+    return { name: xmlFile, source: () => [new Uint8Array(node_fs_1.default.readFileSync(xmlFile))] };
+}
+/** the image that sits next to a NodeSet2 file: <name>.ndjson.gz */
+function siblingImageFileOf(xmlFile) {
+    return xmlFile.replace(/\.xml$/i, ".ndjson.gz");
+}
+/**
+ * the sibling store: when `<file>.ndjson.gz` sits next to `<file>.xml` and its trailer digest is
+ * the SHA-256 of the XML bytes, the image is what the loader gets; otherwise the XML is. The
+ * digest check is not optional and not cached: an XML edited in place next to a stale image
+ * loads from the XML. Nothing is written here; writing images is the opt-in `imageStore`.
+ * Returns the source to load, and which path was taken for the debug log.
+ */
+async function siblingOrXml(xmlFile) {
+    checkNodeSet2XmlFileExists(xmlFile);
+    // the XML is read only when it is going to be parsed or hashed; the image decision starts
+    // with what costs nothing: its size
+    let xmlBytes;
+    const readXml = () => {
+        xmlBytes = xmlBytes || node_fs_1.default.promises.readFile(xmlFile).then((buffer) => new Uint8Array(buffer));
+        return xmlBytes;
+    };
+    const asXml = async (reason) => {
+        const xml = await readXml();
+        return { source: { name: xmlFile, source: () => [xml] }, path: "xml", reason };
+    };
+    const imageFile = siblingImageFileOf(xmlFile);
+    let image;
+    try {
+        image = new Uint8Array(node_fs_1.default.readFileSync(imageFile));
+    }
+    catch {
+        return asXml("no image next to it");
+    }
+    try {
+        // the inflate (zlib, off the main thread) and the hash of the XML (web crypto, off the
+        // main thread too) run alongside; the digest is what decides, the length only rejects early
+        const infoPending = (0, index_js_1.readNodesetImageInfo)(image);
+        const digestPending = readXml().then(index_js_1.sha256Hex);
+        digestPending.catch(() => undefined);
+        const info = await infoPending;
+        const sourceLength = info.header.sourceLength;
+        if (sourceLength !== undefined && sourceLength !== node_fs_1.default.statSync(xmlFile).size) {
+            return asXml(`the image is stale: it was built from ${sourceLength} bytes, the XML has ${node_fs_1.default.statSync(xmlFile).size}`);
+        }
+        // a catalog package older or newer than this loader, a stale or truncated image: its XML is still right
+        const problem = (0, index_js_1.nodesetImageProblem)(info, await digestPending);
+        if (problem)
+            return asXml(problem);
+    }
+    catch (err) {
+        return asXml(`the image cannot be read: ${err.message}`);
+    }
+    return { source: { name: `${xmlFile} (image)`, source: image }, path: "image" };
+}
+/** the version this package was built as, for the header of the images it writes */
+function addressSpacePackageVersion() {
+    try {
+        const packageJson = JSON.parse(node_fs_1.default.readFileSync(node_path_1.default.join(__dirname, "..", "package.json"), "utf8"));
+        return packageJson.version ?? "unknown";
+    }
+    catch {
+        return "unknown";
+    }
+}
+/**
+ * load NodeSet2 documents into an address space: file paths, and {@link NodesetSource} values
+ * for a document that is not a file (a gzip stream, an HTTP response, a string of XML). A
+ * string in the list is always a path here; content and streams go through a source.
+ *
+ * A file with a valid precompiled image next to it (`<name>.ndjson.gz`, the catalog ships one
+ * for every nodeset) is replayed from the image, with nothing to configure. With `imageStore`,
+ * a file without one is hashed and its image replayed when the store has it, written
+ * otherwise; `true` selects the per-user file store ({@link FileNodesetImageStore}).
+ * `imageStore: false` disables the sibling images too and streams the XML, for tests and for
+ * bisecting. The documents load in dependency order whatever the order given; a model one of
+ * them requires may also be one the address space holds already, from an earlier call.
+ */
 async function generateAddressSpace(addressSpace, xmlFiles, options) {
-    await (0, __1.generateAddressSpaceRaw)(addressSpace, xmlFiles, readNodeSet2XmlFile, options || {});
+    const documents = Array.isArray(xmlFiles) ? xmlFiles : [xmlFiles];
+    const loaderOptions = { ...(options || {}) };
+    if (loaderOptions.imageStore === false) {
+        // no sibling images, no store: the XML files, streamed
+        const sources = documents.map((document) => (typeof document === "string" ? nodesetSourceFromFile(document) : document));
+        await (0, index_js_1.generateAddressSpaceRaw)(addressSpace, sources, { ...loaderOptions, imageStore: undefined });
+        return;
+    }
+    if (loaderOptions.imageStore === true) {
+        loaderOptions.imageStore = new nodeset_image_file_store_js_1.FileNodesetImageStore();
+    }
+    // the sibling store first: a catalog image is replayed with nothing to configure; what has
+    // no valid image next to it goes through the XML, and through the store when there is one
+    const sources = [];
+    for (const document of documents) {
+        if (typeof document !== "string") {
+            sources.push(document);
+            continue;
+        }
+        const { source, path: taken, reason } = await siblingOrXml(document);
+        debugLog(`generateAddressSpace: ${node_path_1.default.basename(document)} from ${taken}${reason ? ` (${reason})` : ""}`);
+        sources.push(source);
+    }
+    await (0, index_js_1.generateAddressSpaceRaw)(addressSpace, sources, loaderOptions);
+}
+/** the precompiled image of a NodeSet2 file or source, stamped with this package's version */
+async function nodesetFileToImage(source, options = {}) {
+    const resolved = typeof source === "string" && !source.trimStart().startsWith("<") ? nodesetSourceFromFileWhole(source) : source;
+    return (0, index_js_1.nodesetToImage)(resolved, { addressSpaceVersion: addressSpacePackageVersion(), ...options });
 }
 //# sourceMappingURL=generate_address_space.js.map

package/distNodeJS/generate_address_space.js.map

@@ -1 +1 @@
-{"version":3,"file":"generate_address_space.js","sourceRoot":"","sources":["../source_nodejs/generate_address_space.ts"],"names":[],"mappings":";;;;;AASA,kDAUC;AAED,oDAMC;AA3BD,sDAAyB;AAEzB,uDAAgF;AAChF,0BAAwE;AAExE,MAAM,QAAQ,GAAG,IAAA,iCAAc,EAAC,UAAU,CAAC,CAAC;AAC5C,MAAM,QAAQ,GAAG,IAAA,gCAAa,EAAC,UAAU,CAAC,CAAC;AAC3C,MAAM,QAAQ,GAAG,IAAA,gCAAa,EAAC,UAAU,CAAC,CAAC;AAEpC,KAAK,UAAU,mBAAmB,CAAC,OAAe;IACrD,iBAAiB;IACjB,IAAI,CAAC,iBAAE,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;QAC1B,MAAM,GAAG,GAAG,4EAA4E,OAAO,EAAE,CAAC;QAClG,QAAQ,CAAC,GAAG,CAAC,CAAC;QACd,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;IACzB,CAAC;IACD,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IAC/B,MAAM,OAAO,GAAG,MAAM,iBAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC7D,OAAO,OAAO,CAAC;AACnB,CAAC;AAEM,KAAK,UAAU,oBAAoB,CACtC,YAA2B,EAC3B,QAA2B,EAC3B,OAA8B;IAE9B,MAAM,IAAA,2BAAuB,EAAC,YAAY,EAAE,QAAQ,EAAE,mBAAmB,EAAE,OAAO,IAAI,EAAE,CAAC,CAAC;AAC9F,CAAC"}
+{"version":3,"file":"generate_address_space.js","sourceRoot":"","sources":["../source_nodejs/generate_address_space.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsCA,kDAOC;AAQD,sDAWC;AAMD,8DAQC;AAMD,gEAGC;AAGD,gDAEC;AAkDD,gEAOC;AAeD,oDA6BC;AAGD,gDAIC;AAxMD,sDAAyB;AACzB,0DAA6B;AAC7B,yCAAsC;AACtC,uDAAyC;AAEzC,uDAAgF;AAChF,mDAW8B;AAC9B,+EAAsE;AAEtE,iGAAiG;AACjG,8EAA8E;AAC9E,MAAM,WAAW,GAAG,IAAA,qBAAS,EAAC,kBAAM,CAAC,CAAC;AACtC,IAAA,2BAAgB,EAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,MAAM,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;AAE/E,MAAM,QAAQ,GAAG,IAAA,iCAAc,EAAC,wBAAwB,CAAC,CAAC;AAC1D,MAAM,QAAQ,GAAG,IAAA,gCAAa,EAAC,wBAAwB,CAAC,CAAC;AACzD,MAAM,QAAQ,GAAG,IAAA,gCAAa,EAAC,wBAAwB,CAAC,CAAC;AAEzD,SAAS,0BAA0B,CAAC,OAAe;IAC/C,iBAAiB;IACjB,IAAI,CAAC,iBAAE,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;QAC1B,MAAM,GAAG,GAAG,4EAA4E,OAAO,EAAE,CAAC;QAClG,QAAQ,CAAC,GAAG,CAAC,CAAC;QACd,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;IACzB,CAAC;AACL,CAAC;AAEM,KAAK,UAAU,mBAAmB,CAAC,OAAe;IACrD,0BAA0B,CAAC,OAAO,CAAC,CAAC;IACpC,IAAI,QAAQ,EAAE,CAAC;QACX,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IACnC,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,iBAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC7D,OAAO,OAAO,CAAC;AACnB,CAAC;AAED,2FAA2F;AAC3F,MAAM,eAAe,GAAG,GAAG,GAAG,IAAI,CAAC;AAEnC;;GAEG;AACH,SAAgB,qBAAqB,CAAC,OAAe;IACjD,OAAO;QACH,IAAI,EAAE,OAAO;QACb,MAAM,EAAE,GAAG,EAAE;YACT,0BAA0B,CAAC,OAAO,CAAC,CAAC;YACpC,IAAI,QAAQ,EAAE,CAAC;gBACX,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;YACnC,CAAC;YACD,OAAO,iBAAE,CAAC,gBAAgB,CAAC,OAAO,EAAE,EAAE,aAAa,EAAE,eAAe,EAAE,CAAC,CAAC;QAC5E,CAAC;KACJ,CAAC;AACN,CAAC;AAED;;;GAGG;AACH,SAAgB,yBAAyB,CAAC,QAAgB;IACtD,OAAO;QACH,IAAI,EAAE,QAAQ;QACd,MAAM,EAAE,GAAG,EAAE;YACT,0BAA0B,CAAC,QAAQ,CAAC,CAAC;YACrC,OAAO,iBAAE,CAAC,gBAAgB,CAAC,QAAQ,EAAE,EAAE,aAAa,EAAE,eAAe,EAAE,CAAC,CAAC,IAAI,CAAC,mBAAI,CAAC,YAAY,EAAE,CAAC,CAAC;QACvG,CAAC;KACJ,CAAC;AACN,CAAC;AAED;;;GAGG;AACH,SAAgB,0BAA0B,CAAC,OAAe;IACtD,0BAA0B,CAAC,OAAO,CAAC,CAAC;IACpC,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,IAAI,UAAU,CAAC,iBAAE,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;AACvF,CAAC;AAED,oEAAoE;AACpE,SAAgB,kBAAkB,CAAC,OAAe;IAC9C,OAAO,OAAO,CAAC,OAAO,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;AACpD,CAAC;AAED;;;;;;GAMG;AACH,KAAK,UAAU,YAAY,CAAC,OAAe;IACvC,0BAA0B,CAAC,OAAO,CAAC,CAAC;IACpC,0FAA0F;IAC1F,oCAAoC;IACpC,IAAI,QAAyC,CAAC;IAC9C,MAAM,OAAO,GAAG,GAAG,EAAE;QACjB,QAAQ,GAAG,QAAQ,IAAI,iBAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;QAC9F,OAAO,QAAQ,CAAC;IACpB,CAAC,CAAC;IACF,MAAM,KAAK,GAAG,KAAK,EAAE,MAAe,EAAE,EAAE;QACpC,MAAM,GAAG,GAAG,MAAM,OAAO,EAAE,CAAC;QAC5B,OAAO,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC,EAAwB,EAAE,IAAI,EAAE,KAAc,EAAE,MAAM,EAAE,CAAC;IAClH,CAAC,CAAC;IACF,MAAM,SAAS,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC;IAC9C,IAAI,KAAiB,CAAC;IACtB,IAAI,CAAC;QACD,KAAK,GAAG,IAAI,UAAU,CAAC,iBAAE,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC;IACvD,CAAC;IAAC,MAAM,CAAC;QACL,OAAO,KAAK,CAAC,qBAAqB,CAAC,CAAC;IACxC,CAAC;IACD,IAAI,CAAC;QACD,uFAAuF;QACvF,4FAA4F;QAC5F,MAAM,WAAW,GAAG,IAAA,+BAAoB,EAAC,KAAK,CAAC,CAAC;QAChD,MAAM,aAAa,GAAG,OAAO,EAAE,CAAC,IAAI,CAAC,oBAAS,CAAC,CAAC;QAChD,aAAa,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;QACrC,MAAM,IAAI,GAAG,MAAM,WAAW,CAAC;QAC/B,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;QAC9C,IAAI,YAAY,KAAK,SAAS,IAAI,YAAY,KAAK,iBAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC;YAC3E,OAAO,KAAK,CAAC,yCAAyC,YAAY,uBAAuB,iBAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;QAC1H,CAAC;QACD,wGAAwG;QACxG,MAAM,OAAO,GAAG,IAAA,8BAAmB,EAAC,IAAI,EAAE,MAAM,aAAa,CAAC,CAAC;QAC/D,IAAI,OAAO;YAAE,OAAO,KAAK,CAAC,OAAO,CAAC,CAAC;IACvC,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACX,OAAO,KAAK,CAAC,6BAA8B,GAAa,CAAC,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;IACD,OAAO,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;AACpF,CAAC;AAED,oFAAoF;AACpF,SAAgB,0BAA0B;IACtC,IAAI,CAAC;QACD,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,iBAAE,CAAC,YAAY,CAAC,mBAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,cAAc,CAAC,EAAE,MAAM,CAAC,CAAyB,CAAC;QAC5H,OAAO,WAAW,CAAC,OAAO,IAAI,SAAS,CAAC;IAC5C,CAAC;IAAC,MAAM,CAAC;QACL,OAAO,SAAS,CAAC;IACrB,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;GAYG;AACI,KAAK,UAAU,oBAAoB,CACtC,YAA2B,EAC3B,QAAgD,EAChD,OAA8B;IAE9B,MAAM,SAAS,GAAG,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;IAClE,MAAM,aAAa,GAAyB,EAAE,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC,EAAE,CAAC;IACnE,IAAI,aAAa,CAAC,UAAU,KAAK,KAAK,EAAE,CAAC;QACrC,uDAAuD;QACvD,MAAM,OAAO,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,OAAO,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;QACzH,MAAM,IAAA,kCAAuB,EAAC,YAAY,EAAE,OAAO,EAAE,EAAE,GAAG,aAAa,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC,CAAC;QAClG,OAAO;IACX,CAAC;IACD,IAAI,aAAa,CAAC,UAAU,KAAK,IAAI,EAAE,CAAC;QACpC,aAAa,CAAC,UAAU,GAAG,IAAI,mDAAqB,EAAE,CAAC;IAC3D,CAAC;IACD,2FAA2F;IAC3F,0FAA0F;IAC1F,MAAM,OAAO,GAAoB,EAAE,CAAC;IACpC,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;QAC/B,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;YAC/B,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACvB,SAAS;QACb,CAAC;QACD,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,YAAY,CAAC,QAAQ,CAAC,CAAC;QACrE,QAAQ,CAAC,yBAAyB,mBAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,SAAS,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,KAAK,MAAM,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QAC1G,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACzB,CAAC;IACD,MAAM,IAAA,kCAAuB,EAAC,YAAY,EAAE,OAAO,EAAE,aAAa,CAAC,CAAC;AACxE,CAAC;AAED,8FAA8F;AACvF,KAAK,UAAU,kBAAkB,CAAC,MAA8B,EAAE,UAAiC,EAAE;IACxG,MAAM,QAAQ,GACV,OAAO,MAAM,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,0BAA0B,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;IACpH,OAAO,IAAA,yBAAiB,EAAC,QAAQ,EAAE,EAAE,mBAAmB,EAAE,0BAA0B,EAAE,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;AAC1G,CAAC"}

package/distNodeJS/index.d.ts

@@ -1 +1,3 @@
-export * from "./generate_address_space";
+export * from "./address_space_digest.js";
+export * from "./generate_address_space.js";
+export * from "./nodeset_image_file_store.js";

package/distNodeJS/index.js

@@ -14,5 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./generate_address_space"), exports);
+__exportStar(require("./address_space_digest.js"), exports);
+__exportStar(require("./generate_address_space.js"), exports);
+__exportStar(require("./nodeset_image_file_store.js"), exports);
 //# sourceMappingURL=index.js.map

package/distNodeJS/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../source_nodejs/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2DAAyC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../source_nodejs/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4DAA0C;AAC1C,8DAA4C;AAC5C,gEAA8C"}

package/distNodeJS/nodeset_image_file_store.d.ts

@@ -0,0 +1,29 @@
+import type { NodesetImageStore } from "../dist/api/index.js";
+export interface FileNodesetImageStoreOptions {
+    /**
+     * the directory; defaults to `NODE_OPCUA_NODESET_IMAGE_DIR`, then
+     * `$XDG_CACHE_HOME/node-opcua/nodeset-images`, then `~/.cache/node-opcua/nodeset-images`
+     */
+    directory?: string;
+    /** the size the store stays under, oldest images dropped first @default 256 MiB */
+    maxBytes?: number;
+}
+/** the default directory: per user, never the shared temp root, since a server trusts what it reads here */
+export declare function defaultNodesetImageDirectory(): string;
+/**
+ * the images in a directory of the user's, one file per key, written atomically; a corrupt or
+ * foreign file is the loader's to detect and this store's to replace; the store stays under a
+ * size by dropping the least recently written images
+ */
+export declare class FileNodesetImageStore implements NodesetImageStore {
+    readonly directory: string;
+    private readonly maxBytes;
+    constructor(options?: FileNodesetImageStoreOptions);
+    private fileOf;
+    get(key: string): Promise<Uint8Array | undefined>;
+    put(key: string, image: Uint8Array): Promise<void>;
+    /** drop the oldest images until the directory fits, never the one just written */
+    private evict;
+    /** the keys the directory holds */
+    keys(): Promise<string[]>;
+}

package/distNodeJS/nodeset_image_file_store.js

@@ -0,0 +1,120 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileNodesetImageStore = void 0;
+exports.defaultNodesetImageDirectory = defaultNodesetImageDirectory;
+const node_fs_1 = __importDefault(require("node:fs"));
+const node_os_1 = __importDefault(require("node:os"));
+const node_path_1 = __importDefault(require("node:path"));
+const node_opcua_debug_1 = require("node-opcua-debug");
+const debugLog = (0, node_opcua_debug_1.make_debugLog)("nodeset_image_file_store");
+/** the default directory: per user, never the shared temp root, since a server trusts what it reads here */
+function defaultNodesetImageDirectory() {
+    if (process.env.NODE_OPCUA_NODESET_IMAGE_DIR) {
+        return process.env.NODE_OPCUA_NODESET_IMAGE_DIR;
+    }
+    const cache = process.env.XDG_CACHE_HOME || node_path_1.default.join(node_os_1.default.homedir(), ".cache");
+    return node_path_1.default.join(cache, "node-opcua", "nodeset-images");
+}
+const IMAGE_EXTENSION = ".ndjson.gz";
+/**
+ * the images in a directory of the user's, one file per key, written atomically; a corrupt or
+ * foreign file is the loader's to detect and this store's to replace; the store stays under a
+ * size by dropping the least recently written images
+ */
+class FileNodesetImageStore {
+    directory;
+    maxBytes;
+    constructor(options = {}) {
+        this.directory = options.directory ?? defaultNodesetImageDirectory();
+        this.maxBytes = options.maxBytes ?? 256 * 1024 * 1024;
+    }
+    fileOf(key) {
+        if (!/^[A-Za-z0-9._-]+$/.test(key)) {
+            throw new Error(`FileNodesetImageStore: not a key: ${key}`);
+        }
+        return node_path_1.default.join(this.directory, key + IMAGE_EXTENSION);
+    }
+    async get(key) {
+        const file = this.fileOf(key);
+        let stat;
+        try {
+            stat = await node_fs_1.default.promises.stat(file);
+        }
+        catch {
+            return undefined;
+        }
+        if (!stat.isFile()) {
+            return undefined;
+        }
+        // on POSIX an image another user could have written is not one to trust
+        if (process.platform !== "win32" && (stat.mode & 0o022) !== 0) {
+            debugLog("ignoring an image writable by others:", file);
+            return undefined;
+        }
+        try {
+            const bytes = await node_fs_1.default.promises.readFile(file);
+            return new Uint8Array(bytes.buffer, bytes.byteOffset, bytes.byteLength);
+        }
+        catch (err) {
+            debugLog("cannot read", file, err.message);
+            return undefined;
+        }
+    }
+    async put(key, image) {
+        const file = this.fileOf(key);
+        await node_fs_1.default.promises.mkdir(this.directory, { recursive: true, mode: 0o700 });
+        const temp = `${file}.${process.pid}.${Math.random().toString(36).slice(2)}.tmp`;
+        await node_fs_1.default.promises.writeFile(temp, image, { mode: 0o600 });
+        await node_fs_1.default.promises.rename(temp, file);
+        await this.evict(file);
+    }
+    /** drop the oldest images until the directory fits, never the one just written */
+    async evict(keep) {
+        const names = (await node_fs_1.default.promises.readdir(this.directory)).filter((n) => n.endsWith(IMAGE_EXTENSION));
+        const entries = [];
+        for (const name of names) {
+            const file = node_path_1.default.join(this.directory, name);
+            try {
+                const stat = await node_fs_1.default.promises.stat(file);
+                entries.push({ file, size: stat.size, mtime: stat.mtimeMs });
+            }
+            catch {
+                /* gone meanwhile */
+            }
+        }
+        let total = entries.reduce((n, e) => n + e.size, 0);
+        entries.sort((a, b) => a.mtime - b.mtime);
+        for (const entry of entries) {
+            if (total <= this.maxBytes) {
+                break;
+            }
+            if (entry.file === keep) {
+                continue;
+            }
+            try {
+                await node_fs_1.default.promises.unlink(entry.file);
+                total -= entry.size;
+                debugLog("evicted", entry.file);
+            }
+            catch {
+                /* gone meanwhile */
+            }
+        }
+    }
+    /** the keys the directory holds */
+    async keys() {
+        try {
+            return (await node_fs_1.default.promises.readdir(this.directory))
+                .filter((n) => n.endsWith(IMAGE_EXTENSION))
+                .map((n) => n.slice(0, -IMAGE_EXTENSION.length));
+        }
+        catch {
+            return [];
+        }
+    }
+}
+exports.FileNodesetImageStore = FileNodesetImageStore;
+//# sourceMappingURL=nodeset_image_file_store.js.map

package/distNodeJS/nodeset_image_file_store.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"nodeset_image_file_store.js","sourceRoot":"","sources":["../source_nodejs/nodeset_image_file_store.ts"],"names":[],"mappings":";;;;;;AAmBA,oEAMC;AAzBD,sDAAyB;AACzB,sDAAyB;AACzB,0DAA6B;AAC7B,uDAAiD;AAGjD,MAAM,QAAQ,GAAG,IAAA,gCAAa,EAAC,0BAA0B,CAAC,CAAC;AAY3D,4GAA4G;AAC5G,SAAgB,4BAA4B;IACxC,IAAI,OAAO,CAAC,GAAG,CAAC,4BAA4B,EAAE,CAAC;QAC3C,OAAO,OAAO,CAAC,GAAG,CAAC,4BAA4B,CAAC;IACpD,CAAC;IACD,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,cAAc,IAAI,mBAAI,CAAC,IAAI,CAAC,iBAAE,CAAC,OAAO,EAAE,EAAE,QAAQ,CAAC,CAAC;IAC9E,OAAO,mBAAI,CAAC,IAAI,CAAC,KAAK,EAAE,YAAY,EAAE,gBAAgB,CAAC,CAAC;AAC5D,CAAC;AAED,MAAM,eAAe,GAAG,YAAY,CAAC;AAErC;;;;GAIG;AACH,MAAa,qBAAqB;IACd,SAAS,CAAS;IACjB,QAAQ,CAAS;IAElC,YAAY,UAAwC,EAAE;QAClD,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,4BAA4B,EAAE,CAAC;QACrE,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,GAAG,GAAG,IAAI,GAAG,IAAI,CAAC;IAC1D,CAAC;IAEO,MAAM,CAAC,GAAW;QACtB,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;YACjC,MAAM,IAAI,KAAK,CAAC,qCAAqC,GAAG,EAAE,CAAC,CAAC;QAChE,CAAC;QACD,OAAO,mBAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,GAAG,eAAe,CAAC,CAAC;IAC5D,CAAC;IAEM,KAAK,CAAC,GAAG,CAAC,GAAW;QACxB,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAC9B,IAAI,IAAc,CAAC;QACnB,IAAI,CAAC;YACD,IAAI,GAAG,MAAM,iBAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxC,CAAC;QAAC,MAAM,CAAC;YACL,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;YACjB,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,wEAAwE;QACxE,IAAI,OAAO,CAAC,QAAQ,KAAK,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;YAC5D,QAAQ,CAAC,uCAAuC,EAAE,IAAI,CAAC,CAAC;YACxD,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,IAAI,CAAC;YACD,MAAM,KAAK,GAAG,MAAM,iBAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC/C,OAAO,IAAI,UAAU,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;QAC5E,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,QAAQ,CAAC,aAAa,EAAE,IAAI,EAAG,GAAa,CAAC,OAAO,CAAC,CAAC;YACtD,OAAO,SAAS,CAAC;QACrB,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,GAAG,CAAC,GAAW,EAAE,KAAiB;QAC3C,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAC9B,MAAM,iBAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;QAC1E,MAAM,IAAI,GAAG,GAAG,IAAI,IAAI,OAAO,CAAC,GAAG,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC;QACjF,MAAM,iBAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;QAC1D,MAAM,iBAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACrC,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC3B,CAAC;IAED,kFAAkF;IAC1E,KAAK,CAAC,KAAK,CAAC,IAAY;QAC5B,MAAM,KAAK,GAAG,CAAC,MAAM,iBAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC,CAAC;QACrG,MAAM,OAAO,GAAyD,EAAE,CAAC;QACzE,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACvB,MAAM,IAAI,GAAG,mBAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;YAC7C,IAAI,CAAC;gBACD,MAAM,IAAI,GAAG,MAAM,iBAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC1C,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;YACjE,CAAC;YAAC,MAAM,CAAC;gBACL,oBAAoB;YACxB,CAAC;QACL,CAAC;QACD,IAAI,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;QACpD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC;QAC1C,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;YAC1B,IAAI,KAAK,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACzB,MAAM;YACV,CAAC;YACD,IAAI,KAAK,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;gBACtB,SAAS;YACb,CAAC;YACD,IAAI,CAAC;gBACD,MAAM,iBAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBACrC,KAAK,IAAI,KAAK,CAAC,IAAI,CAAC;gBACpB,QAAQ,CAAC,SAAS,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;YACpC,CAAC;YAAC,MAAM,CAAC;gBACL,oBAAoB;YACxB,CAAC;QACL,CAAC;IACL,CAAC;IAED,mCAAmC;IAC5B,KAAK,CAAC,IAAI;QACb,IAAI,CAAC;YACD,OAAO,CAAC,MAAM,iBAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;iBAC7C,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;iBAC1C,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC;QACzD,CAAC;QAAC,MAAM,CAAC;YACL,OAAO,EAAE,CAAC;QACd,CAAC;IACL,CAAC;CACJ;AA5FD,sDA4FC"}

package/impl/_instantiate_helpers.ts

@@ -0,0 +1,197 @@
+/**
+ * @module node-opcua-address-space
+ */
+import chalk from "chalk";
+import {
+    CloneHelper,
+    reconstructFunctionalGroupType,
+    reconstructNonHierarchicalReferences,
+    type UAMethod,
+    type UAObject,
+    type UAObjectType,
+    type UAVariable,
+    type UAVariableType
+} from "node-opcua-address-space-base";
+import { BrowseDirection } from "node-opcua-data-model";
+import { checkDebugFlag, make_errorLog, make_warningLog } from "node-opcua-debug";
+import { resolveNodeId, sameNodeId } from "node-opcua-nodeid";
+import { makeOptionalsMap, type OptionalMap } from "../api/helpers/make_optionals_map.js";
+import { MandatoryChildOrRequestedOptionalFilter } from "./_mandatory_child_or_requested_optional_filter.js";
+import { _clone_hierarchical_references } from "./base_node_private.js";
+
+// const debugLog = make_debugLog("INSTANTIATE");
+// const doDebug = checkDebugFlag("INSTANTIATE");
+const warningLog = make_warningLog("INSTANTIATE");
+const errorLog = make_errorLog("INSTANTIATE");
+
+const doTrace = 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<B extends UAObject | UAVariable | UAMethod, T extends UAObjectType | UAVariableType>(
+    instance: B,
+    topMostType: T,
+    typeDefinitionNode: T,
+    copyAlsoModellingRules: boolean,
+    copyAlsoAllOptionals: boolean,
+    optionalsMap: OptionalMap,
+    extraInfo: CloneHelper,
+    browseNameMap: Set<string>
+) {
+    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 (sameNodeId(topMostType.nodeId, typeDefinitionNode.nodeId)) {
+        return; // nothing to do
+    }
+
+    const filter = new MandatoryChildOrRequestedOptionalFilter(instance, copyAlsoAllOptionals, optionalsMap);
+
+    doTrace &&
+        traceLog(
+            chalk.cyan(extraInfo.pad(), "cloning relevant member of typeDefinition class"),
+            `${typeDefinitionNode.browseName.toString()}\n optionals${JSON.stringify(optionalsMap)}`
+        );
+
+    _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.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.red("Cannot find object with nodeId ") + baseTypeDefinitionNodeId);
+    }
+    extraInfo.level++;
+    _initialize_properties_and_components(
+        instance,
+        topMostType,
+        baseTypeDefinition,
+        copyAlsoModellingRules,
+        copyAlsoAllOptionals,
+        optionalsMap,
+        extraInfo,
+        browseNameMap
+    );
+    extraInfo.level--;
+}
+
+export function initialize_properties_and_components<
+    B extends UAObject | UAVariable | UAMethod,
+    T extends UAVariableType | UAObjectType
+>(
+    instance: B,
+    topMostType: T,
+    nodeType: T,
+    copyAlsoModellingRules: boolean,
+    copyAlsoAllOptionals: boolean,
+    optionals?: string[]
+): void {
+    const extraInfo = new CloneHelper();
+
+    extraInfo.pushContext({
+        clonedParent: instance,
+        originalParent: nodeType
+    });
+    extraInfo.registerClonedObject({
+        clonedNode: instance,
+        originalNode: nodeType
+    });
+
+    const optionalsMap = makeOptionalsMap(optionals);
+
+    const browseNameMap = new Set<string>();
+
+    _initialize_properties_and_components(
+        instance,
+        topMostType,
+        nodeType,
+        copyAlsoModellingRules,
+        copyAlsoAllOptionals,
+        optionalsMap,
+        extraInfo,
+        browseNameMap
+    );
+
+    // instantiate optionals from interfaces
+    instantiate_interface_children<B>(
+        nodeType,
+        extraInfo,
+        instance,
+        copyAlsoModellingRules,
+        copyAlsoAllOptionals,
+        optionalsMap,
+        browseNameMap
+    );
+
+    reconstructFunctionalGroupType(extraInfo);
+
+    reconstructNonHierarchicalReferences(extraInfo);
+}
+
+function instantiate_interface_children<B extends UAObject | UAVariable | UAMethod>(
+    nodeType: UAObjectType | UAVariableType,
+    extraInfo: CloneHelper,
+    instance: B,
+    copyAlsoModellingRules: boolean,
+    copyAlsoAllOptionals: boolean,
+    optionalsMap: OptionalMap,
+    browseNameMap: Set<string>
+) {
+    const interfaces = nodeType.findReferencesEx(resolveNodeId("HasInterface"), BrowseDirection.Forward);
+    if (interfaces.length === 0) {
+        return;
+    }
+    for (const reference of interfaces) {
+        const interfaceType = (reference.node as UAObjectType) || 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.cyan(extraInfo.pad(), "instantiating optionals from interface"),
+                `${interfaceType.browseName.toString()}`
+            );
+        _initialize_properties_and_components(
+            instance,
+            topMostTypeBaseInterface,
+            interfaceType,
+            copyAlsoModellingRules,
+            copyAlsoAllOptionals,
+            optionalsMap,
+            extraInfo,
+            browseNameMap
+        );
+    }
+}