node-opcua-client 2.73.1 → 2.76.0

package/dist/client_subscription.d.ts

@@ -1,241 +1,241 @@
-/**
- * @module node-opcua-client
- */
-/// <reference types="node" />
-import { EventEmitter } from "events";
-import { Byte, Double, UInt32 } from "node-opcua-basic-types";
-import { DiagnosticInfo } from "node-opcua-data-model";
-import { ReadValueIdOptions, TimestampsToReturn } from "node-opcua-service-read";
-import { MonitoringMode, MonitoringParametersOptions, NotificationMessage, SetTriggeringResponse } from "node-opcua-service-subscription";
-import { Callback, StatusCode } from "node-opcua-status-code";
-import { ErrorCallback } from "node-opcua-status-code";
-import { ClientMonitoredItem } from "./client_monitored_item";
-import { ClientMonitoredItemBase } from "./client_monitored_item_base";
-import { ClientMonitoredItemGroup } from "./client_monitored_item_group";
-import { ClientSession, MonitoredItemData, SubscriptionId } from "./client_session";
-export interface ClientSubscriptionOptions {
-    requestedPublishingInterval?: number;
-    requestedLifetimeCount?: number;
-    requestedMaxKeepAliveCount?: number;
-    maxNotificationsPerPublish?: number;
-    publishingEnabled?: boolean;
-    priority?: number;
-}
-export declare type ClientHandle = number;
-export interface ClientMonitoredItemBaseMap {
-    [key: string]: ClientMonitoredItemBase;
-}
-export interface ModifySubscriptionOptions {
-    requestedPublishingInterval?: Double;
-    requestedLifetimeCount?: UInt32;
-    requestedMaxKeepAliveCount?: UInt32;
-    maxNotificationsPerPublish?: UInt32;
-    priority?: Byte;
-}
-export interface ModifySubscriptionResult {
-    revisedPublishingInterval: Double;
-    revisedLifetimeCount: UInt32;
-    revisedMaxKeepAliveCount: UInt32;
-}
-export interface ClientSubscription extends EventEmitter {
-    subscriptionId: SubscriptionId;
-    publishingInterval: number;
-    lifetimeCount: number;
-    maxKeepAliveCount: number;
-    maxNotificationsPerPublish: number;
-    publishingEnabled: boolean;
-    priority: number;
-    monitoredItems: ClientMonitoredItemBaseMap;
-    timeoutHint: number;
-    /**
-     * return the session associated with the subscription.
-     * (may throw if the session is not valid)
-     */
-    session: ClientSession;
-    /**
-     * return true if the subscription is attached to a valid session
-     */
-    hasSession: boolean;
-    /**
-     * true is the subscription is fully active
-     */
-    isActive: boolean;
-    /**
-     * add a monitor item to the subscription
-     *
-     * @method monitor
-     *
-     * Monitoring a simple Value Change
-     * ---------------------------------
-     *
-     * @example:
-     *
-     *   clientSubscription.monitor(
-     *     // itemToMonitor:
-     *     {
-     *       nodeId: "ns=0;i=2258",
-     *       attributeId: AttributeIds.Value,
-     *       indexRange: null,
-     *       dataEncoding: { namespaceIndex: 0, name: null }
-     *     },
-     *     // requestedParameters:
-     *     {
-     *        samplingInterval: 3000,
-     *        filter: null,
-     *        queueSize: 1,
-     *        discardOldest: true
-     *     },
-     *     TimestampsToReturn.Neither
-     *   );
-     *
-     * Monitoring a Value Change With a DataChange  Filter
-     * ---------------------------------------------------
-     *
-     * options.trigger       {DataChangeTrigger} {Status|StatusValue|StatusValueTimestamp}
-     * options.deadbandType  {DeadbandType}      {None|Absolute|Percent}
-     * options.deadbandValue {Double}
-     *
-     * @example:
-     *
-     *   clientSubscription.monitor(
-     *     // itemToMonitor:
-     *     {
-     *       nodeId: "ns=0;i=2258",
-     *       attributeId: AttributeIds.Value,
-     *     },
-     *     // requestedParameters:
-     *     {
-     *        samplingInterval: 3000,
-     *        filter: new DataChangeFilter({
-     *             trigger: DataChangeTrigger.StatusValue,
-     *             deadbandType: DeadbandType.Absolute,
-     *             deadbandValue: 0.1
-     *        }),
-     *        queueSize: 1,
-     *        discardOldest: true
-     *     },
-     *     TimestampsToReturn.Neither
-     *   );
-     *
-     *
-     * Monitoring an Event
-     * -------------------
-     *
-     *  If the monitor attributeId is EventNotifier then the filter must be specified
-     *
-     * @example:
-     *
-     *  var filter =  new EventFilter({
-     *    selectClauses: [
-     *             { browsePath: [ {name: 'ActiveState'  }, {name: 'id'}  ]},
-     *             { browsePath: [ {name: 'ConditionName'}                ]}
-     *    ],
-     *    whereClause: []
-     *  });
-     *
-     *  clientSubscription.monitor(
-     *     // itemToMonitor:
-     *     {
-     *       nodeId: "ns=0;i=2258",
-     *       attributeId: AttributeIds.EventNotifier,
-     *       indexRange: null,
-     *       dataEncoding: { namespaceIndex: 0, name: null }
-     *     },
-     *     // requestedParameters:
-     *     {
-     *        samplingInterval: 3000,
-     *
-     *        filter: filter,
-     *
-     *        queueSize: 1,
-     *        discardOldest: true
-     *     },
-     *     TimestampsToReturn.Neither
-     *   );
-     *
-     *
-     *
-     *
-     *
-     *
-     */
-    monitor(itemToMonitor: ReadValueIdOptions, requestedParameters: MonitoringParametersOptions, timestampsToReturn: TimestampsToReturn, monitoringMode?: MonitoringMode): Promise<ClientMonitoredItem>;
-    monitor(itemToMonitor: ReadValueIdOptions, requestedParameters: MonitoringParametersOptions, timestampsToReturn: TimestampsToReturn, monitoringMode: MonitoringMode, callback: Callback<ClientMonitoredItem>): void;
-    /**
-     * @method monitorItems
-     * @param itemsToMonitor
-     * @param requestedParameters
-     * @param timestampsToReturn
-     * @return a ClientMonitoredItemGroup
-     * @async
-     */
-    monitorItems(itemsToMonitor: ReadValueIdOptions[], requestedParameters: MonitoringParametersOptions, timestampsToReturn: TimestampsToReturn): Promise<ClientMonitoredItemGroup>;
-    /**
-     * @method monitorItems
-     * @param itemsToMonitor
-     * @param requestedParameters
-     * @param timestampsToReturn
-     * @param done
-     * @async
-     */
-    monitorItems(itemsToMonitor: ReadValueIdOptions[], requestedParameters: MonitoringParametersOptions, timestampsToReturn: TimestampsToReturn, callback: Callback<ClientMonitoredItemGroup>): void;
-    getMonitoredItems(): Promise<MonitoredItemData>;
-    getMonitoredItems(callback: (err: Error | null, result?: MonitoredItemData) => void): void;
-    modify(options: ModifySubscriptionOptions, callback: Callback<ModifySubscriptionResult>): void;
-    modify(options: ModifySubscriptionOptions): Promise<ModifySubscriptionResult>;
-    setTriggering(triggeringItem: ClientMonitoredItemBase, linksToAdd: ClientMonitoredItemBase[] | null, linksToRemove: ClientMonitoredItemBase[] | null, callback: Callback<SetTriggeringResponse>): void;
-    setTriggering(triggeringItem: ClientMonitoredItemBase, linksToAdd: ClientMonitoredItemBase[] | null, linksToRemove: ClientMonitoredItemBase[] | null): Promise<SetTriggeringResponse>;
-    terminate(): Promise<void>;
-    terminate(callback: ErrorCallback): void;
-}
-export declare interface ClientSubscription {
-    once(event: string | symbol, listener: (...args: any[]) => void): this;
-    on(event: string | symbol, listener: (...args: any[]) => void): this;
-    /**
-     * notify the observers that the subscription has now started
-     * @event started
-     */
-    on(event: "started", eventHandler: (subscriptionId: number) => void): this;
-    /**
-     * notify the observers tha the client subscription has terminated
-     * @event  terminated
-     */
-    on(event: "terminated", eventHandler: () => void): this;
-    /**
-     * notify the observers that a new monitored item has been added to the subscription.
-     * @event  item_added
-     */
-    on(event: "item_added", eventHandler: (monitoredItem: ClientMonitoredItem) => void): this;
-    /**
-     * notify the observers that a keep alive Publish Response has been received from the server.
-     * @event keepalive
-     */
-    on(event: "keepalive", eventHandler: () => void): this;
-    /**
-     * notify the observers that an error has occurred
-     * @event internal_error
-     * @param event
-     * @param eventHandler
-     */
-    on(event: "internal_error", eventHandler: (err: Error) => void): this;
-    on(event: "raw_notification", eventHandler: (notificationMessage: NotificationMessage) => void): this;
-    /**
-     * notify the observers that some notifications has been received from the server in  a PublishResponse
-     * each modified monitored Item
-     * @event  received_notifications
-     */
-    on(event: "received_notifications", eventHandler: (notificationMessage: NotificationMessage) => void): this;
-    /**
-     * notify the observers that the server has send a status changed notification (such as BadTimeout )
-     * @event status_changed
-     */
-    on(event: "status_changed", eventHandler: (status: StatusCode, diagnosticInfo: DiagnosticInfo) => void): this;
-    on(event: "error", eventHandler: (err: Error) => void): this;
-}
-export declare interface ClientSubscription {
-    _createMonitoredItem(itemToMonitor: ReadValueIdOptions, monitoringParameters: MonitoringParametersOptions, timestampsToReturn: TimestampsToReturn): ClientMonitoredItem;
-}
-export declare class ClientSubscription {
-    static create(clientSession: ClientSession, options: ClientSubscriptionOptions): ClientSubscription;
-    static ignoreNextWarning: boolean;
-}
+/**
+ * @module node-opcua-client
+ */
+/// <reference types="node" />
+import { EventEmitter } from "events";
+import { Byte, Double, UInt32 } from "node-opcua-basic-types";
+import { DiagnosticInfo } from "node-opcua-data-model";
+import { ReadValueIdOptions, TimestampsToReturn } from "node-opcua-service-read";
+import { MonitoringMode, MonitoringParametersOptions, NotificationMessage, SetTriggeringResponse } from "node-opcua-service-subscription";
+import { Callback, StatusCode } from "node-opcua-status-code";
+import { ErrorCallback } from "node-opcua-status-code";
+import { ClientMonitoredItem } from "./client_monitored_item";
+import { ClientMonitoredItemBase } from "./client_monitored_item_base";
+import { ClientMonitoredItemGroup } from "./client_monitored_item_group";
+import { ClientSession, MonitoredItemData, SubscriptionId } from "./client_session";
+export interface ClientSubscriptionOptions {
+    requestedPublishingInterval?: number;
+    requestedLifetimeCount?: number;
+    requestedMaxKeepAliveCount?: number;
+    maxNotificationsPerPublish?: number;
+    publishingEnabled?: boolean;
+    priority?: number;
+}
+export declare type ClientHandle = number;
+export interface ClientMonitoredItemBaseMap {
+    [key: string]: ClientMonitoredItemBase;
+}
+export interface ModifySubscriptionOptions {
+    requestedPublishingInterval?: Double;
+    requestedLifetimeCount?: UInt32;
+    requestedMaxKeepAliveCount?: UInt32;
+    maxNotificationsPerPublish?: UInt32;
+    priority?: Byte;
+}
+export interface ModifySubscriptionResult {
+    revisedPublishingInterval: Double;
+    revisedLifetimeCount: UInt32;
+    revisedMaxKeepAliveCount: UInt32;
+}
+export interface ClientSubscription extends EventEmitter {
+    subscriptionId: SubscriptionId;
+    publishingInterval: number;
+    lifetimeCount: number;
+    maxKeepAliveCount: number;
+    maxNotificationsPerPublish: number;
+    publishingEnabled: boolean;
+    priority: number;
+    monitoredItems: ClientMonitoredItemBaseMap;
+    timeoutHint: number;
+    /**
+     * return the session associated with the subscription.
+     * (may throw if the session is not valid)
+     */
+    session: ClientSession;
+    /**
+     * return true if the subscription is attached to a valid session
+     */
+    hasSession: boolean;
+    /**
+     * true is the subscription is fully active
+     */
+    isActive: boolean;
+    /**
+     * add a monitor item to the subscription
+     *
+     * @method monitor
+     *
+     * Monitoring a simple Value Change
+     * ---------------------------------
+     *
+     * @example:
+     *
+     *   clientSubscription.monitor(
+     *     // itemToMonitor:
+     *     {
+     *       nodeId: "ns=0;i=2258",
+     *       attributeId: AttributeIds.Value,
+     *       indexRange: null,
+     *       dataEncoding: { namespaceIndex: 0, name: null }
+     *     },
+     *     // requestedParameters:
+     *     {
+     *        samplingInterval: 3000,
+     *        filter: null,
+     *        queueSize: 1,
+     *        discardOldest: true
+     *     },
+     *     TimestampsToReturn.Neither
+     *   );
+     *
+     * Monitoring a Value Change With a DataChange  Filter
+     * ---------------------------------------------------
+     *
+     * options.trigger       {DataChangeTrigger} {Status|StatusValue|StatusValueTimestamp}
+     * options.deadbandType  {DeadbandType}      {None|Absolute|Percent}
+     * options.deadbandValue {Double}
+     *
+     * @example:
+     *
+     *   clientSubscription.monitor(
+     *     // itemToMonitor:
+     *     {
+     *       nodeId: "ns=0;i=2258",
+     *       attributeId: AttributeIds.Value,
+     *     },
+     *     // requestedParameters:
+     *     {
+     *        samplingInterval: 3000,
+     *        filter: new DataChangeFilter({
+     *             trigger: DataChangeTrigger.StatusValue,
+     *             deadbandType: DeadbandType.Absolute,
+     *             deadbandValue: 0.1
+     *        }),
+     *        queueSize: 1,
+     *        discardOldest: true
+     *     },
+     *     TimestampsToReturn.Neither
+     *   );
+     *
+     *
+     * Monitoring an Event
+     * -------------------
+     *
+     *  If the monitor attributeId is EventNotifier then the filter must be specified
+     *
+     * @example:
+     *
+     *  var filter =  new EventFilter({
+     *    selectClauses: [
+     *             { browsePath: [ {name: 'ActiveState'  }, {name: 'id'}  ]},
+     *             { browsePath: [ {name: 'ConditionName'}                ]}
+     *    ],
+     *    whereClause: []
+     *  });
+     *
+     *  clientSubscription.monitor(
+     *     // itemToMonitor:
+     *     {
+     *       nodeId: "ns=0;i=2258",
+     *       attributeId: AttributeIds.EventNotifier,
+     *       indexRange: null,
+     *       dataEncoding: { namespaceIndex: 0, name: null }
+     *     },
+     *     // requestedParameters:
+     *     {
+     *        samplingInterval: 3000,
+     *
+     *        filter: filter,
+     *
+     *        queueSize: 1,
+     *        discardOldest: true
+     *     },
+     *     TimestampsToReturn.Neither
+     *   );
+     *
+     *
+     *
+     *
+     *
+     *
+     */
+    monitor(itemToMonitor: ReadValueIdOptions, requestedParameters: MonitoringParametersOptions, timestampsToReturn: TimestampsToReturn, monitoringMode?: MonitoringMode): Promise<ClientMonitoredItem>;
+    monitor(itemToMonitor: ReadValueIdOptions, requestedParameters: MonitoringParametersOptions, timestampsToReturn: TimestampsToReturn, monitoringMode: MonitoringMode, callback: Callback<ClientMonitoredItem>): void;
+    /**
+     * @method monitorItems
+     * @param itemsToMonitor
+     * @param requestedParameters
+     * @param timestampsToReturn
+     * @return a ClientMonitoredItemGroup
+     * @async
+     */
+    monitorItems(itemsToMonitor: ReadValueIdOptions[], requestedParameters: MonitoringParametersOptions, timestampsToReturn: TimestampsToReturn): Promise<ClientMonitoredItemGroup>;
+    /**
+     * @method monitorItems
+     * @param itemsToMonitor
+     * @param requestedParameters
+     * @param timestampsToReturn
+     * @param done
+     * @async
+     */
+    monitorItems(itemsToMonitor: ReadValueIdOptions[], requestedParameters: MonitoringParametersOptions, timestampsToReturn: TimestampsToReturn, callback: Callback<ClientMonitoredItemGroup>): void;
+    getMonitoredItems(): Promise<MonitoredItemData>;
+    getMonitoredItems(callback: (err: Error | null, result?: MonitoredItemData) => void): void;
+    modify(options: ModifySubscriptionOptions, callback: Callback<ModifySubscriptionResult>): void;
+    modify(options: ModifySubscriptionOptions): Promise<ModifySubscriptionResult>;
+    setTriggering(triggeringItem: ClientMonitoredItemBase, linksToAdd: ClientMonitoredItemBase[] | null, linksToRemove: ClientMonitoredItemBase[] | null, callback: Callback<SetTriggeringResponse>): void;
+    setTriggering(triggeringItem: ClientMonitoredItemBase, linksToAdd: ClientMonitoredItemBase[] | null, linksToRemove: ClientMonitoredItemBase[] | null): Promise<SetTriggeringResponse>;
+    terminate(): Promise<void>;
+    terminate(callback: ErrorCallback): void;
+}
+export declare interface ClientSubscription {
+    once(event: string | symbol, listener: (...args: any[]) => void): this;
+    on(event: string | symbol, listener: (...args: any[]) => void): this;
+    /**
+     * notify the observers that the subscription has now started
+     * @event started
+     */
+    on(event: "started", eventHandler: (subscriptionId: number) => void): this;
+    /**
+     * notify the observers tha the client subscription has terminated
+     * @event  terminated
+     */
+    on(event: "terminated", eventHandler: () => void): this;
+    /**
+     * notify the observers that a new monitored item has been added to the subscription.
+     * @event  item_added
+     */
+    on(event: "item_added", eventHandler: (monitoredItem: ClientMonitoredItem) => void): this;
+    /**
+     * notify the observers that a keep alive Publish Response has been received from the server.
+     * @event keepalive
+     */
+    on(event: "keepalive", eventHandler: () => void): this;
+    /**
+     * notify the observers that an error has occurred
+     * @event internal_error
+     * @param event
+     * @param eventHandler
+     */
+    on(event: "internal_error", eventHandler: (err: Error) => void): this;
+    on(event: "raw_notification", eventHandler: (notificationMessage: NotificationMessage) => void): this;
+    /**
+     * notify the observers that some notifications has been received from the server in  a PublishResponse
+     * each modified monitored Item
+     * @event  received_notifications
+     */
+    on(event: "received_notifications", eventHandler: (notificationMessage: NotificationMessage) => void): this;
+    /**
+     * notify the observers that the server has send a status changed notification (such as BadTimeout )
+     * @event status_changed
+     */
+    on(event: "status_changed", eventHandler: (status: StatusCode, diagnosticInfo: DiagnosticInfo) => void): this;
+    on(event: "error", eventHandler: (err: Error) => void): this;
+}
+export declare interface ClientSubscription {
+    _createMonitoredItem(itemToMonitor: ReadValueIdOptions, monitoringParameters: MonitoringParametersOptions, timestampsToReturn: TimestampsToReturn): ClientMonitoredItem;
+}
+export declare class ClientSubscription {
+    static create(clientSession: ClientSession, options: ClientSubscriptionOptions): ClientSubscription;
+    static ignoreNextWarning: boolean;
+}

package/dist/client_subscription.js

@@ -1,15 +1,15 @@
-"use strict";
-/**
- * @module node-opcua-client
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ClientSubscription = void 0;
-class ClientSubscription {
-    static create(clientSession, options) {
-        /* istanbul ignore next*/
-        throw new Error("Not Implemented");
-    }
-}
-exports.ClientSubscription = ClientSubscription;
-ClientSubscription.ignoreNextWarning = false;
+"use strict";
+/**
+ * @module node-opcua-client
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClientSubscription = void 0;
+class ClientSubscription {
+    static create(clientSession, options) {
+        /* istanbul ignore next*/
+        throw new Error("Not Implemented");
+    }
+}
+exports.ClientSubscription = ClientSubscription;
+ClientSubscription.ignoreNextWarning = false;
 //# sourceMappingURL=client_subscription.js.map

package/dist/client_utils.d.ts

@@ -1,22 +1,22 @@
-/**
- * @module node-opcua-client
- */
-import { NodeIdLike } from "node-opcua-nodeid";
-import { Variant } from "node-opcua-variant";
-import { ClientSession, ResponseCallback } from "./client_session";
-interface AnalogDataItemSnapshot {
-    engineeringUnits: Variant | null;
-    engineeringUnitsRange: Variant | null;
-    instrumentRange: Variant | null;
-    valuePrecision: Variant | null;
-    definition: Variant | null;
-}
-/**
- * @method readUAAnalogItem
- * @param session
- * @param nodeId
- * @param callback
- */
-export declare function readUAAnalogItem(session: ClientSession, nodeId: NodeIdLike): Promise<AnalogDataItemSnapshot>;
-export declare function readUAAnalogItem(session: ClientSession, nodeId: NodeIdLike, callback: ResponseCallback<AnalogDataItemSnapshot>): void;
-export {};
+/**
+ * @module node-opcua-client
+ */
+import { NodeIdLike } from "node-opcua-nodeid";
+import { Variant } from "node-opcua-variant";
+import { ClientSession, ResponseCallback } from "./client_session";
+interface AnalogDataItemSnapshot {
+    engineeringUnits: Variant | null;
+    engineeringUnitsRange: Variant | null;
+    instrumentRange: Variant | null;
+    valuePrecision: Variant | null;
+    definition: Variant | null;
+}
+/**
+ * @method readUAAnalogItem
+ * @param session
+ * @param nodeId
+ * @param callback
+ */
+export declare function readUAAnalogItem(session: ClientSession, nodeId: NodeIdLike): Promise<AnalogDataItemSnapshot>;
+export declare function readUAAnalogItem(session: ClientSession, nodeId: NodeIdLike, callback: ResponseCallback<AnalogDataItemSnapshot>): void;
+export {};