@opentap/runner-client 2.22.1 → 2.23.0-alpha.1.2.10769060909

package/dist/cjs/DTOs.js

@@ -16,8 +16,8 @@ var __extends = (this && this.__extends) || (function () {
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SessionShutdownInitiated = exports.SessionStartFailed = exports.SessionStarted = exports.SessionStartInitiated = exports.SessionEventArgs = exports.SettingsTapPackage = exports.RepositorySettingsPackageDefinition = exports.RepositoryPackageDefinition = exports.RepositoryPackageReference = exports.ProfileGroup = exports.ListItemType = exports.ComponentSettings = exports.FileDescriptor = exports.Resource = exports.PluginTypeSelectorControl = exports.PictureControl = exports.PasswordControl = exports.MultiSelectControl = exports.DropdownControl = exports.EnabledControl = exports.DirectoryPathControl = exports.FilePathControl = exports.ComboBoxControl = exports.TextBoxControl = exports.DataGridControl = exports.DataGridReferenceControl = exports.CheckBoxControl = exports.AvailableValue = exports.ButtonsControl = exports.ButtonControl = exports.ExternalParameter = exports.MetaData = exports.DisplayAttribute = exports.VisualStatus = exports.Icon = exports.ColumnDisplayName = exports.LayoutMode = exports.Layout = exports.Setting = exports.ComponentSettingsListItem = exports.AnnotatedObject = exports.ComponentSettingsList = exports.ComponentSettingsIdentifier = exports.ComponentSettingsBase = exports.Links = exports.Session = exports.ImageResolveErrorResponse = exports.ErrorResponse = exports.PackageSpecifier = exports.Image = void 0;
-exports.BreakEventArgs = exports.TestStepChangeEventArgs = exports.SettingsChangedEventArgs = exports.TestPlanExecutionStateChangedEventArgs = exports.TestPlanChangeEventArgs = exports.StoppedEventArgs = exports.StoppingEventArgs = exports.StartedEventArgs = exports.StartingEventArgs = exports.SessionTimeoutEventArgs = exports.SessionEventType = exports.SessionEvent = exports.MetricValue = exports.MetricsRequest = exports.SessionMetricInfo = exports.MetricsPollRate = exports.SessionMetricType = exports.SessionMetricKind = exports.ResultColumn = exports.Result = exports.LogEvent = exports.TestStepRun = exports.TestRun = exports.WatchDog = exports.Parameter = exports.BreakPoints = exports.InstalledFile = exports.Interaction = exports.CommonContext = exports.CommonSettings = exports.ValidationError = exports.TestStepValidationError = exports.TestStepCopy = exports.TestStepType = exports.TestStep = exports.TestPlan = exports.ExecutionState = exports.Verdict = exports.RunStatus = exports.MissingLicenseResponse = exports.LogEntry = exports.LogList = exports.ApiException = exports.ImageCreationFailed = exports.ImageCreated = exports.ImageCreating = exports.ImageEventArgs = exports.SessionInactivityLimitHit = exports.SessionShutdownFailed = exports.SessionShutdown = void 0;
-exports.RunnerDeletedEvent = exports.RunnerUpdatedEvent = exports.RunnerRegisteredEvent = exports.RunnerEvent = exports.TestPlanRunCompletedEventArgs = exports.TestPlanRunStartEventArgs = exports.TestPlanRunEvent = exports.TestStepRunCompletedEventArgs = exports.TestStepRunStartEventArgs = exports.TestStepRunEvent = exports.OnTestStepRun = exports.OnTestPlanRun = exports.TestPlanSettingsChangedEventArgs = exports.UserInputRequestCompletedEventArgs = exports.UserInputRequestEventArgs = void 0;
+exports.BreakEventArgs = exports.TestStepChangeEventArgs = exports.SettingsChangedEventArgs = exports.TestPlanExecutionStateChangedEventArgs = exports.TestPlanChangeEventArgs = exports.StoppedEventArgs = exports.StoppingEventArgs = exports.StartedEventArgs = exports.StartingEventArgs = exports.SessionTimeoutEventArgs = exports.SessionEventType = exports.SessionEvent = exports.MetricValue = exports.MetricsConfiguration = exports.SessionMetricInfo = exports.MetricsPollRate = exports.SessionMetricType = exports.SessionMetricKind = exports.ResultColumn = exports.Result = exports.LogEvent = exports.TestStepRun = exports.TestRun = exports.WatchDog = exports.Parameter = exports.BreakPoints = exports.InstalledFile = exports.Interaction = exports.CommonContext = exports.CommonSettings = exports.ValidationError = exports.TestStepValidationError = exports.TestStepCopy = exports.TestStepType = exports.TestStep = exports.TestPlan = exports.ExecutionState = exports.Verdict = exports.RunStatus = exports.MissingLicenseResponse = exports.LogEntry = exports.LogList = exports.ApiException = exports.ImageCreationFailed = exports.ImageCreated = exports.ImageCreating = exports.ImageEventArgs = exports.SessionInactivityLimitHit = exports.SessionShutdownFailed = exports.SessionShutdown = void 0;
+exports.RunnerDeletedEvent = exports.RunnerUpdatedEvent = exports.RunnerRegisteredEvent = exports.RunnerEvent = exports.TestPlanRunCompletedEventArgs = exports.TestPlanRunStartEventArgs = exports.TestPlanRunEvent = exports.TestStepRunCompletedEventArgs = exports.TestStepRunStartEventArgs = exports.TestStepRunEvent = exports.OnTestStepRun = exports.OnTestPlanRun = exports.MetricsConfigurationChangedEventArgs = exports.HeartbeatEventArgs = exports.TestPlanSettingsChangedEventArgs = exports.UserInputRequestCompletedEventArgs = exports.UserInputRequestEventArgs = void 0;
 var Image = /** @class */ (function () {
     function Image(data) {
         this.packages = [];
@@ -3136,8 +3136,8 @@ var SessionMetricInfo = /** @class */ (function () {
     return SessionMetricInfo;
 }());
 exports.SessionMetricInfo = SessionMetricInfo;
-var MetricsRequest = /** @class */ (function () {
-    function MetricsRequest(data) {
+var MetricsConfiguration = /** @class */ (function () {
+    function MetricsConfiguration(data) {
         this.metrics = [];
         if (data) {
             for (var property in data) {
@@ -3146,20 +3146,20 @@ var MetricsRequest = /** @class */ (function () {
             }
         }
     }
-    MetricsRequest.prototype.init = function (_data) {
+    MetricsConfiguration.prototype.init = function (_data) {
         if (_data) {
             this.publishRate = _data['PublishRate'];
             if (Array.isArray(_data['Metrics']))
                 this.metrics = _data['Metrics'].map(function (item) { return SessionMetricInfo.fromJS(item); });
         }
     };
-    MetricsRequest.fromJS = function (data) {
+    MetricsConfiguration.fromJS = function (data) {
         data = typeof data === 'object' ? data : {};
-        var result = new MetricsRequest();
+        var result = new MetricsConfiguration();
         result.init(data);
         return result;
     };
-    MetricsRequest.prototype.toJSON = function (data) {
+    MetricsConfiguration.prototype.toJSON = function (data) {
         data = typeof data === 'object' ? data : {};
         data['PublishRate'] = this.publishRate;
         if (Array.isArray(this.metrics)) {
@@ -3167,9 +3167,9 @@ var MetricsRequest = /** @class */ (function () {
         }
         return data;
     };
-    return MetricsRequest;
+    return MetricsConfiguration;
 }());
-exports.MetricsRequest = MetricsRequest;
+exports.MetricsConfiguration = MetricsConfiguration;
 var MetricValue = /** @class */ (function () {
     function MetricValue(data) {
         if (data) {
@@ -3313,6 +3313,8 @@ var SessionEventType;
     SessionEventType["SessionTimeoutHit"] = "SessionTimeoutHit";
     SessionEventType["TestPlanSettingsChanged"] = "TestPlanSettingsChanged";
     SessionEventType["TypeCacheInvalidated"] = "TypeCacheInvalidated";
+    SessionEventType["Heartbeat"] = "Heartbeat";
+    SessionEventType["MetricsConfigurationChanged"] = "MetricsConfigurationChanged";
 })(SessionEventType = exports.SessionEventType || (exports.SessionEventType = {}));
 var SessionTimeoutEventArgs = /** @class */ (function (_super) {
     __extends(SessionTimeoutEventArgs, _super);
@@ -3650,6 +3652,54 @@ var TestPlanSettingsChangedEventArgs = /** @class */ (function (_super) {
     return TestPlanSettingsChangedEventArgs;
 }(SessionEvent));
 exports.TestPlanSettingsChangedEventArgs = TestPlanSettingsChangedEventArgs;
+var HeartbeatEventArgs = /** @class */ (function (_super) {
+    __extends(HeartbeatEventArgs, _super);
+    function HeartbeatEventArgs(data) {
+        var _this = _super.call(this, data) || this;
+        _this._discriminator = 'HeartbeatEventArgs';
+        return _this;
+    }
+    HeartbeatEventArgs.prototype.init = function (_data) {
+        _super.prototype.init.call(this, _data);
+    };
+    HeartbeatEventArgs.fromJS = function (data) {
+        data = typeof data === 'object' ? data : {};
+        var result = new HeartbeatEventArgs();
+        result.init(data);
+        return result;
+    };
+    HeartbeatEventArgs.prototype.toJSON = function (data) {
+        data = typeof data === 'object' ? data : {};
+        _super.prototype.toJSON.call(this, data);
+        return data;
+    };
+    return HeartbeatEventArgs;
+}(SessionEvent));
+exports.HeartbeatEventArgs = HeartbeatEventArgs;
+var MetricsConfigurationChangedEventArgs = /** @class */ (function (_super) {
+    __extends(MetricsConfigurationChangedEventArgs, _super);
+    function MetricsConfigurationChangedEventArgs(data) {
+        var _this = _super.call(this, data) || this;
+        _this._discriminator = 'MetricsConfigurationChangedEventArgs';
+        return _this;
+    }
+    MetricsConfigurationChangedEventArgs.prototype.init = function (_data) {
+        _super.prototype.init.call(this, _data);
+    };
+    MetricsConfigurationChangedEventArgs.fromJS = function (data) {
+        data = typeof data === 'object' ? data : {};
+        var result = new MetricsConfigurationChangedEventArgs();
+        result.init(data);
+        return result;
+    };
+    MetricsConfigurationChangedEventArgs.prototype.toJSON = function (data) {
+        data = typeof data === 'object' ? data : {};
+        _super.prototype.toJSON.call(this, data);
+        return data;
+    };
+    return MetricsConfigurationChangedEventArgs;
+}(SessionEvent));
+exports.MetricsConfigurationChangedEventArgs = MetricsConfigurationChangedEventArgs;
 var OnTestPlanRun = /** @class */ (function () {
     function OnTestPlanRun(data) {
         if (data) {

package/dist/cjs/SessionClient.js

@@ -303,37 +303,47 @@ var SessionClient = /** @class */ (function (_super) {
      * @param  {SubscriptionOptions} options?
      * @returns Subscription
      */
-    SessionClient.prototype.connectMetric = function (metricInfo, handler, options) {
-        return this.subscribe("Events.Metrics.".concat(metricInfo.subjectPostfix), __assign(__assign({}, options), { callback: function (error, encodedMessage) {
-                var _a, _b;
-                if (error) {
-                    handler(undefined, error);
-                    return;
-                }
-                try {
-                    var time = Number.parseInt((_b = (_a = encodedMessage.headers) === null || _a === void 0 ? void 0 : _a.get('timestamp')) !== null && _b !== void 0 ? _b : '');
-                    var value = void 0;
-                    // Decode the value based on the metric value type given in the metric info
-                    switch (metricInfo.type) {
-                        case DTOs_1.SessionMetricType.Boolean:
-                            value = encoders_1.booleanCodec.decode(encodedMessage.data);
-                            break;
-                        case DTOs_1.SessionMetricType.Double:
-                            value = encoders_1.numberCodec.decode(encodedMessage.data);
-                            break;
-                        case DTOs_1.SessionMetricType.String:
-                            value = encoders_1.stringCodec.decode(encodedMessage.data);
-                            break;
-                        default:
-                            value = encoders_1.jsonCodec.decode(encodedMessage.data);
-                            break;
-                    }
-                    handler(new DTOs_1.MetricValue({ value: value, time: time }), error);
-                }
-                catch (error) {
-                    handler(undefined, error);
-                }
-            } }));
+    SessionClient.prototype.connectMetric = function (metricInfo, handler) {
+        var _this = this;
+        return this.connection.jetstreamManager({ checkAPI: false }).then(function (jetStreamManager) {
+            var stream = "".concat(_this.baseSubject, ".Events.Metrics.").concat(metricInfo.subjectPostfix);
+            return jetStreamManager.consumers
+                .add(stream, {
+                name: "runner-web-client-metric-consumer-".concat(nats_ws_1.nuid.next()),
+            })
+                .then(function (consumerInfo) { var _a; return (_a = _this.connection) === null || _a === void 0 ? void 0 : _a.jetstream().consumers.get(consumerInfo.stream_name, consumerInfo.name); })
+                .then(function (consumer) {
+                consumer === null || consumer === void 0 ? void 0 : consumer.consume({
+                    callback: function (encodedMessage) {
+                        var _a, _b;
+                        try {
+                            var time = Number.parseInt((_b = (_a = encodedMessage.headers) === null || _a === void 0 ? void 0 : _a.get('timestamp')) !== null && _b !== void 0 ? _b : '');
+                            var value = void 0;
+                            // Decode the value based on the metric value type given in the metric info
+                            switch (metricInfo.type) {
+                                case DTOs_1.SessionMetricType.Boolean:
+                                    value = encoders_1.booleanCodec.decode(encodedMessage.data);
+                                    break;
+                                case DTOs_1.SessionMetricType.Double:
+                                    value = encoders_1.numberCodec.decode(encodedMessage.data);
+                                    break;
+                                case DTOs_1.SessionMetricType.String:
+                                    value = encoders_1.stringCodec.decode(encodedMessage.data);
+                                    break;
+                                default:
+                                    value = encoders_1.jsonCodec.decode(encodedMessage.data);
+                                    break;
+                            }
+                            handler(new DTOs_1.MetricValue({ value: value, time: time }), null);
+                        }
+                        catch (error) {
+                            handler(undefined, error);
+                        }
+                    },
+                });
+                return consumer;
+            });
+        });
     };
     /**
      * Unsubscibe from session events
@@ -813,19 +823,19 @@ var SessionClient = /** @class */ (function (_super) {
      * Get the metric information
      * @returns Promise
      */
-    SessionClient.prototype.getMetrics = function () {
-        return this.request('GetMetrics')
-            .then(function (metricsRequestJs) { return DTOs_1.MetricsRequest.fromJS(metricsRequestJs); })
+    SessionClient.prototype.getMetricsConfiguration = function () {
+        return this.request('GetMetricsConfiguration')
+            .then(function (metricsRequestJs) { return DTOs_1.MetricsConfiguration.fromJS(metricsRequestJs); })
             .then(this.success())
             .catch(this.error());
     };
     /**
      * Set the metric information. Used for setting up which metrics should be published for polling.
-     * @param  {IMetricsRequest} metricsRequest
+     * @param  {IMetricsConfiguration} metricsRequest
      * @returns Promise
      */
-    SessionClient.prototype.setMetrics = function (metricsRequest) {
-        return this.request('SetMetrics', metricsRequest).then(this.success()).catch(this.error());
+    SessionClient.prototype.setMetricsConfiguration = function (metricsRequest) {
+        return this.request('SetMetricsConfiguration', metricsRequest).then(this.success()).catch(this.error());
     };
     return SessionClient;
 }(BaseClient_1.BaseClient));

package/dist/mjs/BaseClient.d.ts

@@ -1,6 +1,6 @@
 import { DownloadTapSettingsRequest } from './requestDTOs';
 import { ComponentSettingsBase, ComponentSettingsIdentifier, ComponentSettingsListItem, DataGridControl, ErrorResponse, FileParameter, ListItemType, ProfileGroup, RepositoryPackageReference, RepositorySettingsPackageDefinition } from './DTOs';
-import { ConnectionOptions, NatsError, Subscription, SubscriptionOptions, PublishOptions } from 'nats.ws';
+import { ConnectionOptions, NatsConnection, NatsError, Subscription, SubscriptionOptions, PublishOptions } from 'nats.ws';
 interface BaseClientRequestOptions {
     publishOptions?: PublishOptions;
     rawResponse?: boolean;
@@ -9,7 +9,7 @@ interface BaseClientRequestOptions {
 }
 export declare class BaseClient {
     readonly baseSubject: string;
-    private connection;
+    protected connection: NatsConnection | null;
     private connectionOptions;
     private domainAccess;
     private eventEmitter;

package/dist/mjs/DTOs.d.ts

@@ -1115,15 +1115,15 @@ export interface ISessionMetricInfo {
     metricFullName: string;
     subjectPostfix: string;
 }
-export declare class MetricsRequest implements IMetricsRequest {
+export declare class MetricsConfiguration implements IMetricsConfiguration {
     publishRate: MetricsPollRate;
     metrics: SessionMetricInfo[];
-    constructor(data?: IMetricsRequest);
+    constructor(data?: IMetricsConfiguration);
     init(_data?: any): void;
-    static fromJS(data: any): MetricsRequest;
+    static fromJS(data: any): MetricsConfiguration;
     toJSON(data?: any): any;
 }
-export interface IMetricsRequest {
+export interface IMetricsConfiguration {
     publishRate: MetricsPollRate;
     metrics: ISessionMetricInfo[];
 }
@@ -1166,7 +1166,9 @@ export declare enum SessionEventType {
     UserInputCompleted = "UserInputCompleted",
     SessionTimeoutHit = "SessionTimeoutHit",
     TestPlanSettingsChanged = "TestPlanSettingsChanged",
-    TypeCacheInvalidated = "TypeCacheInvalidated"
+    TypeCacheInvalidated = "TypeCacheInvalidated",
+    Heartbeat = "Heartbeat",
+    MetricsConfigurationChanged = "MetricsConfigurationChanged"
 }
 export declare class SessionTimeoutEventArgs extends SessionEvent implements ISessionTimeoutEventArgs {
     constructor(data?: ISessionTimeoutEventArgs);
@@ -1278,6 +1280,27 @@ export declare class TestPlanSettingsChangedEventArgs extends SessionEvent imple
     toJSON(data?: any): any;
 }
 export declare type ITestPlanSettingsChangedEventArgs = ISessionEvent;
+export declare class HeartbeatEventArgs extends SessionEvent implements IHeartbeatEventArgs {
+    constructor(data?: IHeartbeatEventArgs);
+    init(_data?: any): void;
+    static fromJS(data: any): HeartbeatEventArgs;
+    toJSON(data?: any): any;
+}
+export interface IHeartbeatEventArgs extends ISessionEvent {
+    timestamp?: number;
+    watchDog?: IWatchDog;
+    state?: ExecutionState;
+    testPlanRunID?: string;
+}
+export declare class MetricsConfigurationChangedEventArgs extends SessionEvent implements IMetricsConfigurationChangedEventArgs {
+    constructor(data?: IMetricsConfigurationChangedEventArgs);
+    init(_data?: any): void;
+    static fromJS(data: any): MetricsConfigurationChangedEventArgs;
+    toJSON(data?: any): any;
+}
+export interface IMetricsConfigurationChangedEventArgs extends ISessionEvent {
+    metricsConfiguration?: IMetricsConfiguration;
+}
 export interface IOnTestPlanRun {
     status?: string;
     userId?: string;

package/dist/mjs/DTOs.js

@@ -2744,7 +2744,7 @@ export class SessionMetricInfo {
         return data;
     }
 }
-export class MetricsRequest {
+export class MetricsConfiguration {
     constructor(data) {
         this.metrics = [];
         if (data) {
@@ -2763,7 +2763,7 @@ export class MetricsRequest {
     }
     static fromJS(data) {
         data = typeof data === 'object' ? data : {};
-        const result = new MetricsRequest();
+        const result = new MetricsConfiguration();
         result.init(data);
         return result;
     }
@@ -2915,6 +2915,8 @@ export var SessionEventType;
     SessionEventType["SessionTimeoutHit"] = "SessionTimeoutHit";
     SessionEventType["TestPlanSettingsChanged"] = "TestPlanSettingsChanged";
     SessionEventType["TypeCacheInvalidated"] = "TypeCacheInvalidated";
+    SessionEventType["Heartbeat"] = "Heartbeat";
+    SessionEventType["MetricsConfigurationChanged"] = "MetricsConfigurationChanged";
 })(SessionEventType || (SessionEventType = {}));
 export class SessionTimeoutEventArgs extends SessionEvent {
     constructor(data) {
@@ -3200,6 +3202,46 @@ export class TestPlanSettingsChangedEventArgs extends SessionEvent {
         return data;
     }
 }
+export class HeartbeatEventArgs extends SessionEvent {
+    constructor(data) {
+        super(data);
+        this._discriminator = 'HeartbeatEventArgs';
+    }
+    init(_data) {
+        super.init(_data);
+    }
+    static fromJS(data) {
+        data = typeof data === 'object' ? data : {};
+        const result = new HeartbeatEventArgs();
+        result.init(data);
+        return result;
+    }
+    toJSON(data) {
+        data = typeof data === 'object' ? data : {};
+        super.toJSON(data);
+        return data;
+    }
+}
+export class MetricsConfigurationChangedEventArgs extends SessionEvent {
+    constructor(data) {
+        super(data);
+        this._discriminator = 'MetricsConfigurationChangedEventArgs';
+    }
+    init(_data) {
+        super.init(_data);
+    }
+    static fromJS(data) {
+        data = typeof data === 'object' ? data : {};
+        const result = new MetricsConfigurationChangedEventArgs();
+        result.init(data);
+        return result;
+    }
+    toJSON(data) {
+        data = typeof data === 'object' ? data : {};
+        super.toJSON(data);
+        return data;
+    }
+}
 export class OnTestPlanRun {
     constructor(data) {
         if (data) {

package/dist/mjs/SessionClient.d.ts

@@ -1,5 +1,5 @@
-import { BreakPoints, CommonContext, CommonSettings, DataGridControl, IMetricValue, IMetricsRequest, ISessionMetricInfo, Image, Interaction, ListItemType, LogList, MetricsRequest, OnTestPlanRun, OnTestStepRun, Parameter, RepositoryPackageDefinition, RepositoryPackageReference, Resource, Result, RunStatus, SessionEvent, Setting, TestPlan, TestRun, TestStepType, TestStepValidationError, WatchDog } from './DTOs';
-import { ConnectionOptions, NatsError, Subscription, SubscriptionOptions } from 'nats.ws';
+import { BreakPoints, CommonContext, CommonSettings, DataGridControl, IMetricValue, IMetricsConfiguration, ISessionMetricInfo, Image, Interaction, ListItemType, LogList, MetricsConfiguration, OnTestPlanRun, OnTestStepRun, Parameter, RepositoryPackageDefinition, RepositoryPackageReference, Resource, Result, RunStatus, SessionEvent, Setting, TestPlan, TestRun, TestStepType, TestStepValidationError, WatchDog } from './DTOs';
+import { ConnectionOptions, Consumer, NatsError, Subscription, SubscriptionOptions } from 'nats.ws';
 import { BaseClient } from './BaseClient';
 export declare class SessionClient extends BaseClient {
     private subscriptions;
@@ -88,7 +88,7 @@ export declare class SessionClient extends BaseClient {
      * @param  {SubscriptionOptions} options?
      * @returns Subscription
      */
-    connectMetric(metricInfo: ISessionMetricInfo, handler: (result: IMetricValue | undefined, err: NatsError | Error | null) => void, options?: SubscriptionOptions): Subscription;
+    connectMetric(metricInfo: ISessionMetricInfo, handler: (result: IMetricValue | undefined, err: NatsError | Error | null) => void): Promise<Consumer | undefined>;
     /**
      * Unsubscibe from session events
      */
@@ -357,11 +357,11 @@ export declare class SessionClient extends BaseClient {
      * Get the metric information
      * @returns Promise
      */
-    getMetrics(): Promise<MetricsRequest>;
+    getMetricsConfiguration(): Promise<MetricsConfiguration>;
     /**
      * Set the metric information. Used for setting up which metrics should be published for polling.
-     * @param  {IMetricsRequest} metricsRequest
+     * @param  {IMetricsConfiguration} metricsRequest
      * @returns Promise
      */
-    setMetrics(metricsRequest: IMetricsRequest): Promise<void>;
+    setMetricsConfiguration(metricsRequest: IMetricsConfiguration): Promise<void>;
 }

package/dist/mjs/SessionClient.js

@@ -1,5 +1,5 @@
-import { BreakPoints, CommonContext, CommonSettings, DataGridControl, Image, Interaction, ListItemType, LogList, MetricValue, MetricsRequest, OnTestPlanRun, OnTestStepRun, Parameter, Result, RunStatus, SessionEvent, SessionMetricType, Setting, TestPlan, TestRun, TestStepType, TestStepValidationError, WatchDog, } from './DTOs';
-import { JSONCodec } from 'nats.ws';
+import { BreakPoints, CommonContext, CommonSettings, DataGridControl, Image, Interaction, ListItemType, LogList, MetricValue, MetricsConfiguration, OnTestPlanRun, OnTestStepRun, Parameter, Result, RunStatus, SessionEvent, SessionMetricType, Setting, TestPlan, TestRun, TestStepType, TestStepValidationError, WatchDog, } from './DTOs';
+import { JSONCodec, nuid } from 'nats.ws';
 import { booleanCodec, jsonCodec, numberCodec, stringCodec } from './encoders';
 import { BaseClient } from './BaseClient';
 export class SessionClient extends BaseClient {
@@ -272,37 +272,46 @@ export class SessionClient extends BaseClient {
      * @param  {SubscriptionOptions} options?
      * @returns Subscription
      */
-    connectMetric(metricInfo, handler, options) {
-        return this.subscribe(`Events.Metrics.${metricInfo.subjectPostfix}`, Object.assign(Object.assign({}, options), { callback(error, encodedMessage) {
-                var _a, _b;
-                if (error) {
-                    handler(undefined, error);
-                    return;
-                }
-                try {
-                    const time = Number.parseInt((_b = (_a = encodedMessage.headers) === null || _a === void 0 ? void 0 : _a.get('timestamp')) !== null && _b !== void 0 ? _b : '');
-                    let value;
-                    // Decode the value based on the metric value type given in the metric info
-                    switch (metricInfo.type) {
-                        case SessionMetricType.Boolean:
-                            value = booleanCodec.decode(encodedMessage.data);
-                            break;
-                        case SessionMetricType.Double:
-                            value = numberCodec.decode(encodedMessage.data);
-                            break;
-                        case SessionMetricType.String:
-                            value = stringCodec.decode(encodedMessage.data);
-                            break;
-                        default:
-                            value = jsonCodec.decode(encodedMessage.data);
-                            break;
-                    }
-                    handler(new MetricValue({ value, time }), error);
-                }
-                catch (error) {
-                    handler(undefined, error);
-                }
-            } }));
+    connectMetric(metricInfo, handler) {
+        return this.connection.jetstreamManager({ checkAPI: false }).then(jetStreamManager => {
+            const stream = `${this.baseSubject}.Events.Metrics.${metricInfo.subjectPostfix}`;
+            return jetStreamManager.consumers
+                .add(stream, {
+                name: `runner-web-client-metric-consumer-${nuid.next()}`,
+            })
+                .then(consumerInfo => { var _a; return (_a = this.connection) === null || _a === void 0 ? void 0 : _a.jetstream().consumers.get(consumerInfo.stream_name, consumerInfo.name); })
+                .then(consumer => {
+                consumer === null || consumer === void 0 ? void 0 : consumer.consume({
+                    callback(encodedMessage) {
+                        var _a, _b;
+                        try {
+                            const time = Number.parseInt((_b = (_a = encodedMessage.headers) === null || _a === void 0 ? void 0 : _a.get('timestamp')) !== null && _b !== void 0 ? _b : '');
+                            let value;
+                            // Decode the value based on the metric value type given in the metric info
+                            switch (metricInfo.type) {
+                                case SessionMetricType.Boolean:
+                                    value = booleanCodec.decode(encodedMessage.data);
+                                    break;
+                                case SessionMetricType.Double:
+                                    value = numberCodec.decode(encodedMessage.data);
+                                    break;
+                                case SessionMetricType.String:
+                                    value = stringCodec.decode(encodedMessage.data);
+                                    break;
+                                default:
+                                    value = jsonCodec.decode(encodedMessage.data);
+                                    break;
+                            }
+                            handler(new MetricValue({ value, time }), null);
+                        }
+                        catch (error) {
+                            handler(undefined, error);
+                        }
+                    },
+                });
+                return consumer;
+            });
+        });
     }
     /**
      * Unsubscibe from session events
@@ -780,18 +789,18 @@ export class SessionClient extends BaseClient {
      * Get the metric information
      * @returns Promise
      */
-    getMetrics() {
-        return this.request('GetMetrics')
-            .then(metricsRequestJs => MetricsRequest.fromJS(metricsRequestJs))
+    getMetricsConfiguration() {
+        return this.request('GetMetricsConfiguration')
+            .then(metricsRequestJs => MetricsConfiguration.fromJS(metricsRequestJs))
             .then(this.success())
             .catch(this.error());
     }
     /**
      * Set the metric information. Used for setting up which metrics should be published for polling.
-     * @param  {IMetricsRequest} metricsRequest
+     * @param  {IMetricsConfiguration} metricsRequest
      * @returns Promise
      */
-    setMetrics(metricsRequest) {
-        return this.request('SetMetrics', metricsRequest).then(this.success()).catch(this.error());
+    setMetricsConfiguration(metricsRequest) {
+        return this.request('SetMetricsConfiguration', metricsRequest).then(this.success()).catch(this.error());
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opentap/runner-client",
-  "version": "2.22.1",
+  "version": "2.23.0-alpha.1.2.10769060909",
   "description": "This is the web client for the OpenTAP Runner.",
   "main": "./dist/cjs/index.js",
   "module": "./dist/mjs/index.js",
@@ -45,7 +45,7 @@
     "typescript": "^4.8.2"
   },
   "dependencies": {
-    "nats.ws": "^1.9.0",
+    "nats.ws": "^1.29.0",
     "uuid": "^9.0.0",
     "events": "^3.3.0"
   },