node-opcua-address-space 2.96.0 → 2.98.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "node-opcua-address-space",
-    "version": "2.96.0",
+    "version": "2.98.0",
     "description": "pure nodejs OPCUA SDK - module -address-space",
     "main": "./dist/src/index_current.js",
     "types": "./dist/source/index.d.ts",
@@ -16,42 +16,42 @@
         "c": "mocha --version"
     },
     "dependencies": {
-        "@types/lodash": "4.14.191",
+        "@types/lodash": "4.14.192",
         "@types/semver": "^7.3.13",
         "async": "^3.2.4",
         "chalk": "4.1.2",
         "dequeue": "^1.0.5",
         "lodash": "4.17.21",
-        "node-opcua-address-space-base": "2.96.0",
+        "node-opcua-address-space-base": "2.98.0",
         "node-opcua-assert": "2.88.0",
-        "node-opcua-basic-types": "2.92.0",
-        "node-opcua-binary-stream": "2.90.1",
-        "node-opcua-client-dynamic-extension-object": "2.96.0",
+        "node-opcua-basic-types": "2.98.0",
+        "node-opcua-binary-stream": "2.98.0",
+        "node-opcua-client-dynamic-extension-object": "2.98.0",
         "node-opcua-constants": "2.88.0",
         "node-opcua-crypto": "^2.1.2",
-        "node-opcua-data-access": "2.96.0",
-        "node-opcua-data-model": "2.95.0",
-        "node-opcua-data-value": "2.95.0",
-        "node-opcua-date-time": "2.90.1",
-        "node-opcua-debug": "2.90.1",
-        "node-opcua-enum": "2.90.1",
-        "node-opcua-extension-object": "2.95.0",
-        "node-opcua-factory": "2.95.0",
-        "node-opcua-nodeid": "2.90.1",
-        "node-opcua-nodeset-ua": "2.96.0",
-        "node-opcua-numeric-range": "2.95.0",
-        "node-opcua-object-registry": "2.90.1",
-        "node-opcua-pseudo-session": "2.96.0",
-        "node-opcua-service-browse": "2.96.0",
-        "node-opcua-service-call": "2.96.0",
-        "node-opcua-service-history": "2.96.0",
-        "node-opcua-service-translate-browse-path": "2.96.0",
-        "node-opcua-service-write": "2.96.0",
-        "node-opcua-status-code": "2.90.1",
-        "node-opcua-types": "2.96.0",
-        "node-opcua-utils": "2.90.1",
-        "node-opcua-variant": "2.95.0",
-        "node-opcua-xml2json": "2.96.0",
+        "node-opcua-data-access": "2.98.0",
+        "node-opcua-data-model": "2.98.0",
+        "node-opcua-data-value": "2.98.0",
+        "node-opcua-date-time": "2.98.0",
+        "node-opcua-debug": "2.98.0",
+        "node-opcua-enum": "2.98.0",
+        "node-opcua-extension-object": "2.98.0",
+        "node-opcua-factory": "2.98.0",
+        "node-opcua-nodeid": "2.98.0",
+        "node-opcua-nodeset-ua": "2.98.0",
+        "node-opcua-numeric-range": "2.98.0",
+        "node-opcua-object-registry": "2.98.0",
+        "node-opcua-pseudo-session": "2.98.0",
+        "node-opcua-service-browse": "2.98.0",
+        "node-opcua-service-call": "2.98.0",
+        "node-opcua-service-history": "2.98.0",
+        "node-opcua-service-translate-browse-path": "2.98.0",
+        "node-opcua-service-write": "2.98.0",
+        "node-opcua-status-code": "2.98.0",
+        "node-opcua-types": "2.98.0",
+        "node-opcua-utils": "2.98.0",
+        "node-opcua-variant": "2.98.0",
+        "node-opcua-xml2json": "2.98.0",
         "semver": "^7.3.8",
         "set-prototype-of": "^1.0.0",
         "thenify": "^3.3.1",
@@ -59,14 +59,14 @@
     },
     "devDependencies": {
         "mocha": "^10.2.0",
-        "node-opcua-benchmarker": "2.90.1",
-        "node-opcua-leak-detector": "2.90.1",
-        "node-opcua-nodesets": "2.96.0",
-        "node-opcua-packet-analyzer": "2.95.0",
-        "node-opcua-service-filter": "2.96.0",
-        "node-opcua-test-fixtures": "2.96.0",
+        "node-opcua-benchmarker": "2.98.0",
+        "node-opcua-leak-detector": "2.98.0",
+        "node-opcua-nodesets": "2.98.0",
+        "node-opcua-packet-analyzer": "2.98.0",
+        "node-opcua-service-filter": "2.98.0",
+        "node-opcua-test-fixtures": "2.98.0",
         "should": "^13.2.3",
-        "sinon": "^15.0.1",
+        "sinon": "^15.0.3",
         "source-map-support": "^0.5.21"
     },
     "author": "Etienne Rossignon",
@@ -84,5 +84,5 @@
         "internet of things"
     ],
     "homepage": "http://node-opcua.github.io/",
-    "gitHead": "43642e4aaa1ca2a3938b044cc2237544dfff764a"
+    "gitHead": "07dcdd8e8c7f2b55544c6e23023093e35674829c"
 }

package/source/interfaces/alarms_and_conditions/ua_condition_ex.ts

@@ -1,4 +1,4 @@
-import { BaseNode, UAObject, UAVariable } from "node-opcua-address-space-base";
+import { BaseNode, UAObject, UAProperty, UAVariable } from "node-opcua-address-space-base";
 import { LocalizedText } from "node-opcua-data-model";
 import { NodeId } from "node-opcua-nodeid";
 import { UACondition_Base } from "node-opcua-nodeset-ua";
@@ -7,6 +7,7 @@ import { TimeZoneDataType } from "node-opcua-types";
 import { UATwoStateVariableEx } from "../../ua_two_state_variable_ex";
 import { ConditionInfoOptions } from "./condition_info_i";
 import { ConditionSnapshot } from "./condition_snapshot";
+import { DataType } from "node-opcua-basic-types";
 
 
 
@@ -48,8 +49,8 @@ export interface UAConditionEx extends UAObject, UACondition_Base, UAConditionHe
     enabledState: UATwoStateVariableEx;
     on(eventName: string, eventHandler: any): this;
     //
-    // conditionClassId: UAProperty<NodeId, /*c*/DataType.NodeId>;
-    // conditionClassName: UAProperty<LocalizedText, /*c*/DataType.LocalizedText>;
+    conditionClassId: UAProperty<NodeId, /*c*/DataType.NodeId>;
+    conditionClassName: UAProperty<LocalizedText, /*c*/DataType.LocalizedText>;
     // conditionSubClassId?: UAProperty<NodeId, /*c*/DataType.NodeId>;
     // conditionSubClassName?: UAProperty<LocalizedText, /*c*/DataType.LocalizedText>;
     // conditionName: UAProperty<UAString, /*c*/DataType.String>;

package/source/loader/make_xml_extension_object_parser.ts

@@ -1,7 +1,7 @@
 import { Byte, coerceInt64, coerceUInt64, Int16, Int32, Int64, SByte, UAString, UInt16, UInt32, UInt64 } from "node-opcua-basic-types";
 import { LocalizedTextOptions } from "node-opcua-data-model";
 import { make_debugLog, make_warningLog } from "node-opcua-debug";
-import { coerceNodeId, NodeId, NodeIdType } from "node-opcua-nodeid";
+import { coerceNodeId, INodeId, NodeId, NodeIdType } from "node-opcua-nodeid";
 import { EnumDefinition, StructureDefinition } from "node-opcua-types";
 import { lowerFirstLetter } from "node-opcua-utils";
 import { DataType } from "node-opcua-variant";
@@ -82,7 +82,7 @@ const localizedTextReader: ReaderStateParserLike = {
 };
 
 function clamp(value: number, minValue: number, maxValue: number) {
-    if (value< minValue) {
+    if (value < minValue) {
         warningLog(`invalid value range : ${value} < ${minValue} but should be [${minValue} , ${maxValue}]`);
         return minValue;
     }
@@ -257,25 +257,26 @@ function _clone(a: any): any {
 }
 
 function _makeTypeReader(
-    dataTypeNodeId: NodeId,
+    dataTypeNodeId1: NodeId,
     definitionMap: DefinitionMap2,
     readerMap: Record<string, ReaderStateParserLike>
 ): { name: string; parser: ReaderStateParserLike } {
-    if (dataTypeNodeId.namespace === 0 && dataTypeNodeId.value === 0) {
+    const n = dataTypeNodeId1 as INodeId;
+    if (n.identifierType === NodeIdType.NUMERIC && n.namespace === 0 && n.value === 0) {
         // a generic Extension Object
         return { name: "Variant", parser: partials["Variant"] };
     }
     if (
-        dataTypeNodeId.namespace === 0 &&
-        dataTypeNodeId.identifierType === NodeIdType.NUMERIC &&
-        dataTypeNodeId.value < DataType.ExtensionObject
+        n.namespace === 0 &&
+        n.identifierType === NodeIdType.NUMERIC &&
+        n.value < DataType.ExtensionObject
     ) {
-        const name = DataType[dataTypeNodeId.value as number] as string;
+        const name = DataType[n.value as number] as string;
         const parser = partials[name];
         return { name, parser };
     }
 
-    const { name, definition } = definitionMap.findDefinition(dataTypeNodeId);
+    const { name, definition } = definitionMap.findDefinition(n);
     const dataTypeName = name;
 
     // console.log("NAME = ", dataTypeNodeId.toString(), name, definition);

package/src/address_space.ts

@@ -10,7 +10,7 @@ import { ExtraDataTypeManager } from "node-opcua-client-dynamic-extension-object
 import { DataTypeIds, VariableTypeIds } from "node-opcua-constants";
 import { BrowseDirection, NodeClass, QualifiedName } from "node-opcua-data-model";
 import { ExtensionObject } from "node-opcua-extension-object";
-import { coerceExpandedNodeId, coerceNodeId, makeNodeId, NodeId, NodeIdLike, resolveNodeId, sameNodeId } from "node-opcua-nodeid";
+import { coerceExpandedNodeId, coerceNodeId, INodeId, makeNodeId, NodeId, NodeIdLike, NodeIdType, resolveNodeId, sameNodeId } from "node-opcua-nodeid";
 import { ObjectRegistry } from "node-opcua-object-registry";
 import { BrowseResult } from "node-opcua-service-browse";
 import { StatusCodes } from "node-opcua-status-code";
@@ -483,18 +483,19 @@ export class AddressSpace implements AddressSpacePrivate {
         if (sameNodeId(enumerationTypeNodeId, dataTypeNode!.nodeId)) {
             return DataType.Int32;
         }
+        const n = dataTypeNode.nodeId as INodeId;
 
-        if (dataTypeNode.nodeId.namespace === 0 && dataTypeNode.nodeId.value === 29) {
+        if (n.namespace === 0 && n.value === 29) {
             // Number
             return DataType.Null; //which one ?
         }
 
-        if (dataTypeNode.nodeId.namespace === 0 && dataTypeNode.nodeId.value === 0) {
+        if (n.namespace === 0 && n.value === 0) {
             return DataType.Null;
         }
 
-        if (dataTypeNode.nodeId.namespace === 0 && dataTypeNode.nodeId.value <= 25) {
-            return dataTypeNode.nodeId.value as DataType;
+        if (n.identifierType === NodeIdType.NUMERIC && n.namespace === 0 && n.value <= 25) {
+            return n.value as DataType;
         }
 
         const result = this.findCorrespondingBasicDataType(dataTypeNode.subtypeOfObj as UADataType);

package/src/alarms_and_conditions/ua_condition_impl.ts

@@ -31,7 +31,8 @@ import {
     UAEventType,
     BaseNode,
     UAObject,
-    InstantiateObjectOptions
+    InstantiateObjectOptions,
+    UAProperty
 } from "node-opcua-address-space-base";
 import { UAConditionVariable } from "node-opcua-nodeset-ua";
 
@@ -48,7 +49,6 @@ import { UAConditionType } from "../ua_condition_type";
 import { UABaseEventImpl } from "./ua_base_event_impl";
 import { ConditionSnapshotImpl } from "./condition_snapshot_impl";
 
-
 const debugLog = make_debugLog(__filename);
 const errorLog = make_errorLog(__filename);
 const doDebug = checkDebugFlag(__filename);
@@ -56,6 +56,8 @@ const warningLog = make_warningLog(__filename);
 
 export declare interface UAConditionImpl extends UAConditionEx, UABaseEventImpl {
     on(eventName: string, eventHandler: any): this;
+    conditionClassId: UAProperty<NodeId, /*c*/ DataType.NodeId>;
+    conditionClassName: UAProperty<LocalizedText, /*c*/ DataType.LocalizedText>;
 }
 /**
  *
@@ -452,7 +454,11 @@ export class UAConditionImpl extends UABaseEventImpl implements UAConditionEx {
                 }
             }
         } else {
-            warningLog("Condition ", this.nodeId.toString(), "is not linked to a Object with a IsConditionOf(reversed(HasCondition))");
+            warningLog(
+                "Condition ",
+                this.nodeId.toString(),
+                "is not linked to a Object with a IsConditionOf(reversed(HasCondition))"
+            );
         }
         // xx console.log("MMMMMMMM%%%%%%%%%%%%%%%%%%%%% branch  " +
         // branch.getBranchId().toString() + " eventId = " + branch.getEventId().toString("hex"));
@@ -647,7 +653,6 @@ export class UAConditionImpl extends UABaseEventImpl implements UAConditionEx {
     }
 }
 
-
 /**
  * instantiate a Condition.
  * this will create the unique EventId and will set eventType
@@ -1126,11 +1131,11 @@ function _add_comment_method(
     callback: CallbackT<CallMethodResultOptions>
 ) {
     //
-    // The AddComment Method is used to apply a comment to a specific state of a Condition 
-    // instance. Normally, the NodeId of the Object instance is passed as the ObjectId to the Call 
-    // Service. However, some Servers do not expose Condition instances in the AddressSpace. 
-    // Therefore, all Servers shall also allow Clients to call the AddComment Method by specifying 
-    // ConditionId as the ObjectId. The Method cannot be called with an ObjectId of the 
+    // The AddComment Method is used to apply a comment to a specific state of a Condition
+    // instance. Normally, the NodeId of the Object instance is passed as the ObjectId to the Call
+    // Service. However, some Servers do not expose Condition instances in the AddressSpace.
+    // Therefore, all Servers shall also allow Clients to call the AddComment Method by specifying
+    // ConditionId as the ObjectId. The Method cannot be called with an ObjectId of the
     // ConditionType Node.
     // Signature
     //   - EventId EventId identifying a particular Event Notification where a state was reported for a

package/src/base_node_impl.ts

@@ -1159,6 +1159,10 @@ export class BaseNodeImpl extends EventEmitter implements BaseNode {
         BaseNode_removePrivate(this);
     }
 
+    public isDisposed(): boolean {
+        return !this.addressSpacePrivate;
+    }
+
     // istanbul ignore next
     public dumpXML(xmlWriter: XmlWriter): void {
         console.error(" This ", (NodeClass as any)[this.nodeClass]);
@@ -1504,8 +1508,8 @@ function _asObject<T extends BaseNode>(references: UAReference[], addressSpace:
             // tslint:disable-next-line:no-console
             console.log(
                 chalk.red(" Warning :  object with nodeId ") +
-                    chalk.cyan(reference.nodeId.toString()) +
-                    chalk.red(" cannot be found in the address space !")
+                chalk.cyan(reference.nodeId.toString()) +
+                chalk.red(" cannot be found in the address space !")
             );
         }
         return obj as any as T;

package/src/base_node_private.ts

@@ -527,8 +527,8 @@ function _clone_children_on_template(
         return;
     }
     // we have found a matching child on the new parent.
-    // the mission is to enrich this child node with compoents and property that
-    // exists also in the template
+    // the mission is to enrich this child node with components and properties that
+    // exist also in the template
 
     let typeDefinitionNode: UAVariableType | UAObjectType | null = nodeToCloneTypeDefinition;
     while (typeDefinitionNode) {
@@ -580,7 +580,18 @@ function _clone_children_on_template(
                         ],
                         copyAlsoModellingRules
                     };
-                    const a = grandChild.clone(options, optionalFilter, extraInfo);
+
+                    const alreadyCloned = extraInfo.getCloned(grandChild);
+                    if (alreadyCloned) {
+                        alreadyCloned.addReference({
+                            referenceType: ref.referenceType,
+                            isForward: false,
+                            nodeId: newParentChild.nodeId
+                        });
+                    } else {
+                        const a = grandChild.clone(options, optionalFilter, extraInfo);
+                        extraInfo.registerClonedObject(a,grandChild);
+                    }
                 }
             }
         }
@@ -664,20 +675,36 @@ function _clone_collection_new(
             );
 
         extraInfo.level += 4;
-        const clone = node.clone(options, optionalFilter, extraInfo);
-        extraInfo.level -= 4;
-        doTrace && traceLog(extraInfo.pad(), "cloning => ", node.browseName.toString(), "nodeId", clone.nodeId.toString());
 
-        extraInfo.level++;
-        _clone_children_on_template(nodeToClone, newParent, node, copyAlsoModellingRules, optionalFilter, extraInfo, browseNameMap);
-        extraInfo.level--;
+        const alreadyCloned = extraInfo.getCloned(node);
+        if (alreadyCloned) {
+            alreadyCloned.addReference({
+                referenceType: reference.referenceType,
+                isForward: false,
+                nodeId: newParent.nodeId
+            });
+        } else {
+            const clone = node.clone(options, optionalFilter, extraInfo);
 
-        // also clone or instantiate interface members that may be required in the optionals
-        extraInfo.level++;
-        _cloneInterface(nodeToClone, newParent, node, optionalFilter, extraInfo, browseNameMap);
-        extraInfo.level--;
+            extraInfo.level -= 4;
+            doTrace && traceLog(extraInfo.pad(), "cloning => ", node.browseName.toString(), "nodeId", clone.nodeId.toString());
 
-        if (extraInfo) {
+            extraInfo.level++;
+            _clone_children_on_template(
+                nodeToClone,
+                newParent,
+                node,
+                copyAlsoModellingRules,
+                optionalFilter,
+                extraInfo,
+                browseNameMap
+            );
+            extraInfo.level--;
+
+            // also clone or instantiate interface members that may be required in the optionals
+            extraInfo.level++;
+            _cloneInterface(nodeToClone, newParent, node, optionalFilter, extraInfo, browseNameMap);
+            extraInfo.level--;
             extraInfo.registerClonedObject(node, clone);
         }
     }
@@ -787,7 +814,7 @@ function _crap_extractInterfaces(typeDefinitionNode: UAObjectType | UAVariableTy
     const addressSpace = typeDefinitionNode.addressSpace;
     // example:
     // FolderType
-    //   FunctionalGroupType
+    //   (di):FunctionalGroupType
     //     MachineryItemIdentificationType     : IMachineryItemVendorNameplateType
     //       MachineIdentificationType         : IMachineTagNameplateType, IMachineVendorNamePlateType
     //         MachineToolIdentificationType
@@ -852,7 +879,21 @@ function _cloneInterface(
         _clone_collection_new(nodeToClone, node, aggregates, false, localFilter, extraInfo, browseNameMap);
     }
 }
-export function _clone_children_references(
+
+function __clone_organizes_references(
+    node: UAObject | UAVariable | UAMethod | UAObjectType | UAVariableType,
+    newParent: UAObject | UAVariable | UAMethod,
+    copyAlsoModellingRules: boolean,
+    optionalFilter: CloneFilter,
+    extraInfo: CloneExtraInfo,
+    browseNameMap: Set<string>
+): void {
+    // find all references that derives from the Organizes
+    const organizedRef = node.findReferencesEx("Organizes", BrowseDirection.Forward);
+    _clone_collection_new(node, newParent, organizedRef, copyAlsoModellingRules, optionalFilter, extraInfo, browseNameMap);
+}
+
+function __clone_children_references(
     node: UAObject | UAVariable | UAMethod | UAObjectType | UAVariableType,
     newParent: UAObject | UAVariable | UAMethod,
     copyAlsoModellingRules: boolean,
@@ -860,11 +901,22 @@ export function _clone_children_references(
     extraInfo: CloneExtraInfo,
     browseNameMap: Set<string>
 ): void {
-    // find all reference that derives from the Aggregates
+    // find all references that derives from the Aggregates
     const aggregatesRef = node.findReferencesEx("Aggregates", BrowseDirection.Forward);
     _clone_collection_new(node, newParent, aggregatesRef, copyAlsoModellingRules, optionalFilter, extraInfo, browseNameMap);
 }
 
+export function _clone_hierarchical_references(
+    node: UAObject | UAVariable | UAMethod | UAObjectType | UAVariableType,
+    newParent: UAObject | UAVariable | UAMethod,
+    copyAlsoModellingRules: boolean,
+    optionalFilter: CloneFilter,
+    extraInfo: CloneExtraInfo,
+    browseNameMap: Set<string>
+) {
+    __clone_children_references(node, newParent, copyAlsoModellingRules, optionalFilter, extraInfo, browseNameMap);
+    __clone_organizes_references(node, newParent, copyAlsoModellingRules, optionalFilter, extraInfo, browseNameMap);
+}
 export function _clone_non_hierarchical_references(
     nodeToClone: UAObject | UAVariable | UAMethod | UAObjectType | UAVariableType,
     newParent: BaseNode,
@@ -900,7 +952,7 @@ export function _clone<T extends UAObject | UAVariable | UAMethod>(
         !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");
     const namespace = options.namespace;
     const constructorOptions: any = {
         ...options,
@@ -955,7 +1007,7 @@ export function _clone<T extends UAObject | UAVariable | UAMethod>(
         const newFilter = optionalFilter.filterFor(cloneObj);
 
         const browseNameMap = new Set<string>();
-        _clone_children_references(this, cloneObj, options.copyAlsoModellingRules, newFilter!, extraInfo, browseNameMap);
+        _clone_hierarchical_references(this, cloneObj, options.copyAlsoModellingRules, newFilter!, extraInfo, browseNameMap);
 
         if (this.nodeClass === NodeClass.Object || this.nodeClass === NodeClass.Variable) {
             let typeDefinitionNode: UAVariableType | UAObjectType | null = this.typeDefinitionObj;
@@ -965,7 +1017,7 @@ export function _clone<T extends UAObject | UAVariable | UAMethod>(
                         extraInfo?.pad(),
                         chalk.blueBright("---------------------- Exploring ", typeDefinitionNode.browseName.toString())
                     );
-                _clone_children_references(
+                _clone_hierarchical_references(
                     typeDefinitionNode,
                     cloneObj,
                     options.copyAlsoModellingRules,
@@ -976,14 +1028,7 @@ 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(this, cloneObj, options.copyAlsoModellingRules, newFilter, extraInfo, browseNameMap);
     }
     cloneObj.propagate_back_references();
     cloneObj.install_extra_properties();

package/src/data_access/ua_two_state_discrete_impl.ts

@@ -130,7 +130,9 @@ export function _addTwoStateDiscrete(namespace: INamespace, options: AddTwoState
     const variable = namespace.addVariable({
         accessLevel: options.accessLevel,
         browseName: options.browseName,
+        displayName: options.displayName,
         componentOf: options.componentOf,
+        propertyOf: options.propertyOf,
         dataType: DataType.Boolean,
         nodeId: options.nodeId,
         typeDefinition: twoStateDiscreteType.nodeId,