node-opcua-client 2.76.0 → 2.77.0

package/dist/alarms_and_conditions/client_alarm_tools_acknowledge_all_conditions.js

@@ -1,193 +1,193 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.confirmAllConditions = exports.acknwoledgeAllConditions = exports.findActiveConditions = exports.confirmCondition = exports.acknowledgeCondition = void 0;
-const node_opcua_nodeid_1 = require("node-opcua-nodeid");
-const node_opcua_service_filter_1 = require("node-opcua-service-filter");
-const node_opcua_service_read_1 = require("node-opcua-service-read");
-const node_opcua_status_code_1 = require("node-opcua-status-code");
-const node_opcua_variant_1 = require("node-opcua-variant");
-const node_opcua_debug_1 = require("node-opcua-debug");
-const client_alarm_1 = require("./client_alarm");
-const client_alarm_tools_extractConditionFields_1 = require("./client_alarm_tools_extractConditionFields");
-const client_tools_1 = require("./client_tools");
-const doDebug = (0, node_opcua_debug_1.checkDebugFlag)(__filename);
-const debugLog = (0, node_opcua_debug_1.make_debugLog)(__filename);
-const errorLog = (0, node_opcua_debug_1.make_errorLog)(__filename);
-/**
- *
- * @param session
- * @param eventStuff
- * @param comment
- */
-function acknowledgeCondition(session, eventStuff, comment) {
-    return __awaiter(this, void 0, void 0, function* () {
-        try {
-            const conditionId = eventStuff.conditionId.value;
-            const eventId = eventStuff.eventId.value;
-            return yield session.acknowledgeCondition(conditionId, eventId, comment);
-        }
-        catch (err) {
-            errorLog("Acknowledging alarm has failed !", err);
-            return node_opcua_status_code_1.StatusCodes.BadInternalError;
-        }
-    });
-}
-exports.acknowledgeCondition = acknowledgeCondition;
-function confirmCondition(session, eventStuff, comment) {
-    return __awaiter(this, void 0, void 0, function* () {
-        try {
-            const conditionId = eventStuff.conditionId.value;
-            const eventId = eventStuff.eventId.value;
-            return yield session.confirmCondition(conditionId, eventId, comment);
-        }
-        catch (err) {
-            errorLog("Acknowledging alarm has failed !", err);
-            return node_opcua_status_code_1.StatusCodes.BadInternalError;
-        }
-    });
-}
-exports.confirmCondition = confirmCondition;
-/**
- * Enumerate all events
- * @param session
- */
-function findActiveConditions(session) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const request = {
-            maxNotificationsPerPublish: 10000,
-            priority: 6,
-            publishingEnabled: true,
-            requestedLifetimeCount: 1000,
-            requestedMaxKeepAliveCount: 100,
-            requestedPublishingInterval: 100
-        };
-        const subscription = yield session.createSubscription2(request);
-        const itemToMonitor = {
-            attributeId: node_opcua_service_read_1.AttributeIds.EventNotifier,
-            nodeId: (0, node_opcua_nodeid_1.resolveNodeId)("Server") // i=2253
-        };
-        const fields = yield (0, client_alarm_tools_extractConditionFields_1.extractConditionFields)(session, "AcknowledgeableConditionType");
-        // note: we may want to have this select clause
-        //  Or(OfType("AcknowledgeableConditionType"), OfType("RefreshStartEventType"), OfType("RefreshEndEventType"))
-        const eventFilter = (0, node_opcua_service_filter_1.constructEventFilter)(fields);
-        const monitoringParameters = {
-            discardOldest: false,
-            filter: eventFilter,
-            queueSize: 100,
-            samplingInterval: 0
-        };
-        const event_monitoringItem = yield subscription.monitor(itemToMonitor, monitoringParameters, node_opcua_service_read_1.TimestampsToReturn.Both);
-        const acknowledgeableConditions = [];
-        let refreshStartEventHasBeenReceived = false;
-        let RefreshEndEventHasBeenReceived = false;
-        const RefreshStartEventType = (0, node_opcua_nodeid_1.resolveNodeId)("RefreshStartEventType").toString();
-        const RefreshEndEventType = (0, node_opcua_nodeid_1.resolveNodeId)("RefreshEndEventType").toString();
-        const promise = new Promise((resolve, reject) => {
-            // now create a event monitored Item
-            event_monitoringItem.on("changed", (_eventFields) => {
-                const eventFields = _eventFields;
-                try {
-                    if (RefreshEndEventHasBeenReceived) {
-                        return;
-                    }
-                    // dumpEvent(session, fields, eventFields);
-                    const pojo = (0, client_alarm_1.fieldsToJson)(fields, eventFields);
-                    // console.log(pojo.eventType.value.toString({ addressSpace}), RefreshEndEventType, RefreshStartEventType);
-                    // make sure we only start recording event after the RefreshStartEvent has been received
-                    if (!refreshStartEventHasBeenReceived) {
-                        if (pojo.eventType.value.toString() === RefreshStartEventType) {
-                            refreshStartEventHasBeenReceived = true;
-                        }
-                        return;
-                    }
-                    if (pojo.eventType.value.toString() === RefreshEndEventType) {
-                        RefreshEndEventHasBeenReceived = true;
-                        resolve();
-                        return;
-                    }
-                    if (!pojo.conditionId.value) {
-                        // not a Acknowledgeable condition
-                        return;
-                    }
-                    if (pojo.ackedState.id.dataType === node_opcua_variant_1.DataType.Boolean) {
-                        acknowledgeableConditions.push(pojo);
-                    }
-                }
-                catch (err) {
-                    errorLog("Error !!", err);
-                }
-            });
-            // async call without waiting !
-            try {
-                (0, client_tools_1.callConditionRefresh)(subscription);
-            }
-            catch (err) {
-                // it is possible that server do not implement conditionRefresh ...
-                debugLog("Server may not implement conditionRefresh", err);
-            }
-        });
-        yield promise;
-        // now shut down susbscription
-        yield subscription.terminate();
-        return acknowledgeableConditions;
-    });
-}
-exports.findActiveConditions = findActiveConditions;
-function acknwoledgeAllConditions(session, message) {
-    return __awaiter(this, void 0, void 0, function* () {
-        try {
-            let conditions = yield findActiveConditions(session);
-            if (conditions.length === 0) {
-                debugLog("Warning: cannot find conditions ");
-            }
-            // filter acknowledgable conditions (no acked yet)
-            conditions = conditions.filter((pojo) => pojo.ackedState.id.value === false);
-            const promises = [];
-            for (const eventStuff of conditions) {
-                promises.push(acknowledgeCondition(session, eventStuff, message));
-            }
-            const result = yield Promise.all(promises);
-            if (doDebug) {
-                debugLog("Acked all results: ", result.map((e) => e.toString()).join(" "));
-            }
-        }
-        catch (err) {
-            errorLog("Error", err);
-        }
-    });
-}
-exports.acknwoledgeAllConditions = acknwoledgeAllConditions;
-function confirmAllConditions(session, message) {
-    return __awaiter(this, void 0, void 0, function* () {
-        try {
-            let conditions = yield findActiveConditions(session);
-            if (conditions.length === 0) {
-                debugLog("Warning: cannot find conditions ");
-            }
-            // filter acknowledgable conditions (no acked yet)
-            conditions = conditions.filter((pojo) => pojo.confirmedState.id.value === false);
-            const promises = [];
-            for (const eventStuff of conditions) {
-                promises.push(confirmCondition(session, eventStuff, message));
-            }
-            const result = yield Promise.all(promises);
-            if (doDebug) {
-                debugLog("Confirm all results: ", result.map((e) => e.toString()).join(" "));
-            }
-        }
-        catch (err) {
-            errorLog("Error", err);
-        }
-    });
-}
-exports.confirmAllConditions = confirmAllConditions;
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.confirmAllConditions = exports.acknwoledgeAllConditions = exports.findActiveConditions = exports.confirmCondition = exports.acknowledgeCondition = void 0;
+const node_opcua_nodeid_1 = require("node-opcua-nodeid");
+const node_opcua_service_filter_1 = require("node-opcua-service-filter");
+const node_opcua_service_read_1 = require("node-opcua-service-read");
+const node_opcua_status_code_1 = require("node-opcua-status-code");
+const node_opcua_variant_1 = require("node-opcua-variant");
+const node_opcua_debug_1 = require("node-opcua-debug");
+const client_alarm_1 = require("./client_alarm");
+const client_alarm_tools_extractConditionFields_1 = require("./client_alarm_tools_extractConditionFields");
+const client_tools_1 = require("./client_tools");
+const doDebug = (0, node_opcua_debug_1.checkDebugFlag)(__filename);
+const debugLog = (0, node_opcua_debug_1.make_debugLog)(__filename);
+const errorLog = (0, node_opcua_debug_1.make_errorLog)(__filename);
+/**
+ *
+ * @param session
+ * @param eventStuff
+ * @param comment
+ */
+function acknowledgeCondition(session, eventStuff, comment) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            const conditionId = eventStuff.conditionId.value;
+            const eventId = eventStuff.eventId.value;
+            return yield session.acknowledgeCondition(conditionId, eventId, comment);
+        }
+        catch (err) {
+            errorLog("Acknowledging alarm has failed !", err);
+            return node_opcua_status_code_1.StatusCodes.BadInternalError;
+        }
+    });
+}
+exports.acknowledgeCondition = acknowledgeCondition;
+function confirmCondition(session, eventStuff, comment) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            const conditionId = eventStuff.conditionId.value;
+            const eventId = eventStuff.eventId.value;
+            return yield session.confirmCondition(conditionId, eventId, comment);
+        }
+        catch (err) {
+            errorLog("Acknowledging alarm has failed !", err);
+            return node_opcua_status_code_1.StatusCodes.BadInternalError;
+        }
+    });
+}
+exports.confirmCondition = confirmCondition;
+/**
+ * Enumerate all events
+ * @param session
+ */
+function findActiveConditions(session) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const request = {
+            maxNotificationsPerPublish: 10000,
+            priority: 6,
+            publishingEnabled: true,
+            requestedLifetimeCount: 1000,
+            requestedMaxKeepAliveCount: 100,
+            requestedPublishingInterval: 100
+        };
+        const subscription = yield session.createSubscription2(request);
+        const itemToMonitor = {
+            attributeId: node_opcua_service_read_1.AttributeIds.EventNotifier,
+            nodeId: (0, node_opcua_nodeid_1.resolveNodeId)("Server") // i=2253
+        };
+        const fields = yield (0, client_alarm_tools_extractConditionFields_1.extractConditionFields)(session, "AcknowledgeableConditionType");
+        // note: we may want to have this select clause
+        //  Or(OfType("AcknowledgeableConditionType"), OfType("RefreshStartEventType"), OfType("RefreshEndEventType"))
+        const eventFilter = (0, node_opcua_service_filter_1.constructEventFilter)(fields);
+        const monitoringParameters = {
+            discardOldest: false,
+            filter: eventFilter,
+            queueSize: 100,
+            samplingInterval: 0
+        };
+        const event_monitoringItem = yield subscription.monitor(itemToMonitor, monitoringParameters, node_opcua_service_read_1.TimestampsToReturn.Both);
+        const acknowledgeableConditions = [];
+        let refreshStartEventHasBeenReceived = false;
+        let RefreshEndEventHasBeenReceived = false;
+        const RefreshStartEventType = (0, node_opcua_nodeid_1.resolveNodeId)("RefreshStartEventType").toString();
+        const RefreshEndEventType = (0, node_opcua_nodeid_1.resolveNodeId)("RefreshEndEventType").toString();
+        const promise = new Promise((resolve, reject) => {
+            // now create a event monitored Item
+            event_monitoringItem.on("changed", (_eventFields) => {
+                const eventFields = _eventFields;
+                try {
+                    if (RefreshEndEventHasBeenReceived) {
+                        return;
+                    }
+                    // dumpEvent(session, fields, eventFields);
+                    const pojo = (0, client_alarm_1.fieldsToJson)(fields, eventFields);
+                    // console.log(pojo.eventType.value.toString({ addressSpace}), RefreshEndEventType, RefreshStartEventType);
+                    // make sure we only start recording event after the RefreshStartEvent has been received
+                    if (!refreshStartEventHasBeenReceived) {
+                        if (pojo.eventType.value.toString() === RefreshStartEventType) {
+                            refreshStartEventHasBeenReceived = true;
+                        }
+                        return;
+                    }
+                    if (pojo.eventType.value.toString() === RefreshEndEventType) {
+                        RefreshEndEventHasBeenReceived = true;
+                        resolve();
+                        return;
+                    }
+                    if (!pojo.conditionId.value) {
+                        // not a Acknowledgeable condition
+                        return;
+                    }
+                    if (pojo.ackedState.id.dataType === node_opcua_variant_1.DataType.Boolean) {
+                        acknowledgeableConditions.push(pojo);
+                    }
+                }
+                catch (err) {
+                    errorLog("Error !!", err);
+                }
+            });
+            // async call without waiting !
+            try {
+                (0, client_tools_1.callConditionRefresh)(subscription);
+            }
+            catch (err) {
+                // it is possible that server do not implement conditionRefresh ...
+                debugLog("Server may not implement conditionRefresh", err);
+            }
+        });
+        yield promise;
+        // now shut down susbscription
+        yield subscription.terminate();
+        return acknowledgeableConditions;
+    });
+}
+exports.findActiveConditions = findActiveConditions;
+function acknwoledgeAllConditions(session, message) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            let conditions = yield findActiveConditions(session);
+            if (conditions.length === 0) {
+                debugLog("Warning: cannot find conditions ");
+            }
+            // filter acknowledgable conditions (no acked yet)
+            conditions = conditions.filter((pojo) => pojo.ackedState.id.value === false);
+            const promises = [];
+            for (const eventStuff of conditions) {
+                promises.push(acknowledgeCondition(session, eventStuff, message));
+            }
+            const result = yield Promise.all(promises);
+            if (doDebug) {
+                debugLog("Acked all results: ", result.map((e) => e.toString()).join(" "));
+            }
+        }
+        catch (err) {
+            errorLog("Error", err);
+        }
+    });
+}
+exports.acknwoledgeAllConditions = acknwoledgeAllConditions;
+function confirmAllConditions(session, message) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            let conditions = yield findActiveConditions(session);
+            if (conditions.length === 0) {
+                debugLog("Warning: cannot find conditions ");
+            }
+            // filter acknowledgable conditions (no acked yet)
+            conditions = conditions.filter((pojo) => pojo.confirmedState.id.value === false);
+            const promises = [];
+            for (const eventStuff of conditions) {
+                promises.push(confirmCondition(session, eventStuff, message));
+            }
+            const result = yield Promise.all(promises);
+            if (doDebug) {
+                debugLog("Confirm all results: ", result.map((e) => e.toString()).join(" "));
+            }
+        }
+        catch (err) {
+            errorLog("Error", err);
+        }
+    });
+}
+exports.confirmAllConditions = confirmAllConditions;
 //# sourceMappingURL=client_alarm_tools_acknowledge_all_conditions.js.map

package/dist/alarms_and_conditions/client_alarm_tools_dump_event.d.ts

@@ -1,9 +1,9 @@
-import { IBasicSession } from "node-opcua-pseudo-session";
-import { Variant } from "node-opcua-variant";
-/**
- *
- * @param session
- * @param fields
- * @param eventFields
- */
-export declare function dumpEvent(session: IBasicSession, fields: string[], eventFields: Variant[]): Promise<void>;
+import { IBasicSession } from "node-opcua-pseudo-session";
+import { Variant } from "node-opcua-variant";
+/**
+ *
+ * @param session
+ * @param fields
+ * @param eventFields
+ */
+export declare function dumpEvent(session: IBasicSession, fields: string[], eventFields: Variant[]): Promise<void>;

package/dist/alarms_and_conditions/client_alarm_tools_dump_event.js

@@ -1,74 +1,74 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.dumpEvent = void 0;
-const chalk = require("chalk");
-const node_opcua_data_model_1 = require("node-opcua-data-model");
-const node_opcua_status_code_1 = require("node-opcua-status-code");
-const node_opcua_variant_1 = require("node-opcua-variant");
-/**
- *
- * @param session
- * @param fields
- * @param eventFields
- */
-function dumpEvent(session, fields, eventFields) {
-    return __awaiter(this, void 0, void 0, function* () {
-        function getBrowseName(_session, nodeId) {
-            return __awaiter(this, void 0, void 0, function* () {
-                const dataValue = yield _session.read({
-                    attributeId: node_opcua_data_model_1.AttributeIds.BrowseName,
-                    nodeId
-                });
-                if (dataValue.statusCode === node_opcua_status_code_1.StatusCodes.Good) {
-                    const browseName = dataValue.value.value.name;
-                    return browseName;
-                }
-                else {
-                    return "???";
-                }
-            });
-        }
-        function w(str, l) {
-            return str.padEnd(l, " ").substring(0, l);
-        }
-        function __dumpEvent1(_session, _fields, variant, index) {
-            return __awaiter(this, void 0, void 0, function* () {
-                if (variant.dataType === node_opcua_variant_1.DataType.Null) {
-                    return;
-                }
-                if (variant.dataType === node_opcua_variant_1.DataType.NodeId) {
-                    const name = yield getBrowseName(_session, variant.value);
-                    // tslint:disable-next-line: no-console
-                    console.log(chalk.yellow(w(name, 30), w(_fields[index], 25)), chalk.cyan(w(node_opcua_variant_1.DataType[variant.dataType], 10).toString()), chalk.cyan.bold(name), "(", w(variant.value, 20), ")");
-                }
-                else {
-                    // tslint:disable-next-line: no-console
-                    console.log(chalk.yellow(w("", 30), w(_fields[index], 25)), chalk.cyan(w(node_opcua_variant_1.DataType[variant.dataType], 10).toString()), variant.value);
-                }
-            });
-        }
-        function __dumpEvent(_session, _fields, _eventFields) {
-            return __awaiter(this, void 0, void 0, function* () {
-                let index = 0;
-                const promises = [];
-                for (const variant of _eventFields) {
-                    promises.push(__dumpEvent1(_session, _fields, variant, index));
-                    index++;
-                }
-                yield Promise.all(promises);
-            });
-        }
-        yield __dumpEvent(session, fields, eventFields);
-    });
-}
-exports.dumpEvent = dumpEvent;
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dumpEvent = void 0;
+const chalk = require("chalk");
+const node_opcua_data_model_1 = require("node-opcua-data-model");
+const node_opcua_status_code_1 = require("node-opcua-status-code");
+const node_opcua_variant_1 = require("node-opcua-variant");
+/**
+ *
+ * @param session
+ * @param fields
+ * @param eventFields
+ */
+function dumpEvent(session, fields, eventFields) {
+    return __awaiter(this, void 0, void 0, function* () {
+        function getBrowseName(_session, nodeId) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const dataValue = yield _session.read({
+                    attributeId: node_opcua_data_model_1.AttributeIds.BrowseName,
+                    nodeId
+                });
+                if (dataValue.statusCode === node_opcua_status_code_1.StatusCodes.Good) {
+                    const browseName = dataValue.value.value.name;
+                    return browseName;
+                }
+                else {
+                    return "???";
+                }
+            });
+        }
+        function w(str, l) {
+            return str.padEnd(l, " ").substring(0, l);
+        }
+        function __dumpEvent1(_session, _fields, variant, index) {
+            return __awaiter(this, void 0, void 0, function* () {
+                if (variant.dataType === node_opcua_variant_1.DataType.Null) {
+                    return;
+                }
+                if (variant.dataType === node_opcua_variant_1.DataType.NodeId) {
+                    const name = yield getBrowseName(_session, variant.value);
+                    // tslint:disable-next-line: no-console
+                    console.log(chalk.yellow(w(name, 30), w(_fields[index], 25)), chalk.cyan(w(node_opcua_variant_1.DataType[variant.dataType], 10).toString()), chalk.cyan.bold(name), "(", w(variant.value, 20), ")");
+                }
+                else {
+                    // tslint:disable-next-line: no-console
+                    console.log(chalk.yellow(w("", 30), w(_fields[index], 25)), chalk.cyan(w(node_opcua_variant_1.DataType[variant.dataType], 10).toString()), variant.value);
+                }
+            });
+        }
+        function __dumpEvent(_session, _fields, _eventFields) {
+            return __awaiter(this, void 0, void 0, function* () {
+                let index = 0;
+                const promises = [];
+                for (const variant of _eventFields) {
+                    promises.push(__dumpEvent1(_session, _fields, variant, index));
+                    index++;
+                }
+                yield Promise.all(promises);
+            });
+        }
+        yield __dumpEvent(session, fields, eventFields);
+    });
+}
+exports.dumpEvent = dumpEvent;
 //# sourceMappingURL=client_alarm_tools_dump_event.js.map

package/dist/alarms_and_conditions/client_alarm_tools_extractConditionFields.d.ts

@@ -1,3 +1,3 @@
-import { NodeIdLike } from "node-opcua-nodeid";
-import { IBasicSession } from "node-opcua-pseudo-session";
-export declare function extractConditionFields(session: IBasicSession, conditionNodeId: NodeIdLike): Promise<string[]>;
+import { NodeIdLike } from "node-opcua-nodeid";
+import { IBasicSession } from "node-opcua-pseudo-session";
+export declare function extractConditionFields(session: IBasicSession, conditionNodeId: NodeIdLike): Promise<string[]>;