@opentap/runner-client 2.21.0 → 2.22.0-alpha.1.1.10179797802

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.TestStepRunEvent = exports.OnTestStepRun = exports.OnTestPlanRun = exports.TestPlanSettingsChangedEventArgs = exports.UserInputRequestCompletedEventArgs = exports.UserInputRequestEventArgs = 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.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 = 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;
 var Image = /** @class */ (function () {
     function Image(data) {
         this.packages = [];
@@ -3062,6 +3062,144 @@ var ResultColumn = /** @class */ (function () {
     return ResultColumn;
 }());
 exports.ResultColumn = ResultColumn;
+var SessionMetricKind;
+(function (SessionMetricKind) {
+    SessionMetricKind["Poll"] = "Poll";
+    SessionMetricKind["Push"] = "Push";
+    SessionMetricKind["PushPoll"] = "PushPoll";
+})(SessionMetricKind = exports.SessionMetricKind || (exports.SessionMetricKind = {}));
+var SessionMetricType;
+(function (SessionMetricType) {
+    SessionMetricType["Unknown"] = "Unknown";
+    SessionMetricType["Double"] = "Double";
+    SessionMetricType["Boolean"] = "Boolean";
+    SessionMetricType["String"] = "String";
+})(SessionMetricType = exports.SessionMetricType || (exports.SessionMetricType = {}));
+var MetricsPollRate;
+(function (MetricsPollRate) {
+    MetricsPollRate[MetricsPollRate["OneSecond"] = 1] = "OneSecond";
+    MetricsPollRate[MetricsPollRate["TwoSeconds"] = 2] = "TwoSeconds";
+    MetricsPollRate[MetricsPollRate["FiveSeconds"] = 5] = "FiveSeconds";
+    MetricsPollRate[MetricsPollRate["TenSeconds"] = 10] = "TenSeconds";
+    MetricsPollRate[MetricsPollRate["FifteenSeconds"] = 15] = "FifteenSeconds";
+    MetricsPollRate[MetricsPollRate["OneMinute"] = 60] = "OneMinute";
+    MetricsPollRate[MetricsPollRate["TwoMinutes"] = 120] = "TwoMinutes";
+    MetricsPollRate[MetricsPollRate["FiveMinutes"] = 300] = "FiveMinutes";
+    MetricsPollRate[MetricsPollRate["TenMinutes"] = 600] = "TenMinutes";
+    MetricsPollRate[MetricsPollRate["FifteenMinutes"] = 900] = "FifteenMinutes";
+    MetricsPollRate[MetricsPollRate["OneHour"] = 3600] = "OneHour";
+})(MetricsPollRate = exports.MetricsPollRate || (exports.MetricsPollRate = {}));
+var SessionMetricInfo = /** @class */ (function () {
+    function SessionMetricInfo(data) {
+        this.attributes = [];
+        if (data) {
+            for (var property in data) {
+                if (Object.prototype.hasOwnProperty.call(data, property))
+                    this[property] = data[property];
+            }
+        }
+    }
+    SessionMetricInfo.prototype.init = function (_data) {
+        if (_data) {
+            this.publish = _data['Publish'];
+            this.kind = _data['Kind'];
+            this.type = _data['Type'];
+            this.groupName = _data['GroupName'];
+            this.name = _data['Name'];
+            this.metricFullName = _data['MetricFullName'];
+            this.subjectPostfix = _data['SubjectPostfix'];
+            if (Array.isArray(_data['Attributes']))
+                this.attributes = _data['Attributes'];
+        }
+    };
+    SessionMetricInfo.fromJS = function (data) {
+        data = typeof data === 'object' ? data : {};
+        var result = new SessionMetricInfo();
+        result.init(data);
+        return result;
+    };
+    SessionMetricInfo.prototype.toJSON = function (data) {
+        data = typeof data === 'object' ? data : {};
+        data['Publish'] = this.publish;
+        data['Kind'] = this.kind;
+        data['Type'] = this.type;
+        data['GroupName'] = this.groupName;
+        data['Name'] = this.name;
+        data['MetricFullName'] = this.metricFullName;
+        data['SubjectPostfix'] = this.subjectPostfix;
+        data['Attributes'] = [];
+        if (Array.isArray(this.attributes)) {
+            data['Attributes'] = this.attributes;
+        }
+        return data;
+    };
+    return SessionMetricInfo;
+}());
+exports.SessionMetricInfo = SessionMetricInfo;
+var MetricsRequest = /** @class */ (function () {
+    function MetricsRequest(data) {
+        this.metrics = [];
+        if (data) {
+            for (var property in data) {
+                if (Object.prototype.hasOwnProperty.call(data, property))
+                    this[property] = data[property];
+            }
+        }
+    }
+    MetricsRequest.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) {
+        data = typeof data === 'object' ? data : {};
+        var result = new MetricsRequest();
+        result.init(data);
+        return result;
+    };
+    MetricsRequest.prototype.toJSON = function (data) {
+        data = typeof data === 'object' ? data : {};
+        data['PublishRate'] = this.publishRate;
+        if (Array.isArray(this.metrics)) {
+            data['SessionMetricInfo'] = this.metrics.map(function (item) { return item.toJSON(); });
+        }
+        return data;
+    };
+    return MetricsRequest;
+}());
+exports.MetricsRequest = MetricsRequest;
+var MetricValue = /** @class */ (function () {
+    function MetricValue(data) {
+        if (data) {
+            for (var property in data) {
+                if (Object.prototype.hasOwnProperty.call(data, property))
+                    this[property] = data[property];
+            }
+        }
+    }
+    MetricValue.prototype.init = function (_data) {
+        if (_data) {
+            this.time = _data['Time'];
+            this.value = _data['Value'];
+        }
+    };
+    MetricValue.fromJS = function (data) {
+        data = typeof data === 'object' ? data : {};
+        var result = new MetricValue();
+        result.init(data);
+        return result;
+    };
+    MetricValue.prototype.toJSON = function (data) {
+        data = typeof data === 'object' ? data : {};
+        data['Time'] = this.time;
+        data['Value'] = this.value;
+        return data;
+    };
+    return MetricValue;
+}());
+exports.MetricValue = MetricValue;
 var SessionEvent = /** @class */ (function () {
     function SessionEvent(data) {
         if (data) {

package/dist/cjs/SessionClient.js

@@ -29,6 +29,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SessionClient = void 0;
 var DTOs_1 = require("./DTOs");
 var nats_ws_1 = require("nats.ws");
+var encoders_1 = require("./encoders");
 var BaseClient_1 = require("./BaseClient");
 var SessionClient = /** @class */ (function (_super) {
     __extends(SessionClient, _super);
@@ -49,8 +50,8 @@ var SessionClient = /** @class */ (function (_super) {
                     return;
                 }
                 try {
-                    var jsonCodec = (0, nats_ws_1.JSONCodec)();
-                    var logListJson = jsonCodec.decode(encodedMessage === null || encodedMessage === void 0 ? void 0 : encodedMessage.data);
+                    var jsonCodec_1 = (0, nats_ws_1.JSONCodec)();
+                    var logListJson = jsonCodec_1.decode(encodedMessage === null || encodedMessage === void 0 ? void 0 : encodedMessage.data);
                     var logList = DTOs_1.LogList.fromJS(logListJson);
                     sessionLogsHandler(logList, error);
                 }
@@ -71,8 +72,8 @@ var SessionClient = /** @class */ (function (_super) {
                 return;
             }
             try {
-                var jsonCodec = (0, nats_ws_1.JSONCodec)();
-                var sessionEventJs = jsonCodec.decode(encodedMessage === null || encodedMessage === void 0 ? void 0 : encodedMessage.data);
+                var jsonCodec_2 = (0, nats_ws_1.JSONCodec)();
+                var sessionEventJs = jsonCodec_2.decode(encodedMessage === null || encodedMessage === void 0 ? void 0 : encodedMessage.data);
                 var sessionEvent = DTOs_1.SessionEvent.fromJS(sessionEventJs);
                 eventHandler(sessionEvent, error);
             }
@@ -97,8 +98,8 @@ var SessionClient = /** @class */ (function (_super) {
                         return;
                     }
                     try {
-                        var jsonCodec = (0, nats_ws_1.JSONCodec)();
-                        var resultJs = jsonCodec.decode(encodedMessage === null || encodedMessage === void 0 ? void 0 : encodedMessage.data);
+                        var jsonCodec_3 = (0, nats_ws_1.JSONCodec)();
+                        var resultJs = jsonCodec_3.decode(encodedMessage === null || encodedMessage === void 0 ? void 0 : encodedMessage.data);
                         var result = DTOs_1.Result.fromJS(resultJs);
                         resultHandler(result, error);
                     }
@@ -112,8 +113,8 @@ var SessionClient = /** @class */ (function (_super) {
                         return;
                     }
                     try {
-                        var jsonCodec = (0, nats_ws_1.JSONCodec)();
-                        var testRunJs = jsonCodec.decode(encodedMessage === null || encodedMessage === void 0 ? void 0 : encodedMessage.data);
+                        var jsonCodec_4 = (0, nats_ws_1.JSONCodec)();
+                        var testRunJs = jsonCodec_4.decode(encodedMessage === null || encodedMessage === void 0 ? void 0 : encodedMessage.data);
                         var testRun = DTOs_1.TestRun.fromJS(testRunJs);
                         testRunHandler(testRun, error);
                     }
@@ -135,8 +136,8 @@ var SessionClient = /** @class */ (function (_super) {
                     return;
                 }
                 try {
-                    var jsonCodec = (0, nats_ws_1.JSONCodec)();
-                    var testRunJs = jsonCodec.decode(encodedMessage === null || encodedMessage === void 0 ? void 0 : encodedMessage.data);
+                    var jsonCodec_5 = (0, nats_ws_1.JSONCodec)();
+                    var testRunJs = jsonCodec_5.decode(encodedMessage === null || encodedMessage === void 0 ? void 0 : encodedMessage.data);
                     var testRun = DTOs_1.TestRun.fromJS(testRunJs);
                     testRunHandler(testRun, error);
                 }
@@ -159,8 +160,8 @@ var SessionClient = /** @class */ (function (_super) {
                     return;
                 }
                 try {
-                    var jsonCodec = (0, nats_ws_1.JSONCodec)();
-                    var onTestPlanRunJs = jsonCodec.decode(encodedMessage === null || encodedMessage === void 0 ? void 0 : encodedMessage.data);
+                    var jsonCodec_6 = (0, nats_ws_1.JSONCodec)();
+                    var onTestPlanRunJs = jsonCodec_6.decode(encodedMessage === null || encodedMessage === void 0 ? void 0 : encodedMessage.data);
                     var onTestPlanRun = DTOs_1.OnTestPlanRun.fromJS(onTestPlanRunJs);
                     handler(onTestPlanRun, error);
                 }
@@ -183,8 +184,8 @@ var SessionClient = /** @class */ (function (_super) {
                     return;
                 }
                 try {
-                    var jsonCodec = (0, nats_ws_1.JSONCodec)();
-                    var logListJson = jsonCodec.decode(encodedMessage === null || encodedMessage === void 0 ? void 0 : encodedMessage.data);
+                    var jsonCodec_7 = (0, nats_ws_1.JSONCodec)();
+                    var logListJson = jsonCodec_7.decode(encodedMessage === null || encodedMessage === void 0 ? void 0 : encodedMessage.data);
                     var logList = DTOs_1.LogList.fromJS(logListJson);
                     handler(logList, error);
                 }
@@ -207,8 +208,8 @@ var SessionClient = /** @class */ (function (_super) {
                     return;
                 }
                 try {
-                    var jsonCodec = (0, nats_ws_1.JSONCodec)();
-                    var parameterListJs = jsonCodec.decode(encodedMessage === null || encodedMessage === void 0 ? void 0 : encodedMessage.data);
+                    var jsonCodec_8 = (0, nats_ws_1.JSONCodec)();
+                    var parameterListJs = jsonCodec_8.decode(encodedMessage === null || encodedMessage === void 0 ? void 0 : encodedMessage.data);
                     var parameterList = parameterListJs.map(function (parameterJs) { return DTOs_1.Parameter.fromJS(parameterJs); });
                     handler(parameterList, error);
                 }
@@ -233,8 +234,8 @@ var SessionClient = /** @class */ (function (_super) {
                     return;
                 }
                 try {
-                    var jsonCodec = (0, nats_ws_1.JSONCodec)();
-                    var onTestStepRunJs = jsonCodec.decode(encodedMessage === null || encodedMessage === void 0 ? void 0 : encodedMessage.data);
+                    var jsonCodec_9 = (0, nats_ws_1.JSONCodec)();
+                    var onTestStepRunJs = jsonCodec_9.decode(encodedMessage === null || encodedMessage === void 0 ? void 0 : encodedMessage.data);
                     var onTestStepRun = DTOs_1.OnTestStepRun.fromJS(onTestStepRunJs);
                     var stepRunId = (_a = encodedMessage.subject.match(/\.StepRun\.(.+)$/)) === null || _a === void 0 ? void 0 : _a[1];
                     handler(stepRunId, onTestStepRun, error);
@@ -259,8 +260,8 @@ var SessionClient = /** @class */ (function (_super) {
                     return;
                 }
                 try {
-                    var jsonCodec = (0, nats_ws_1.JSONCodec)();
-                    var parameterListJs = jsonCodec.decode(encodedMessage === null || encodedMessage === void 0 ? void 0 : encodedMessage.data);
+                    var jsonCodec_10 = (0, nats_ws_1.JSONCodec)();
+                    var parameterListJs = jsonCodec_10.decode(encodedMessage === null || encodedMessage === void 0 ? void 0 : encodedMessage.data);
                     var parameterList = parameterListJs.map(function (parameterJs) { return DTOs_1.Parameter.fromJS(parameterJs); });
                     handler(parameterList, error);
                 }
@@ -285,8 +286,8 @@ var SessionClient = /** @class */ (function (_super) {
                     return;
                 }
                 try {
-                    var jsonCodec = (0, nats_ws_1.JSONCodec)();
-                    var resultJs = jsonCodec.decode(encodedMessage === null || encodedMessage === void 0 ? void 0 : encodedMessage.data);
+                    var jsonCodec_11 = (0, nats_ws_1.JSONCodec)();
+                    var resultJs = jsonCodec_11.decode(encodedMessage === null || encodedMessage === void 0 ? void 0 : encodedMessage.data);
                     var result = DTOs_1.Result.fromJS(resultJs);
                     handler(result, error);
                 }
@@ -295,6 +296,45 @@ var SessionClient = /** @class */ (function (_super) {
                 }
             } }));
     };
+    /**
+     * Connect to metrics published for the given SessionMetricInfo
+     * @param  {ISessionMetricInfo} metricInfo
+     * @param  {(result:MetricValue|undefined,err:NatsError|Error|null)=>void} handler
+     * @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);
+                }
+            } }));
+    };
     /**
      * Unsubscibe from session events
      */
@@ -769,6 +809,24 @@ var SessionClient = /** @class */ (function (_super) {
     SessionClient.prototype.getSettingsTypes = function () {
         return this.request('GetSettingsTypes').then(this.success()).catch(this.error());
     };
+    /**
+     * Get the metric information
+     * @returns Promise
+     */
+    SessionClient.prototype.getMetrics = function () {
+        return this.request('GetMetrics')
+            .then(function (metricsRequestJs) { return DTOs_1.MetricsRequest.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
+     * @returns Promise
+     */
+    SessionClient.prototype.setMetrics = function (metricsRequest) {
+        return this.request('SetMetrics', metricsRequest).then(this.success()).catch(this.error());
+    };
     return SessionClient;
 }(BaseClient_1.BaseClient));
 exports.SessionClient = SessionClient;

package/dist/cjs/encoders.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BooleanCodec = exports.NumberCodec = exports.jsonCodec = exports.stringCodec = exports.booleanCodec = exports.numberCodec = void 0;
+var nats_ws_1 = require("nats.ws");
+exports.numberCodec = NumberCodec();
+exports.booleanCodec = BooleanCodec();
+exports.stringCodec = (0, nats_ws_1.StringCodec)();
+exports.jsonCodec = (0, nats_ws_1.JSONCodec)();
+function NumberCodec() {
+    return {
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        encode: function (d) {
+            throw new Error('not implemented');
+        },
+        decode: function (a) {
+            var dataView = new DataView(a.buffer);
+            return dataView.getFloat64(a.byteOffset, true); // BitConverter.ToDouble in C# is little-endian
+        },
+    };
+}
+exports.NumberCodec = NumberCodec;
+function BooleanCodec() {
+    return {
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        encode: function (d) {
+            throw new Error('not implemented');
+        },
+        decode: function (a) {
+            return a[0] === 1;
+        },
+    };
+}
+exports.BooleanCodec = BooleanCodec;

package/dist/mjs/DTOs.d.ts

@@ -1067,6 +1067,78 @@ export interface IResultColumn {
     data?: any[] | undefined;
     typeCode?: string | undefined;
 }
+export declare enum SessionMetricKind {
+    Poll = "Poll",
+    Push = "Push",
+    PushPoll = "PushPoll"
+}
+export declare enum SessionMetricType {
+    Unknown = "Unknown",
+    Double = "Double",
+    Boolean = "Boolean",
+    String = "String"
+}
+export declare enum MetricsPollRate {
+    OneSecond = 1,
+    TwoSeconds = 2,
+    FiveSeconds = 5,
+    TenSeconds = 10,
+    FifteenSeconds = 15,
+    OneMinute = 60,
+    TwoMinutes = 120,
+    FiveMinutes = 300,
+    TenMinutes = 600,
+    FifteenMinutes = 900,
+    OneHour = 3600
+}
+export declare class SessionMetricInfo implements ISessionMetricInfo {
+    publish: boolean;
+    kind: SessionMetricKind;
+    type: SessionMetricType;
+    attributes: object[];
+    groupName: string;
+    name: string;
+    metricFullName: string;
+    subjectPostfix: string;
+    constructor(data?: ISessionMetricInfo);
+    init(_data?: any): void;
+    static fromJS(data: any): SessionMetricInfo;
+    toJSON(data?: any): any;
+}
+export interface ISessionMetricInfo {
+    publish: boolean;
+    kind: SessionMetricKind;
+    type: SessionMetricType;
+    attributes: object[];
+    groupName: string;
+    name: string;
+    metricFullName: string;
+    subjectPostfix: string;
+}
+export declare class MetricsRequest implements IMetricsRequest {
+    publishRate: MetricsPollRate;
+    metrics: SessionMetricInfo[];
+    constructor(data?: IMetricsRequest);
+    init(_data?: any): void;
+    static fromJS(data: any): MetricsRequest;
+    toJSON(data?: any): any;
+}
+export interface IMetricsRequest {
+    publishRate: MetricsPollRate;
+    metrics: ISessionMetricInfo[];
+}
+export declare class MetricValue implements IMetricValue {
+    time: number;
+    value: boolean | number | string | object;
+    constructor(data?: IMetricValue);
+    init(_data?: any): void;
+    static fromJS(data: any): MetricValue;
+    toJSON(data?: any): any;
+}
+export interface IMetricValue {
+    time: number;
+    value: boolean | number | string | object;
+}
 export declare class SessionEvent implements ISessionEvent {
     eventType?: SessionEventType;
     sessionId?: string;

package/dist/mjs/DTOs.js

@@ -2672,6 +2672,138 @@ export class ResultColumn {
         return data;
     }
 }
+export var SessionMetricKind;
+(function (SessionMetricKind) {
+    SessionMetricKind["Poll"] = "Poll";
+    SessionMetricKind["Push"] = "Push";
+    SessionMetricKind["PushPoll"] = "PushPoll";
+})(SessionMetricKind || (SessionMetricKind = {}));
+export var SessionMetricType;
+(function (SessionMetricType) {
+    SessionMetricType["Unknown"] = "Unknown";
+    SessionMetricType["Double"] = "Double";
+    SessionMetricType["Boolean"] = "Boolean";
+    SessionMetricType["String"] = "String";
+})(SessionMetricType || (SessionMetricType = {}));
+export var MetricsPollRate;
+(function (MetricsPollRate) {
+    MetricsPollRate[MetricsPollRate["OneSecond"] = 1] = "OneSecond";
+    MetricsPollRate[MetricsPollRate["TwoSeconds"] = 2] = "TwoSeconds";
+    MetricsPollRate[MetricsPollRate["FiveSeconds"] = 5] = "FiveSeconds";
+    MetricsPollRate[MetricsPollRate["TenSeconds"] = 10] = "TenSeconds";
+    MetricsPollRate[MetricsPollRate["FifteenSeconds"] = 15] = "FifteenSeconds";
+    MetricsPollRate[MetricsPollRate["OneMinute"] = 60] = "OneMinute";
+    MetricsPollRate[MetricsPollRate["TwoMinutes"] = 120] = "TwoMinutes";
+    MetricsPollRate[MetricsPollRate["FiveMinutes"] = 300] = "FiveMinutes";
+    MetricsPollRate[MetricsPollRate["TenMinutes"] = 600] = "TenMinutes";
+    MetricsPollRate[MetricsPollRate["FifteenMinutes"] = 900] = "FifteenMinutes";
+    MetricsPollRate[MetricsPollRate["OneHour"] = 3600] = "OneHour";
+})(MetricsPollRate || (MetricsPollRate = {}));
+export class SessionMetricInfo {
+    constructor(data) {
+        this.attributes = [];
+        if (data) {
+            for (const property in data) {
+                if (Object.prototype.hasOwnProperty.call(data, property))
+                    this[property] = data[property];
+            }
+        }
+    }
+    init(_data) {
+        if (_data) {
+            this.publish = _data['Publish'];
+            this.kind = _data['Kind'];
+            this.type = _data['Type'];
+            this.groupName = _data['GroupName'];
+            this.name = _data['Name'];
+            this.metricFullName = _data['MetricFullName'];
+            this.subjectPostfix = _data['SubjectPostfix'];
+            if (Array.isArray(_data['Attributes']))
+                this.attributes = _data['Attributes'];
+        }
+    }
+    static fromJS(data) {
+        data = typeof data === 'object' ? data : {};
+        const result = new SessionMetricInfo();
+        result.init(data);
+        return result;
+    }
+    toJSON(data) {
+        data = typeof data === 'object' ? data : {};
+        data['Publish'] = this.publish;
+        data['Kind'] = this.kind;
+        data['Type'] = this.type;
+        data['GroupName'] = this.groupName;
+        data['Name'] = this.name;
+        data['MetricFullName'] = this.metricFullName;
+        data['SubjectPostfix'] = this.subjectPostfix;
+        data['Attributes'] = [];
+        if (Array.isArray(this.attributes)) {
+            data['Attributes'] = this.attributes;
+        }
+        return data;
+    }
+}
+export class MetricsRequest {
+    constructor(data) {
+        this.metrics = [];
+        if (data) {
+            for (const property in data) {
+                if (Object.prototype.hasOwnProperty.call(data, property))
+                    this[property] = data[property];
+            }
+        }
+    }
+    init(_data) {
+        if (_data) {
+            this.publishRate = _data['PublishRate'];
+            if (Array.isArray(_data['Metrics']))
+                this.metrics = _data['Metrics'].map(item => SessionMetricInfo.fromJS(item));
+        }
+    }
+    static fromJS(data) {
+        data = typeof data === 'object' ? data : {};
+        const result = new MetricsRequest();
+        result.init(data);
+        return result;
+    }
+    toJSON(data) {
+        data = typeof data === 'object' ? data : {};
+        data['PublishRate'] = this.publishRate;
+        if (Array.isArray(this.metrics)) {
+            data['SessionMetricInfo'] = this.metrics.map(item => item.toJSON());
+        }
+        return data;
+    }
+}
+export class MetricValue {
+    constructor(data) {
+        if (data) {
+            for (const property in data) {
+                if (Object.prototype.hasOwnProperty.call(data, property))
+                    this[property] = data[property];
+            }
+        }
+    }
+    init(_data) {
+        if (_data) {
+            this.time = _data['Time'];
+            this.value = _data['Value'];
+        }
+    }
+    static fromJS(data) {
+        data = typeof data === 'object' ? data : {};
+        const result = new MetricValue();
+        result.init(data);
+        return result;
+    }
+    toJSON(data) {
+        data = typeof data === 'object' ? data : {};
+        data['Time'] = this.time;
+        data['Value'] = this.value;
+        return data;
+    }
+}
 export class SessionEvent {
     constructor(data) {
         if (data) {

package/dist/mjs/SessionClient.d.ts

@@ -1,4 +1,4 @@
-import { BreakPoints, CommonContext, CommonSettings, DataGridControl, Image, Interaction, ListItemType, LogList, OnTestPlanRun, OnTestStepRun, Parameter, RepositoryPackageDefinition, RepositoryPackageReference, Resource, Result, RunStatus, SessionEvent, Setting, TestPlan, TestRun, TestStepType, TestStepValidationError, WatchDog } from './DTOs';
+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 { BaseClient } from './BaseClient';
 export declare class SessionClient extends BaseClient {
@@ -81,6 +81,14 @@ export declare class SessionClient extends BaseClient {
      * @returns Subscription
      */
     connectTestStepRunResults(testPlanRunId: string, testStepRunId: string, resultName: string, handler: (result: Result | undefined, err: NatsError | Error | null) => void, options?: SubscriptionOptions): Subscription;
+    /**
+     * Connect to metrics published for the given SessionMetricInfo
+     * @param  {ISessionMetricInfo} metricInfo
+     * @param  {(result:MetricValue|undefined,err:NatsError|Error|null)=>void} handler
+     * @param  {SubscriptionOptions} options?
+     * @returns Subscription
+     */
+    connectMetric(metricInfo: ISessionMetricInfo, handler: (result: IMetricValue | undefined, err: NatsError | Error | null) => void, options?: SubscriptionOptions): Subscription;
     /**
      * Unsubscibe from session events
      */
@@ -345,4 +353,15 @@ export declare class SessionClient extends BaseClient {
      * Retrieve settings types used in creating a Settings TapPackage
      */
     getSettingsTypes(): Promise<string[]>;
+    /**
+     * Get the metric information
+     * @returns Promise
+     */
+    getMetrics(): Promise<MetricsRequest>;
+    /**
+     * Set the metric information. Used for setting up which metrics should be published for polling.
+     * @param  {IMetricsRequest} metricsRequest
+     * @returns Promise
+     */
+    setMetrics(metricsRequest: IMetricsRequest): Promise<void>;
 }

package/dist/mjs/SessionClient.js

@@ -1,5 +1,6 @@
-import { BreakPoints, CommonContext, CommonSettings, DataGridControl, Image, Interaction, ListItemType, LogList, OnTestPlanRun, OnTestStepRun, Parameter, Result, RunStatus, SessionEvent, Setting, TestPlan, TestRun, TestStepType, TestStepValidationError, WatchDog, } from './DTOs';
+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 { booleanCodec, jsonCodec, numberCodec, stringCodec } from './encoders';
 import { BaseClient } from './BaseClient';
 export class SessionClient extends BaseClient {
     constructor(baseSubject, options) {
@@ -264,6 +265,45 @@ export class SessionClient extends BaseClient {
                 }
             } }));
     }
+    /**
+     * Connect to metrics published for the given SessionMetricInfo
+     * @param  {ISessionMetricInfo} metricInfo
+     * @param  {(result:MetricValue|undefined,err:NatsError|Error|null)=>void} handler
+     * @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);
+                }
+            } }));
+    }
     /**
      * Unsubscibe from session events
      */
@@ -736,4 +776,22 @@ export class SessionClient extends BaseClient {
     getSettingsTypes() {
         return this.request('GetSettingsTypes').then(this.success()).catch(this.error());
     }
+    /**
+     * Get the metric information
+     * @returns Promise
+     */
+    getMetrics() {
+        return this.request('GetMetrics')
+            .then(metricsRequestJs => MetricsRequest.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
+     * @returns Promise
+     */
+    setMetrics(metricsRequest) {
+        return this.request('SetMetrics', metricsRequest).then(this.success()).catch(this.error());
+    }
 }

package/dist/mjs/encoders.d.ts

@@ -0,0 +1,7 @@
+import { Codec } from 'nats.ws';
+export declare const numberCodec: Codec<number>;
+export declare const booleanCodec: Codec<boolean>;
+export declare const stringCodec: Codec<string>;
+export declare const jsonCodec: Codec<unknown>;
+export declare function NumberCodec(): Codec<number>;
+export declare function BooleanCodec(): Codec<boolean>;

package/dist/mjs/encoders.js

@@ -0,0 +1,28 @@
+import { JSONCodec, StringCodec } from 'nats.ws';
+export const numberCodec = NumberCodec();
+export const booleanCodec = BooleanCodec();
+export const stringCodec = StringCodec();
+export const jsonCodec = JSONCodec();
+export function NumberCodec() {
+    return {
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        encode(d) {
+            throw new Error('not implemented');
+        },
+        decode(a) {
+            const dataView = new DataView(a.buffer);
+            return dataView.getFloat64(a.byteOffset, true); // BitConverter.ToDouble in C# is little-endian
+        },
+    };
+}
+export function BooleanCodec() {
+    return {
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        encode(d) {
+            throw new Error('not implemented');
+        },
+        decode(a) {
+            return a[0] === 1;
+        },
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opentap/runner-client",
-  "version": "2.21.0",
+  "version": "2.22.0-alpha.1.1.10179797802",
   "description": "This is the web client for the OpenTAP Runner.",
   "main": "./dist/cjs/index.js",
   "module": "./dist/mjs/index.js",
@@ -10,7 +10,7 @@
     "require": "./dist/cjs/index.js"
   },
   "scripts": {
-    "build": "rimraf ./dist && tsc -p tsconfig.cjs.json && tsc -p tsconfig.esm.json && ./post-build.sh",
+    "build": "rimraf ./dist && tsc -p tsconfig.cjs.json && tsc -p tsconfig.esm.json && bash ./post-build.sh",
     "lint": "eslint --ignore-path .eslintignore --ext .js,.ts .",
     "format": "prettier --write \"src/**/*.+(js|ts|json)\"",
     "prepare": "npm run build && husky install",