@opentap/runner-client 2.20.0-alpha.1.1 → 2.20.0-alpha.1.1.8328242343

package/{lib → dist/cjs}/BaseClient.js

@@ -60,7 +60,7 @@ var Events;
 var BaseClient = /** @class */ (function () {
     function BaseClient(baseSubject, options) {
         this.domainAccess = new Map();
-        this._headers = new Headers();
+        this._headers = {};
         this.baseSubject = baseSubject;
         this.connectionOptions = __assign({}, options) || {};
         this.connectionOptions.timeout = (options === null || options === void 0 ? void 0 : options.timeout) || DEFAULT_TIMEOUT;
@@ -249,11 +249,14 @@ var BaseClient = /** @class */ (function () {
      * @returns {MsgHdrs} Header object
      */
     BaseClient.prototype.buildHeaders = function () {
-        var _a, _b;
+        var _a;
         var _headers = (0, nats_ws_1.headers)();
         this._accessToken && _headers.set('Authorization', this._accessToken);
         (_a = this.domainAccess) === null || _a === void 0 ? void 0 : _a.forEach(function (value, key) { return _headers.append('DomainAuthorization', "".concat(key, "|").concat(value)); });
-        (_b = this._headers) === null || _b === void 0 ? void 0 : _b.forEach(function (value, key) { return _headers.append(key, value); });
+        Object.entries(this._headers).forEach(function (_a) {
+            var key = _a[0], value = _a[1];
+            return _headers.append(key, value);
+        });
         return _headers;
     };
     /**

package/{lib → 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.TestStepRunCompletedEventArgs = exports.TestStepRunStartEventArgs = exports.TestStepRunEvent = 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 = 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;
 var Image = /** @class */ (function () {
     function Image(data) {
         this.packages = [];
@@ -3512,6 +3512,72 @@ var TestPlanSettingsChangedEventArgs = /** @class */ (function (_super) {
     return TestPlanSettingsChangedEventArgs;
 }(SessionEvent));
 exports.TestPlanSettingsChangedEventArgs = TestPlanSettingsChangedEventArgs;
+var OnTestPlanRun = /** @class */ (function () {
+    function OnTestPlanRun(data) {
+        if (data) {
+            for (var property in data) {
+                if (Object.prototype.hasOwnProperty.call(data, property))
+                    this[property] = data[property];
+            }
+        }
+    }
+    OnTestPlanRun.prototype.init = function (_data) {
+        if (_data) {
+            this.status = _data['Status'];
+            this.userId = _data['UserId'];
+        }
+    };
+    OnTestPlanRun.fromJS = function (data) {
+        data = typeof data === 'object' ? data : {};
+        var result = new OnTestPlanRun();
+        result.init(data);
+        return result;
+    };
+    OnTestPlanRun.prototype.toJSON = function (data) {
+        data = typeof data === 'object' ? data : {};
+        data['Status'] = this.status;
+        data['UserId'] = this.userId;
+        return data;
+    };
+    return OnTestPlanRun;
+}());
+exports.OnTestPlanRun = OnTestPlanRun;
+var OnTestStepRun = /** @class */ (function () {
+    function OnTestStepRun(data) {
+        if (data) {
+            for (var property in data) {
+                if (Object.prototype.hasOwnProperty.call(data, property))
+                    this[property] = data[property];
+            }
+        }
+    }
+    OnTestStepRun.prototype.init = function (_data) {
+        if (_data) {
+            this.status = _data['Status'];
+            this.stepId = _data['StepId'];
+            this.parentRunId = _data['ParentRunId'];
+            this.verdict = _data['Verdict'];
+            this.duration = _data['Duration'];
+        }
+    };
+    OnTestStepRun.fromJS = function (data) {
+        data = typeof data === 'object' ? data : {};
+        var result = new OnTestStepRun();
+        result.init(data);
+        return result;
+    };
+    OnTestStepRun.prototype.toJSON = function (data) {
+        data = typeof data === 'object' ? data : {};
+        data['Status'] = this.status;
+        data['StepId'] = this.stepId;
+        data['ParentRunId'] = this.parentRunId;
+        data['Verdict'] = this.verdict;
+        data['Duration'] = this.duration;
+        return data;
+    };
+    return OnTestStepRun;
+}());
+exports.OnTestStepRun = OnTestStepRun;
 var TestStepRunEvent = /** @class */ (function () {
     function TestStepRunEvent(data) {
         if (data) {

package/{lib → dist/cjs}/SessionClient.js

@@ -123,6 +123,178 @@ var SessionClient = /** @class */ (function (_super) {
                 } })),
         ];
     };
+    /**
+     * @param testRunHandler Function to be called when test run or error is received
+     * @param options (optional) Subscription options
+     * @returns Subscription array: Result and Test Run subscriptions
+     */
+    SessionClient.prototype.connectTestRunEvents = function (testRunHandler, options) {
+        return this.subscribe('OnTestRun', __assign(__assign({}, options), { callback: function (error, encodedMessage) {
+                if (error) {
+                    testRunHandler(undefined, error);
+                    return;
+                }
+                try {
+                    var jsonCodec = (0, nats_ws_1.JSONCodec)();
+                    var testRunJs = jsonCodec.decode(encodedMessage === null || encodedMessage === void 0 ? void 0 : encodedMessage.data);
+                    var testRun = DTOs_1.TestRun.fromJS(testRunJs);
+                    testRunHandler(testRun, error);
+                }
+                catch (error) {
+                    testRunHandler(undefined, error);
+                }
+            } }));
+    };
+    /**
+     * Connect to listen to the TestPlanRun events for the given test plan run ID.
+     * @param  {string} testPlanRunId
+     * @param  {(event:OnTestPlanRun|undefined,err:NatsError|Error|null)=>void} handler
+     * @param  {SubscriptionOptions} options?
+     * @returns Subscription
+     */
+    SessionClient.prototype.connectTestPlanRunEvents = function (testPlanRunId, handler, options) {
+        return this.subscribe("PlanRun.".concat(testPlanRunId), __assign(__assign({}, options), { callback: function (error, encodedMessage) {
+                if (error) {
+                    handler(undefined, error);
+                    return;
+                }
+                try {
+                    var jsonCodec = (0, nats_ws_1.JSONCodec)();
+                    var onTestPlanRunJs = jsonCodec.decode(encodedMessage === null || encodedMessage === void 0 ? void 0 : encodedMessage.data);
+                    var onTestPlanRun = DTOs_1.OnTestPlanRun.fromJS(onTestPlanRunJs);
+                    handler(onTestPlanRun, error);
+                }
+                catch (error) {
+                    handler(undefined, error);
+                }
+            } }));
+    };
+    /**
+     * Connect to listen to the test plan run logs for the given test plan run ID
+     * @param  {string} testPlanRunId
+     * @param  {(logList:LogList|undefined,err:NatsError|Error|null)=>void} handler
+     * @param  {SubscriptionOptions} options?
+     * @returns Subscription
+     */
+    SessionClient.prototype.connectTestPlanRunLogs = function (testPlanRunId, handler, options) {
+        return this.subscribe("PlanRun.".concat(testPlanRunId, ".Logs"), __assign(__assign({}, options), { callback: function (error, encodedMessage) {
+                if (error) {
+                    handler(undefined, error);
+                    return;
+                }
+                try {
+                    var jsonCodec = (0, nats_ws_1.JSONCodec)();
+                    var logListJson = jsonCodec.decode(encodedMessage === null || encodedMessage === void 0 ? void 0 : encodedMessage.data);
+                    var logList = DTOs_1.LogList.fromJS(logListJson);
+                    handler(logList, error);
+                }
+                catch (error) {
+                    handler(undefined, error);
+                }
+            } }));
+    };
+    /**
+     * Connect to listen to the test plan run parameter events for the given test plan run ID
+     * @param  {string} testPlanRunId
+     * @param  {(event:Parameter[]|undefined,err:NatsError|Error|null)=>void} handler
+     * @param  {SubscriptionOptions} options?
+     * @returns Subscription
+     */
+    SessionClient.prototype.connectTestPlanRunParameterEvents = function (testPlanRunId, handler, options) {
+        return this.subscribe("PlanRun.".concat(testPlanRunId, ".Parameters"), __assign(__assign({}, options), { callback: function (error, encodedMessage) {
+                if (error) {
+                    handler(undefined, error);
+                    return;
+                }
+                try {
+                    var jsonCodec = (0, nats_ws_1.JSONCodec)();
+                    var parameterListJs = jsonCodec.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);
+                }
+                catch (error) {
+                    handler(undefined, error);
+                }
+            } }));
+    };
+    /**
+     * Connect to listen to the test step run events for the given test step and test plan run ID
+     * @param  {string} testPlanRunId
+     * @param  {string} testStepRunId
+     * @param  {(testRun:OnTestStepRun|undefined,err:NatsError|Error|null)=>void} handler
+     * @param  {SubscriptionOptions} options?
+     * @returns Subscription
+     */
+    SessionClient.prototype.connectTestStepRunEvents = function (testPlanRunId, testStepRunId, handler, options) {
+        return this.subscribe("PlanRun.".concat(testPlanRunId, ".StepRun.").concat(testStepRunId), __assign(__assign({}, options), { callback: function (error, encodedMessage) {
+                var _a;
+                if (error) {
+                    handler(undefined, undefined, error);
+                    return;
+                }
+                try {
+                    var jsonCodec = (0, nats_ws_1.JSONCodec)();
+                    var onTestStepRunJs = jsonCodec.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);
+                }
+                catch (error) {
+                    handler(undefined, undefined, error);
+                }
+            } }));
+    };
+    /**
+     * Connect to listen to the test step run parameters for the given test step and test plan run ID
+     * @param  {string} testPlanRunId
+     * @param  {string} testStepRunId
+     * @param  {(event:Parameter[]|undefined,err:NatsError|Error|null)=>void} handler
+     * @param  {SubscriptionOptions} options?
+     * @returns Subscription
+     */
+    SessionClient.prototype.connectTestStepRunParameterEvents = function (testPlanRunId, testStepRunId, handler, options) {
+        return this.subscribe("PlanRun.".concat(testPlanRunId, ".StepRun.").concat(testStepRunId, ".Parameters"), __assign(__assign({}, options), { callback: function (error, encodedMessage) {
+                if (error) {
+                    handler(undefined, error);
+                    return;
+                }
+                try {
+                    var jsonCodec = (0, nats_ws_1.JSONCodec)();
+                    var parameterListJs = jsonCodec.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);
+                }
+                catch (error) {
+                    handler(undefined, error);
+                }
+            } }));
+    };
+    /**
+     * Connect to listen to the test step run results for the given test step and test plan run ID
+     * @param  {string} testPlanRunId
+     * @param  {string} testStepRunId
+     * @param  {string} resultName
+     * @param  {(result:Result|undefined,err:NatsError|Error|null)=>void} handler
+     * @param  {SubscriptionOptions} options?
+     * @returns Subscription
+     */
+    SessionClient.prototype.connectTestStepRunResults = function (testPlanRunId, testStepRunId, resultName, handler, options) {
+        return this.subscribe("PlanRun.".concat(testPlanRunId, ".StepRun.").concat(testStepRunId, ".Result.").concat(resultName), __assign(__assign({}, options), { callback: function (error, encodedMessage) {
+                if (error) {
+                    handler(undefined, error);
+                    return;
+                }
+                try {
+                    var jsonCodec = (0, nats_ws_1.JSONCodec)();
+                    var resultJs = jsonCodec.decode(encodedMessage === null || encodedMessage === void 0 ? void 0 : encodedMessage.data);
+                    var result = DTOs_1.Result.fromJS(resultJs);
+                    handler(result, error);
+                }
+                catch (error) {
+                    handler(undefined, error);
+                }
+            } }));
+    };
     /**
      * Unsubscibe from session events
      */

package/dist/cjs/package.json

@@ -0,0 +1,3 @@
+{
+    "type": "commonjs"
+}

package/{lib → dist/mjs}/BaseClient.d.ts

@@ -21,9 +21,13 @@ export declare class BaseClient {
     /** Set request access token */
     set accessToken(value: string);
     /** Get request headers */
-    get headers(): Headers;
+    get headers(): {
+        [key: string]: string;
+    };
     /** Set request headers */
-    set headers(value: Headers);
+    set headers(value: {
+        [key: string]: string;
+    });
     /** Get timeout */
     get timeout(): number;
     /** Set timeout in milliseconds. Default is 40000 milliseconds */