@opentap/runner-client 1.0.0-beta.73 → 1.0.0-beta.75

package/lib/BaseClient.d.ts

@@ -1,6 +1,8 @@
 import { ConnectionOptions, RequestOptions } from 'nats.ws/cjs/nats.js';
 import { ComponentSettingsBase, ComponentSettingsIdentifier, ComponentSettingsListItem, DataGridControl, ErrorResponse, FileParameter, FileResponse, ListItemType, ProfileGroup, RepositoryPackageReference, RepositorySettingsPackageDefinition, SettingsTapPackage } from './DTOs';
 export declare class BaseClient {
+    private connection;
+    private domainAccess;
     private _accessToken;
     /** Get access token */
     get accessToken(): string;
@@ -17,8 +19,6 @@ export declare class BaseClient {
     private _connectionOptions;
     /** Get connection options */
     get connectionOptions(): ConnectionOptions;
-    private domainAccess;
-    private natsConnection;
     constructor(baseSubject: string, options: ConnectionOptions);
     /**
      * Send a request to the nats server.
@@ -28,8 +28,15 @@ export declare class BaseClient {
      * @returns Promise of an object
      */
     protected request<T>(subject: string, payload?: any, options?: RequestOptions): Promise<T>;
+    /**
+     * Check if the the response is an error from the server.
+     * @param {any} response
+     * @returns {boolean}
+     */
+    private isErrorResponse;
     /**
      * Create a connection to the nats server.
+     * @param {ConnectionOptions} options
      */
     private connect;
     /**

package/lib/BaseClient.js

@@ -35,7 +35,8 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     }
 };
 // ! import { connect, ConnectionOptions, Empty, JSONCodec, NatsConnection, RequestOptions, StringCodec } from 'nats.ws' if consuming this library in angular >= 13.
-import { connect, Empty, JSONCodec, StringCodec } from 'nats.ws/cjs/nats.js';
+import { connect, Empty, ErrorCode, JSONCodec, StringCodec } from 'nats.ws/cjs/nats.js';
+import { ErrorResponse, } from './DTOs';
 var BaseClient = /** @class */ (function () {
     function BaseClient(baseSubject, options) {
         this.domainAccess = new Map();
@@ -94,35 +95,56 @@ var BaseClient = /** @class */ (function () {
      * @returns Promise of an object
      */
     BaseClient.prototype.request = function (subject, payload, options) {
-        var _a;
         return __awaiter(this, void 0, void 0, function () {
             var stringCodec, data;
-            return __generator(this, function (_b) {
-                switch (_b.label) {
+            var _this = this;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
                     case 0:
-                        if (!subject || ((_a = this.natsConnection) === null || _a === void 0 ? void 0 : _a.isClosed()))
-                            return [2 /*return*/, Promise.reject()];
+                        if (!subject)
+                            return [2 /*return*/, Promise.reject('Subject is not defined!')];
+                        if (!this.connection)
+                            return [2 /*return*/, Promise.reject('Connection is down! Please try again!')];
+                        if (this.connection.isClosed())
+                            return [2 /*return*/, Promise.reject('Connection has been closed! Please reconnect!')];
                         subject = "".concat(this.baseSubject, ".Request.").concat(subject);
                         stringCodec = StringCodec();
                         data = payload ? stringCodec.encode(JSON.stringify(payload)) : Empty;
-                        return [4 /*yield*/, this.natsConnection
+                        return [4 /*yield*/, this.connection
                                 .request(subject, data, options)
                                 .then(function (message) {
                                 var jsonCodec = JSONCodec();
-                                var responseData = jsonCodec.decode(message.data);
-                                // TODO: implement ErrorResponse handling when server returns an error;
-                                return Promise.resolve(responseData);
+                                var response = jsonCodec.decode(message === null || message === void 0 ? void 0 : message.data);
+                                return _this.isErrorResponse(response)
+                                    ? Promise.reject("".concat(JSON.stringify(ErrorResponse.fromJS(response))))
+                                    : Promise.resolve(response);
                             })
                                 .catch(function (error) {
-                                return Promise.reject(new Error("Request failed: ".concat(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('request timed out');
+                                    default:
+                                        return Promise.reject(error);
+                                }
                             })];
-                    case 1: return [2 /*return*/, _b.sent()];
+                    case 1: return [2 /*return*/, _a.sent()];
                 }
             });
         });
     };
+    /**
+     * Check if the the response is an error from the server.
+     * @param {any} response
+     * @returns {boolean}
+     */
+    BaseClient.prototype.isErrorResponse = function (response) {
+        return response && typeof response === 'object' && ['Type', 'Message', 'StackTrace', 'Parameter'].every(function (prop) { return prop in response; });
+    };
     /**
      * Create a connection to the nats server.
+     * @param {ConnectionOptions} options
      */
     BaseClient.prototype.connect = function (options) {
         return __awaiter(this, void 0, void 0, function () {
@@ -133,7 +155,7 @@ var BaseClient = /** @class */ (function () {
                     case 0:
                         _a.trys.push([0, 2, , 3]);
                         return [4 /*yield*/, connect(options).then(function (connection) {
-                                _this.natsConnection = connection;
+                                _this.connection = connection;
                             })];
                     case 1:
                         _a.sent();
@@ -155,8 +177,8 @@ var BaseClient = /** @class */ (function () {
             return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
-                        if (!this.natsConnection) return [3 /*break*/, 2];
-                        return [4 /*yield*/, ((_a = this.natsConnection) === null || _a === void 0 ? void 0 : _a.close().catch(function (error) {
+                        if (!this.connection) return [3 /*break*/, 2];
+                        return [4 /*yield*/, ((_a = this.connection) === null || _a === void 0 ? void 0 : _a.close().catch(function (error) {
                                 throw new Error("failed to close connection: ".concat(error));
                             }))];
                     case 1:

package/package.json

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

package/readme.md

@@ -1,7 +1,7 @@
 
 # OpenTap Runner Client
 
-This is the TypeScript Client for the OpenTAP Runner Plugin.
+This is the web client for the OpenTAP Runner.
 
 
 ## Authors
@@ -14,18 +14,32 @@ This is the TypeScript Client for the OpenTAP Runner Plugin.
 Install my-project with npm
 
 ```bash
-  npm install my-project
-  cd my-project
+  npm install @opentap/runner-client
 ```
     
-## Usage/Examples
-
-```javascript
-import Component from 'my-project'
-
-function App() {
-  return <Component />
+## Usage example
+
+```typescript
+import { RunnerClient } from "@openTap/runner-client";
+
+class client {
+  runnerClient: RunnerClient;
+
+  constructor() {
+    this.runnerClient = new RunnerClient('<BASE_SUBJECT>', { servers: '<SERVER_ADDRESS>' });
+  }
+
+  getImages() {
+    try {
+      this.data = this.runnerClient?.getImages()
+        .then(res => console.log(res))
+        .catch(error => console.error(error));
+    } catch (error) {
+      console.error(error);
+    }
+  }
 }
+
 ```
 
 
@@ -49,19 +63,13 @@ Install dependencies
   npm install
 ```
 
-Start the server
+Build the library
 
 ```bash
   npm run build
 ```
 
 
-## Test
-
-```bash
-  npm run test
-```
 ## License
 
 [MIT](https://choosealicense.com/licenses/mit/)
-