@opentap/runner-client 2.0.0-alpha.2.9 → 2.0.1

package/README.md

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

package/lib/BaseClient.d.ts

@@ -48,22 +48,6 @@ export declare class BaseClient {
      * @returns Subscription object
      */
     protected subscribe(subject: string, options: SubscriptionOptions): Subscription;
-    /**
-     * Send a request to the nats server.
-     * @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>;
-    /**
-     * Send a request to the nats server.
-     * @param subject The subject to request
-     * @param payload (optional)
-     * @param options (optional)
-     * @returns Promise of an object
-     */
-    protected requestChunked<T>(subject: string, options?: RequestOptions): Promise<T>;
     /**
      * Check if the the response is an error from the server.
      * @param {any} response

package/lib/BaseClient.js

@@ -45,18 +45,8 @@ 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 };
     }
 };
-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 { ComponentSettingsBase, ComponentSettingsIdentifier, ComponentSettingsListItem, DataGridControl, ErrorResponse, ListItemType, ProfileGroup, } from './DTOs';
 import { Empty, ErrorCode, JSONCodec, StringCodec, connect, headers, } from 'nats.ws';
-import { v4 as uuidv4 } from 'uuid';
 var DEFAULT_TIMEOUT = 6000;
 var BaseClient = /** @class */ (function () {
     function BaseClient(baseSubject, options) {
@@ -188,109 +178,6 @@ var BaseClient = /** @class */ (function () {
         var natsSubject = "".concat(this.baseSubject, ".").concat(subject);
         return this.connection.subscribe(natsSubject, options);
     };
-    /**
-     * Send a request to the nats server.
-     * @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 requestSubject, stringCodec, data, headers, opts, fileDescriptor, getChunk, message, i, response, jsonCodec;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        requestSubject = "".concat(this.baseSubject, ".Request.").concat(subject);
-                        if (!this.connection)
-                            return [2 /*return*/, Promise.reject("".concat(requestSubject, ": Connection is down! Please try again!"))];
-                        if (this.connection.isClosed())
-                            return [2 /*return*/, Promise.reject("".concat(requestSubject, ": 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(requestSubject, ": File is empty!"))];
-                        getChunk = function (chunk) {
-                            var offset = chunk * fileDescriptor.chunkSize;
-                            return data.slice(offset, offset + fileDescriptor.chunkSize);
-                        };
-                        this.request(subject, fileDescriptor);
-                        i = 0;
-                        _a.label = 1;
-                    case 1:
-                        if (!(i < fileDescriptor.numberOfChunks)) return [3 /*break*/, 4];
-                        return [4 /*yield*/, this.connection.request(requestSubject, getChunk(i), opts)];
-                    case 2:
-                        message = _a.sent();
-                        _a.label = 3;
-                    case 3:
-                        i++;
-                        return [3 /*break*/, 1];
-                    case 4:
-                        if (message && message.data.length !== 0) {
-                            jsonCodec = JSONCodec();
-                            response = jsonCodec.decode(message.data);
-                        }
-                        return [2 /*return*/, this.isErrorResponse(response) ? Promise.reject(ErrorResponse.fromJS(response)) : Promise.resolve(response)];
-                }
-            });
-        });
-    };
-    /**
-     * Send a request to the nats server.
-     * @param subject The subject to request
-     * @param payload (optional)
-     * @param options (optional)
-     * @returns Promise of an object
-     */
-    BaseClient.prototype.requestChunked = function (subject, options) {
-        return __awaiter(this, void 0, void 0, function () {
-            var replySubject, requestSubject, stringCodec, data, headers, opts, fileDescriptor;
-            var _this = this;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        replySubject = "_INBOX.".concat(uuidv4());
-                        requestSubject = "".concat(this.baseSubject, ".Request.").concat(subject);
-                        if (!this.connection)
-                            return [2 /*return*/, Promise.reject("".concat(requestSubject, ": Connection is down! Please try again!"))];
-                        if (this.connection.isClosed())
-                            return [2 /*return*/, Promise.reject("".concat(requestSubject, ": Connection has been closed! Please reconnect!"))];
-                        stringCodec = StringCodec();
-                        data = stringCodec.encode(JSON.stringify(replySubject));
-                        headers = this.buildHeaders();
-                        opts = __assign(__assign({}, options), { timeout: this.timeout, headers: headers });
-                        return [4 /*yield*/, this.request(subject, data, opts)];
-                    case 1:
-                        fileDescriptor = _a.sent();
-                        // eslint-disable-next-line @typescript-eslint/no-unused-vars
-                        return [2 /*return*/, new Promise(function (resolve, reject) {
-                                var combinedResult = new Uint8Array([]);
-                                var received = 0;
-                                var subscription = _this.connection.subscribe(replySubject);
-                                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));
-                                    received++;
-                                    message.respond(Empty);
-                                    if (received === fileDescriptor.numberOfChunks) {
-                                        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);
-                            })];
-                }
-            });
-        });
-    };
     /**
      * Check if the the response is an error from the server.
      * @param {any} response

package/lib/DTOs.d.ts

@@ -418,45 +418,6 @@ 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 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): Resource;
-    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);
@@ -795,6 +756,7 @@ 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;
@@ -810,6 +772,7 @@ 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

@@ -1238,100 +1238,6 @@ 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 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 Resource();
-        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) {
@@ -2289,6 +2195,7 @@ 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) {
@@ -2325,6 +2232,7 @@ 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;

package/lib/SessionClient.d.ts

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

package/lib/SessionClient.js

@@ -197,27 +197,14 @@ var SessionClient = /** @class */ (function (_super) {
      * @return Test plan loaded. List of load errors is returned.
      */
     SessionClient.prototype.setTestPlanXML = function (xml) {
-        return this.sendChunked('SetTestPlanXML', xml).then(this.success()).catch(this.error());
+        return this.request('SetTestPlanXML', xml).then(this.success()).catch(this.error());
     };
     /**
      * Retrieve loaded test plan XML
      * @return Test plan retrieved
      */
     SessionClient.prototype.getTestPlanXML = function () {
-        return this.requestChunked('GetTestPlanXML').then(this.success()).catch(this.error());
-    };
-    /**
-     * Retrieve loaded test plan XML
-     * @return Test plan retrieved
-     */
-    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 subject = resource.source.replace(runnerResourcePrefix, '');
-        return this.requestChunked(subject).then(this.success()).catch(this.error());
+        return this.request('GetTestPlanXML').then(this.success()).catch(this.error());
     };
     /**
      * Load test plan using a test plan TapPackage from a repository

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opentap/runner-client",
-  "version": "2.0.0-alpha.2.9",
+  "version": "2.0.1",
   "description": "This is the web client for the OpenTAP Runner.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -26,7 +26,6 @@
     "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",
@@ -39,8 +38,7 @@
     "typescript": "^4.8.2"
   },
   "dependencies": {
-    "nats.ws": "^1.9.0",
-    "uuid": "^9.0.0"
+    "nats.ws": "^1.9.0"
   },
   "lint-staged": {
     "*.{ts,js,html}": [