node-opcua-address-space 2.179.0 → 2.181.0

package/dist/impl/alarms_and_conditions/ua_off_normal_alarm_impl.js

@@ -0,0 +1,164 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UAOffNormalAlarmImpl = exports.UAOffNormalAlarmImplBase = void 0;
+const node_opcua_assert_1 = require("node-opcua-assert");
+const node_opcua_nodeid_1 = require("node-opcua-nodeid");
+const node_opcua_utils_1 = require("node-opcua-utils");
+const node_opcua_variant_1 = require("node-opcua-variant");
+const ua_discrete_alarm_impl_js_1 = require("./ua_discrete_alarm_impl.js");
+function isEqual(value1, value2) {
+    return value1 === value2;
+}
+/**
+ * The OffNormalAlarmType is a specialization of the DiscreteAlarmType intended to represent a
+ * discrete Condition that is considered to be not normal.
+ * This sub type is usually used to indicate that a discrete value is in an Alarm state, it is active as
+ * long as a non-normal value is present.
+ */
+class UAOffNormalAlarmImplBase extends ua_discrete_alarm_impl_js_1.UADiscreteAlarmImplBase {
+    /**
+     * When the value of inputNode doesn't match the normalState node value, then the alarm is raised.
+     *
+     */
+    static instantiate(namespace, limitAlarmTypeId, options, data) {
+        const addressSpace = namespace.addressSpace;
+        const offNormalAlarmType = addressSpace.findEventType("OffNormalAlarmType");
+        /* c8 ignore next */
+        if (!offNormalAlarmType) {
+            throw new Error("cannot find offNormalAlarmType");
+        }
+        (0, node_opcua_assert_1.assert)(Object.hasOwn(options, "inputNode"), "must provide inputNode"); // must provide a inputNode
+        (0, node_opcua_assert_1.assert)(Object.hasOwn(options, "normalState"), "must provide a normalState Node"); // must provide a inputNode
+        options.optionals = options.optionals || [];
+        (0, node_opcua_assert_1.assert)(Object.hasOwn(options, "inputNode"), "must provide inputNode"); // must provide a inputNode
+        const alarmNode = ua_discrete_alarm_impl_js_1.UADiscreteAlarmImplBase.instantiate(namespace, limitAlarmTypeId, options, data);
+        Object.setPrototypeOf(alarmNode, exports.UAOffNormalAlarmImpl.prototype);
+        /**
+         * The InputNode Property provides the NodeId of the Variable the Value of which is used as primary input in
+         * the calculation of the Alarm state.
+         *
+         * If this Variable is not in the AddressSpace, a NULL NodeId shall be provided.
+         *
+         * In some systems, an Alarm may be calculated based on multiple Variables Values;
+         * it is up to the system to determine which Variable’s NodeId is used.
+         */
+        const inputNode = addressSpace._coerceNode(options.inputNode);
+        // note: alarmNode.inputNode.readValue() already set by DiscreteAlarmImpl.instantiate
+        if (inputNode) {
+            // install inputNode Node monitoring for change
+            alarmNode.installInputNodeMonitoring(options.inputNode);
+        }
+        /**
+         * The NormalState Property is a Property that points to a Variable which has a value that corresponds to one
+         * of the possible values of the Variable pointed to by the InputNode Property where the NormalState Property
+         * Variable value is the value that is considered to be the normal state of the Variable pointed to by the InputNode
+         * Property. When the value of the Variable referenced by the InputNode Property is not equal to the value of the
+         * NormalState Property the Alarm is Active.
+         *
+         * If this Variable is not in the AddressSpace, a NULL NodeId shall be provided.
+         *
+         */
+        if (options.normalState) {
+            const normalState = addressSpace._coerceNode(options.normalState);
+            const normalStateNodeId = normalState ? normalState.nodeId : new node_opcua_nodeid_1.NodeId();
+            alarmNode.normalState.setValueFromSource({ dataType: node_opcua_variant_1.DataType.NodeId, value: normalStateNodeId });
+            alarmNode.normalState.on("value_changed", (_newDataValue) => {
+                // The node that contains the normalState value has changed.
+                //   we must remove the listener on current normalState and replace
+                //   normalState with the new one and set listener again
+                //   to do:
+            });
+            if (normalState) {
+                // install normalState monitoring for change
+                normalState.on("value_changed", (newDataValue /*, oldDataValue: DataValue*/) => {
+                    alarmNode._onNormalStateDataValueChange(newDataValue);
+                });
+            }
+        }
+        else {
+            alarmNode.normalState.setValueFromSource({ dataType: node_opcua_variant_1.DataType.NodeId, value: node_opcua_nodeid_1.NodeId.nullNodeId });
+        }
+        alarmNode._mayBe_updateAlarmState();
+        return alarmNode;
+    }
+    // HasProperty Variable NormalState NodeId PropertyType Mandatory
+    // The NormalState Property is a Property that points to a Variable which has a value that
+    // corresponds to one of the possible values of the Variable pointed to by the InputNode
+    // Property where the NormalState Property Variable value is the value that is considered to be
+    // the normal state of the Variable pointed to by the InputNode Property. When the value of the
+    // Variable referenced by the InputNode Property is not equal to the value of the NormalState
+    // Property the Alarm is Active. If this Variable is not in the AddressSpace, a Null NodeId shall
+    // be provided.
+    getNormalStateNode() {
+        const nodeId = this.normalState.readValue().value.value;
+        const node = this.addressSpace.findNode(nodeId);
+        if (!node) {
+            return null;
+        }
+        return node;
+    }
+    /**
+     */
+    getNormalStateValue() {
+        const normalStateNode = this.getNormalStateNode();
+        if (!normalStateNode) {
+            return null;
+        }
+        return normalStateNode.readValue().value.value;
+    }
+    /**
+     */
+    setNormalStateValue(_value) {
+        const _normalStateNode = this.getNormalStateNode();
+        throw new Error("Not Implemented yet");
+    }
+    updateAlarmState(isActive, message) {
+        if (isActive === this.activeState.getValue()) {
+            // no change => ignore !
+            return;
+        }
+        const stateName = isActive ? "Active" : "Inactive";
+        // also raise the event
+        this._signalNewCondition(stateName, isActive, message);
+        if (!isActive) {
+            this.currentBranch().setRetain(false);
+        }
+    }
+    _mayBe_updateAlarmState(normalStateValue, inputValue) {
+        if ((0, node_opcua_utils_1.isNullOrUndefined)(normalStateValue) || (0, node_opcua_utils_1.isNullOrUndefined)(inputValue)) {
+            this.activeState.setValue(false);
+            return;
+        }
+        const isActive = !isEqual(normalStateValue, inputValue);
+        this.updateAlarmState(isActive, "automatique update");
+    }
+    _onInputDataValueChange(dataValue) {
+        if (dataValue.statusCode.isNotGood()) {
+            // what shall we do ?
+            return;
+        }
+        if (dataValue.value.dataType === node_opcua_variant_1.DataType.Null) {
+            // what shall we do ?
+            return;
+        }
+        const inputValue = dataValue.value.value;
+        const normalStateValue = this.getNormalStateValue();
+        this._mayBe_updateAlarmState(normalStateValue, inputValue);
+    }
+    _onNormalStateDataValueChange(dataValue) {
+        if (dataValue.statusCode.isNotGood()) {
+            // what shall we do ?
+            return;
+        }
+        if (dataValue.value.dataType === node_opcua_variant_1.DataType.Null) {
+            // what shall we do ?
+            return;
+        }
+        const normalStateValue = dataValue.value.value;
+        const inputValue = this.getInputNodeValue();
+        this._mayBe_updateAlarmState(normalStateValue, inputValue);
+    }
+}
+exports.UAOffNormalAlarmImplBase = UAOffNormalAlarmImplBase;
+exports.UAOffNormalAlarmImpl = UAOffNormalAlarmImplBase;
+//# sourceMappingURL=ua_off_normal_alarm_impl.js.map

package/dist/impl/alarms_and_conditions/ua_off_normal_alarm_impl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ua_off_normal_alarm_impl.js","sourceRoot":"","sources":["../../../impl/alarms_and_conditions/ua_off_normal_alarm_impl.ts"],"names":[],"mappings":";;;AAIA,yDAA2C;AAE3C,yDAA4D;AAG5D,uDAAqD;AACrD,2DAAmE;AAInE,2EAAsE;AAEtE,SAAS,OAAO,CAAC,MAAe,EAAE,MAAe;IAC7C,OAAO,MAAM,KAAK,MAAM,CAAC;AAC7B,CAAC;AAuBD;;;;;GAKG;AACH,MAAa,wBAAyB,SAAQ,mDAAuB;IAIjE;;;OAGG;IACI,MAAM,CAAC,WAAW,CACrB,SAAqB,EACrB,gBAAiC,EACjC,OAAyC,EACzC,IAAqC;QAErC,MAAM,YAAY,GAAG,SAAS,CAAC,YAAmC,CAAC;QAEnE,MAAM,kBAAkB,GAAG,YAAY,CAAC,aAAa,CAAC,oBAAoB,CAAC,CAAC;QAC5E,oBAAoB;QACpB,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;QACtD,CAAC;QAED,IAAA,0BAAM,EAAC,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,WAAW,CAAC,EAAE,wBAAwB,CAAC,CAAC,CAAC,2BAA2B;QAClG,IAAA,0BAAM,EAAC,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,aAAa,CAAC,EAAE,iCAAiC,CAAC,CAAC,CAAC,2BAA2B;QAC7G,OAAO,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,EAAE,CAAC;QAE5C,IAAA,0BAAM,EAAC,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,WAAW,CAAC,EAAE,wBAAwB,CAAC,CAAC,CAAC,2BAA2B;QAClG,MAAM,SAAS,GAAG,mDAAuB,CAAC,WAAW,CAAC,SAAS,EAAE,gBAAgB,EAAE,OAAO,EAAE,IAAI,CAAyB,CAAC;QAC1H,MAAM,CAAC,cAAc,CAAC,SAAS,EAAE,4BAAoB,CAAC,SAAS,CAAC,CAAC;QAEjE;;;;;;;;WAQG;QACH,MAAM,SAAS,GAAG,YAAY,CAAC,WAAW,CAAC,OAAO,CAAC,SAAS,CAAsB,CAAC;QACnF,qFAAqF;QAErF,IAAI,SAAS,EAAE,CAAC;YACZ,+CAA+C;YAC/C,SAAS,CAAC,0BAA0B,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAC5D,CAAC;QAED;;;;;;;;;WASG;QACH,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;YACtB,MAAM,WAAW,GAAG,YAAY,CAAC,WAAW,CAAC,OAAO,CAAC,WAAW,CAAsB,CAAC;YACvF,MAAM,iBAAiB,GAAG,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,0BAAM,EAAE,CAAC;YAC1E,SAAS,CAAC,WAAW,CAAC,kBAAkB,CAAC,EAAE,QAAQ,EAAE,6BAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,iBAAiB,EAAE,CAAC,CAAC;YAClG,SAAS,CAAC,WAAW,CAAC,EAAE,CAAC,eAAe,EAAE,CAAC,aAAwB,EAAE,EAAE;gBACnE,4DAA4D;gBAC5D,mEAAmE;gBACnE,wDAAwD;gBACxD,WAAW;YACf,CAAC,CAAC,CAAC;YACH,IAAI,WAAW,EAAE,CAAC;gBACd,4CAA4C;gBAC5C,WAAW,CAAC,EAAE,CAAC,eAAe,EAAE,CAAC,YAAuB,CAAC,6BAA6B,EAAE,EAAE;oBACtF,SAAS,CAAC,6BAA6B,CAAC,YAAY,CAAC,CAAC;gBAC1D,CAAC,CAAC,CAAC;YACP,CAAC;QACL,CAAC;aAAM,CAAC;YACJ,SAAS,CAAC,WAAW,CAAC,kBAAkB,CAAC,EAAE,QAAQ,EAAE,6BAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,0BAAM,CAAC,UAAU,EAAE,CAAC,CAAC;QACtG,CAAC;QAED,SAAS,CAAC,uBAAuB,EAAE,CAAC;QAEpC,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,iEAAiE;IACjE,0FAA0F;IAC1F,wFAAwF;IACxF,+FAA+F;IAC/F,+FAA+F;IAC/F,6FAA6F;IAC7F,iGAAiG;IACjG,eAAe;IACR,kBAAkB;QACrB,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC;QACxD,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAyC,CAAC;QACxF,IAAI,CAAC,IAAI,EAAE,CAAC;YACR,OAAO,IAAI,CAAC;QAChB,CAAC;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;OACG;IACI,mBAAmB;QACtB,MAAM,eAAe,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAClD,IAAI,CAAC,eAAe,EAAE,CAAC;YACnB,OAAO,IAAI,CAAC;QAChB,CAAC;QACD,OAAO,eAAe,CAAC,SAAS,EAAE,CAAC,KAAK,CAAC,KAAe,CAAC;IAC7D,CAAC;IAED;OACG;IACI,mBAAmB,CAAC,MAAkB;QACzC,MAAM,gBAAgB,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;QACnD,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;IAC3C,CAAC;IAEM,gBAAgB,CAAC,QAAiB,EAAE,OAAe;QACtD,IAAI,QAAQ,KAAK,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,EAAE,CAAC;YAC3C,wBAAwB;YACxB,OAAO;QACX,CAAC;QACD,MAAM,SAAS,GAAG,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC;QACnD,uBAAuB;QACvB,IAAI,CAAC,mBAAmB,CAAC,SAAS,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QACvD,IAAI,CAAC,QAAQ,EAAE,CAAC;YACZ,IAAI,CAAC,aAAa,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAC1C,CAAC;IACL,CAAC;IAED,uBAAuB,CAAC,gBAAgC,EAAE,UAAoB;QAC1E,IAAI,IAAA,oCAAiB,EAAC,gBAAgB,CAAC,IAAI,IAAA,oCAAiB,EAAC,UAAU,CAAC,EAAE,CAAC;YACvE,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YACjC,OAAO;QACX,CAAC;QACD,MAAM,QAAQ,GAAG,CAAC,OAAO,CAAC,gBAAgB,EAAE,UAAU,CAAC,CAAC;QACxD,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,oBAAoB,CAAC,CAAC;IAC1D,CAAC;IAES,uBAAuB,CAAC,SAAoB;QAClD,IAAI,SAAS,CAAC,UAAU,CAAC,SAAS,EAAE,EAAE,CAAC;YACnC,qBAAqB;YACrB,OAAO;QACX,CAAC;QACD,IAAI,SAAS,CAAC,KAAK,CAAC,QAAQ,KAAK,6BAAQ,CAAC,IAAI,EAAE,CAAC;YAC7C,qBAAqB;YACrB,OAAO;QACX,CAAC;QACD,MAAM,UAAU,GAAG,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC;QACzC,MAAM,gBAAgB,GAAG,IAAI,CAAC,mBAAmB,EAAE,CAAC;QACpD,IAAI,CAAC,uBAAuB,CAAC,gBAAgB,EAAE,UAAU,CAAC,CAAC;IAC/D,CAAC;IAES,6BAA6B,CAAC,SAAoB;QACxD,IAAI,SAAS,CAAC,UAAU,CAAC,SAAS,EAAE,EAAE,CAAC;YACnC,qBAAqB;YACrB,OAAO;QACX,CAAC;QACD,IAAI,SAAS,CAAC,KAAK,CAAC,QAAQ,KAAK,6BAAQ,CAAC,IAAI,EAAE,CAAC;YAC7C,qBAAqB;YACrB,OAAO;QACX,CAAC;QACD,MAAM,gBAAgB,GAAG,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC;QAC/C,MAAM,UAAU,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC5C,IAAI,CAAC,uBAAuB,CAAC,gBAAgB,EAAE,UAAU,CAAC,CAAC;IAC/D,CAAC;CACJ;AArKD,4DAqKC;AAGY,QAAA,oBAAoB,GAAG,wBAAwB,CAAC"}

package/dist/impl/alarms_and_conditions/ua_system_off_normal_alarm_impl.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @module node-opcua-address-space.AlarmsAndConditions
+ */
+import type { INamespace } from "node-opcua-address-space-base";
+import type { NodeId } from "node-opcua-nodeid";
+import type { VariantOptions } from "node-opcua-variant";
+import type { InstantiateOffNormalAlarmOptions } from "../../api/interfaces/alarms_and_conditions/instantiate_off_normal_alarm_options.js";
+import { UAOffNormalAlarmImpl } from "./ua_off_normal_alarm_impl.js";
+/**
+ *
+ * This Condition is used by a Server to indicate that an underlying system that is providing  Alarm information is
+ * having a communication problem and that the Server may have invalid or incomplete Condition state in the
+ * Subscription.
+ *
+ */
+export declare class UASystemOffNormalAlarmImpl extends UAOffNormalAlarmImpl {
+    static instantiate(namespace: INamespace, limitAlarmTypeId: string | NodeId, options: InstantiateOffNormalAlarmOptions, data?: Record<string, VariantOptions>): UASystemOffNormalAlarmImpl;
+}

package/dist/impl/alarms_and_conditions/ua_system_off_normal_alarm_impl.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UASystemOffNormalAlarmImpl = void 0;
+const ua_off_normal_alarm_impl_js_1 = require("./ua_off_normal_alarm_impl.js");
+/**
+ *
+ * This Condition is used by a Server to indicate that an underlying system that is providing  Alarm information is
+ * having a communication problem and that the Server may have invalid or incomplete Condition state in the
+ * Subscription.
+ *
+ */
+class UASystemOffNormalAlarmImpl extends ua_off_normal_alarm_impl_js_1.UAOffNormalAlarmImpl {
+    static instantiate(namespace, limitAlarmTypeId, options, data) {
+        return ua_off_normal_alarm_impl_js_1.UAOffNormalAlarmImplBase.instantiate(namespace, limitAlarmTypeId, options, data);
+    }
+}
+exports.UASystemOffNormalAlarmImpl = UASystemOffNormalAlarmImpl;
+//# sourceMappingURL=ua_system_off_normal_alarm_impl.js.map

package/dist/impl/alarms_and_conditions/ua_system_off_normal_alarm_impl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ua_system_off_normal_alarm_impl.js","sourceRoot":"","sources":["../../../impl/alarms_and_conditions/ua_system_off_normal_alarm_impl.ts"],"names":[],"mappings":";;;AAOA,+EAA+F;AAE/F;;;;;;GAMG;AACH,MAAa,0BAA2B,SAAQ,kDAAoB;IACzD,MAAM,CAAC,WAAW,CACrB,SAAqB,EACrB,gBAAiC,EACjC,OAAyC,EACzC,IAAqC;QAErC,OAAO,sDAAwB,CAAC,WAAW,CAAC,SAAS,EAAE,gBAAgB,EAAE,OAAO,EAAE,IAAI,CAA+B,CAAC;IAC1H,CAAC;CACJ;AATD,gEASC"}

package/dist/impl/apply_condition_refresh.d.ts

@@ -0,0 +1,4 @@
+import type { UAObject, UAVariable } from "../api/index.js";
+import type { UAObjectImpl } from "./ua_object_impl.js";
+export type ConditionRefreshCache = Map<string, UAObjectImpl>;
+export declare function apply_condition_refresh(this: UAObject | UAVariable, cache?: ConditionRefreshCache): void;

package/dist/impl/apply_condition_refresh.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.apply_condition_refresh = apply_condition_refresh;
+function isCondition(node) {
+    return typeof node._resend_conditionEvents === "function";
+}
+function apply_condition_refresh(cache) {
+    // visit all notifiers recursively
+    cache = cache || new Map();
+    const notifiers = this.getNotifiers();
+    const eventSources = this.getEventSources();
+    const conditions = this.findReferencesAsObject("HasCondition", true);
+    for (const condition of conditions) {
+        if (isCondition(condition)) {
+            condition._resend_conditionEvents();
+        }
+    }
+    const arr = [...notifiers, ...eventSources];
+    for (const notifier of arr) {
+        const key = notifier.nodeId.toString();
+        if (!cache.has(key)) {
+            cache.set(key, notifier);
+            if (notifier._conditionRefresh) {
+                notifier._conditionRefresh(cache);
+            }
+        }
+    }
+}
+//# sourceMappingURL=apply_condition_refresh.js.map

package/dist/impl/apply_condition_refresh.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"apply_condition_refresh.js","sourceRoot":"","sources":["../../impl/apply_condition_refresh.ts"],"names":[],"mappings":";;AAgCA,0DAuBC;AA3BD,SAAS,WAAW,CAAC,IAAY;IAC7B,OAAO,OAAQ,IAA+B,CAAC,uBAAuB,KAAK,UAAU,CAAC;AAC1F,CAAC;AAED,SAAgB,uBAAuB,CAA8B,KAA6B;IAC9F,kCAAkC;IAClC,KAAK,GAAG,KAAK,IAAI,IAAI,GAAG,EAAE,CAAC;IAC3B,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;IACtC,MAAM,YAAY,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;IAE5C,MAAM,UAAU,GAAG,IAAI,CAAC,sBAAsB,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;IACrE,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;QACjC,IAAI,WAAW,CAAC,SAAS,CAAC,EAAE,CAAC;YACzB,SAAS,CAAC,uBAAuB,EAAE,CAAC;QACxC,CAAC;IACL,CAAC;IACD,MAAM,GAAG,GAAG,CAAC,GAAG,SAAS,EAAE,GAAG,YAAY,CAAmB,CAAC;IAE9D,KAAK,MAAM,QAAQ,IAAI,GAAG,EAAE,CAAC;QACzB,MAAM,GAAG,GAAG,QAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;QACvC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YAClB,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;YACzB,IAAI,QAAQ,CAAC,iBAAiB,EAAE,CAAC;gBAC7B,QAAQ,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;YACtC,CAAC;QACL,CAAC;IACL,CAAC;AACL,CAAC"}

package/dist/impl/base_node_impl.d.ts

@@ -0,0 +1,347 @@
+/**
+ * @module node-opcua-address-space
+ */
+import { type AddReferenceOpts, type AttributeEventName, type BaseNode, type BaseNodeEvents, type BrowseDescriptionOptions2, type IAddressSpace, type INamespace, type ISessionContext, type ListenerSignature, type ModellingRuleType, TypedEventEmitter, type UAMethod, type UAObject, type UAObjectType, type UAProperty, type UAReference, type UAReferenceType, type UAVariable, type UAVariableType } from "node-opcua-address-space-base";
+import type { UAString } from "node-opcua-basic-types";
+import { AccessRestrictionsFlag, AttributeIds, BrowseDirection, LocalizedText, type LocalizedTextLike, NodeClass, QualifiedName, type QualifiedNameLike, type QualifiedNameOptions } from "node-opcua-data-model";
+import { DataValue } from "node-opcua-data-value";
+import { NodeId, type NodeIdLike } from "node-opcua-nodeid";
+import type { UAStateVariable } from "node-opcua-nodeset-ua";
+import type { NumericRange } from "node-opcua-numeric-range";
+import type { ReferenceDescription } from "node-opcua-service-browse";
+import { type StatusCode } from "node-opcua-status-code";
+import { type RelativePathElement, RolePermissionType, type RolePermissionTypeOptions, type WriteValueOptions } from "node-opcua-types";
+import { DataType } from "node-opcua-variant";
+import type { XmlWriter } from "../api/xml_writer.js";
+import type { AddressSpacePrivate } from "./address_space_private.js";
+export interface InternalBaseNodeOptions {
+    /**
+     * the parent address space
+     */
+    addressSpace: AddressSpacePrivate;
+    browseName: QualifiedName;
+    nodeId: NodeId;
+    references?: UAReference[];
+    displayName?: LocalizedTextLike | LocalizedTextLike[];
+    description?: LocalizedTextLike | null;
+    browseFilter?: (this: BaseNode, context?: ISessionContext) => boolean;
+    /**
+     * https://reference.opcfoundation.org/v104/Core/docs/Part3/8.56/
+     */
+    accessRestrictions?: AccessRestrictionsFlag;
+    rolePermissions?: RolePermissionTypeOptions[];
+}
+export declare function makeAttributeEventName(attributeId: AttributeIds): AttributeEventName;
+/**
+ * Base class for all Node classes
+ *
+ * BaseNode is the base class for all the OPCUA objects in the address space
+ * It provides attributes and a set of references to other nodes.
+ * see:
+ * {{#crossLink "UAObject"}}{{/crossLink}},
+ * {{#crossLink "UAVariable"}}{{/crossLink}},
+ * {{#crossLink "Reference"}}{{/crossLink}},
+ * {{#crossLink "UAMethod"}}{{/crossLink}},
+ * {{#crossLink "UAView"}}{{/crossLink}},
+ * {{#crossLink "UAObjectType"}}{{/crossLink}},
+ * {{#crossLink "UADataType"}}{{/crossLink}},
+ * {{#crossLink "UAVariableType"}}{{/crossLink}},
+ *
+ *
+ */
+export declare abstract class BaseNodeImpl<T extends BaseNodeEvents & ListenerSignature<T> = BaseNodeEvents> extends TypedEventEmitter<T> implements BaseNode<T> {
+    static makeAttributeEventName(attributeId: AttributeIds): AttributeEventName;
+    private _accessRestrictions?;
+    private _rolePermissions?;
+    get addressSpace(): IAddressSpace;
+    protected get addressSpacePrivate(): AddressSpacePrivate;
+    get displayName(): LocalizedText[];
+    setDisplayName(value: LocalizedTextLike[] | LocalizedTextLike): void;
+    get description(): LocalizedText;
+    setDescription(value: LocalizedTextLike | null): void;
+    /**
+     * returns the nodeId of this node's Type Definition
+     */
+    get typeDefinition(): NodeId;
+    /**
+     * returns the nodeId of this node's Type Definition
+     */
+    get typeDefinitionObj(): UAObjectType | UAVariableType;
+    get parentNodeId(): NodeId | undefined;
+    /**
+     * namespace index
+     */
+    get namespaceIndex(): number;
+    /**
+     * namespace uri
+     */
+    get namespaceUri(): string;
+    /**
+     * the parent node
+     */
+    get parent(): BaseNode | null;
+    /**
+     * @property modellingRule
+     * @type {String|undefined}
+     */
+    get modellingRule(): ModellingRuleType | undefined;
+    readonly nodeClass: NodeClass;
+    readonly nodeId: NodeId;
+    readonly browseName: QualifiedName;
+    protected _postInstantiateFunc?: (instance: BaseNode, instanceType: BaseNode, options?: unknown) => void;
+    /**
+     * @internal
+     * @param options
+     */
+    constructor(options: InternalBaseNodeOptions);
+    getDisplayName(_locale?: string): string;
+    get namespace(): INamespace;
+    findReferencesEx(referenceType: string | NodeId | UAReferenceType, browseDirection?: BrowseDirection): UAReference[];
+    findReferences_no_cache(referenceTypeNode: UAReferenceType, isForward?: boolean): UAReference[];
+    findReferences(referenceType: string | NodeId | UAReferenceType, isForward?: boolean): UAReference[];
+    findReference(strReference: string | NodeId | UAReferenceType, isForward?: boolean): UAReference | null;
+    findReferencesExAsObject(referenceType: string | NodeId | UAReferenceType, browseDirection?: BrowseDirection): BaseNode[];
+    findReferencesAsObject(referenceType: string | NodeId | UAReferenceType, isForward?: boolean): BaseNode[];
+    /**
+     * return an array with the Aggregates of this object.
+     */
+    getAggregates(): BaseNode[];
+    /**
+     * return an array with the components of this object.
+     */
+    getComponents(): BaseNode[];
+    /**
+     *  return a array with the properties of this object.
+     */
+    getProperties(): BaseNode[];
+    private static _hasChild;
+    getChildren(): BaseNode[];
+    /**
+     * return a array with the notifiers of this object.
+     * only reference of exact type HasNotifier are returned.
+     */
+    getNotifiers(): BaseNode[];
+    /**
+     * return a array with the event source of this object.
+     *  only reference of exact type HasEventSource are returned.
+     */
+    getEventSources(): BaseNode[];
+    /**
+     * return a array of the objects for which this node is an EventSource
+     */
+    getEventSourceOfs(): BaseNode[];
+    /**
+     * the children of this node named `browseName` reached through a reference of type
+     * `referenceType` or a subtype of it, read from the child index rather than by scanning the
+     * references of the node again
+     */
+    private _selectChildren;
+    /**
+     * retrieve a component by name
+     */
+    getComponentByName(browseName: QualifiedNameOptions): UAVariable | UAObject | null;
+    getComponentByName(browseName: string, namespaceIndex?: number): UAVariable | UAObject | null;
+    /**
+     * retrieve a property by name
+     */
+    getPropertyByName(browseName: QualifiedNameOptions): UAVariable | null;
+    getPropertyByName(browseName: string, namespaceIndex?: number): UAVariable | null;
+    /**
+     * retrieve a folder element by name
+     */
+    getFolderElementByName(browseName: QualifiedNameOptions): BaseNode | null;
+    getFolderElementByName(browseName: string, namespaceIndex?: number): BaseNode | null;
+    /**
+     * returns the list of nodes that this folder object organizes
+     */
+    getFolderElements(): BaseNodeImpl[];
+    /**
+     * returns the list of methods that this object provides
+     * @return an array with Method objects.
+     *
+     *
+     * Note: internally, methods are special types of components
+     */
+    getMethods(): UAMethod[];
+    /**
+     * returns the method exposed by this object and with the given nodeId
+     */
+    getMethodById(nodeId: NodeId): UAMethod | null;
+    getMethodByName(methodName: QualifiedNameOptions): UAMethod | null;
+    getMethodByName(methodName: string, namespaceIndex?: number): UAMethod | null;
+    getWriteMask(): number;
+    getUserWriteMask(): number;
+    readAttribute(context: ISessionContext | null, attributeId: AttributeIds, indexRange?: NumericRange, dataEncoding?: QualifiedNameLike | null): DataValue;
+    writeAttribute(context: ISessionContext | null, writeValue: WriteValueOptions, callback: (err: Error | null, statusCode?: StatusCode) => void): void;
+    fullName(): string;
+    ownReferences(): UAReference[];
+    /**
+     *
+     * @param relativePathElement
+     * @param isLast
+     * @return {NodeId[]}
+     */
+    browseNodeByTargetName(relativePathElement: RelativePathElement, isLast: boolean): NodeId[];
+    /**
+     * the references of this node that can answer a relative path element, taken from the child
+     * index, or null when the element is one the index cannot answer (an inverse step, an
+     * unspecified or non-hierarchical reference type, no target name)
+     */
+    private _hierarchicalStepCandidates;
+    /**
+     * browse the node to extract information requested in browseDescription
+     * and returns an array with reference descriptions
+     *
+     *
+     *
+     */
+    browseNode(browseDescription: BrowseDescriptionOptions2, context?: ISessionContext): ReferenceDescription[];
+    allReferences(): UAReference[];
+    /**
+     * @param reference
+     * @param reference.referenceType {String}
+     * @param [reference.isForward = true] {Boolean}
+     * @param reference.nodeId {Node|NodeId|String}
+     *
+     * @example
+     *
+     *     view.addReference({ referenceType: "Organizes", nodeId: myDevice });
+     *
+     * or
+     *
+     *     myDevice1.addReference({ referenceType: "OrganizedBy", nodeId: view });
+     */
+    addReference(reference: AddReferenceOpts): void;
+    removeReference(referenceOpts: AddReferenceOpts): void;
+    /**
+     *
+     */
+    resolveNodeId(nodeId: NodeIdLike): NodeId;
+    /**
+     * Expose the hierarchical children of this node as properties of this node, and this node as
+     * a property of its parents, for the browse names that have no shared accessor.
+     *
+     * A node created while a nodeset loads needs nothing here: its name got a getter on the
+     * prototype (see child_accessors.ts). This is the path for nodes created afterwards through the
+     * namespace API, whose browse names may be anything and must not touch the prototype.
+     */
+    install_extra_properties(): void;
+    /**
+     * undo install_extra_properties for one reference, on both ends when it is an inverse one
+     */
+    uninstall_extra_properties(reference: UAReference): void;
+    toString(): string;
+    toJSON(): Record<string, unknown>;
+    /**
+     * @property isFalseSubStateOf
+     * @type {BaseNode|null}
+     */
+    get isFalseSubStateOf(): BaseNode | null;
+    /**
+     * @property isTrueSubStateOf
+     * @type {BaseNode|null}
+     */
+    get isTrueSubStateOf(): BaseNode | null;
+    /**
+     * @return {UAStateVariable[]} return an array with the SubStates of this object.
+     */
+    getFalseSubStates(): UAStateVariable<LocalizedText>[];
+    /**
+
+     * @return {UAStateVariable[]} return an array with the SubStates of this object.
+     */
+    getTrueSubStates(): UAStateVariable<LocalizedText>[];
+    findHierarchicalReferences(): UAReference[];
+    getChildByName(browseName: QualifiedNameOptions): BaseNode | null;
+    getChildByName(browseName: string, namespaceIndex?: number): BaseNode | null;
+    getNodeVersion(): UAProperty<UAString, DataType.String> | null;
+    get nodeVersion(): UAProperty<UAString, DataType.String> | undefined;
+    set nodeVersion(_n: unknown);
+    get toStateNode(): BaseNode | null;
+    get fromStateNode(): BaseNode | null;
+    /**
+     * this methods propagates the forward references to the pointed node
+     * by inserting backward references to the counter part node
+     * @private
+     */
+    propagate_back_references(): void;
+    /**
+     * propagate_back_references for a node a NodeSet2 file declared: its references may be held
+     * by their target as well, so each is looked up there before a back reference is built
+     */
+    propagate_back_references_declared_from_both_ends(): void;
+    /** one reference of a node a NodeSet2 file declared, see propagate_back_references_declared_from_both_ends */
+    propagate_back_reference_declared_from_both_ends(reference: UAReference): void;
+    private _propagate_back_references;
+    /**
+     * the dispose method should be called when the node is no longer used, to release
+     * back pointer to the address space and clear caches.
+     *
+     * @private
+     */
+    dispose(): void;
+    isDisposed(): boolean;
+    dumpXML(xmlWriter: XmlWriter): void;
+    /**
+     * Undo the effect of propagate_back_references
+     */
+    unpropagate_back_references(): void;
+    installPostInstallFunc(f: (instance: BaseNode, tpyeNode: BaseNode, opts?: unknown) => void): void;
+    _on_child_added(childNode: BaseNode): void;
+    _on_child_removed(_obj: BaseNode): void;
+    /**
+     * @private
+     * @param reference
+     */
+    _add_backward_reference(reference: UAReference): void;
+    protected _coerceReferenceType(referenceType: string | NodeId | UAReferenceType): UAReferenceType | null;
+    private __addReference;
+    /** kept as given; the LocalizedText objects are built on first read (most nodes are never asked) */
+    private _setDisplayName;
+    private _setDescription;
+    private _notifyAttributeChange;
+    private _clear_caches;
+    canUserWriteAttribute(context: ISessionContext | null, attributeId: AttributeIds): boolean;
+    private _readAccessRestrictions;
+    private _readRolePermissions;
+    private _readUserRolePermissions;
+    /**
+     *
+     * @param rolePermissions
+     */
+    setRolePermissions(rolePermissions: RolePermissionTypeOptions[]): void;
+    getRolePermissions(inherited: boolean): RolePermissionType[] | null;
+    get rolePermissions(): RolePermissionType[] | undefined;
+    setAccessRestrictions(accessRestrictions: AccessRestrictionsFlag): void;
+    get accessRestrictions(): AccessRestrictionsFlag | undefined;
+    getAccessRestrictions(inherited: boolean): AccessRestrictionsFlag;
+}
+/**
+ * the child designated by `node.<accessorName>`: what the shared getters resolve, exposed for the
+ * code that walks dotted paths by name (`_getCompositeKey`); works under `isFrugal` too, where no
+ * own accessor is ever installed
+ */
+export declare function resolveChildAccessor(node: BaseNode, accessorName: string): BaseNode | undefined;
+/**
+ * The accessor names under which a child of `node` can never be reached: the reserved names, the
+ * members of the class of the node (attributes, methods, EventEmitter and Object members) and its
+ * own fields. A child carrying one of these is reachable through `getChildByName` only.
+ *
+ * The generator of the typed nodeset interfaces reads this so that a generated interface names a
+ * child exactly the way the runtime exposes it.
+ *
+ * @internal
+ */
+export declare function childAccessorNamesShadowedBy(node: BaseNode): Set<string>;
+/**
+ * Define the shared getter of every browse name seen since the last call: the nodeset loader calls
+ * it once a load is complete, so that the prototype changes in one batch rather than once per
+ * new name in the middle of node creation.
+ */
+export declare function flushSharedChildAccessors(): number;
+/**
+ * Give browse names created at runtime a shared accessor, for an application that builds its
+ * model through the namespace API and wants `parent.<child>` without an accessor on every parent.
+ */
+export declare function defineSharedChildAccessors(browseNames: string[]): void;
+export declare function getReferenceType(reference: UAReference): UAReferenceType;