@opentap/runner-client 2.0.2 → 2.1.0

package/README.md

@@ -44,7 +44,7 @@ class client {
 }
 
 ```
- 
+
 
 ## How to build locally
 

package/lib/BaseClient.d.ts

@@ -26,9 +26,11 @@ export declare class BaseClient {
      * @param subject The subject to request
      * @param payload (optional)
      * @param options (optional)
+     * @param isFullSubject (optional) If true, use the subject as request subject
+     * without appending it to the baseSubject
      * @returns Promise of an object
      */
-    protected request<T>(subject: string, payload?: any, options?: RequestOptions): Promise<T>;
+    protected request<T>(subject: string, payload?: any, options?: RequestOptions, isFullSubject?: boolean): Promise<T>;
     /**
      * Handle the error
      * @param error
@@ -48,6 +50,22 @@ export declare class BaseClient {
      * @returns Subscription object
      */
     protected subscribe(subject: string, options: SubscriptionOptions): Subscription;
+    /**
+     * Send an object to the nats server with chunks.
+     * @param subject The subject to request
+     * @param payload (optional)
+     * @param options (optional)
+     * @returns Promise of an object
+     */
+    protected sendChunked<T>(subject: string, payload?: any, options?: RequestOptions): Promise<T>;
+    /**
+     * Request an object to the nats server with chunks.
+     * @param subject The subject to request
+     * @param payload (optional)
+     * @param options (optional)
+     * @returns Promise of an object
+     */
+    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

@@ -45,7 +45,16 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
-import { ComponentSettingsBase, ComponentSettingsIdentifier, ComponentSettingsListItem, DataGridControl, ErrorResponse, ListItemType, ProfileGroup, } from './DTOs';
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+import { ComponentSettingsBase, ComponentSettingsIdentifier, ComponentSettingsListItem, DataGridControl, ErrorResponse, FileDescriptor, ListItemType, ProfileGroup, } from './DTOs';
 import { Empty, ErrorCode, JSONCodec, StringCodec, connect, headers, } from 'nats.ws';
 var DEFAULT_TIMEOUT = 6000;
 var BaseClient = /** @class */ (function () {
@@ -97,16 +106,18 @@ var BaseClient = /** @class */ (function () {
      * @param subject The subject to request
      * @param payload (optional)
      * @param options (optional)
+     * @param isFullSubject (optional) If true, use the subject as request subject
+     * without appending it to the baseSubject
      * @returns Promise of an object
      */
-    BaseClient.prototype.request = function (subject, payload, options) {
+    BaseClient.prototype.request = function (subject, payload, options, isFullSubject) {
         return __awaiter(this, void 0, void 0, function () {
             var stringCodec, data, headers, opts;
             var _this = this;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        subject = "".concat(this.baseSubject, ".Request.").concat(subject);
+                        subject = isFullSubject ? subject : "".concat(this.baseSubject, ".Request.").concat(subject);
                         if (!this.connection)
                             return [2 /*return*/, Promise.reject("".concat(subject, ": Connection is down! Please try again!"))];
                         if (this.connection.isClosed())
@@ -178,6 +189,135 @@ var BaseClient = /** @class */ (function () {
         var natsSubject = "".concat(this.baseSubject, ".").concat(subject);
         return this.connection.subscribe(natsSubject, options);
     };
+    /**
+     * Send an object to the nats server with chunks.
+     * @param subject The subject to request
+     * @param payload (optional)
+     * @param options (optional)
+     * @returns Promise of an object
+     */
+    BaseClient.prototype.sendChunked = function (subject, payload, options) {
+        return __awaiter(this, void 0, void 0, function () {
+            var stringCodec, data, headers, opts, fileDescriptor, getChunk, dataSubject, i;
+            var _this = this;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (!this.connection)
+                            return [2 /*return*/, Promise.reject("".concat(subject, ": Connection is down! Please try again!"))];
+                        if (this.connection.isClosed())
+                            return [2 /*return*/, Promise.reject("".concat(subject, ": Connection has been closed! Please reconnect!"))];
+                        stringCodec = StringCodec();
+                        data = payload ? stringCodec.encode(JSON.stringify(payload)) : Empty;
+                        headers = this.buildHeaders();
+                        opts = __assign(__assign({}, options), { timeout: this.timeout, headers: headers });
+                        fileDescriptor = new FileDescriptor(data.length);
+                        if (!fileDescriptor.numberOfChunks)
+                            return [2 /*return*/, Promise.reject("".concat(subject, ": File is empty!"))];
+                        getChunk = function (chunk) {
+                            var offset = chunk * fileDescriptor.chunkSize;
+                            return data.slice(offset, offset + fileDescriptor.chunkSize);
+                        };
+                        return [4 /*yield*/, this.request(subject, fileDescriptor, opts)];
+                    case 1:
+                        dataSubject = _a.sent();
+                        for (i = 0; i < fileDescriptor.numberOfChunks; i++) {
+                            this.connection.publish(dataSubject, getChunk(i), opts);
+                        }
+                        return [2 /*return*/, new Promise(function (resolve, reject) {
+                                if (!_this.connection) {
+                                    return Promise.reject('No nats connection.');
+                                }
+                                var combinedResult = new Uint8Array([]);
+                                // Subscribe to dataSubject before sending the terminating message to ensure we are listening before the server starts responding
+                                var subscription = _this.connection.subscribe(dataSubject);
+                                // Publish an empty message to indicate that we are ready to listen
+                                _this.connection.publish(dataSubject, Empty, opts);
+                                var first = true;
+                                subscription.callback = function (error, message) {
+                                    // The first message is the empty message we published above.
+                                    // We should discard this message before we proceed
+                                    if (first === true) {
+                                        first = false;
+                                        return;
+                                    }
+                                    if (error) {
+                                        reject(error);
+                                    }
+                                    combinedResult = new Uint8Array(__spreadArray(__spreadArray([], Array.from(combinedResult), true), Array.from(message === null || message === void 0 ? void 0 : message.data), true));
+                                    if ((message === null || message === void 0 ? void 0 : message.data.length) === 0) {
+                                        resolve(combinedResult);
+                                    }
+                                };
+                            }).then(function (byteArray) {
+                                var jsonCodec = JSONCodec();
+                                var response = jsonCodec.decode(byteArray);
+                                return _this.isErrorResponse(response) ? Promise.reject(ErrorResponse.fromJS(response)) : Promise.resolve(response);
+                            })];
+                }
+            });
+        });
+    };
+    /**
+     * Request an object to the nats server with chunks.
+     * @param subject The subject to request
+     * @param payload (optional)
+     * @param options (optional)
+     * @returns Promise of an object
+     */
+    BaseClient.prototype.requestChunked = function (subject, replySubject, payload, options, isFullSubject, rawResponse) {
+        return __awaiter(this, void 0, void 0, function () {
+            var fileSize;
+            var _this = this;
+            return __generator(this, function (_a) {
+                if (!this.connection)
+                    return [2 /*return*/, Promise.reject("".concat(subject, ": Connection is down! Please try again!"))];
+                if (this.connection.isClosed())
+                    return [2 /*return*/, Promise.reject("".concat(subject, ": Connection has been closed! Please reconnect!"))];
+                fileSize = -1;
+                return [2 /*return*/, new Promise(function (resolve, reject) {
+                        var combinedResult = new Uint8Array([]);
+                        // Subscribe to the subject before starting the process
+                        var subscription = _this.connection.subscribe(replySubject);
+                        var resolveIfCompleted = function () {
+                            if (combinedResult.length === fileSize) {
+                                subscription.unsubscribe();
+                                resolve(combinedResult);
+                            }
+                        };
+                        subscription.callback = function (error, message) {
+                            if (error) {
+                                reject(error);
+                            }
+                            combinedResult = new Uint8Array(__spreadArray(__spreadArray([], Array.from(combinedResult), true), Array.from(message === null || message === void 0 ? void 0 : message.data), true));
+                            resolveIfCompleted();
+                        };
+                        var headers = _this.buildHeaders();
+                        var opts = __assign(__assign({}, options), { timeout: _this.timeout, headers: headers });
+                        // Request the file descriptor from the runner by posting the reply subject
+                        return _this.request(subject, payload, opts, isFullSubject)
+                            .then(function (fileDescriptor) { return FileDescriptor.fromJS(fileDescriptor); })
+                            .then(function (fileDescriptor) {
+                            fileSize = fileDescriptor.fileSize;
+                            resolveIfCompleted();
+                        })
+                            .catch(function (error) {
+                            subscription.unsubscribe();
+                            throw error;
+                        });
+                    }).then(function (byteArray) {
+                        if (byteArray.length !== fileSize)
+                            return Promise.reject("Unexpected response size. Expected ".concat(fileSize, " bytes, but got ").concat(byteArray.length, "."));
+                        // Avoid decoding the response if the expected response is bytearray
+                        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);
+                    })];
+            });
+        });
+    };
     /**
      * Check if the the response is an error from the server.
      * @param {any} response

package/lib/DTOs.d.ts

@@ -418,6 +418,53 @@ 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;
+}
+export interface ITestPlanRequest {
+    properties?: string[] | null | undefined;
+    subject?: string | undefined;
+}
+export declare class FileDescriptor implements IFileDescriptor {
+    numberOfChunks: number;
+    fileSize: number;
+    chunkSize: number;
+    private readonly defaultChunkSize;
+    constructor(fileSize: number, chunkSize?: number);
+    init(_data?: any): void;
+    static fromJS(data: any): FileDescriptor;
+    toJSON(data?: any): any;
+}
+export interface IFileDescriptor {
+    numberOfChunks: number;
+    fileSize: number;
+    chunkSize: number;
+}
 export declare class ComponentSettings extends ComponentSettingsBase implements IComponentSettings {
     settings?: Setting[] | undefined;
     constructor(data?: IComponentSettings);
@@ -756,7 +803,6 @@ export declare class TestStep implements ITestStep {
     typeName?: string | undefined;
     typeDisplay?: DisplayAttribute | undefined;
     name?: string | undefined;
-    expandedName?: string | undefined;
     protected _discriminator: string;
     constructor(data?: ITestStep);
     init(_data?: any): void;
@@ -772,7 +818,6 @@ export interface ITestStep {
     typeName?: string | undefined;
     typeDisplay?: DisplayAttribute | undefined;
     name?: string | undefined;
-    expandedName?: string | undefined;
 }
 export declare class TestStepType extends TestStep implements ITestStepType {
     availableChildrenTypes?: 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,106 @@ 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() {
+    }
+    return TestPlanRequest;
+}());
+export { TestPlanRequest };
+var FileDescriptor = /** @class */ (function () {
+    function FileDescriptor(fileSize, chunkSize) {
+        var _a;
+        this.defaultChunkSize = 512000;
+        if (chunkSize === 0) {
+            throw Error('chunkSize cannot set to 0');
+        }
+        this.fileSize = fileSize;
+        this.chunkSize = chunkSize !== null && chunkSize !== void 0 ? chunkSize : this.defaultChunkSize;
+        this.numberOfChunks = Math.floor((((_a = this.fileSize) !== null && _a !== void 0 ? _a : 0) + this.chunkSize - 1) / this.chunkSize);
+    }
+    FileDescriptor.prototype.init = function (_data) {
+        if (_data) {
+            this.numberOfChunks = _data['NumberOfChunks'];
+            this.fileSize = _data['FileSize'];
+            this.chunkSize = _data['ChunkSize'];
+        }
+    };
+    FileDescriptor.fromJS = function (data) {
+        data = typeof data === 'object' ? data : {};
+        var result = new FileDescriptor(0);
+        result.init(data);
+        return result;
+    };
+    FileDescriptor.prototype.toJSON = function (data) {
+        data = typeof data === 'object' ? data : {};
+        data['NumberOfChunks'] = this.numberOfChunks;
+        data['FileSize'] = this.fileSize;
+        data['ChunkSize'] = this.chunkSize;
+        return data;
+    };
+    return FileDescriptor;
+}());
+export { FileDescriptor };
 var ComponentSettings = /** @class */ (function (_super) {
     __extends(ComponentSettings, _super);
     function ComponentSettings(data) {
@@ -1532,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;
@@ -1777,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;
@@ -2195,15 +2300,14 @@ var TestStep = /** @class */ (function () {
             this.typeName = _data['TypeName'];
             this.typeDisplay = _data['TypeDisplay'] ? DisplayAttribute.fromJS(_data['TypeDisplay']) : undefined;
             this.name = _data['Name'];
-            this.expandedName = _data['ExpandedName'];
         }
     };
     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);
@@ -2232,7 +2336,6 @@ var TestStep = /** @class */ (function () {
         data['TypeName'] = this.typeName;
         data['TypeDisplay'] = this.typeDisplay ? this.typeDisplay.toJSON() : undefined;
         data['Name'] = this.name;
-        data['ExpandedName'] = this.expandedName;
         return data;
     };
     return TestStep;
@@ -2863,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>;
+    /**
+     * Downloads the resource from the runner and returns it as raw bytes
+     * @return Raw bytes representing the resource
+     */
+    downloadResource(resource: Resource): Promise<Uint8Array>;
     /**
      * Load test plan using a test plan TapPackage from a repository
      * @param {RepositoryPackageDefinition} packageReference

package/lib/SessionClient.js

@@ -27,6 +27,7 @@ var __assign = (this && this.__assign) || function () {
 import { BreakPoints, CommonContext, CommonSettings, DataGridControl, Image, Interaction, ListItemType, LogList, Result, RunStatus, SessionEvent, Setting, TestPlan, TestRun, TestStepType, TestStepValidationError, WatchDog, } from './DTOs';
 import { JSONCodec } from 'nats.ws';
 import { BaseClient } from './BaseClient';
+import { v4 as uuidv4 } from 'uuid';
 var SessionClient = /** @class */ (function (_super) {
     __extends(SessionClient, _super);
     function SessionClient(baseSubject, options) {
@@ -197,14 +198,32 @@ var SessionClient = /** @class */ (function (_super) {
      * @return Test plan loaded. List of load errors is returned.
      */
     SessionClient.prototype.setTestPlanXML = function (xml) {
-        return this.request('SetTestPlanXML', xml).then(this.success()).catch(this.error());
+        return this.sendChunked('SetTestPlanXML', xml).then(this.success()).catch(this.error());
     };
     /**
      * Retrieve loaded test plan XML
      * @return Test plan retrieved
      */
     SessionClient.prototype.getTestPlanXML = function () {
-        return this.request('GetTestPlanXML').then(this.success()).catch(this.error());
+        // Generate a unique subject where the Runner will publish the chunks
+        var replySubject = "_INBOX.".concat(uuidv4());
+        return this.requestChunked('GetTestPlanXML', replySubject, replySubject).then(this.success()).catch(this.error());
+    };
+    /**
+     * Downloads the resource from the runner and returns it as raw bytes
+     * @return Raw bytes representing the 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
@@ -227,7 +246,8 @@ var SessionClient = /** @class */ (function (_super) {
      * @return Test plan resources opened.
      */
     SessionClient.prototype.resourcesOpen = function () {
-        return this.request('ResourcesOpen')
+        var replySubject = "_INBOX.".concat(uuidv4());
+        return this.requestChunked('ResourcesOpen', replySubject, replySubject)
             .then(function (testPlanJs) { return TestPlan.fromJS(testPlanJs); })
             .then(this.success())
             .catch(this.error());
@@ -237,7 +257,8 @@ var SessionClient = /** @class */ (function (_super) {
      * @return Test plan resources closed.
      */
     SessionClient.prototype.resourcesClose = function () {
-        return this.request('ResourcesClose')
+        var replySubject = "_INBOX.".concat(uuidv4());
+        return this.requestChunked('ResourcesClose', replySubject, replySubject)
             .then(function (testPlanJs) { return TestPlan.fromJS(testPlanJs); })
             .then(this.success())
             .catch(this.error());
@@ -272,7 +293,12 @@ var SessionClient = /** @class */ (function (_super) {
      * @return Test plan retrieved
      */
     SessionClient.prototype.getTestPlan = function (properties) {
-        return this.request('GetTestPlan', properties)
+        var replySubject = "_INBOX.".concat(uuidv4());
+        var payload = {
+            subject: replySubject,
+            properties: properties,
+        };
+        return this.requestChunked('GetTestPlan', replySubject, payload)
             .then(function (testPlanJs) { return TestPlan.fromJS(testPlanJs); })
             .then(this.success())
             .catch(this.error());
@@ -283,7 +309,7 @@ var SessionClient = /** @class */ (function (_super) {
      * @return Test plan changed
      */
     SessionClient.prototype.setTestPlan = function (plan) {
-        return this.request('SetTestPlan', plan)
+        return this.sendChunked('SetTestPlan', plan)
             .then(function (testPlanJs) { return TestPlan.fromJS(testPlanJs); })
             .then(this.success())
             .catch(this.error());

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opentap/runner-client",
-  "version": "2.0.2",
+  "version": "2.1.0",
   "description": "This is the web client for the OpenTAP Runner.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -26,6 +26,7 @@
     "url": "git://github.com/opentap/runner-client-web.git"
   },
   "devDependencies": {
+    "@types/uuid": "^8.3.4",
     "@typescript-eslint/eslint-plugin": "^5.36.1",
     "@typescript-eslint/parser": "^5.36.1",
     "eslint": "^8.23.0",
@@ -38,7 +39,8 @@
     "typescript": "^4.8.2"
   },
   "dependencies": {
-    "nats.ws": "^1.9.0"
+    "nats.ws": "^1.9.0",
+    "uuid": "^9.0.0"
   },
   "lint-staged": {
     "*.{ts,js,html}": [