@opentap/runner-client 2.1.2 → 2.1.3-alpha.1.3

package/lib/BaseClient.d.ts

@@ -1,10 +1,13 @@
+/// <reference types="node" />
 import { ComponentSettingsBase, ComponentSettingsIdentifier, ComponentSettingsListItem, DataGridControl, ErrorResponse, FileParameter, FileResponse, ListItemType, ProfileGroup, RepositoryPackageReference, RepositorySettingsPackageDefinition, SettingsTapPackage } from './DTOs';
 import { ConnectionOptions, RequestOptions, Subscription, SubscriptionOptions } from 'nats.ws';
+import { EventEmitter } from 'events';
 export declare class BaseClient {
     private connection;
     private baseSubject;
     private connectionOptions;
     private domainAccess;
+    private eventEmitter;
     private _accessToken;
     private _headers;
     private _timeout;
@@ -97,6 +100,17 @@ export declare class BaseClient {
      * @returns
      */
     protected success<T>(): ((value: T) => T | PromiseLike<T>) | null | undefined;
+    /**
+     * Add an error-event listener.
+     * @param listener
+     * @returns {EventEmitter}
+     */
+    addErrorEventListener(listener: (...args: any[]) => void): EventEmitter;
+    /**
+     * Remove an error-event listener.
+     * @param listener
+     */
+    removeAllErrorEventListener(): void;
     /**
      * Retrieve component settings overview
      * @returns {{Promise<ComponentSettingsIdentifier[]>}}

package/lib/BaseClient.js

@@ -56,6 +56,7 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
 };
 import { ComponentSettingsBase, ComponentSettingsIdentifier, ComponentSettingsListItem, DataGridControl, ErrorResponse, FileDescriptor, ListItemType, ProfileGroup, } from './DTOs';
 import { Empty, ErrorCode, JSONCodec, StringCodec, connect, headers, } from 'nats.ws';
+import { EventEmitter } from 'events';
 var DEFAULT_TIMEOUT = 6000;
 var BaseClient = /** @class */ (function () {
     function BaseClient(baseSubject, options) {
@@ -64,6 +65,7 @@ var BaseClient = /** @class */ (function () {
         this.baseSubject = baseSubject;
         this.connectionOptions = __assign({}, options) || {};
         this.connectionOptions.timeout = (options === null || options === void 0 ? void 0 : options.timeout) || DEFAULT_TIMEOUT;
+        this.eventEmitter = new EventEmitter();
     }
     Object.defineProperty(BaseClient.prototype, "accessToken", {
         /** Get request access token */
@@ -135,7 +137,11 @@ var BaseClient = /** @class */ (function () {
                                     var jsonCodec = JSONCodec();
                                     response = jsonCodec.decode(message.data);
                                 }
-                                return _this.isErrorResponse(response) ? Promise.reject(ErrorResponse.fromJS(response)) : Promise.resolve(response);
+                                if (_this.isErrorResponse(response)) {
+                                    _this.eventEmitter.emit('errorEvent', response);
+                                    return Promise.reject(ErrorResponse.fromJS(response));
+                                }
+                                return Promise.resolve(response);
                             })
                                 .catch(function (error) { return Promise.reject(_this.natsErrorHandler(error, subject)); })];
                     case 1: return [2 /*return*/, _a.sent()];
@@ -160,6 +166,7 @@ var BaseClient = /** @class */ (function () {
             default:
                 errorResponse.message = error.message;
         }
+        this.eventEmitter.emit('errorEvent', errorResponse);
         return errorResponse;
     };
     /**
@@ -267,16 +274,17 @@ var BaseClient = /** @class */ (function () {
      * @returns Promise of an object
      */
     BaseClient.prototype.requestChunked = function (subject, replySubject, payload, options, isFullSubject, rawResponse) {
+        var _a;
         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 __generator(this, function (_b) {
+                if ((_a = this.connection) === null || _a === void 0 ? void 0 : _a.isClosed())
                     return [2 /*return*/, Promise.reject("".concat(subject, ": Connection has been closed! Please reconnect!"))];
                 fileSize = -1;
                 return [2 /*return*/, new Promise(function (resolve, reject) {
+                        if (!_this.connection)
+                            return Promise.reject("".concat(subject, ": Connection is down! Please try again!"));
                         var combinedResult = new Uint8Array([]);
                         // Subscribe to the subject before starting the process
                         var subscription = _this.connection.subscribe(replySubject);
@@ -375,7 +383,7 @@ var BaseClient = /** @class */ (function () {
                                 _this.connection = null;
                             }).catch(function (error) {
                                 throw new Error("failed to close connection: ".concat(error));
-                            }))];
+                            }).finally(function () { return _this === null || _this === void 0 ? void 0 : _this.removeAllErrorEventListener(); }))];
                     case 1:
                         _b.sent();
                         _b.label = 2;
@@ -410,6 +418,23 @@ var BaseClient = /** @class */ (function () {
     BaseClient.prototype.success = function () {
         return function (response) { return response; };
     };
+    /**
+     * Add an error-event listener.
+     * @param listener
+     * @returns {EventEmitter}
+     */
+    BaseClient.prototype.addErrorEventListener = function (listener) {
+        var _a;
+        return (_a = this.eventEmitter) === null || _a === void 0 ? void 0 : _a.addListener('errorEvent', listener);
+    };
+    /**
+     * Remove an error-event listener.
+     * @param listener
+     */
+    BaseClient.prototype.removeAllErrorEventListener = function () {
+        var _a;
+        (_a = this.eventEmitter) === null || _a === void 0 ? void 0 : _a.removeAllListeners('errorEvent');
+    };
     /**
      * Retrieve component settings overview
      * @returns {{Promise<ComponentSettingsIdentifier[]>}}

package/lib/DTOs.d.ts

@@ -803,6 +803,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;
@@ -818,6 +819,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

@@ -2300,6 +2300,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) {
@@ -2336,6 +2337,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opentap/runner-client",
-  "version": "2.1.2",
+  "version": "2.1.3-alpha.1.3",
   "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/node": "^18.11.9",
     "@types/uuid": "^8.3.4",
     "@typescript-eslint/eslint-plugin": "^5.36.1",
     "@typescript-eslint/parser": "^5.36.1",