@opentap/runner-client 1.2.0-beta.3 → 1.2.0-beta.5

package/lib/BaseClient.d.ts

@@ -29,6 +29,13 @@ export declare class BaseClient {
      * @returns Promise of an object
      */
     protected request<T>(subject: string, payload?: any, options?: RequestOptions): Promise<T>;
+    /**
+     * Handle the error
+     * @param error
+     * @param subject
+     * @returns
+     */
+    private natsErrorHandler;
     /**
      * Build the headers' object.
      * @returns {MsgHdrs} Header object

package/lib/BaseClient.js

@@ -45,7 +45,7 @@ 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 { ErrorResponse, } from './DTOs';
+import { ComponentSettingsBase, ComponentSettingsIdentifier, ComponentSettingsListItem, DataGridControl, ErrorResponse, ListItemType, ProfileGroup, } from './DTOs';
 import { Empty, ErrorCode, JSONCodec, StringCodec, connect, headers, } from 'nats.ws/cjs/nats.js';
 var DEFAULT_TIMEOUT = 6000;
 var BaseClient = /** @class */ (function () {
@@ -123,25 +123,33 @@ var BaseClient = /** @class */ (function () {
                                     var jsonCodec = JSONCodec();
                                     response = jsonCodec.decode(message.data);
                                 }
-                                return _this.isErrorResponse(response)
-                                    ? Promise.reject("".concat(JSON.stringify(ErrorResponse.fromJS(response))))
-                                    : Promise.resolve(response);
+                                return _this.isErrorResponse(response) ? Promise.reject(ErrorResponse.fromJS(response)) : Promise.resolve(response);
                             })
-                                .catch(function (error) {
-                                switch (error === null || error === void 0 ? void 0 : error.code) {
-                                    case ErrorCode.NoResponders:
-                                        return Promise.reject("No responders to ".concat(subject));
-                                    case ErrorCode.Timeout:
-                                        return Promise.reject("".concat(subject, " timed out"));
-                                    default:
-                                        return Promise.reject("".concat(subject, ": ").concat(error));
-                                }
-                            })];
+                                .catch(function (error) { return Promise.reject(_this.natsErrorHandler(error, subject)); })];
                     case 1: return [2 /*return*/, _a.sent()];
                 }
             });
         });
     };
+    /**
+     * Handle the error
+     * @param error
+     * @param subject
+     * @returns
+     */
+    BaseClient.prototype.natsErrorHandler = function (error, subject) {
+        var errorResponse = new ErrorResponse(error);
+        errorResponse.subject = subject;
+        errorResponse.stackTrace = error === null || error === void 0 ? void 0 : error.stack;
+        switch (error === null || error === void 0 ? void 0 : error.code) {
+            case ErrorCode.NoResponders:
+                errorResponse.message = 'No Responders';
+                break;
+            default:
+                errorResponse.message = error.message;
+        }
+        return errorResponse;
+    };
     /**
      * Build the headers' object.
      * @returns {MsgHdrs} Header object
@@ -251,7 +259,7 @@ var BaseClient = /** @class */ (function () {
      */
     BaseClient.prototype.error = function () {
         return function (error) {
-            throw new Error(error);
+            throw error;
         };
     };
     /**
@@ -266,7 +274,14 @@ var BaseClient = /** @class */ (function () {
      * @returns {{Promise<ComponentSettingsIdentifier[]>}}
      */
     BaseClient.prototype.getComponentSettingsOverview = function () {
-        return this.request('GetComponentSettingsOverview').then(this.success()).catch(this.error());
+        return this.request('GetComponentSettingsOverview')
+            .then(function (componentSettingsIdentifiers) {
+            return componentSettingsIdentifiers.map(function (componentSettingsIdentifier) {
+                return ComponentSettingsIdentifier.fromJS(componentSettingsIdentifier);
+            });
+        })
+            .then(this.success())
+            .catch(this.error());
     };
     /**
      * Change componentsettings
@@ -277,11 +292,10 @@ var BaseClient = /** @class */ (function () {
      */
     BaseClient.prototype.setComponentSettings = function (groupName, name, returnedSettings) {
         var setComponentSettingsRequest = { groupName: groupName, name: name, returnedSettings: returnedSettings };
-        return groupName && name && returnedSettings
-            ? this.request('SetComponentSettings', setComponentSettingsRequest)
-                .then(this.success())
-                .catch(this.error())
-            : Promise.reject('all parameters must be defined');
+        return this.request('SetComponentSettings', setComponentSettingsRequest)
+            .then(function (componentSettingsBase) { return ComponentSettingsBase.fromJS(componentSettingsBase); })
+            .then(this.success())
+            .catch(this.error());
     };
     /**
      * Retrieve componentsettings
@@ -291,11 +305,10 @@ var BaseClient = /** @class */ (function () {
      */
     BaseClient.prototype.getComponentSettings = function (groupName, name) {
         var getComponentSettingsRequest = { groupName: groupName, name: name };
-        return groupName && name
-            ? this.request('GetComponentSettings', getComponentSettingsRequest)
-                .then(this.success())
-                .catch(this.error())
-            : Promise.reject('all parameters must be defined');
+        return this.request('GetComponentSettings', getComponentSettingsRequest)
+            .then(function (componentSettingsBase) { return ComponentSettingsBase.fromJS(componentSettingsBase); })
+            .then(this.success())
+            .catch(this.error());
     };
     /**
      * Retrieve componentsettings list item
@@ -306,11 +319,10 @@ var BaseClient = /** @class */ (function () {
      */
     BaseClient.prototype.getComponentSettingsListItem = function (groupName, name, index) {
         var getComponentSettingsListItemRequest = { groupName: groupName, name: name, index: index };
-        return groupName && name
-            ? this.request('GetComponentSettingsListItem', getComponentSettingsListItemRequest)
-                .then(this.success())
-                .catch(this.error())
-            : Promise.reject('all parameters must be defined');
+        return this.request('GetComponentSettingsListItem', getComponentSettingsListItemRequest)
+            .then(function (componentSettingsListItem) { return ComponentSettingsListItem.fromJS(componentSettingsListItem); })
+            .then(this.success())
+            .catch(this.error());
     };
     /**
      * Set componentsettings list item settings
@@ -322,11 +334,10 @@ var BaseClient = /** @class */ (function () {
      */
     BaseClient.prototype.setComponentSettingsListItem = function (groupName, name, index, item) {
         var setComponentSettingsListItemRequest = { groupName: groupName, name: name, index: index, item: item };
-        return groupName && name && item
-            ? this.request('SetComponentSettingsListItem', setComponentSettingsListItemRequest)
-                .then(this.success())
-                .catch(this.error())
-            : Promise.reject('all parameters must be defined');
+        return this.request('SetComponentSettingsListItem', setComponentSettingsListItemRequest)
+            .then(function (componentSettingsListItem) { return ComponentSettingsListItem.fromJS(componentSettingsListItem); })
+            .then(this.success())
+            .catch(this.error());
     };
     /**
      * Get component setting data grid
@@ -343,11 +354,10 @@ var BaseClient = /** @class */ (function () {
             index: index,
             propertyName: propertyName,
         };
-        return groupName && name && propertyName
-            ? this.request('GetComponentSettingDataGrid', getComponentSettingDataGridRequest)
-                .then(this.success())
-                .catch(this.error())
-            : Promise.reject('all parameters must be defined');
+        return this.request('GetComponentSettingDataGrid', getComponentSettingDataGridRequest)
+            .then(function (dataGridControl) { return DataGridControl.fromJS(dataGridControl); })
+            .then(this.success())
+            .catch(this.error());
     };
     /**
      * Set component setting data grid
@@ -366,11 +376,10 @@ var BaseClient = /** @class */ (function () {
             propertyName: propertyName,
             dataGridControl: dataGridControl,
         };
-        return groupName && name && propertyName && dataGridControl
-            ? this.request('SetComponentSettingDataGrid', setComponentSettingDataGridRequest)
-                .then(this.success())
-                .catch(this.error())
-            : Promise.reject('all parameters must be defined');
+        return this.request('SetComponentSettingDataGrid', setComponentSettingDataGridRequest)
+            .then(function (dataGridControl) { return DataGridControl.fromJS(dataGridControl); })
+            .then(this.success())
+            .catch(this.error());
     };
     /**
      * Add component setting item type to data grid
@@ -389,11 +398,10 @@ var BaseClient = /** @class */ (function () {
             propertyName: propertyName,
             typeName: typeName,
         };
-        return groupName && name && propertyName && typeName
-            ? this.request('AddComponentSettingDataGridItemType', addComponentSettingDataGridItemTypeRequest)
-                .then(this.success())
-                .catch(this.error())
-            : Promise.reject('all parameters must be defined');
+        return this.request('AddComponentSettingDataGridItemType', addComponentSettingDataGridItemTypeRequest)
+            .then(function (dataGridControl) { return DataGridControl.fromJS(dataGridControl); })
+            .then(this.success())
+            .catch(this.error());
     };
     /**
      * Add component setting item to data grid
@@ -410,11 +418,10 @@ var BaseClient = /** @class */ (function () {
             index: index,
             propertyName: propertyName,
         };
-        return groupName && name && propertyName
-            ? this.request('AddComponentSettingDataGridItem', getComponentSettingDataGridRequest)
-                .then(this.success())
-                .catch(this.error())
-            : Promise.reject('all parameters must be defined');
+        return this.request('AddComponentSettingDataGridItem', getComponentSettingDataGridRequest)
+            .then(function (dataGridControl) { return DataGridControl.fromJS(dataGridControl); })
+            .then(this.success())
+            .catch(this.error());
     };
     /**
      * Get item types available in the component setting data grid
@@ -431,11 +438,10 @@ var BaseClient = /** @class */ (function () {
             index: index,
             propertyName: propertyName,
         };
-        return groupName && name && propertyName
-            ? this.request('GetComponentSettingDataGridTypes', getComponentSettingDataGridRequest)
-                .then(this.success())
-                .catch(this.error())
-            : Promise.reject('all parameters must be defined');
+        return this.request('GetComponentSettingDataGridTypes', getComponentSettingDataGridRequest)
+            .then(function (listItemTypes) { return listItemTypes.map(function (listItemType) { return ListItemType.fromJS(listItemType); }); })
+            .then(this.success())
+            .catch(this.error());
     };
     /**
      * Change componentsettings profiles
@@ -443,16 +449,20 @@ var BaseClient = /** @class */ (function () {
      * @returns {Promise<ProfileGroup[]>}
      */
     BaseClient.prototype.setComponentSettingsProfiles = function (returnedSettings) {
-        return returnedSettings
-            ? this.request('SetComponentSettingsProfiles', returnedSettings).then(this.success()).catch(this.error())
-            : Promise.reject('returnedSettings must be defined');
+        return this.request('SetComponentSettingsProfiles', returnedSettings)
+            .then(function (profileGroups) { return profileGroups.map(function (profileGroup) { return ProfileGroup.fromJS(profileGroup); }); })
+            .then(this.success())
+            .catch(this.error());
     };
     /**
      * Get componentsettings profiles
      * @returns {Promise<ProfileGroup[]>}
      */
     BaseClient.prototype.getComponentSettingsProfiles = function () {
-        return this.request('GetComponentSettingsProfiles').then(this.success()).catch(this.error());
+        return this.request('GetComponentSettingsProfiles')
+            .then(function (profileGroups) { return profileGroups.map(function (profileGroup) { return ProfileGroup.fromJS(profileGroup); }); })
+            .then(this.success())
+            .catch(this.error());
     };
     /**
      * Upload exported OpenTAP Settings files
@@ -471,11 +481,10 @@ var BaseClient = /** @class */ (function () {
      * @returns {Promise<ErrorResponse[]>}
      */
     BaseClient.prototype.loadComponentSettingsFromRepository = function (packageReference) {
-        return packageReference
-            ? this.request('LoadComponentSettingsFromRepository', packageReference)
-                .then(this.success())
-                .catch(this.error())
-            : Promise.reject('packageReference must be defined');
+        return this.request('LoadComponentSettingsFromRepository', packageReference)
+            .then(function (errorResponses) { return errorResponses.map(function (errorResponse) { return ErrorResponse.fromJS(errorResponse); }); })
+            .then(this.success())
+            .catch(this.error());
     };
     /**
      * Save a TapPackage containing component settings in a package repository
@@ -495,11 +504,10 @@ var BaseClient = /** @class */ (function () {
      */
     BaseClient.prototype.getComponentSettingsListAvailableTypes = function (groupName, name) {
         var getComponentSettingsRequest = { groupName: groupName, name: name };
-        return groupName && name
-            ? this.request('GetComponentSettingsListAvailableTypes', getComponentSettingsRequest)
-                .then(this.success())
-                .catch(this.error())
-            : Promise.reject('all parameters must be defined');
+        return this.request('GetComponentSettingsListAvailableTypes', getComponentSettingsRequest)
+            .then(function (listItemTypes) { return listItemTypes.map(function (listItemType) { return ListItemType.fromJS(listItemType); }); })
+            .then(this.success())
+            .catch(this.error());
     };
     /**
      * Adds a new item to a component settings list
@@ -510,11 +518,10 @@ var BaseClient = /** @class */ (function () {
      */
     BaseClient.prototype.addComponentSettingsListItem = function (groupName, name, typeName) {
         var addComponentSettingsListItemRequest = { groupName: groupName, name: name, typeName: typeName };
-        return groupName && name && typeName
-            ? this.request('AddComponentSettingsListItem', addComponentSettingsListItemRequest)
-                .then(this.success())
-                .catch(this.error())
-            : Promise.reject('all parameters must be defined');
+        return this.request('AddComponentSettingsListItem', addComponentSettingsListItemRequest)
+            .then(function (listItemTypes) { return listItemTypes.map(function (listItemType) { return ListItemType.fromJS(listItemType); }); })
+            .then(this.success())
+            .catch(this.error());
     };
     /**
      * Get settings package files

package/lib/DTOs.d.ts

@@ -37,6 +37,7 @@ export declare class ErrorResponse implements IErrorResponse {
     source?: string | undefined;
     stackTrace?: string | undefined;
     inner?: ErrorResponse | undefined;
+    subject?: string | undefined;
     constructor(data?: IErrorResponse);
     init(_data?: any): void;
     static fromJS(data: any): ErrorResponse;

package/lib/index.d.ts

@@ -2,3 +2,5 @@ export { RunnerClient } from './RunnerClient';
 export { SessionClient } from './SessionClient';
 export * from './DTOs';
 export * from 'nats.ws/lib/nats-base-client/types';
+export * from 'nats.ws/lib/nats-base-client/authenticator';
+export * from 'nats.ws/lib/nats-base-client/error';

package/lib/index.js

@@ -2,3 +2,5 @@ export { RunnerClient } from './RunnerClient';
 export { SessionClient } from './SessionClient';
 export * from './DTOs';
 export * from 'nats.ws/lib/nats-base-client/types'; // TODO: Delete this line if you are consuming this library in angular > v11. The types export will be done automatically.
+export * from 'nats.ws/lib/nats-base-client/authenticator';
+export * from 'nats.ws/lib/nats-base-client/error';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opentap/runner-client",
-  "version": "1.2.0-beta.3",
+  "version": "1.2.0-beta.5",
   "description": "This is the TypeScript Client for the OpenTAP Runner Plugin.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",