node-opcua-address-space 2.66.1 → 2.67.0

package/dist/src/ua_variable_impl.d.ts

@@ -1,4 +1,4 @@
-import { CloneExtraInfo, ContinuationData, VariableDataValueSetterWithCallback } from "node-opcua-address-space-base";
+import { BindExtensionObjectOptions, CloneExtraInfo, ContinuationData, VariableDataValueSetterWithCallback } from "node-opcua-address-space-base";
 import { QualifiedNameLike, NodeClass, AccessLevelFlag, AttributeIds } from "node-opcua-data-model";
 import { DataValue, DataValueT } from "node-opcua-data-value";
 import { PreciseClock } from "node-opcua-date-time";
@@ -148,13 +148,8 @@ export declare class UAVariableImpl extends BaseNodeImpl implements UAVariable {
      */
     checkVariantCompatibility(value: Variant): StatusCode;
     /**
-     * @method touchValue
      * touch the source timestamp of a Variable and cascade up the change
      * to the parent variable if any.
-     *
-     * @param [optionalNow=null] {Object}
-     * @param optionalNow.timestamp    {Date}
-     * @param optionalNow.picoseconds  {Number}
      */
     touchValue(optionalNow?: PreciseClock): void;
     /**
@@ -290,16 +285,22 @@ export declare class UAVariableImpl extends BaseNodeImpl implements UAVariable {
     getDataTypeNode(): UADataType;
     get dataTypeObj(): UADataType;
     checkExtensionObjectIsCorrect(extObj: ExtensionObject | ExtensionObject[] | null): boolean;
+    /**
+     * @private
+     * install UAVariable to exposed th
+     *
+     * precondition:
+     */
+    installExtensionObjectVariables(): void;
     /**
      * @method bindExtensionObject
      * @return {ExtensionObject}
      */
-    bindExtensionObject(optionalExtensionObject?: ExtensionObject): ExtensionObject | null;
+    bindExtensionObject(optionalExtensionObject?: ExtensionObject, options?: BindExtensionObjectOptions): ExtensionObject | null;
     updateExtensionObjectPartial(partialExtensionObject?: {
         [key: string]: any;
     }): ExtensionObject;
     incrementExtensionObjectPartial(path: string | string[]): void;
-    constructExtensionObjectFromComponents(): any;
     toString(): string;
     historyRead(context: ISessionContext, historyReadDetails: HistoryReadDetails | ReadRawModifiedDetails | ReadEventDetails | ReadProcessedDetails | ReadAtTimeDetails, indexRange: NumericRange | null, dataEncoding: QualifiedNameLike | null, continuationData: ContinuationData): Promise<HistoryReadResult>;
     historyRead(context: ISessionContext, historyReadDetails: HistoryReadDetails | ReadRawModifiedDetails | ReadEventDetails | ReadProcessedDetails | ReadAtTimeDetails, indexRange: NumericRange | null, dataEncoding: QualifiedNameLike | null, continuationData: ContinuationData, callback: CallbackT<HistoryReadResult>): void;

package/dist/src/ua_variable_impl.js

@@ -22,7 +22,6 @@ const node_opcua_service_write_1 = require("node-opcua-service-write");
 const node_opcua_status_code_1 = require("node-opcua-status-code");
 const node_opcua_types_1 = require("node-opcua-types");
 const utils = require("node-opcua-utils");
-const node_opcua_utils_1 = require("node-opcua-utils");
 const node_opcua_variant_1 = require("node-opcua-variant");
 const session_context_1 = require("../source/session_context");
 const multiform_func_1 = require("../source/helpers/multiform_func");
@@ -30,6 +29,7 @@ const base_node_impl_1 = require("./base_node_impl");
 const base_node_private_1 = require("./base_node_private");
 const ua_data_type_impl_1 = require("./ua_data_type_impl");
 const apply_condition_refresh_1 = require("./apply_condition_refresh");
+const ua_variable_impl_ext_obj_1 = require("./ua_variable_impl_ext_obj");
 const debugLog = (0, node_opcua_debug_1.make_debugLog)(__filename);
 const warningLog = (0, node_opcua_debug_1.make_warningLog)(__filename);
 const doDebug = (0, node_opcua_debug_1.checkDebugFlag)(__filename);
@@ -478,7 +478,8 @@ class UAVariableImpl extends base_node_impl_1.BaseNodeImpl {
                 }
                 if (this.dataType.namespace === 0 &&
                     this.dataType.value === node_opcua_variant_1.DataType.LocalizedText &&
-                    variant.dataType !== node_opcua_variant_1.DataType.LocalizedText && variant.dataType !== node_opcua_variant_1.DataType.Null) {
+                    variant.dataType !== node_opcua_variant_1.DataType.LocalizedText &&
+                    variant.dataType !== node_opcua_variant_1.DataType.Null) {
                     throw new Error("Variant must provide a valid LocalizedText : variant = " +
                         variant.toString() +
                         " this.dataType= " +
@@ -547,7 +548,21 @@ class UAVariableImpl extends base_node_impl_1.BaseNodeImpl {
             dataValue.sourceTimestamp = now.timestamp;
             dataValue.statusCode = statusCode;
             dataValue.value = variant1;
-            this._internal_set_dataValue(dataValue);
+            if (dataValue.value.dataType === node_opcua_variant_1.DataType.ExtensionObject) {
+                this.$dataValue = dataValue;
+                (0, node_opcua_assert_1.assert)(this.checkExtensionObjectIsCorrect(dataValue.value.value));
+                // ----------------------------------
+                if (this.$extensionObject) {
+                    // we have an extension object already bound to this node
+                    // the client is asking us to replace the object entierly by a new one
+                    const ext = dataValue.value.value;
+                    (0, ua_variable_impl_ext_obj_1._setExtensionObject)(this, ext);
+                    return;
+                }
+            }
+            else {
+                this._internal_set_dataValue(dataValue);
+            }
         }
         catch (err) {
             errorLog("UAVariable#setValueFromString Error : ", this.browseName.toString(), this.nodeId.toString());
@@ -730,30 +745,12 @@ class UAVariableImpl extends base_node_impl_1.BaseNodeImpl {
         return node_opcua_status_code_1.StatusCodes.Good;
     }
     /**
-     * @method touchValue
      * touch the source timestamp of a Variable and cascade up the change
      * to the parent variable if any.
-     *
-     * @param [optionalNow=null] {Object}
-     * @param optionalNow.timestamp    {Date}
-     * @param optionalNow.picoseconds  {Number}
      */
     touchValue(optionalNow) {
         const now = optionalNow || (0, node_opcua_date_time_1.getCurrentClock)();
-        this.$dataValue.sourceTimestamp = now.timestamp;
-        this.$dataValue.sourcePicoseconds = now.picoseconds;
-        this.$dataValue.serverTimestamp = now.timestamp;
-        this.$dataValue.serverPicoseconds = now.picoseconds;
-        this.$dataValue.statusCode = node_opcua_status_code_1.StatusCodes.Good;
-        if (this.minimumSamplingInterval === 0) {
-            if (this.listenerCount("value_changed") > 0) {
-                const clonedDataValue = this.readValue();
-                this.emit("value_changed", clonedDataValue);
-            }
-        }
-        if (this.parent && this.parent.nodeClass === node_opcua_data_model_1.NodeClass.Variable) {
-            this.parent.touchValue(now);
-        }
+        (0, ua_variable_impl_ext_obj_1.propagateTouchValueUpward)(this, now);
     }
     /**
      * bind a variable with a get and set functions.
@@ -972,6 +969,11 @@ class UAVariableImpl extends base_node_impl_1.BaseNodeImpl {
         (0, node_opcua_assert_1.assert)(typeof newVariable._timestamped_set_func === "function");
         (0, node_opcua_assert_1.assert)(newVariable.dataType === this.dataType);
         newVariable.$dataValue = this.$dataValue.clone();
+        // also bind extension object
+        const v = newVariable.$dataValue.value;
+        if (v.dataType === node_opcua_variant_1.DataType.ExtensionObject && v.value && v.arrayType === node_opcua_variant_1.VariantArrayType.Scalar) {
+            newVariable.bindExtensionObject(newVariable.$dataValue.value.value);
+        }
         return newVariable;
     }
     getDataTypeNode() {
@@ -1026,262 +1028,37 @@ class UAVariableImpl extends base_node_impl_1.BaseNodeImpl {
         }
     }
     /**
-     * @method bindExtensionObject
-     * @return {ExtensionObject}
+     * @private
+     * install UAVariable to exposed th
+     *
+     * precondition:
      */
-    bindExtensionObject(optionalExtensionObject) {
-        var _a, _b;
-        const addressSpace = this.addressSpace;
-        const structure = addressSpace.findDataType("Structure");
-        let extensionObject_;
-        if (!structure) {
-            // the addressSpace is limited and doesn't provide extension object
-            // bindExtensionObject cannot be performed and shall finish here.
-            return null;
-        }
-        // istanbul ignore next
-        if (doDebug) {
-            debugLog(" ------------------------------ binding ", this.browseName.toString(), this.nodeId.toString());
-        }
-        (0, node_opcua_assert_1.assert)(structure && structure.browseName.toString() === "Structure", "expecting DataType Structure to be in IAddressSpace");
-        const dt = this.getDataTypeNode();
-        if (!dt.isSupertypeOf(structure)) {
-            return null;
-        }
-        // the namespace for the structure browse name elements
-        const structureNamespace = dt.nodeId.namespace;
-        // -------------------- make sure we do not bind a variable twice ....
-        if (this.$extensionObject) {
-            // istanbul ignore next
-            // if (!force && !utils.isNullOrUndefined(optionalExtensionObject)) {
-            //     throw new Error(
-            //         "bindExtensionObject: unsupported case : $extensionObject already exists on " +
-            //             this.browseName.toString() +
-            //             " " +
-            //             this.nodeId.toString()
-            //     );
-            // }
-            // istanbul ignore next
-            if (!this.checkExtensionObjectIsCorrect(this.$extensionObject)) {
-                warningLog("on node : ", this.browseName.toString(), this.nodeId.toString(), "dataType=", this.dataType.toString({ addressSpace: this.addressSpace }));
-                warningLog((_a = this.$extensionObject) === null || _a === void 0 ? void 0 : _a.toString());
-                throw new Error("bindExtensionObject: $extensionObject is incorrect: we are expecting a " +
-                    this.dataType.toString({ addressSpace: this.addressSpace }) +
-                    " but we got a " +
-                    ((_b = this.$extensionObject) === null || _b === void 0 ? void 0 : _b.constructor.name));
-            }
-            return this.$extensionObject;
-            // throw new Error("Variable already bound");
-        }
-        this.$extensionObject = optionalExtensionObject;
-        // ------------------------------------------------------------------
-        function prepareVariantValue(dataType, value) {
-            if ((dataType === node_opcua_variant_1.DataType.Int32 || dataType === node_opcua_variant_1.DataType.UInt32) && value && value.key) {
-                value = value.value;
-            }
-            return value;
-        }
-        const bindProperty = (propertyNode, name, extensionObject, dataType) => {
-            // eslint-disable-next-line @typescript-eslint/no-this-alias
-            const self = this;
-            propertyNode.bindVariable({
-                timestamped_get: () => {
-                    const propertyValue = self.$extensionObject[name];
-                    if (propertyValue === undefined) {
-                        propertyNode.$dataValue.value.dataType = node_opcua_variant_1.DataType.Null;
-                        propertyNode.$dataValue.statusCode = node_opcua_status_code_1.StatusCodes.Good;
-                        propertyNode.$dataValue.value.value = null;
-                        return new node_opcua_data_value_1.DataValue(propertyNode.$dataValue);
-                    }
-                    const value = prepareVariantValue(dataType, propertyValue);
-                    propertyNode.$dataValue.statusCode = node_opcua_status_code_1.StatusCodes.Good;
-                    propertyNode.$dataValue.value.dataType = dataType;
-                    propertyNode.$dataValue.value.value = value;
-                    return new node_opcua_data_value_1.DataValue(propertyNode.$dataValue);
-                },
-                timestamped_set: (dataValue, callback) => {
-                    dataValue;
-                    callback(null, node_opcua_status_code_1.StatusCodes.BadNotWritable);
+    installExtensionObjectVariables() {
+        (0, ua_variable_impl_ext_obj_1._installExtensionObjectBindingOnProperties)(this, { createMissingProp: true });
+        // now recursively install extension object on children
+        for (const child of this.getComponents()) {
+            if (child.nodeClass === node_opcua_data_model_1.NodeClass.Variable && child instanceof UAVariableImpl) {
+                if (child.isExtensionObject()) {
+                    child.installExtensionObjectVariables();
                 }
-            }, true);
-        };
-        const components = this.getComponents();
-        // ------------------------------------------------------
-        // make sure we have a structure
-        // ------------------------------------------------------
-        const s = this.readValue();
-        // istanbul ignore next
-        if (this.dataTypeObj.isAbstract) {
-            warningLog("Warning the DataType associated with this Variable is abstract ", this.dataTypeObj.browseName.toString());
-            warningLog("You need to provide a extension object yourself ");
-            throw new Error("bindExtensionObject requires a extensionObject as associated dataType is only abstract");
-        }
-        if (s.value && (s.value.dataType === node_opcua_variant_1.DataType.Null || (s.value.dataType === node_opcua_variant_1.DataType.ExtensionObject && !s.value.value))) {
-            // create a structure and bind it
-            extensionObject_ = this.$extensionObject || addressSpace.constructExtensionObject(this.dataType, {});
-            extensionObject_ = new Proxy(extensionObject_, makeHandler(this));
-            this.$extensionObject = extensionObject_;
-            const theValue = new node_opcua_variant_1.Variant({
-                dataType: node_opcua_variant_1.DataType.ExtensionObject,
-                value: this.$extensionObject
-            });
-            this.setValueFromSource(theValue, node_opcua_status_code_1.StatusCodes.Good);
-            // eslint-disable-next-line @typescript-eslint/no-this-alias
-            const self = this;
-            this.bindVariable({
-                timestamped_get() {
-                    self.$dataValue.value.value = self.$extensionObject;
-                    const d = new node_opcua_data_value_1.DataValue(self.$dataValue);
-                    d.value = new node_opcua_variant_1.Variant(d.value);
-                    return d;
-                },
-                timestamped_set(dataValue, callback) {
-                    const ext = dataValue.value.value;
-                    if (!self.checkExtensionObjectIsCorrect(ext)) {
-                        return callback(null, node_opcua_status_code_1.StatusCodes.BadInvalidArgument);
-                    }
-                    self.$extensionObject = new Proxy(ext, makeHandler(self));
-                    self.touchValue();
-                    callback(null, node_opcua_status_code_1.StatusCodes.Good);
-                }
-            }, true);
-        }
-        else {
-            // verify that variant has the correct type
-            (0, node_opcua_assert_1.assert)(s.value.dataType === node_opcua_variant_1.DataType.ExtensionObject);
-            this.$extensionObject = s.value.value;
-            (0, node_opcua_assert_1.assert)(this.checkExtensionObjectIsCorrect(this.$extensionObject));
-            (0, node_opcua_assert_1.assert)(s.statusCode.equals(node_opcua_status_code_1.StatusCodes.Good));
-        }
-        // ------------------------------------------------------
-        // now bind each member
-        // ------------------------------------------------------
-        const definition = dt._getDefinition();
-        // istanbul ignore next
-        if (!definition) {
-            throw new Error("xx definition missing in " + dt.toString());
-        }
-        const getOrCreateProperty = (field) => {
-            let property;
-            const selectedComponents = components.filter((f) => f instanceof UAVariableImpl && f.browseName.name.toString() === field.name);
-            if (field.dataType.value === node_opcua_variant_1.DataType.Variant) {
-                warningLog("Warning : variant is not supported in ExtensionObject");
-            }
-            if (selectedComponents.length === 1) {
-                property = selectedComponents[0];
-                /* istanbul ignore next */
             }
-            else {
-                debugLog("adding missing array variable", field.name, this.browseName.toString(), this.nodeId.toString());
-                // todo: Handle array appropriately...
-                (0, node_opcua_assert_1.assert)(selectedComponents.length === 0);
-                // create a variable (Note we may use ns=1;s=parentName/0:PropertyName)
-                property = this.namespace.addVariable({
-                    browseName: { namespaceIndex: structureNamespace, name: field.name.toString() },
-                    componentOf: this,
-                    dataType: field.dataType,
-                    minimumSamplingInterval: this.minimumSamplingInterval
-                });
-                (0, node_opcua_assert_1.assert)(property.minimumSamplingInterval === this.minimumSamplingInterval);
-            }
-            return property;
-        };
-        for (const field of definition.fields || []) {
-            if (node_opcua_nodeid_1.NodeId.sameNodeId(node_opcua_nodeid_1.NodeId.nullNodeId, field.dataType)) {
-                warningLog("field.dataType is null ! ", field.toString(), node_opcua_nodeid_1.NodeId.nullNodeId.toString());
-                warningLog(" dataType replaced with BaseDataType ");
-                warningLog(definition.toString());
-                field.dataType = this.resolveNodeId("BaseDataType");
-            }
-            const camelCaseName = (0, node_opcua_utils_1.lowerFirstLetter)(field.name);
-            (0, node_opcua_assert_1.assert)(Object.prototype.hasOwnProperty.call(this.$extensionObject, camelCaseName));
-            const propertyNode = getOrCreateProperty(field);
-            propertyNode.$dataValue.statusCode = node_opcua_status_code_1.StatusCodes.Good;
-            propertyNode.touchValue();
-            const basicDataType = addressSpace.findCorrespondingBasicDataType(field.dataType);
-            // istanbul ignore next
-            if (doDebug) {
-                const x = addressSpace.findNode(field.dataType).browseName.toString();
-                debugLog(chalk.cyan("xxx"), " dataType", w(field.dataType.toString(), 8), w(field.name, 35), "valueRank", chalk.cyan(w((0, base_node_private_1.valueRankToString)(field.valueRank), 10)), chalk.green(w(x, 25)), "basicType = ", chalk.yellow(w(basicDataType.toString(), 20)), propertyNode.nodeId.toString(), propertyNode.readValue().statusCode.toString());
-            }
-            if (this.$extensionObject[camelCaseName] !== undefined && basicDataType === node_opcua_variant_1.DataType.ExtensionObject) {
-                (0, node_opcua_assert_1.assert)(this.$extensionObject[camelCaseName] instanceof Object);
-                this.$extensionObject[camelCaseName] = new Proxy(this.$extensionObject[camelCaseName], makeHandler(propertyNode));
-                propertyNode._internal_set_value(new node_opcua_variant_1.Variant({
-                    dataType: node_opcua_variant_1.DataType.ExtensionObject,
-                    value: this.$extensionObject[camelCaseName]
-                }));
-                propertyNode.bindExtensionObject();
-                propertyNode.$extensionObject = this.$extensionObject[camelCaseName];
-            }
-            else {
-                const prop = this.$extensionObject[camelCaseName];
-                if (prop === undefined) {
-                    propertyNode._internal_set_value(new node_opcua_variant_1.Variant({
-                        dataType: node_opcua_variant_1.DataType.Null
-                    }));
-                }
-                else {
-                    const preparedValue = prepareVariantValue(basicDataType, prop);
-                    propertyNode._internal_set_value(new node_opcua_variant_1.Variant({
-                        dataType: basicDataType,
-                        value: preparedValue
-                    }));
-                }
-                // eslint-disable-next-line @typescript-eslint/no-this-alias
-                const self = this;
-                //  property.camelCaseName = camelCaseName;
-                propertyNode.setValueFromSource = function (variant) {
-                    // eslint-disable-next-line @typescript-eslint/no-this-alias
-                    const inner_this = this;
-                    const variant1 = node_opcua_variant_1.Variant.coerce(variant);
-                    inner_this.verifyVariantCompatibility(variant1);
-                    self.$extensionObject[camelCaseName] = variant1.value;
-                    self.touchValue();
-                };
-            }
-            (0, node_opcua_assert_1.assert)(propertyNode.readValue().statusCode.equals(node_opcua_status_code_1.StatusCodes.Good));
-            bindProperty(propertyNode, camelCaseName, this.$extensionObject, basicDataType);
         }
-        (0, node_opcua_assert_1.assert)(this.$extensionObject instanceof Object);
-        return this.$extensionObject;
+    }
+    /**
+     * @method bindExtensionObject
+     * @return {ExtensionObject}
+     */
+    bindExtensionObject(optionalExtensionObject, options) {
+        return (0, ua_variable_impl_ext_obj_1._bindExtensionObject)(this, optionalExtensionObject, options);
     }
     updateExtensionObjectPartial(partialExtensionObject) {
-        setExtensionObjectValue(this, partialExtensionObject);
+        (0, ua_variable_impl_ext_obj_1.setExtensionObjectValue)(this, partialExtensionObject);
         return this.$extensionObject;
     }
     incrementExtensionObjectPartial(path) {
-        let name;
-        if (typeof path === "string") {
-            path = path.split(".");
-        }
-        (0, node_opcua_assert_1.assert)(path instanceof Array);
-        const extensionObject = this.constructExtensionObjectFromComponents();
-        let i;
-        // read partial value
-        const partialData = {};
-        let p = partialData;
-        for (i = 0; i < path.length - 1; i++) {
-            name = path[i];
-            p[name] = {};
-            p = p[name];
-        }
-        name = path[path.length - 1];
-        p[name] = 0;
-        let c1 = partialData;
-        let c2 = extensionObject;
-        for (i = 0; i < path.length - 1; i++) {
-            name = path[i];
-            c1 = partialData[name];
-            c2 = extensionObject[name];
-        }
-        name = path[path.length - 1];
-        c1[name] = c2[name];
-        c1[name] += 1;
-        setExtensionObjectValue(this, partialData);
-    }
-    constructExtensionObjectFromComponents() {
-        return this.readValue().value.value;
+        const extensionObject = this.readValue().value.value;
+        const partialData = (0, ua_variable_impl_ext_obj_1.extractPartialData)(path, extensionObject);
+        (0, ua_variable_impl_ext_obj_1.setExtensionObjectValue)(this, partialData);
     }
     toString() {
         const options = new base_node_private_1.ToStringBuilder();
@@ -1356,6 +1133,14 @@ class UAVariableImpl extends base_node_impl_1.BaseNodeImpl {
                 warningLog(dataValue.toString());
                 throw new Error("Invalid Extension Object on nodeId =" + this.nodeId.toString());
             }
+            // ----------------------------------
+            // if (this.$extensionObject) {
+            //     // we have an extension object already bound to this node
+            //     // the client is asking us to replace the object entierly by a new one
+            //     const ext = dataValue.value.value;
+            //     _setExtensionObject(this, ext);
+            //     return;
+            // }
         }
         // // istanbul ignore next
         // if (this.dataType.namespace === 0) {
@@ -1750,48 +1535,6 @@ function bind_getter(options) {
         }
     }
 }
-function w(str, n) {
-    return (str + "                                                              ").substr(0, n);
-}
-function _getter(target, key /*, receiver*/) {
-    if (target[key] === undefined) {
-        return undefined;
-    }
-    return target[key];
-}
-function _setter(variable, target, key, value /*, receiver*/) {
-    target[key] = value;
-    const child = variable[key];
-    if (child && child.touchValue) {
-        child.touchValue();
-    }
-    return true; // true means the set operation has succeeded
-}
-function makeHandler(variable) {
-    const handler = {
-        get: _getter,
-        set: _setter.bind(null, variable)
-    };
-    return handler;
-}
-function setExtensionObjectValue(node, partialObject) {
-    const extensionObject = node.$extensionObject;
-    if (!extensionObject) {
-        throw new Error("setExtensionObjectValue node has no extension object " + node.browseName.toString());
-    }
-    function _update_extension_object(extObject, partialObject1) {
-        const keys = Object.keys(partialObject1);
-        for (const prop of keys) {
-            if (extObject[prop] instanceof Object) {
-                _update_extension_object(extObject[prop], partialObject1[prop]);
-            }
-            else {
-                extObject[prop] = partialObject1[prop];
-            }
-        }
-    }
-    _update_extension_object(extensionObject, partialObject);
-}
 class UAVariableImplT extends UAVariableImpl {
 }
 exports.UAVariableImplT = UAVariableImplT;