node-opcua-client 2.98.0 → 2.98.1

package/dist/alarms_and_conditions/client_alarm.d.ts

@@ -0,0 +1,49 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import { EventEmitter } from "events";
+import { NodeId } from "node-opcua-nodeid";
+import { StatusCode } from "node-opcua-status-code";
+import { Variant } from "node-opcua-variant";
+import { ClientSession } from "../client_session";
+export interface TVariant<T> extends Variant {
+    value: T;
+}
+export interface TTwoStateStatus extends TVariant<string> {
+    id: TVariant<boolean>;
+}
+export interface EventStuff {
+    conditionId: TVariant<NodeId>;
+    eventType: TVariant<NodeId>;
+    eventId: TVariant<Buffer>;
+    retain: TVariant<boolean>;
+    activeState: TTwoStateStatus;
+    ackedState: TTwoStateStatus;
+    confirmedState: TTwoStateStatus;
+    conditionName?: TVariant<string>;
+}
+export interface ClientAlarm {
+    conditionId: NodeId;
+    eventType: NodeId;
+    fields: EventStuff;
+    on(eventName: "changed", eventHandler: () => void): this;
+    acknowledge(session: ClientSession, comment: string): Promise<StatusCode>;
+    getField(fieldName: string): Variant | null;
+}
+/**
+ * describes a OPCUA Alarm as seen in the client side
+ */
+export declare class ClientAlarm extends EventEmitter {
+    conditionId: NodeId;
+    eventType: NodeId;
+    eventId: Buffer;
+    fields: EventStuff;
+    constructor(eventFields: EventStuff);
+    confirm(session: ClientSession, comment: string): Promise<StatusCode>;
+    update(eventFields: EventStuff): void;
+    getRetain(): boolean;
+    toString(): string;
+}
+/**
+ * @private
+ */
+export declare function fieldsToJson(fields: string[], eventFields: Variant[], flat?: boolean): EventStuff;

package/dist/alarms_and_conditions/client_alarm.js

@@ -0,0 +1,110 @@
+"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.fieldsToJson = exports.ClientAlarm = void 0;
+const events_1 = require("events");
+const node_opcua_assert_1 = require("node-opcua-assert");
+const node_opcua_debug_1 = require("node-opcua-debug");
+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 warningLog = (0, node_opcua_debug_1.make_warningLog)(__filename);
+/**
+ * describes a OPCUA Alarm as seen in the client side
+ */
+class ClientAlarm extends events_1.EventEmitter {
+    constructor(eventFields) {
+        super();
+        this.conditionId = (0, node_opcua_nodeid_1.resolveNodeId)(eventFields.conditionId.value);
+        this.eventType = (0, node_opcua_nodeid_1.resolveNodeId)(eventFields.eventType.value);
+        this.eventId = eventFields.eventId.value;
+        this.fields = eventFields;
+        this.update(eventFields);
+    }
+    acknowledge(session, comment) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield session.acknowledgeCondition(this.conditionId, this.eventId, comment);
+        });
+    }
+    confirm(session, comment) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield session.confirmCondition(this.conditionId, this.eventId, comment);
+        });
+    }
+    update(eventFields) {
+        (0, node_opcua_assert_1.assert)(this.conditionId.toString() === (0, node_opcua_nodeid_1.resolveNodeId)(eventFields.conditionId.value).toString());
+        (0, node_opcua_assert_1.assert)(this.eventType.toString() === (0, node_opcua_nodeid_1.resolveNodeId)(eventFields.eventType.value).toString());
+        this.eventId = eventFields.eventId.value;
+        this.fields = eventFields;
+    }
+    getRetain() {
+        return this.fields.retain.value;
+    }
+    toString() {
+        return (this.constructor.name +
+            ": " +
+            this.conditionId.toString() +
+            " " +
+            this.eventType.toString() +
+            " " +
+            Object.entries(this.fields)
+                .filter(([key, value]) => value.dataType !== node_opcua_variant_1.DataType.Null)
+                .map(([key, value]) => key.padEnd(30) + "=" + value.toString())
+                .join("\n") +
+            "\n\n");
+    }
+    getField(fieldName) {
+        return this.fields[fieldName] || null;
+    }
+}
+exports.ClientAlarm = ClientAlarm;
+/**
+ * @private
+ */
+function fieldsToJson(fields, eventFields, flat) {
+    function setProperty(_data, fieldName, value) {
+        let name;
+        if (!fieldName || value === null) {
+            return;
+        }
+        if (!flat) {
+            const f = fieldName.split(".");
+            if (f.length === 1) {
+                fieldName = (0, node_opcua_utils_1.lowerFirstLetter)(fieldName);
+                _data[fieldName] = value;
+            }
+            else {
+                for (let i = 0; i < f.length - 1; i++) {
+                    name = (0, node_opcua_utils_1.lowerFirstLetter)(f[i]);
+                    _data[name] = _data[name] || {};
+                    _data = _data[name];
+                }
+                name = (0, node_opcua_utils_1.lowerFirstLetter)(f[f.length - 1]);
+                _data[name] = value;
+            }
+        }
+        else {
+            const name = fieldName.split(".").map(node_opcua_utils_1.lowerFirstLetter).join(".");
+            _data[name] = value;
+        }
+    }
+    if (fields.length > eventFields.length) {
+        warningLog("warning fields.length !==  eventFields.length", fields.length, eventFields.length);
+    }
+    const data = {};
+    for (let index = 0; index < fields.length; index++) {
+        const variant = eventFields[index];
+        setProperty(data, fields[index], variant);
+    }
+    return data;
+}
+exports.fieldsToJson = fieldsToJson;
+//# sourceMappingURL=client_alarm.js.map

package/dist/alarms_and_conditions/client_alarm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client_alarm.js","sourceRoot":"","sources":["../../source/alarms_and_conditions/client_alarm.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mCAAsC;AACtC,yDAA2C;AAC3C,uDAAmD;AACnD,yDAA0D;AAE1D,uDAAoD;AACpD,2DAAuD;AAGvD,MAAM,UAAU,GAAG,IAAA,kCAAe,EAAC,UAAU,CAAC,CAAC;AA4B/C;;GAEG;AACH,MAAa,WAAY,SAAQ,qBAAY;IAMzC,YAAmB,WAAuB;QACtC,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,WAAW,GAAG,IAAA,iCAAa,EAAC,WAAW,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAChE,IAAI,CAAC,SAAS,GAAG,IAAA,iCAAa,EAAC,WAAW,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAC5D,IAAI,CAAC,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC;QACzC,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC;QAC1B,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IAC7B,CAAC;IACY,WAAW,CAAC,OAAsB,EAAE,OAAe;;YAC5D,OAAO,MAAM,OAAO,CAAC,oBAAoB,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACvF,CAAC;KAAA;IACY,OAAO,CAAC,OAAsB,EAAE,OAAe;;YACxD,OAAO,MAAM,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACnF,CAAC;KAAA;IACM,MAAM,CAAC,WAAuB;QACjC,IAAA,0BAAM,EAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,KAAK,IAAA,iCAAa,EAAC,WAAW,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;QAChG,IAAA,0BAAM,EAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,KAAK,IAAA,iCAAa,EAAC,WAAW,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC5F,IAAI,CAAC,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC;QACzC,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC;IAC9B,CAAC;IACM,SAAS;QACZ,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC;IACpC,CAAC;IACM,QAAQ;QACX,OAAO,CACH,IAAI,CAAC,WAAW,CAAC,IAAI;YACrB,IAAI;YACJ,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE;YAC3B,GAAG;YACH,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE;YACzB,GAAG;YACH,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC;iBACtB,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,KAAK,6BAAQ,CAAC,IAAI,CAAC;iBAC1D,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,GAAG,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;iBAC9D,IAAI,CAAC,IAAI,CAAC;YACf,MAAM,CACT,CAAC;IACN,CAAC;IAEM,QAAQ,CAAC,SAAiB;QAC7B,OAAQ,IAAI,CAAC,MAAc,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC;IACnD,CAAC;CACJ;AAhDD,kCAgDC;AAED;;GAEG;AACH,SAAgB,YAAY,CAAC,MAAgB,EAAE,WAAsB,EAAE,IAAc;IAEjF,SAAS,WAAW,CAAC,KAA8B,EAAE,SAAiB,EAAE,KAAc;QAClF,IAAI,IAAY,CAAC;QACjB,IAAI,CAAC,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE;YAC9B,OAAO;SACV;QACD,IAAI,CAAC,IAAI,EAAE;YACP,MAAM,CAAC,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC/B,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;gBAChB,SAAS,GAAG,IAAA,mCAAgB,EAAC,SAAS,CAAC,CAAC;gBACxC,KAAK,CAAC,SAAS,CAAC,GAAG,KAAK,CAAC;aAC5B;iBAAM;gBACH,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;oBACnC,IAAI,GAAG,IAAA,mCAAgB,EAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;oBAC9B,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;oBAChC,KAAK,GAAG,KAAK,CAAC,IAAI,CAA4B,CAAC;iBAClD;gBACD,IAAI,GAAG,IAAA,mCAAgB,EAAC,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;gBACzC,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;aACvB;SACJ;aAAM;YACH,MAAM,IAAI,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,mCAAgB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAClE,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;SACvB;IACL,CAAC;IACD,IAAI,MAAM,CAAC,MAAM,GAAG,WAAW,CAAC,MAAM,EAAE;QACpC,UAAU,CAAC,+CAA+C,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;KAClG;IACD,MAAM,IAAI,GAAQ,EAAE,CAAC;IACrB,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;QAChD,MAAM,OAAO,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;QACnC,WAAW,CAAC,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,CAAC;KAC7C;IAED,OAAO,IAAI,CAAC;AAChB,CAAC;AApCD,oCAoCC"}

package/dist/alarms_and_conditions/client_alarm_list.d.ts

@@ -0,0 +1,25 @@
+/// <reference types="node" />
+import { EventEmitter } from "events";
+import { ClientAlarm, EventStuff } from "./client_alarm";
+export interface ClientAlarmList {
+    on(eventName: "alarmChanged", handler: (alarm: ClientAlarm) => void): this;
+    on(eventName: "alarmDeleted", handler: (alarm: ClientAlarm) => void): this;
+    on(eventName: "newAlarm", handler: (alarm: ClientAlarm) => void): this;
+    emit(eventName: "alarmChanged", alarm: ClientAlarm): boolean;
+    emit(eventName: "newAlarm", alarm: ClientAlarm): boolean;
+    emit(eventName: "alarmDeleted", alarm: ClientAlarm): boolean;
+}
+export declare class ClientAlarmList extends EventEmitter implements Iterable<ClientAlarm> {
+    private _map;
+    constructor();
+    [Symbol.iterator](): Iterator<ClientAlarm>;
+    alarms(): ClientAlarm[];
+    update(eventField: EventStuff): void;
+    removeAlarm(eventField: EventStuff): void;
+    get length(): number;
+    purgeUnusedAlarms(): void;
+    private _removeAlarm;
+    private makeKey;
+    private findAlarm;
+    private deleteAlarm;
+}

package/dist/alarms_and_conditions/client_alarm_list.js

@@ -0,0 +1,98 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClientAlarmList = void 0;
+const events_1 = require("events");
+const node_opcua_assert_1 = require("node-opcua-assert");
+const client_alarm_1 = require("./client_alarm");
+// maintain a set of alarm list for a client
+class ClientAlarmList extends events_1.EventEmitter {
+    constructor() {
+        super();
+        this._map = {};
+    }
+    [Symbol.iterator]() {
+        let pointer = 0;
+        const components = Object.values(this._map);
+        return {
+            next() {
+                if (pointer >= components.length) {
+                    return {
+                        done: true,
+                        value: components[pointer++]
+                    };
+                }
+                else {
+                    return {
+                        done: false,
+                        value: components[pointer++]
+                    };
+                }
+            }
+        };
+    }
+    alarms() {
+        return Object.values(this._map);
+    }
+    update(eventField) {
+        // Spec says:
+        // Clients shall check for multiple Event Notifications for a ConditionBranch to avoid
+        // overwriting a new state delivered together with an older state from the Refresh
+        // process.
+        const { conditionId, eventType } = eventField;
+        (0, node_opcua_assert_1.assert)(conditionId, "must have a valid conditionId ( verify that event is a acknodweldgeable type");
+        const alarm = this.findAlarm(conditionId.value, eventType.value);
+        if (!alarm) {
+            const key = this.makeKey(conditionId.value, eventType.value);
+            const newAlarm = new client_alarm_1.ClientAlarm(eventField);
+            this._map[key] = newAlarm;
+            this.emit("newAlarm", newAlarm);
+            this.emit("alarmChanged", newAlarm);
+        }
+        else {
+            alarm.update(eventField);
+            this.emit("alarmChanged", alarm);
+        }
+    }
+    removeAlarm(eventField) {
+        const { conditionId, eventType } = eventField;
+        const alarm = this.findAlarm(conditionId.value, eventType.value);
+        if (alarm) {
+            alarm.update(eventField);
+            this._removeAlarm(alarm);
+        }
+    }
+    get length() {
+        return Object.keys(this._map).length;
+    }
+    purgeUnusedAlarms() {
+        const alarms = this.alarms();
+        for (const alarm of alarms) {
+            if (!alarm.getRetain()) {
+                this._removeAlarm(alarm);
+            }
+        }
+    }
+    _removeAlarm(alarm) {
+        this.emit("alarmDeleted", alarm);
+        this.deleteAlarm(alarm.conditionId, alarm.eventType);
+    }
+    makeKey(conditionId, eventType) {
+        return conditionId.toString() + "|" + eventType.toString();
+    }
+    findAlarm(conditionId, eventType) {
+        const key = this.makeKey(conditionId, eventType);
+        const _c = this._map[key];
+        return _c || null;
+    }
+    deleteAlarm(conditionId, eventType) {
+        const key = this.makeKey(conditionId, eventType);
+        const _c = this._map[key];
+        if (_c) {
+            delete this._map[key];
+            return true;
+        }
+        return false;
+    }
+}
+exports.ClientAlarmList = ClientAlarmList;
+//# sourceMappingURL=client_alarm_list.js.map

package/dist/alarms_and_conditions/client_alarm_list.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client_alarm_list.js","sourceRoot":"","sources":["../../source/alarms_and_conditions/client_alarm_list.ts"],"names":[],"mappings":";;;AAAA,mCAAsC;AACtC,yDAA2C;AAG3C,iDAAyD;AAWzD,4CAA4C;AAC5C,MAAa,eAAgB,SAAQ,qBAAY;IAG7C;QACI,KAAK,EAAE,CAAC;QAHJ,SAAI,GAAmC,EAAE,CAAC;IAIlD,CAAC;IAEM,CAAC,MAAM,CAAC,QAAQ,CAAC;QACpB,IAAI,OAAO,GAAG,CAAC,CAAC;QAChB,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC5C,OAAO;YACH,IAAI;gBACA,IAAI,OAAO,IAAI,UAAU,CAAC,MAAM,EAAE;oBAC9B,OAAO;wBACH,IAAI,EAAE,IAAI;wBACV,KAAK,EAAE,UAAU,CAAC,OAAO,EAAE,CAAC;qBAC/B,CAAC;iBACL;qBAAM;oBACH,OAAO;wBACH,IAAI,EAAE,KAAK;wBACX,KAAK,EAAE,UAAU,CAAC,OAAO,EAAE,CAAC;qBAC/B,CAAC;iBACL;YACL,CAAC;SACJ,CAAC;IACN,CAAC;IAEM,MAAM;QACT,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;IAEM,MAAM,CAAC,UAAsB;QAChC,aAAa;QACb,sFAAsF;QACtF,kFAAkF;QAClF,WAAW;QAEX,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,GAAG,UAAU,CAAC;QAC9C,IAAA,0BAAM,EAAC,WAAW,EAAE,8EAA8E,CAAC,CAAC;QACpG,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,KAAK,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC;QAEjE,IAAI,CAAC,KAAK,EAAE;YACR,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,KAAK,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC;YAC7D,MAAM,QAAQ,GAAG,IAAI,0BAAW,CAAC,UAAU,CAAC,CAAC;YAC7C,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC;YAC1B,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;YAChC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC;SACvC;aAAM;YACH,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YACzB,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;SACpC;IACL,CAAC;IACM,WAAW,CAAC,UAAsB;QACrC,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,GAAG,UAAU,CAAC;QAC9C,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,KAAK,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC;QACjE,IAAI,KAAK,EAAE;YACP,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YACzB,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;SAC5B;IACL,CAAC;IAED,IAAW,MAAM;QACb,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC;IACzC,CAAC;IACM,iBAAiB;QACpB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QAC7B,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE;YACxB,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,EAAE;gBACpB,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;aAC5B;SACJ;IACL,CAAC;IAEO,YAAY,CAAC,KAAkB;QACnC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;QACjC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;IACzD,CAAC;IAEO,OAAO,CAAC,WAAmB,EAAE,SAAiB;QAClD,OAAO,WAAW,CAAC,QAAQ,EAAE,GAAG,GAAG,GAAG,SAAS,CAAC,QAAQ,EAAE,CAAC;IAC/D,CAAC;IACO,SAAS,CAAC,WAAmB,EAAE,SAAiB;QACpD,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;QACjD,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC1B,OAAO,EAAE,IAAI,IAAI,CAAC;IACtB,CAAC;IACO,WAAW,CAAC,WAAmB,EAAE,SAAiB;QACtD,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;QACjD,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC1B,IAAI,EAAE,EAAE;YACJ,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACtB,OAAO,IAAI,CAAC;SACf;QACD,OAAO,KAAK,CAAC;IACjB,CAAC;CACJ;AA/FD,0CA+FC"}

package/dist/alarms_and_conditions/client_alarm_tools.d.ts

@@ -0,0 +1,4 @@
+import { ClientSession } from "../client_session";
+import { ClientAlarmList } from "./client_alarm_list";
+export declare function uninstallAlarmMonitoring(session: ClientSession): Promise<void>;
+export declare function installAlarmMonitoring(session: ClientSession): Promise<ClientAlarmList>;

package/dist/alarms_and_conditions/client_alarm_tools.js

@@ -0,0 +1,157 @@
+"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.installAlarmMonitoring = exports.uninstallAlarmMonitoring = void 0;
+const node_opcua_data_model_1 = require("node-opcua-data-model");
+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_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_list_1 = require("./client_alarm_list");
+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)("A&E");
+const debugLog = (0, node_opcua_debug_1.make_debugLog)("A&E");
+const warningLog = (0, node_opcua_debug_1.make_warningLog)("A&E");
+function r(_key, o) {
+    if (o && o.dataType === "Null") {
+        return undefined;
+    }
+    return o;
+}
+// ------------------------------------------------------------------------------------------------------------------------------
+function uninstallAlarmMonitoring(session) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const _sessionPriv = session;
+        if (!_sessionPriv.$clientAlarmList) {
+            return;
+        }
+        const mi = _sessionPriv.$monitoredItemForAlarmList;
+        mi.removeAllListeners();
+        _sessionPriv.$monitoredItemForAlarmList = null;
+        yield _sessionPriv.$subscriptionforAlarmList.terminate();
+        _sessionPriv.$clientAlarmList = null;
+        return;
+    });
+}
+exports.uninstallAlarmMonitoring = uninstallAlarmMonitoring;
+// Release 1.04 8 OPC Unified Architecture, Part 9
+// 4.5 Condition state synchronization
+//
+// A Client that wishes to display the current status of Alarms and Conditions (known as a
+// “current Alarm display”) would use the following logic to process Refresh Event Notifications.
+// The Client flags all Retained Conditions as suspect on reception of the Event of the
+// RefreshStartEventType. The Client adds any new Events that are received during the Refresh
+// without flagging them as suspect. The Client also removes the suspect flag from any Retained
+// Conditions that are returned as part of the Refresh. When the Client receives a
+// RefreshEndEvent, the Client removes any remaining suspect Events, since they no longer
+// apply.
+// ------------------------------------------------------------------------------------------------------------------------------
+function installAlarmMonitoring(session) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const _sessionPriv = session;
+        // create
+        if (_sessionPriv.$clientAlarmList) {
+            return _sessionPriv.$clientAlarmList;
+        }
+        const clientAlarmList = new client_alarm_list_1.ClientAlarmList();
+        _sessionPriv.$clientAlarmList = clientAlarmList;
+        const request = {
+            maxNotificationsPerPublish: 100,
+            priority: 6,
+            publishingEnabled: true,
+            requestedLifetimeCount: 10000,
+            requestedMaxKeepAliveCount: 10,
+            requestedPublishingInterval: 500
+        };
+        const subscription = yield session.createSubscription2(request);
+        _sessionPriv.$subscriptionforAlarmList = subscription;
+        const itemToMonitor = {
+            attributeId: node_opcua_data_model_1.AttributeIds.EventNotifier,
+            nodeId: (0, node_opcua_nodeid_1.resolveNodeId)("Server") // i=2253
+        };
+        const fields = yield (0, client_alarm_tools_extractConditionFields_1.extractConditionFields)(session, "AlarmConditionType");
+        const AcknowledgeableConditionType = (0, node_opcua_nodeid_1.resolveNodeId)("AcknowledgeableConditionType");
+        const eventFilter = (0, node_opcua_service_filter_1.constructEventFilter)(fields, (0, node_opcua_service_filter_1.ofType)(AcknowledgeableConditionType));
+        const monitoringParameters = {
+            discardOldest: false,
+            filter: eventFilter,
+            queueSize: 1000,
+            samplingInterval: 0
+        };
+        // now create a event monitored Item
+        const eventMonitoringItem = yield subscription.monitor(itemToMonitor, monitoringParameters, node_opcua_service_read_1.TimestampsToReturn.Both);
+        const queueEvent = [];
+        function flushQueue() {
+            const q = [...queueEvent];
+            queueEvent.length = 0;
+            for (const pojo of q) {
+                clientAlarmList.update(pojo);
+            }
+        }
+        let inInit = true;
+        eventMonitoringItem.on("changed", (eventFields) => {
+            var _a, _b;
+            const pojo = (0, client_alarm_1.fieldsToJson)(fields, eventFields);
+            const { eventType, eventId, conditionId, conditionName } = pojo;
+            debugLog("xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx ---- ALARM RECEIVED " +
+                eventType.value.toString() +
+                " " +
+                ((_a = eventId.value) === null || _a === void 0 ? void 0 : _a.toString("hex")));
+            try {
+                if (!conditionId || !conditionId.value || conditionId.dataType === node_opcua_variant_1.DataType.Null) {
+                    // not a acknowledgeable condition
+                    warningLog(" not acknowledgeable condition ---- " + eventType.value.toString() + " ", conditionId, conditionName === null || conditionName === void 0 ? void 0 : conditionName.value, " " + ((_b = eventId.value) === null || _b === void 0 ? void 0 : _b.toString("hex")));
+                    return;
+                }
+                queueEvent.push(pojo);
+                if (queueEvent.length === 1 && !inInit) {
+                    setTimeout(() => flushQueue(), 10);
+                }
+            }
+            catch (err) {
+                warningLog(JSON.stringify(pojo, r, " "));
+                warningLog("Error !!", err);
+            }
+            // Release 1.04 8 OPC Unified Architecture, Part 9
+            // 4.5 Condition state synchronization
+            // RefreshRequiredEventType
+            // Under some circumstances a Server may not be capable of ensuring the Client is fully
+            //  in sync with the current state of Condition instances. For example, if the underlying
+            // system represented by the Server is reset or communications are lost for some period
+            // of time the Server may need to resynchronize itself with the underlying system. In
+            // these cases, the Server shall send an Event of the RefreshRequiredEventType to
+            // advise the Client that a Refresh may be necessary. A Client receiving this special
+            // Event should initiate a ConditionRefresh as noted in this clause.
+            // TODO
+        });
+        try {
+            yield (0, client_tools_1.callConditionRefresh)(subscription);
+        }
+        catch (err) {
+            if (err.message.match(/BadNothingToDo/)) {
+                /** fine! nothing to do */
+            }
+            else {
+                warningLog("Server may not implement condition refresh", err.message);
+            }
+        }
+        _sessionPriv.$monitoredItemForAlarmList = eventMonitoringItem;
+        setTimeout(() => flushQueue(), 10);
+        inInit = false;
+        // also request updates
+        return clientAlarmList;
+    });
+}
+exports.installAlarmMonitoring = installAlarmMonitoring;
+//# sourceMappingURL=client_alarm_tools.js.map

package/dist/alarms_and_conditions/client_alarm_tools.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client_alarm_tools.js","sourceRoot":"","sources":["../../source/alarms_and_conditions/client_alarm_tools.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,iEAAqD;AACrD,yDAAkD;AAClD,yEAAyE;AACzE,qEAAiF;AAEjF,2DAAuD;AACvD,uDAAkF;AAKlF,iDAA0D;AAC1D,2DAAsD;AACtD,2GAAqF;AACrF,iDAAsD;AAEtD,MAAM,OAAO,GAAG,IAAA,iCAAc,EAAC,KAAK,CAAC,CAAC;AACtC,MAAM,QAAQ,GAAG,IAAA,gCAAa,EAAC,KAAK,CAAC,CAAC;AACtC,MAAM,UAAU,GAAG,IAAA,kCAAe,EAAC,KAAK,CAAC,CAAC;AAE1C,SAAS,CAAC,CAAC,IAAY,EAAE,CAA0C;IAC/D,IAAI,CAAC,IAAI,CAAC,CAAC,QAAQ,KAAK,MAAM,EAAE;QAC5B,OAAO,SAAS,CAAC;KACpB;IACD,OAAO,CAAC,CAAC;AACb,CAAC;AAMD,iIAAiI;AACjI,SAAsB,wBAAwB,CAAC,OAAsB;;QACjE,MAAM,YAAY,GAAG,OAA4B,CAAC;QAClD,IAAI,CAAC,YAAY,CAAC,gBAAgB,EAAE;YAChC,OAAO;SACV;QAED,MAAM,EAAE,GAAG,YAAY,CAAC,0BAAiD,CAAC;QAC1E,EAAE,CAAC,kBAAkB,EAAE,CAAC;QAExB,YAAY,CAAC,0BAA0B,GAAG,IAAI,CAAC;QAC/C,MAAM,YAAY,CAAC,yBAA0B,CAAC,SAAS,EAAE,CAAC;QAC1D,YAAY,CAAC,gBAAgB,GAAG,IAAI,CAAC;QACrC,OAAO;IACX,CAAC;CAAA;AAbD,4DAaC;AAED,kDAAkD;AAClD,sCAAsC;AACtC,EAAE;AACF,0FAA0F;AAC1F,iGAAiG;AACjG,uFAAuF;AACvF,6FAA6F;AAC7F,+FAA+F;AAC/F,kFAAkF;AAClF,yFAAyF;AACzF,SAAS;AAET,iIAAiI;AACjI,SAAsB,sBAAsB,CAAC,OAAsB;;QAC/D,MAAM,YAAY,GAAG,OAA4B,CAAC;QAClD,SAAS;QACT,IAAI,YAAY,CAAC,gBAAgB,EAAE;YAC/B,OAAO,YAAY,CAAC,gBAAgB,CAAC;SACxC;QACD,MAAM,eAAe,GAAG,IAAI,mCAAe,EAAE,CAAC;QAC9C,YAAY,CAAC,gBAAgB,GAAG,eAAe,CAAC;QAEhD,MAAM,OAAO,GAAqC;YAC9C,0BAA0B,EAAE,GAAG;YAC/B,QAAQ,EAAE,CAAC;YACX,iBAAiB,EAAE,IAAI;YACvB,sBAAsB,EAAE,KAAK;YAC7B,0BAA0B,EAAE,EAAE;YAC9B,2BAA2B,EAAE,GAAG;SACnC,CAAC;QACF,MAAM,YAAY,GAAG,MAAM,OAAO,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;QAChE,YAAY,CAAC,yBAAyB,GAAG,YAAY,CAAC;QAEtD,MAAM,aAAa,GAAuB;YACtC,WAAW,EAAE,oCAAY,CAAC,aAAa;YACvC,MAAM,EAAE,IAAA,iCAAa,EAAC,QAAQ,CAAC,CAAC,SAAS;SAC5C,CAAC;QAEF,MAAM,MAAM,GAAG,MAAM,IAAA,kEAAsB,EAAC,OAAO,EAAE,oBAAoB,CAAC,CAAC;QAE3E,MAAM,4BAA4B,GAAG,IAAA,iCAAa,EAAC,8BAA8B,CAAC,CAAC;QAEnF,MAAM,WAAW,GAAG,IAAA,gDAAoB,EAAC,MAAM,EAAE,IAAA,kCAAM,EAAC,4BAA4B,CAAC,CAAC,CAAC;QAEvF,MAAM,oBAAoB,GAAgC;YACtD,aAAa,EAAE,KAAK;YACpB,MAAM,EAAE,WAAW;YACnB,SAAS,EAAE,IAAI;YACf,gBAAgB,EAAE,CAAC;SACtB,CAAC;QAEF,oCAAoC;QACpC,MAAM,mBAAmB,GAAG,MAAM,YAAY,CAAC,OAAO,CAAC,aAAa,EAAE,oBAAoB,EAAE,4CAAkB,CAAC,IAAI,CAAC,CAAC;QAErH,MAAM,UAAU,GAAiB,EAAE,CAAC;QACpC,SAAS,UAAU;YACf,MAAM,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,CAAC;YAC1B,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC;YACtB,KAAK,MAAM,IAAI,IAAI,CAAC,EAAE;gBAClB,eAAe,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;aAChC;QACL,CAAC;QAED,IAAI,MAAM,GAAG,IAAI,CAAC;QAClB,mBAAmB,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,WAAsB,EAAE,EAAE;;YAEzD,MAAM,IAAI,GAAG,IAAA,2BAAY,EAAC,MAAM,EAAE,WAAW,CAAC,CAAC;YAC/C,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,GAAG,IAAI,CAAC;YAEhE,QAAQ,CACJ,oFAAoF;gBAChF,SAAS,CAAC,KAAK,CAAC,QAAQ,EAAE;gBAC1B,GAAG;iBACH,MAAA,OAAO,CAAC,KAAK,0CAAE,QAAQ,CAAC,KAAK,CAAC,CAAA,CACrC,CAAC;YACF,IAAI;gBACA,IAAI,CAAC,WAAW,IAAI,CAAC,WAAW,CAAC,KAAK,IAAI,WAAW,CAAC,QAAQ,KAAK,6BAAQ,CAAC,IAAI,EAAE;oBAC9E,kCAAkC;oBAClC,UAAU,CACN,sCAAsC,GAAG,SAAS,CAAC,KAAK,CAAC,QAAQ,EAAE,GAAG,GAAG,EACzE,WAAW,EACX,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,KAAK,EACpB,GAAG,IAAG,MAAA,OAAO,CAAC,KAAK,0CAAE,QAAQ,CAAC,KAAK,CAAC,CAAA,CACvC,CAAC;oBACF,OAAO;iBACV;gBACD,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACtB,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE;oBACpC,UAAU,CAAC,GAAG,EAAE,CAAC,UAAU,EAAE,EAAE,EAAE,CAAC,CAAC;iBACtC;aACJ;YAAC,OAAO,GAAG,EAAE;gBACV,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;gBACzC,UAAU,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;aAC/B;YAED,kDAAkD;YAClD,sCAAsC;YACtC,2BAA2B;YAC3B,uFAAuF;YACvF,yFAAyF;YACzF,uFAAuF;YACvF,qFAAqF;YACrF,iFAAiF;YACjF,qFAAqF;YACrF,oEAAoE;YACpE,OAAO;QACX,CAAC,CAAC,CAAC;QAEH,IAAI;YACA,MAAM,IAAA,mCAAoB,EAAC,YAAY,CAAC,CAAC;SAC5C;QAAC,OAAO,GAAG,EAAE;YACV,IAAK,GAAa,CAAC,OAAO,CAAC,KAAK,CAAC,gBAAgB,CAAC,EAAE;gBAChD,0BAA0B;aAC7B;iBAAM;gBACH,UAAU,CAAC,4CAA4C,EAAU,GAAI,CAAC,OAAO,CAAC,CAAC;aAClF;SACJ;QACD,YAAY,CAAC,0BAA0B,GAAG,mBAAmB,CAAC;QAE9D,UAAU,CAAC,GAAG,EAAE,CAAC,UAAU,EAAE,EAAE,EAAE,CAAC,CAAC;QACnC,MAAM,GAAG,KAAK,CAAC;QAEf,uBAAuB;QACvB,OAAO,eAAe,CAAC;IAC3B,CAAC;CAAA;AA/GD,wDA+GC"}

package/dist/alarms_and_conditions/client_alarm_tools_acknowledge_all_conditions.d.ts

@@ -0,0 +1,18 @@
+import { StatusCode } from "node-opcua-status-code";
+import { ClientSession } from "../client_session";
+import { EventStuff } from "./client_alarm";
+/**
+ *
+ * @param session
+ * @param eventStuff
+ * @param comment
+ */
+export declare function acknowledgeCondition(session: ClientSession, eventStuff: EventStuff, comment: string): Promise<StatusCode>;
+export declare function confirmCondition(session: ClientSession, eventStuff: EventStuff, comment: string): Promise<StatusCode>;
+/**
+ * Enumerate all events
+ * @param session
+ */
+export declare function findActiveConditions(session: ClientSession): Promise<EventStuff[]>;
+export declare function acknwoledgeAllConditions(session: ClientSession, message: string): Promise<void>;
+export declare function confirmAllConditions(session: ClientSession, message: string): Promise<void>;