node-opcua-address-space 2.98.2 → 2.100.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "node-opcua-address-space",
-    "version": "2.98.2",
+    "version": "2.100.0",
     "description": "pure nodejs OPCUA SDK - module address-space",
     "main": "./dist/src/index_current.js",
     "types": "./dist/source/index.d.ts",
@@ -22,36 +22,36 @@
         "chalk": "4.1.2",
         "dequeue": "^1.0.5",
         "lodash": "4.17.21",
-        "node-opcua-address-space-base": "2.98.2",
+        "node-opcua-address-space-base": "2.100.0",
         "node-opcua-assert": "2.98.1",
-        "node-opcua-basic-types": "2.98.1",
+        "node-opcua-basic-types": "2.99.0",
         "node-opcua-binary-stream": "2.98.1",
-        "node-opcua-client-dynamic-extension-object": "2.98.2",
+        "node-opcua-client-dynamic-extension-object": "2.99.0",
         "node-opcua-constants": "2.98.1",
         "node-opcua-crypto": "^2.1.2",
-        "node-opcua-data-access": "2.98.2",
-        "node-opcua-data-model": "2.98.1",
-        "node-opcua-data-value": "2.98.1",
-        "node-opcua-date-time": "2.98.1",
-        "node-opcua-debug": "2.98.1",
+        "node-opcua-data-access": "2.99.0",
+        "node-opcua-data-model": "2.99.0",
+        "node-opcua-data-value": "2.99.0",
+        "node-opcua-date-time": "2.99.0",
+        "node-opcua-debug": "2.99.0",
         "node-opcua-enum": "2.98.1",
-        "node-opcua-extension-object": "2.98.1",
-        "node-opcua-factory": "2.98.1",
-        "node-opcua-nodeid": "2.98.1",
-        "node-opcua-nodeset-ua": "2.98.2",
-        "node-opcua-numeric-range": "2.98.1",
-        "node-opcua-object-registry": "2.98.1",
-        "node-opcua-pseudo-session": "2.98.2",
-        "node-opcua-service-browse": "2.98.2",
-        "node-opcua-service-call": "2.98.2",
-        "node-opcua-service-history": "2.98.2",
-        "node-opcua-service-translate-browse-path": "2.98.2",
-        "node-opcua-service-write": "2.98.2",
+        "node-opcua-extension-object": "2.99.0",
+        "node-opcua-factory": "2.99.0",
+        "node-opcua-nodeid": "2.99.0",
+        "node-opcua-nodeset-ua": "2.100.0",
+        "node-opcua-numeric-range": "2.99.0",
+        "node-opcua-object-registry": "2.99.0",
+        "node-opcua-pseudo-session": "2.99.0",
+        "node-opcua-service-browse": "2.99.0",
+        "node-opcua-service-call": "2.99.0",
+        "node-opcua-service-history": "2.99.0",
+        "node-opcua-service-translate-browse-path": "2.99.0",
+        "node-opcua-service-write": "2.99.0",
         "node-opcua-status-code": "2.98.1",
-        "node-opcua-types": "2.98.2",
+        "node-opcua-types": "2.99.0",
         "node-opcua-utils": "2.98.1",
-        "node-opcua-variant": "2.98.1",
-        "node-opcua-xml2json": "2.98.2",
+        "node-opcua-variant": "2.99.0",
+        "node-opcua-xml2json": "2.99.0",
         "semver": "^7.3.8",
         "set-prototype-of": "^1.0.0",
         "thenify": "^3.3.1",
@@ -60,11 +60,11 @@
     "devDependencies": {
         "mocha": "^10.2.0",
         "node-opcua-benchmarker": "2.98.1",
-        "node-opcua-leak-detector": "2.98.1",
-        "node-opcua-nodesets": "2.98.2",
-        "node-opcua-packet-analyzer": "2.98.1",
-        "node-opcua-service-filter": "2.98.2",
-        "node-opcua-test-fixtures": "2.98.2",
+        "node-opcua-leak-detector": "2.99.0",
+        "node-opcua-nodesets": "2.99.0",
+        "node-opcua-packet-analyzer": "2.99.0",
+        "node-opcua-service-filter": "2.100.0",
+        "node-opcua-test-fixtures": "2.99.0",
         "should": "^13.2.3",
         "sinon": "^15.0.3",
         "source-map-support": "^0.5.21"
@@ -84,7 +84,7 @@
         "internet of things"
     ],
     "homepage": "http://node-opcua.github.io/",
-    "gitHead": "6df8aa25475ba1235e585566cb2dec68b7e7a85f",
+    "gitHead": "e143ff72418bb3db8c0a2cb8d4b7e54a90521a73",
     "files": [
         "dist",
         "distHelpers",
@@ -93,7 +93,9 @@
         "src",
         "nodeJS.d.ts",
         "nodeJS.js",
+        "nodesets",
         "testHelpers.js",
-        "testHelpers.d.ts"
+        "testHelpers.d.ts",
+        "source_nodejs"
     ]
 }

package/source/loader/load_nodeset2.ts

@@ -261,9 +261,9 @@ function makeNodeSetParserEngine(addressSpace: IAddressSpace, options: NodeSetLo
                 // istanbul ignore next
                 if (!existingNamespace) {
                     errorLog(
-                        "Please ensure that the required namespace ",
+                        "Please ensure that the required namespace",
                         requiredModel.modelUri,
-                        "is loaded firs when loading ",
+                        "is loaded first when loading",
                         model.modelUri
                     );
                     throw new Error("LoadNodeSet : Cannot find namespace for " + requiredModel.modelUri);
@@ -271,8 +271,7 @@ function makeNodeSetParserEngine(addressSpace: IAddressSpace, options: NodeSetLo
                 /**
                  *  from https://reference.opcfoundation.org/Core/docs/Part6/F.2/
                  *  The version of the model defined in the UANodeSet.
-                 *  This is a human readable string and not intended for programmatic comparisons.
-                 *
+                 *  This is a human-readable string and not intended for programmatic comparisons.
                  */
                 const isLowerVersion = (existingVersion: string, requiredVersion: string): boolean => {
                     const existingSemver = makeSemverCompatible(existingVersion);
@@ -294,7 +293,7 @@ function makeNodeSetParserEngine(addressSpace: IAddressSpace, options: NodeSetLo
                     errorLog(
                         "Expecting ",
                         requiredModel.modelUri,
-                        " with publicationDatea at least ",
+                        " with publicationDate at least ",
                         requiredModel.publicationDate.toUTCString(),
                         " but namespace publicationDate is ",
                         existingNamespace.publicationDate.toUTCString()

package/source_nodejs/generate_address_space.ts

@@ -0,0 +1,60 @@
+import * as fs from "fs";
+import { callbackify } from "util";
+
+import { checkDebugFlag, make_debugLog, make_errorLog } from "node-opcua-debug";
+import { IAddressSpace } from "node-opcua-address-space-base";
+
+import { generateAddressSpaceRaw } from "..";
+import { NodeSetLoaderOptions } from "../source/interfaces/nodeset_loader_options";
+
+const doDebug = checkDebugFlag(__filename);
+const debugLog = make_debugLog(__filename);
+const errorLog = make_errorLog(__filename);
+
+export async function readNodeSet2XmlFile(xmlFile: string): Promise<string> {
+    // istanbul ignore next
+    if (!fs.existsSync(xmlFile)) {
+        const msg = "[NODE-OPCUA-E02] generateAddressSpace : cannot find nodeset2 xml file at " + xmlFile;
+        errorLog(msg);
+        throw new Error(msg);
+    }
+    debugLog(" parsing ", xmlFile);
+    const xmlData = await fs.promises.readFile(xmlFile, "utf-8");
+    return xmlData;
+}
+export function generateAddressSpace(
+    addressSpace: IAddressSpace,
+    xmlFiles: string | string[],
+    callback: (err?: Error) => void
+): void;
+export function generateAddressSpace(
+    addressSpace: IAddressSpace,
+    xmlFiles: string | string[],
+    options: NodeSetLoaderOptions | undefined,
+    callback: (err?: Error) => void
+): void;
+export function generateAddressSpace(
+    addressSpace: IAddressSpace,
+    xmlFiles: string | string[],
+    options?: NodeSetLoaderOptions
+): Promise<void>;
+export function generateAddressSpace(
+    ... args: any[]
+): any {
+    const addressSpace = args[0] as IAddressSpace;
+    const xmlFiles = args[1] as string | string[];
+    if (args.length === 4) {
+        const options = args[2] as NodeSetLoaderOptions | undefined;
+        const callback = args[3]  as (err?: Error) => void;
+        callbackify(generateAddressSpaceRaw)(addressSpace, xmlFiles, readNodeSet2XmlFile, options ||{}, callback!);
+    } else {
+        const options = {};
+        const callback = args[2]  as (err?: Error) => void;
+        callbackify(generateAddressSpaceRaw)(addressSpace, xmlFiles, readNodeSet2XmlFile, options, callback!);
+    }
+}
+
+// tslint:disable:no-var-requires
+// tslint:disable:max-line-length
+const thenify = require("thenify");
+(module.exports as any).generateAddressSpace = thenify.withCallback((module.exports as any).generateAddressSpace);

package/source_nodejs/index.ts

@@ -0,0 +1 @@
+export * from "./generate_address_space";

package/src/base_node_private.ts

@@ -31,7 +31,8 @@ import {
     UAVariableType,
     ISessionContext,
     UAReference,
-    CloneOptions
+    CloneOptions,
+    CloneHelper
 } from "node-opcua-address-space-base";
 import { DataValue } from "node-opcua-data-value";
 import { ObjectTypeIds, VariableTypeIds } from "node-opcua-constants";
@@ -458,16 +459,6 @@ export function VariableOrVariableType_toString(this: UAVariableType | UAVariabl
     }
 }
 
-const defaultExtraInfo = {
-    level: 0,
-    pad(): string {
-        return "";
-    },
-    registerClonedObject(node: BaseNode, node1: BaseNode): void {
-        /** */
-    }
-};
-
 /**
  *
  *
@@ -589,8 +580,8 @@ function _clone_children_on_template(
                             nodeId: newParentChild.nodeId
                         });
                     } else {
-                        const a = grandChild.clone(options, optionalFilter, extraInfo);
-                        extraInfo.registerClonedObject(a,grandChild);
+                        const clonedGrandChild = grandChild.clone(options, optionalFilter, extraInfo);
+                        extraInfo.registerClonedObject(clonedGrandChild, grandChild);
                     }
                 }
             }
@@ -612,7 +603,7 @@ function _clone_collection_new(
     browseNameMap: Set<string>
 ): void {
     const namespace = newParent.namespace;
-    extraInfo = extraInfo || defaultExtraInfo;
+    extraInfo = extraInfo || new CloneHelper();
     const addressSpace = newParent.addressSpace;
     assert(!optionalFilter || (typeof optionalFilter.shouldKeep === "function" && typeof optionalFilter.filterFor === "function"));
 
@@ -664,30 +655,71 @@ function _clone_collection_new(
             copyAlsoModellingRules
         };
 
-        doTrace &&
-            traceLog(
-                extraInfo.pad(),
-                "cloning => ",
-                reference.referenceType.toString({ addressSpace }),
-                "=>",
-                node.browseName.toString(),
-                chalk.magentaBright(node.typeDefinitionObj?.browseName.toString())
-            );
-
-        extraInfo.level += 4;
-
         const alreadyCloned = extraInfo.getCloned(node);
         if (alreadyCloned) {
-            alreadyCloned.addReference({
-                referenceType: reference.referenceType,
-                isForward: false,
-                nodeId: newParent.nodeId
-            });
+            // instabul ignore next
+            doTrace &&
+                traceLog(
+                    extraInfo.pad(),
+                    "node ",
+                    node.browseName.toString(),
+                    node.nodeId.toString(),
+                    "already cloned as",
+                    alreadyCloned.nodeId.toString()
+                );
+
+            const hasReference =
+                alreadyCloned.findReferencesExAsObject(reference.referenceType, BrowseDirection.Inverse).length > 0;
+            if (!hasReference) {
+                alreadyCloned.addReference({
+                    referenceType: reference.referenceType,
+                    isForward: false,
+                    nodeId: newParent.nodeId
+                });
+            } else {
+                doTrace &&
+                    traceLog(
+                        extraInfo.pad(),
+                        "reference to node  ",
+                        alreadyCloned.browseName.toString(),
+                        alreadyCloned.nodeId.toString(),
+                        " already exists !"
+                    );
+            }
         } else {
-            const clone = node.clone(options, optionalFilter, extraInfo);
+            doTrace &&
+                traceLog(
+                    extraInfo.pad(),
+                    "cloning => ",
+                    reference.referenceType.toString({ addressSpace }),
+                    "=>",
+                    node.browseName.toString(),
+                    node.nodeId.toString(),
+                    chalk.magentaBright(node.typeDefinitionObj?.browseName.toString())
+                );
+
+            extraInfo.level += 1;
+            const clonedNode = node.clone(options, optionalFilter, extraInfo);
+            assert(extraInfo.getCloned(node));
 
-            extraInfo.level -= 4;
-            doTrace && traceLog(extraInfo.pad(), "cloning => ", node.browseName.toString(), "nodeId", clone.nodeId.toString());
+            extraInfo.level -= 1;
+
+            // instabul ignore next
+            doTrace &&
+                traceLog(
+                    extraInfo.pad(),
+                    "cloned => ",
+                    node.browseName.toString(),
+                    "",
+                    extraInfo.pad(),
+                    "    original nodeId",
+                    node.nodeId.toString(),
+                    "",
+                    extraInfo.pad(),
+                    "    cloned   nodeId",
+                    clonedNode.nodeId.toString(),
+                    ""
+                );
 
             extraInfo.level++;
             _clone_children_on_template(
@@ -705,7 +737,8 @@ function _clone_collection_new(
             extraInfo.level++;
             _cloneInterface(nodeToClone, newParent, node, optionalFilter, extraInfo, browseNameMap);
             extraInfo.level--;
-            extraInfo.registerClonedObject(node, clone);
+            // === clone);
+            // extraInfo.registerClonedObject(clone, node);
         }
     }
 }
@@ -846,7 +879,7 @@ function _cloneInterface(
             chalk.green("-------------------- now cloning interfaces of ", node.browseName.toString(), node.nodeId.toString())
         );
 
-    extraInfo = extraInfo || defaultExtraInfo;
+    extraInfo = extraInfo || new CloneHelper();
     const addressSpace = node.addressSpace;
 
     if (node.nodeClass !== NodeClass.Object && node.nodeClass !== NodeClass.Variable) {
@@ -940,7 +973,7 @@ export function _clone_non_hierarchical_references(
  * @private
  */
 export function _clone<T extends UAObject | UAVariable | UAMethod>(
-    this: T,
+    originalNode: T,
     Constructor: new (options: any) => T,
     options: CloneOptions,
     optionalFilter: CloneFilter,
@@ -951,21 +984,21 @@ export function _clone<T extends UAObject | UAVariable | UAMethod>(
     assert(
         !extraInfo || (extraInfo !== null && typeof extraInfo === "object" && typeof extraInfo.registerClonedObject === "function")
     );
-    assert(!(this as any).subtypeOf, "We do not do cloning of Type yet");
-    assert(!extraInfo.getCloned(this), "object has already been cloned");
+    assert(!(originalNode as any).subtypeOf, "We do not do cloning of Type yet");
+    assert(!extraInfo.getCloned(originalNode), "object has already been cloned");
     const namespace = options.namespace;
     const constructorOptions: any = {
         ...options,
         addressSpace: namespace.addressSpace,
-        browseName: this.browseName,
-        description: this.description,
-        displayName: this.displayName,
-        nodeClass: this.nodeClass
+        browseName: originalNode.browseName,
+        description: originalNode.description,
+        displayName: originalNode.displayName,
+        nodeClass: originalNode.nodeClass
     };
     constructorOptions.references = options.references || [];
 
-    if (this.nodeClass === NodeClass.Variable || this.nodeClass === NodeClass.Object) {
-        const voThis = this as UAObject | UAVariable;
+    if (originalNode.nodeClass === NodeClass.Variable || originalNode.nodeClass === NodeClass.Object) {
+        const voThis = originalNode as UAObject | UAVariable;
         if (voThis.typeDefinition) {
             constructorOptions.references.push(
                 new ReferenceImpl({
@@ -978,8 +1011,8 @@ export function _clone<T extends UAObject | UAVariable | UAMethod>(
     }
 
     if (!constructorOptions.modellingRule) {
-        if (this.modellingRule && options.copyAlsoModellingRules) {
-            const modellingRuleNode = this.findReferencesAsObject("HasModellingRule", true)[0];
+        if (originalNode.modellingRule && options.copyAlsoModellingRules) {
+            const modellingRuleNode = originalNode.findReferencesAsObject("HasModellingRule", true)[0];
             assert(modellingRuleNode);
             constructorOptions.references.push(
                 new ReferenceImpl({
@@ -997,29 +1030,41 @@ export function _clone<T extends UAObject | UAVariable | UAMethod>(
 
     assert(constructorOptions.nodeId instanceof NodeId);
 
-    const cloneObj = new Constructor(constructorOptions);
-    (this.addressSpace as AddressSpacePrivate)._register(cloneObj);
+    const clonedNode = new Constructor(constructorOptions);
+    (originalNode.addressSpace as AddressSpacePrivate)._register(clonedNode);
+    extraInfo.registerClonedObject(clonedNode, originalNode);
 
     if (!options.ignoreChildren) {
         // clone children and the rest ....
         options.copyAlsoModellingRules = options.copyAlsoModellingRules || false;
 
-        const newFilter = optionalFilter.filterFor(cloneObj);
+        const newFilter = optionalFilter.filterFor(clonedNode);
 
         const browseNameMap = new Set<string>();
-        _clone_hierarchical_references(this, cloneObj, options.copyAlsoModellingRules, newFilter!, extraInfo, browseNameMap);
+        _clone_hierarchical_references(
+            originalNode,
+            clonedNode,
+            options.copyAlsoModellingRules,
+            newFilter!,
+            extraInfo,
+            browseNameMap
+        );
 
-        if (this.nodeClass === NodeClass.Object || this.nodeClass === NodeClass.Variable) {
-            let typeDefinitionNode: UAVariableType | UAObjectType | null = this.typeDefinitionObj;
+        if (originalNode.nodeClass === NodeClass.Object || originalNode.nodeClass === NodeClass.Variable) {
+            let typeDefinitionNode: UAVariableType | UAObjectType | null = originalNode.typeDefinitionObj;
             while (typeDefinitionNode) {
                 doTrace &&
                     traceLog(
                         extraInfo?.pad(),
-                        chalk.blueBright("---------------------- Exploring ", typeDefinitionNode.browseName.toString())
+                        chalk.blueBright(
+                            originalNode.browseName.toString(),
+                            "-----> Exploring ",
+                            typeDefinitionNode.browseName.toString()
+                        )
                     );
                 _clone_hierarchical_references(
                     typeDefinitionNode,
-                    cloneObj,
+                    clonedNode,
                     options.copyAlsoModellingRules,
                     newFilter,
                     extraInfo,
@@ -1028,12 +1073,19 @@ export function _clone<T extends UAObject | UAVariable | UAMethod>(
                 typeDefinitionNode = typeDefinitionNode.subtypeOfObj;
             }
         }
-        _clone_non_hierarchical_references(this, cloneObj, options.copyAlsoModellingRules, newFilter, extraInfo, browseNameMap);
+        _clone_non_hierarchical_references(
+            originalNode,
+            clonedNode,
+            options.copyAlsoModellingRules,
+            newFilter,
+            extraInfo,
+            browseNameMap
+        );
     }
-    cloneObj.propagate_back_references();
-    cloneObj.install_extra_properties();
+    clonedNode.propagate_back_references();
+    clonedNode.install_extra_properties();
 
-    return cloneObj;
+    return clonedNode;
 }
 
 export function _handle_HierarchicalReference(node: BaseNode, reference: UAReference): void {

package/src/ua_method_impl.ts

@@ -29,7 +29,7 @@ import {
     ISessionContext,
     UAVariable,
     defaultCloneFilter,
-    defaultCloneExtraInfo
+    makeDefaultCloneExtraInfo
 } from "node-opcua-address-space-base";
 import { SessionContext } from "../source/session_context";
 import { _clone } from "./base_node_private";
@@ -264,12 +264,12 @@ export class UAMethodImpl extends BaseNodeImpl implements UAMethod {
 
         _handle_hierarchy_parent(addressSpace, options.references, options);
 
-        const clonedMethod = _clone.call(
+        const clonedMethod = _clone(
             this,
             UAMethodImpl,
             options,
             optionalFilter || defaultCloneFilter,
-            extraInfo || defaultCloneExtraInfo
+            extraInfo || makeDefaultCloneExtraInfo()
         ) as UAMethodImpl;
 
         clonedMethod._asyncExecutionFunction = this._asyncExecutionFunction;

package/src/ua_object_impl.ts

@@ -27,7 +27,7 @@ import {
     UAEventType,
     IEventData,
     defaultCloneFilter,
-    defaultCloneExtraInfo,
+    makeDefaultCloneExtraInfo,
     EventNotifierFlags
 } from "node-opcua-address-space-base";
 import { make_errorLog } from "node-opcua-debug";
@@ -91,17 +91,17 @@ export class UAObjectImpl extends BaseNodeImpl implements UAObject {
 
     public clone(options: CloneOptions, optionalFilter?: CloneFilter, extraInfo?: CloneExtraInfo): UAObject {
         options = {
-            ...options,
             eventNotifier: this.eventNotifier,
-            symbolicName: this.symbolicName || undefined
+            symbolicName: this.symbolicName || undefined,
+            ...options,
         };
 
-        const cloneObject = _clone.call(
+        const cloneObject = _clone(
             this,
             UAObjectImpl,
             options,
             optionalFilter || defaultCloneFilter,
-            extraInfo || defaultCloneExtraInfo
+            extraInfo || makeDefaultCloneExtraInfo()
         ) as UAObject;
         // xx  newObject.propagate_back_references();
         // xx newObject.install_extra_properties();