@opentap/runner-client 1.0.0-beta.74 → 1.0.0-beta.76

package/lib/BaseClient.d.ts

@@ -1,26 +1,14 @@
-import { ConnectionOptions, NatsConnection, RequestOptions } from 'nats.ws/cjs/nats.js';
+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 _accessToken;
-    /** Get access token */
-    get accessToken(): string;
-    /** Set access token */
-    set accessToken(value: string);
+    private connection;
+    private baseSubject;
+    private connectionOptions;
     private _timeout;
     /** Get timeout */
     get timeout(): number;
     /** Set timeout */
     set timeout(value: number);
-    private _baseSubject;
-    /** Get subject */
-    get baseSubject(): string;
-    private _connectionOptions;
-    /** Get connection options */
-    get connectionOptions(): ConnectionOptions;
-    private _connection;
-    /** Get connection instance */
-    get connection(): NatsConnection;
-    private domainAccess;
     constructor(baseSubject: string, options: ConnectionOptions);
     /**
      * Send a request to the nats server.
@@ -40,7 +28,7 @@ export declare class BaseClient {
      * Create a connection to the nats server.
      * @param {ConnectionOptions} options
      */
-    private connect;
+    connect(): Promise<void>;
     /**
      * Close the connection.
      */
@@ -50,7 +38,6 @@ export declare class BaseClient {
      * @param domain
      * @param accessToken
      */
-    protected setDomainAccessToken(domain: string, accessToken: string): void;
     /**
      * Generic error callback function.
      * @returns

package/lib/BaseClient.js

@@ -1,3 +1,14 @@
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -37,32 +48,18 @@ 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, ErrorCode, JSONCodec, StringCodec } from 'nats.ws/cjs/nats.js';
 import { ErrorResponse, } from './DTOs';
+var DEFAULT_TIMEOUT = 6000;
 var BaseClient = /** @class */ (function () {
     function BaseClient(baseSubject, options) {
-        this.domainAccess = new Map();
-        this._baseSubject = baseSubject;
-        this._connectionOptions = options || { servers: 'ws://localhost:443' };
-        var undefinedSubject = function () {
-            throw new Error('A base subject must be specified');
-        };
-        baseSubject ? this.connect(this._connectionOptions) : undefinedSubject();
+        //this.domainAccess = new Map<string, string>();
+        this.baseSubject = baseSubject;
+        this.connectionOptions = __assign({}, options) || {};
+        this.connectionOptions.timeout = (options === null || options === void 0 ? void 0 : options.timeout) || DEFAULT_TIMEOUT;
     }
-    Object.defineProperty(BaseClient.prototype, "accessToken", {
-        /** Get access token */
-        get: function () {
-            return this._accessToken;
-        },
-        /** Set access token */
-        set: function (value) {
-            this._accessToken = value;
-        },
-        enumerable: false,
-        configurable: true
-    });
     Object.defineProperty(BaseClient.prototype, "timeout", {
         /** Get timeout */
         get: function () {
-            return this._timeout;
+            return this._timeout || DEFAULT_TIMEOUT;
         },
         /** Set timeout */
         set: function (value) {
@@ -71,30 +68,6 @@ var BaseClient = /** @class */ (function () {
         enumerable: false,
         configurable: true
     });
-    Object.defineProperty(BaseClient.prototype, "baseSubject", {
-        /** Get subject */
-        get: function () {
-            return this._baseSubject;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(BaseClient.prototype, "connectionOptions", {
-        /** Get connection options */
-        get: function () {
-            return this._connectionOptions;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(BaseClient.prototype, "connection", {
-        /** Get connection instance */
-        get: function () {
-            return this._connection;
-        },
-        enumerable: false,
-        configurable: true
-    });
     /**
      * Send a request to the nats server.
      * @param subject The subject to request
@@ -103,20 +76,24 @@ 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;
+            var stringCodec, data, opts;
             var _this = this;
-            return __generator(this, function (_b) {
-                switch (_b.label) {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
                     case 0:
-                        if (!subject || ((_a = this.connection) === 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 not up yet! Please try again later!')];
+                        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;
+                        opts = __assign(__assign({}, options), { timeout: this.timeout });
                         return [4 /*yield*/, this.connection
-                                .request(subject, data, options)
+                                .request(subject, data, opts)
                                 .then(function (message) {
                                 var jsonCodec = JSONCodec();
                                 var response = jsonCodec.decode(message === null || message === void 0 ? void 0 : message.data);
@@ -134,7 +111,7 @@ var BaseClient = /** @class */ (function () {
                                         return Promise.reject(error);
                                 }
                             })];
-                    case 1: return [2 /*return*/, _b.sent()];
+                    case 1: return [2 /*return*/, _a.sent()];
                 }
             });
         });
@@ -151,24 +128,31 @@ var BaseClient = /** @class */ (function () {
      * Create a connection to the nats server.
      * @param {ConnectionOptions} options
      */
-    BaseClient.prototype.connect = function (options) {
+    BaseClient.prototype.connect = function () {
         return __awaiter(this, void 0, void 0, function () {
             var error_1;
             var _this = this;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        _a.trys.push([0, 2, , 3]);
-                        return [4 /*yield*/, connect(options).then(function (connection) {
-                                _this._connection = connection;
-                            })];
+                        if (!this.baseSubject)
+                            return [2 /*return*/, Promise.reject('Subject must be given')];
+                        if (this.connection)
+                            return [2 /*return*/, Promise.resolve()];
+                        _a.label = 1;
                     case 1:
-                        _a.sent();
-                        return [3 /*break*/, 3];
-                    case 2:
+                        _a.trys.push([1, 3, , 4]);
+                        return [4 /*yield*/, connect(this.connectionOptions)
+                                .then(function (connection) {
+                                _this.connection = connection;
+                                return Promise.resolve();
+                            })
+                                .catch(function (error) { return Promise.reject("Failed to connect to ".concat(_this.connectionOptions.servers, " with ").concat(error)); })];
+                    case 2: return [2 /*return*/, _a.sent()];
+                    case 3:
                         error_1 = _a.sent();
-                        throw new Error("connection to ".concat(options.servers, " failed due to ").concat(error_1));
-                    case 3: return [2 /*return*/];
+                        return [2 /*return*/, Promise.reject("Failed to connect to ".concat(this.connectionOptions.servers, " with ").concat(error_1))];
+                    case 4: return [2 /*return*/];
                 }
             });
         });
@@ -182,8 +166,8 @@ var BaseClient = /** @class */ (function () {
             return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
-                        if (!this._connection) return [3 /*break*/, 2];
-                        return [4 /*yield*/, ((_a = this._connection) === 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:
@@ -199,11 +183,11 @@ var BaseClient = /** @class */ (function () {
      * @param domain
      * @param accessToken
      */
-    BaseClient.prototype.setDomainAccessToken = function (domain, accessToken) {
-        if (!domain)
-            return;
+    /* protected setDomainAccessToken(domain: string, accessToken: string): void {
+        if (!domain) return;
+
         this.domainAccess.set(domain, accessToken);
-    };
+    } */
     /**
      * Generic error callback function.
      * @returns

package/lib/index.d.ts

@@ -1,3 +1,4 @@
 export { RunnerClient } from './RunnerClient';
 export { SessionClient } from './SessionClient';
 export * from './DTOs';
+export * from 'nats.ws/lib/nats-base-client/types';

package/lib/index.js

@@ -1,3 +1,4 @@
 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.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opentap/runner-client",
-  "version": "1.0.0-beta.74",
+  "version": "1.0.0-beta.76",
   "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/)
-