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

package/lib/BaseClient.d.ts

@@ -1,5 +1,5 @@
-import { ConnectionOptions, RequestOptions } from 'nats.ws/cjs/nats.js';
 import { ComponentSettingsBase, ComponentSettingsIdentifier, ComponentSettingsListItem, DataGridControl, ErrorResponse, FileParameter, FileResponse, ListItemType, ProfileGroup, RepositoryPackageReference, RepositorySettingsPackageDefinition, SettingsTapPackage } from './DTOs';
+import { ConnectionOptions, RequestOptions, Subscription, SubscriptionOptions } from 'nats.ws/cjs/nats.js';
 export declare class BaseClient {
     private connection;
     private baseSubject;
@@ -18,6 +18,13 @@ export declare class BaseClient {
      * @returns Promise of an object
      */
     protected request<T>(subject: string, payload?: any, options?: RequestOptions): Promise<T>;
+    /**
+     * Subscribes to given subject.
+     * @param subject The subject to subscribe
+     * @param options Subscription options
+     * @returns Subscription object
+     */
+    protected subscribe(subject: string, options: SubscriptionOptions): Subscription;
     /**
      * Check if the the response is an error from the server.
      * @param {any} response

package/lib/BaseClient.js

@@ -45,9 +45,8 @@ 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 { 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';
+import { Empty, ErrorCode, JSONCodec, StringCodec, connect, } from 'nats.ws/cjs/nats.js';
 var DEFAULT_TIMEOUT = 6000;
 var BaseClient = /** @class */ (function () {
     function BaseClient(baseSubject, options) {
@@ -116,6 +115,22 @@ var BaseClient = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Subscribes to given subject.
+     * @param subject The subject to subscribe
+     * @param options Subscription options
+     * @returns Subscription object
+     */
+    BaseClient.prototype.subscribe = function (subject, options) {
+        if (!subject)
+            throw Error('Subject is not defined!');
+        if (!this.connection)
+            throw Error('Connection is not up yet! Please try again later!');
+        if (this.connection.isClosed())
+            throw Error('Connection has been closed! Please reconnect!');
+        var natsSubject = "".concat(this.baseSubject, ".").concat(subject);
+        return this.connection.subscribe(natsSubject, options);
+    };
     /**
      * Check if the the response is an error from the server.
      * @param {any} response

package/lib/DTOs.d.ts

@@ -61,18 +61,16 @@ export interface IImageResolveErrorResponse extends IErrorResponse {
     dotGraph?: string | undefined;
 }
 export declare class Session implements ISession {
-    url?: string | undefined;
+    subject?: string | undefined;
     id?: string;
-    imageId?: string | undefined;
     constructor(data?: ISession);
     init(_data?: any): void;
     static fromJS(data: any): Session;
     toJSON(data?: any): any;
 }
 export interface ISession {
-    url?: string | undefined;
+    subject?: string | undefined;
     id?: string;
-    imageId?: string | undefined;
 }
 export declare class Links implements ILinks {
     editor?: string | undefined;

package/lib/DTOs.js

@@ -180,9 +180,8 @@ var Session = /** @class */ (function () {
     }
     Session.prototype.init = function (_data) {
         if (_data) {
-            this.url = _data['Url'];
+            this.subject = _data['Subject'];
             this.id = _data['Id'];
-            this.imageId = _data['ImageId'];
         }
     };
     Session.fromJS = function (data) {
@@ -193,9 +192,8 @@ var Session = /** @class */ (function () {
     };
     Session.prototype.toJSON = function (data) {
         data = typeof data === 'object' ? data : {};
-        data['Url'] = this.url;
+        data['Subject'] = this.subject;
         data['Id'] = this.id;
-        data['ImageId'] = this.imageId;
         return data;
     };
     return Session;

package/lib/SessionClient.d.ts

@@ -1,8 +1,27 @@
-import { BreakPoints, CommonContext, CommonSettings, DataGridControl, Image, Interaction, ListItemType, LogList, Parameter, RepositoryPackageDefinition, RepositoryPackageReference, RunStatus, Setting, TestPlan, TestStepType, TestStepValidationError, WatchDog } from './DTOs';
+import { BreakPoints, CommonContext, CommonSettings, DataGridControl, Image, Interaction, ListItemType, LogList, Parameter, RepositoryPackageDefinition, RepositoryPackageReference, Result, RunStatus, SessionEvent, Setting, TestPlan, TestRun, TestStepType, TestStepValidationError, WatchDog } from './DTOs';
+import { ConnectionOptions, NatsError, Subscription, SubscriptionOptions } from 'nats.ws/cjs/nats.js';
 import { BaseClient } from './BaseClient';
-import { ConnectionOptions } from 'nats.ws';
 export declare class SessionClient extends BaseClient {
     constructor(baseSubject: string, options: ConnectionOptions);
+    /**
+     * @param sessionLogsHandler Function to be called when log list or error is received
+     * @param options (optional) Subscription options
+     * @returns Subscription object
+     */
+    connectSessionLogs(sessionLogsHandler: (logList: LogList | undefined, err: NatsError | Error | null) => void, options?: SubscriptionOptions): Subscription;
+    /**
+     * @param eventHandler Function to be called when session event or error is received
+     * @param options (optional) Subscription options
+     * @returns Subscription object
+     */
+    connectSessionEvents(eventHandler: (sessionEvent: SessionEvent | undefined, err: NatsError | Error | null) => void, options?: SubscriptionOptions): Subscription;
+    /**
+     * @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
+     * @param options (optional) Subscription options
+     * @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];
     /**
      * Retrieve session logs
      * @param id (optional)

package/lib/SessionClient.js

@@ -13,12 +13,109 @@ var __extends = (this && this.__extends) || (function () {
         d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
     };
 })();
+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);
+};
+import { LogList, Result, SessionEvent, TestRun, } from './DTOs';
+import { JSONCodec } from 'nats.ws/cjs/nats.js';
 import { BaseClient } from './BaseClient';
 var SessionClient = /** @class */ (function (_super) {
     __extends(SessionClient, _super);
     function SessionClient(baseSubject, options) {
         return _super.call(this, baseSubject, options) || this;
     }
+    /**
+     * @param sessionLogsHandler Function to be called when log list or error is received
+     * @param options (optional) Subscription options
+     * @returns Subscription object
+     */
+    SessionClient.prototype.connectSessionLogs = function (sessionLogsHandler, options) {
+        return this.subscribe('SessionLogs', __assign(__assign({}, options), { callback: function (error, encodedMessage) {
+                if (error) {
+                    sessionLogsHandler(undefined, error);
+                    return;
+                }
+                try {
+                    var jsonCodec = JSONCodec();
+                    var logListJson = jsonCodec.decode(encodedMessage === null || encodedMessage === void 0 ? void 0 : encodedMessage.data);
+                    var logList = LogList.fromJS(logListJson);
+                    sessionLogsHandler(logList, error);
+                }
+                catch (error) {
+                    sessionLogsHandler(undefined, error);
+                }
+            } }));
+    };
+    /**
+     * @param eventHandler Function to be called when session event or error is received
+     * @param options (optional) Subscription options
+     * @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);
+                }
+            } }));
+    };
+    /**
+     * @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
+     * @param options (optional) Subscription options
+     * @returns Subscription array: Result and Test Run subscriptions
+     */
+    SessionClient.prototype.connectSessionResults = function (resultHandler, testRunHandler, options) {
+        return [
+            this.subscribe('OnResult', __assign(__assign({}, options), { callback: function (error, encodedMessage) {
+                    if (error) {
+                        resultHandler(undefined, error);
+                        return;
+                    }
+                    try {
+                        var jsonCodec = JSONCodec();
+                        var resultJs = jsonCodec.decode(encodedMessage === null || encodedMessage === void 0 ? void 0 : encodedMessage.data);
+                        var result = Result.fromJS(resultJs);
+                        resultHandler(result, error);
+                    }
+                    catch (error) {
+                        resultHandler(undefined, error);
+                    }
+                } })),
+            this.subscribe('OnTestRun', __assign(__assign({}, options), { callback: function (error, encodedMessage) {
+                    if (error) {
+                        testRunHandler(undefined, error);
+                        return;
+                    }
+                    try {
+                        var jsonCodec = JSONCodec();
+                        var testRunJs = jsonCodec.decode(encodedMessage === null || encodedMessage === void 0 ? void 0 : encodedMessage.data);
+                        var testRun = TestRun.fromJS(testRunJs);
+                        testRunHandler(testRun, error);
+                    }
+                    catch (error) {
+                        testRunHandler(undefined, error);
+                    }
+                } })),
+        ];
+    };
     /**
      * Retrieve session logs
      * @param id (optional)

package/package.json

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