@opentap/runner-client 1.2.1 → 1.2.2-alpha.1

package/README.md

@@ -9,15 +9,15 @@ This is the web client for the OpenTAP Runner.
 - [@OpenTAP.io](https://opentap.io/)
 
 
-## Installation
+## How to install the client
 
-Install my-project with npm
+Install with npm
 
 ```bash
   npm install @opentap/runner-client
 ```
     
-## Usage example
+## How to use the client
 
 ```typescript
 import { RunnerClient } from "@openTap/runner-client";
@@ -27,34 +27,34 @@ class client {
 
   constructor() {
     this.runnerClient = new RunnerClient('<BASE_SUBJECT>', { servers: '<SERVER_ADDRESS>' });
+    // Always connect first
+    this.runnerClient.connect()
+      .then(() => console.log('CONNECTED'))
+      .catch(err => console.log(err));
   }
 
   getImages() {
-    try {
-      this.data = this.runnerClient?.getImages()
-        .then(res => console.log(res))
-        .catch(error => console.error(error));
-    } catch (error) {
-      console.error(error);
-    }
+    this.data = this.runnerClient?.getImages()
+      .then(res => console.log(res))
+      .catch(error => console.error(error));
   }
 }
 
 ```
 
 
-## Build locally
+## How to build locally
 
 Clone the project
 
 ```bash
-  git clone https://link-to-project
+  ~ git clone https://github.com/opentap/runner-client-web.git
 ```
 
 Go to the project directory
 
 ```bash
-  cd my-project
+  ~ cd runner-client-web
 ```
 
 Install dependencies
@@ -69,6 +69,7 @@ Build the library
   npm run build
 ```
 
+## How to debug the project
 
 ## License
 

package/lib/BaseClient.js

@@ -184,7 +184,7 @@ var BaseClient = /** @class */ (function () {
      * @returns {boolean}
      */
     BaseClient.prototype.isErrorResponse = function (response) {
-        return response && typeof response === 'object' && ['Type', 'Message', 'StackTrace', 'Parameter'].every(function (prop) { return prop in response; });
+        return response && typeof response === 'object' && ['Type', 'Message', 'StackTrace'].every(function (prop) { return prop in response; });
     };
     /**
      * Create a connection to the nats server.

package/lib/SessionClient.d.ts

@@ -2,6 +2,8 @@ import { BreakPoints, CommonContext, CommonSettings, DataGridControl, Image, Int
 import { ConnectionOptions, NatsError, Subscription, SubscriptionOptions } from 'nats.ws/cjs/nats.js';
 import { BaseClient } from './BaseClient';
 export declare class SessionClient extends BaseClient {
+    private eventsSubscription;
+    private eventsWildcardSubscription;
     constructor(baseSubject: string, options: ConnectionOptions);
     /**
      * @param sessionLogsHandler Function to be called when log list or error is received
@@ -14,7 +16,7 @@ export declare class SessionClient extends BaseClient {
      * @param options (optional) Subscription options
      * @returns Subscription object
      */
-    connectSessionEvents(eventHandler: (sessionEvent: SessionEvent | undefined, err: NatsError | Error | null) => void, options?: SubscriptionOptions): Subscription;
+    connectSessionEvents(eventHandler: (sessionEvent: SessionEvent | undefined, err: NatsError | Error | null) => void, options?: SubscriptionOptions): void;
     /**
      * @param resultHandler Function to be called when result or error is received
      * @param testRunHandler Function to be called when test run or error is received
@@ -22,6 +24,10 @@ export declare class SessionClient extends BaseClient {
      * @returns Subscription array: Result and Test Run subscriptions
      */
     connectSessionResults(resultHandler: (result: Result | undefined, err: NatsError | Error | null) => void, testRunHandler: (testRun: TestRun | undefined, err: NatsError | Error | null) => void, options?: SubscriptionOptions): [Subscription, Subscription];
+    /**
+     * Unsubscibe from session events
+     */
+    unsubscribeSessionEvents(): void;
     /**
      * Retrieve session logs
      * @param id (optional)

package/lib/SessionClient.js

@@ -60,21 +60,23 @@ var SessionClient = /** @class */ (function (_super) {
      * @returns Subscription object
      */
     SessionClient.prototype.connectSessionEvents = function (eventHandler, options) {
-        return this.subscribe('Events', __assign(__assign({}, options), { callback: function (error, encodedMessage) {
-                if (error) {
-                    eventHandler(undefined, error);
-                    return;
-                }
-                try {
-                    var jsonCodec = JSONCodec();
-                    var sessionEventJs = jsonCodec.decode(encodedMessage === null || encodedMessage === void 0 ? void 0 : encodedMessage.data);
-                    var sessionEvent = SessionEvent.fromJS(sessionEventJs);
-                    eventHandler(sessionEvent, error);
-                }
-                catch (error) {
-                    eventHandler(undefined, error);
-                }
-            } }));
+        var callback = function (error, encodedMessage) {
+            if (error) {
+                eventHandler(undefined, error);
+                return;
+            }
+            try {
+                var jsonCodec = JSONCodec();
+                var sessionEventJs = jsonCodec.decode(encodedMessage === null || encodedMessage === void 0 ? void 0 : encodedMessage.data);
+                var sessionEvent = SessionEvent.fromJS(sessionEventJs);
+                eventHandler(sessionEvent, error);
+            }
+            catch (error) {
+                eventHandler(undefined, error);
+            }
+        };
+        this.eventsSubscription = this.subscribe('Events', __assign(__assign({}, options), { callback: callback }));
+        this.eventsWildcardSubscription = this.subscribe('Events.*', __assign(__assign({}, options), { callback: callback }));
     };
     /**
      * @param resultHandler Function to be called when result or error is received
@@ -116,6 +118,17 @@ var SessionClient = /** @class */ (function (_super) {
                 } })),
         ];
     };
+    /**
+     * Unsubscibe from session events
+     */
+    SessionClient.prototype.unsubscribeSessionEvents = function () {
+        if (this.eventsSubscription) {
+            this.eventsSubscription.unsubscribe();
+        }
+        if (this.eventsWildcardSubscription) {
+            this.eventsWildcardSubscription.unsubscribe();
+        }
+    };
     /**
      * Retrieve session logs
      * @param id (optional)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opentap/runner-client",
-  "version": "1.2.1",
+  "version": "1.2.2-alpha.1",
   "description": "This is the web client for the OpenTAP Runner.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",