@opentap/runner-client 2.0.0-alpha.1.1 → 2.0.0-alpha.2.1

package/lib/BaseClient.d.ts

@@ -65,7 +65,7 @@ export declare class BaseClient {
      * @param options (optional)
      * @returns Promise of an object
      */
-    protected requestChunked<T>(subject: string, replySubject: string, payload: any, options?: RequestOptions, isFullSubject?: boolean): Promise<T>;
+    protected requestChunked<T>(subject: string, replySubject: string, payload: any, options?: RequestOptions, isFullSubject?: boolean, rawResponse?: boolean): Promise<T>;
     /**
      * Check if the the response is an error from the server.
      * @param {any} response

package/lib/BaseClient.js

@@ -265,7 +265,7 @@ var BaseClient = /** @class */ (function () {
      * @param options (optional)
      * @returns Promise of an object
      */
-    BaseClient.prototype.requestChunked = function (subject, replySubject, payload, options, isFullSubject) {
+    BaseClient.prototype.requestChunked = function (subject, replySubject, payload, options, isFullSubject, rawResponse) {
         return __awaiter(this, void 0, void 0, function () {
             var fileSize;
             var _this = this;
@@ -308,6 +308,8 @@ var BaseClient = /** @class */ (function () {
                     }).then(function (byteArray) {
                         if (byteArray.length !== fileSize)
                             return Promise.reject("Unexpected response size. Expected ".concat(fileSize, " bytes, but got ").concat(byteArray.length, "."));
+                        if (rawResponse)
+                            return Promise.resolve(byteArray);
                         var jsonCodec = JSONCodec();
                         var response = jsonCodec.decode(byteArray);
                         return _this.isErrorResponse(response) ? Promise.reject(ErrorResponse.fromJS(response)) : Promise.resolve(response);

package/lib/DTOs.d.ts

@@ -418,6 +418,30 @@ export declare class PasswordControl extends Setting implements IPasswordControl
 export interface IPasswordControl extends ISetting {
     password?: string | undefined;
 }
+export declare class PictureControl extends Setting implements IPictureControl {
+    description?: string | undefined;
+    mimeType?: string | undefined;
+    resource?: Resource | undefined;
+    constructor(data?: IPictureControl);
+    init(_data?: any): void;
+    static fromJS(data: any): PictureControl;
+    toJSON(data?: any): any;
+}
+export interface IPictureControl extends ISetting {
+    description?: string | undefined;
+    mimeType?: string | undefined;
+    resource?: Resource | undefined;
+}
+export declare class Resource implements IResource {
+    source?: string | undefined;
+    constructor(data?: IResource);
+    init(_data?: any): void;
+    static fromJS(data: any): Resource;
+    toJSON(data?: any): any;
+}
+export interface IResource {
+    source?: string | undefined;
+}
 export declare class TestPlanRequest implements ITestPlanRequest {
     properties?: string[] | null | undefined;
     subject?: string | undefined;

package/lib/DTOs.js

@@ -506,6 +506,11 @@ var Setting = /** @class */ (function (_super) {
             result_12.init(data);
             return result_12;
         }
+        if (data['ControlType'] === 'PictureControl') {
+            var result_13 = new PictureControl();
+            result_13.init(data);
+            return result_13;
+        }
         var result = new Setting();
         result.init(data);
         return result;
@@ -997,9 +1002,9 @@ var TextBoxControl = /** @class */ (function (_super) {
     TextBoxControl.fromJS = function (data) {
         data = typeof data === 'object' ? data : {};
         if (data['ControlType'] === 'ComboBoxControl') {
-            var result_13 = new ComboBoxControl();
-            result_13.init(data);
-            return result_13;
+            var result_14 = new ComboBoxControl();
+            result_14.init(data);
+            return result_14;
         }
         var result = new TextBoxControl();
         result.init(data);
@@ -1238,6 +1243,66 @@ var PasswordControl = /** @class */ (function (_super) {
     return PasswordControl;
 }(Setting));
 export { PasswordControl };
+var PictureControl = /** @class */ (function (_super) {
+    __extends(PictureControl, _super);
+    function PictureControl(data) {
+        var _this = _super.call(this, data) || this;
+        _this._discriminator = 'PictureControl';
+        return _this;
+    }
+    PictureControl.prototype.init = function (_data) {
+        _super.prototype.init.call(this, _data);
+        if (_data) {
+            this.description = _data['Description'];
+            this.mimeType = _data['MimeType'];
+            this.resource = _data['Resource'] ? Resource.fromJS(_data['Resource']) : undefined;
+        }
+    };
+    PictureControl.fromJS = function (data) {
+        data = typeof data === 'object' ? data : {};
+        var result = new PictureControl();
+        result.init(data);
+        return result;
+    };
+    PictureControl.prototype.toJSON = function (data) {
+        data = typeof data === 'object' ? data : {};
+        data['Description'] = this.description;
+        data['MimeType'] = this.mimeType;
+        data['Resource'] = this.resource ? this.resource.toJSON() : undefined;
+        _super.prototype.toJSON.call(this, data);
+        return data;
+    };
+    return PictureControl;
+}(Setting));
+export { PictureControl };
+var Resource = /** @class */ (function () {
+    function Resource(data) {
+        if (data) {
+            for (var property in data) {
+                if (Object.prototype.hasOwnProperty.call(data, property))
+                    this[property] = data[property];
+            }
+        }
+    }
+    Resource.prototype.init = function (_data) {
+        if (_data) {
+            this.source = _data['Source'];
+        }
+    };
+    Resource.fromJS = function (data) {
+        data = typeof data === 'object' ? data : {};
+        var result = new Resource();
+        result.init(data);
+        return result;
+    };
+    Resource.prototype.toJSON = function (data) {
+        data = typeof data === 'object' ? data : {};
+        data['Source'] = this.source;
+        return data;
+    };
+    return Resource;
+}());
+export { Resource };
 var TestPlanRequest = /** @class */ (function () {
     function TestPlanRequest() {
     }
@@ -1572,40 +1637,40 @@ var SessionEventArgs = /** @class */ (function () {
     SessionEventArgs.fromJS = function (data) {
         data = typeof data === 'object' ? data : {};
         if (data['SessionEventType'] === 'SessionStartInitiated') {
-            var result_14 = new SessionStartInitiated();
-            result_14.init(data);
-            return result_14;
-        }
-        if (data['SessionEventType'] === 'SessionStarted') {
-            var result_15 = new SessionStarted();
+            var result_15 = new SessionStartInitiated();
             result_15.init(data);
             return result_15;
         }
-        if (data['SessionEventType'] === 'SessionStartFailed') {
-            var result_16 = new SessionStartFailed();
+        if (data['SessionEventType'] === 'SessionStarted') {
+            var result_16 = new SessionStarted();
             result_16.init(data);
             return result_16;
         }
-        if (data['SessionEventType'] === 'SessionShutdownInitiated') {
-            var result_17 = new SessionShutdownInitiated();
+        if (data['SessionEventType'] === 'SessionStartFailed') {
+            var result_17 = new SessionStartFailed();
             result_17.init(data);
             return result_17;
         }
-        if (data['SessionEventType'] === 'SessionShutdown') {
-            var result_18 = new SessionShutdown();
+        if (data['SessionEventType'] === 'SessionShutdownInitiated') {
+            var result_18 = new SessionShutdownInitiated();
             result_18.init(data);
             return result_18;
         }
-        if (data['SessionEventType'] === 'SessionShutdownFailed') {
-            var result_19 = new SessionShutdownFailed();
+        if (data['SessionEventType'] === 'SessionShutdown') {
+            var result_19 = new SessionShutdown();
             result_19.init(data);
             return result_19;
         }
-        if (data['SessionEventType'] === 'SessionInactivityLimitHit') {
-            var result_20 = new SessionInactivityLimitHit();
+        if (data['SessionEventType'] === 'SessionShutdownFailed') {
+            var result_20 = new SessionShutdownFailed();
             result_20.init(data);
             return result_20;
         }
+        if (data['SessionEventType'] === 'SessionInactivityLimitHit') {
+            var result_21 = new SessionInactivityLimitHit();
+            result_21.init(data);
+            return result_21;
+        }
         var result = new SessionEventArgs();
         result.init(data);
         return result;
@@ -1817,20 +1882,20 @@ var ImageEventArgs = /** @class */ (function () {
     ImageEventArgs.fromJS = function (data) {
         data = typeof data === 'object' ? data : {};
         if (data['ImageEventType'] === 'ImageCreating') {
-            var result_21 = new ImageCreating();
-            result_21.init(data);
-            return result_21;
-        }
-        if (data['ImageEventType'] === 'ImageCreated') {
-            var result_22 = new ImageCreated();
+            var result_22 = new ImageCreating();
             result_22.init(data);
             return result_22;
         }
-        if (data['ImageEventType'] === 'ImageCreationFailed') {
-            var result_23 = new ImageCreationFailed();
+        if (data['ImageEventType'] === 'ImageCreated') {
+            var result_23 = new ImageCreated();
             result_23.init(data);
             return result_23;
         }
+        if (data['ImageEventType'] === 'ImageCreationFailed') {
+            var result_24 = new ImageCreationFailed();
+            result_24.init(data);
+            return result_24;
+        }
         var result = new ImageEventArgs();
         result.init(data);
         return result;
@@ -2240,9 +2305,9 @@ var TestStep = /** @class */ (function () {
     TestStep.fromJS = function (data) {
         data = typeof data === 'object' ? data : {};
         if (data['TestStepTypeOrInstance'] === 'TestStepType') {
-            var result_24 = new TestStepType();
-            result_24.init(data);
-            return result_24;
+            var result_25 = new TestStepType();
+            result_25.init(data);
+            return result_25;
         }
         var result = new TestStep();
         result.init(data);
@@ -2901,70 +2966,70 @@ var SessionEvent = /** @class */ (function () {
     SessionEvent.fromJS = function (data) {
         data = typeof data === 'object' ? data : {};
         if (data['discriminator'] === 'SessionTimeoutEventArgs') {
-            var result_25 = new SessionTimeoutEventArgs();
-            result_25.init(data);
-            return result_25;
-        }
-        if (data['discriminator'] === 'StartingEventArgs') {
-            var result_26 = new StartingEventArgs();
+            var result_26 = new SessionTimeoutEventArgs();
             result_26.init(data);
             return result_26;
         }
-        if (data['discriminator'] === 'StartedEventArgs') {
-            var result_27 = new StartedEventArgs();
+        if (data['discriminator'] === 'StartingEventArgs') {
+            var result_27 = new StartingEventArgs();
             result_27.init(data);
             return result_27;
         }
-        if (data['discriminator'] === 'StoppingEventArgs') {
-            var result_28 = new StoppingEventArgs();
+        if (data['discriminator'] === 'StartedEventArgs') {
+            var result_28 = new StartedEventArgs();
             result_28.init(data);
             return result_28;
         }
-        if (data['discriminator'] === 'StoppedEventArgs') {
-            var result_29 = new StoppedEventArgs();
+        if (data['discriminator'] === 'StoppingEventArgs') {
+            var result_29 = new StoppingEventArgs();
             result_29.init(data);
             return result_29;
         }
-        if (data['discriminator'] === 'TestPlanChangeEventArgs') {
-            var result_30 = new TestPlanChangeEventArgs();
+        if (data['discriminator'] === 'StoppedEventArgs') {
+            var result_30 = new StoppedEventArgs();
             result_30.init(data);
             return result_30;
         }
-        if (data['discriminator'] === 'TestPlanExecutionStateChangedEventArgs') {
-            var result_31 = new TestPlanExecutionStateChangedEventArgs();
+        if (data['discriminator'] === 'TestPlanChangeEventArgs') {
+            var result_31 = new TestPlanChangeEventArgs();
             result_31.init(data);
             return result_31;
         }
-        if (data['discriminator'] === 'SettingsChangedEventArgs') {
-            var result_32 = new SettingsChangedEventArgs();
+        if (data['discriminator'] === 'TestPlanExecutionStateChangedEventArgs') {
+            var result_32 = new TestPlanExecutionStateChangedEventArgs();
             result_32.init(data);
             return result_32;
         }
-        if (data['discriminator'] === 'TestStepChangeEventArgs') {
-            var result_33 = new TestStepChangeEventArgs();
+        if (data['discriminator'] === 'SettingsChangedEventArgs') {
+            var result_33 = new SettingsChangedEventArgs();
             result_33.init(data);
             return result_33;
         }
-        if (data['discriminator'] === 'BreakEventArgs') {
-            var result_34 = new BreakEventArgs();
+        if (data['discriminator'] === 'TestStepChangeEventArgs') {
+            var result_34 = new TestStepChangeEventArgs();
             result_34.init(data);
             return result_34;
         }
-        if (data['discriminator'] === 'UserInputRequestEventArgs') {
-            var result_35 = new UserInputRequestEventArgs();
+        if (data['discriminator'] === 'BreakEventArgs') {
+            var result_35 = new BreakEventArgs();
             result_35.init(data);
             return result_35;
         }
-        if (data['discriminator'] === 'UserInputRequestCompletedEventArgs') {
-            var result_36 = new UserInputRequestCompletedEventArgs();
+        if (data['discriminator'] === 'UserInputRequestEventArgs') {
+            var result_36 = new UserInputRequestEventArgs();
             result_36.init(data);
             return result_36;
         }
-        if (data['discriminator'] === 'TestPlanSettingsChangedEventArgs') {
-            var result_37 = new TestPlanSettingsChangedEventArgs();
+        if (data['discriminator'] === 'UserInputRequestCompletedEventArgs') {
+            var result_37 = new UserInputRequestCompletedEventArgs();
             result_37.init(data);
             return result_37;
         }
+        if (data['discriminator'] === 'TestPlanSettingsChangedEventArgs') {
+            var result_38 = new TestPlanSettingsChangedEventArgs();
+            result_38.init(data);
+            return result_38;
+        }
         var result = new SessionEvent();
         result.init(data);
         return result;

package/lib/SessionClient.d.ts

@@ -1,4 +1,4 @@
-import { BreakPoints, CommonContext, CommonSettings, DataGridControl, Image, Interaction, ListItemType, LogList, Parameter, RepositoryPackageDefinition, RepositoryPackageReference, Result, RunStatus, SessionEvent, Setting, TestPlan, TestRun, TestStepType, TestStepValidationError, WatchDog } from './DTOs';
+import { BreakPoints, CommonContext, CommonSettings, DataGridControl, Image, Interaction, ListItemType, LogList, Parameter, RepositoryPackageDefinition, RepositoryPackageReference, Result, Resource, 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 {
@@ -86,6 +86,11 @@ export declare class SessionClient extends BaseClient {
      * @return Test plan retrieved
      */
     getTestPlanXML(): Promise<string>;
+    /**
+     * Returns the resource in a base64 encoded string
+     * @return The resource pointed to by `resource`
+     */
+    downloadResource(resource: Resource): Promise<Uint8Array>;
     /**
      * Load test plan using a test plan TapPackage from a repository
      * @param {RepositoryPackageDefinition} packageReference

package/lib/SessionClient.js

@@ -209,6 +209,22 @@ var SessionClient = /** @class */ (function (_super) {
         var replySubject = "_INBOX.".concat(uuidv4());
         return this.requestChunked('GetTestPlanXML', replySubject, replySubject).then(this.success()).catch(this.error());
     };
+    /**
+     * Returns the resource in a base64 encoded string
+     * @return The resource pointed to by `resource`
+     */
+    SessionClient.prototype.downloadResource = function (resource) {
+        var _a;
+        var runnerResourcePrefix = 'subject://';
+        if (!((_a = resource.source) === null || _a === void 0 ? void 0 : _a.startsWith(runnerResourcePrefix))) {
+            return Promise.reject('The source of the provided resource is not a nats subject.');
+        }
+        var replySubject = "_INBOX.".concat(uuidv4());
+        var subject = resource.source.slice(runnerResourcePrefix.length);
+        return this.requestChunked(subject, replySubject, replySubject, undefined, true, true)
+            .then(this.success())
+            .catch(this.error());
+    };
     /**
      * Load test plan using a test plan TapPackage from a repository
      * @param {RepositoryPackageDefinition} packageReference

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opentap/runner-client",
-  "version": "2.0.0-alpha.1.1",
+  "version": "2.0.0-alpha.2.1",
   "description": "This is the web client for the OpenTAP Runner.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",