@opentap/runner-client 2.24.0-alpha.1.3.11013598225 → 2.24.0

package/dist/cjs/DTOs.js

@@ -17,7 +17,7 @@ var __extends = (this && this.__extends) || (function () {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SessionShutdownInitiated = exports.SessionStartFailed = exports.SessionStarted = exports.SessionStartInitiated = exports.SessionEventArgs = exports.SettingsTapPackage = exports.RepositorySettingsPackageDefinition = exports.RepositoryPackageDefinition = exports.RepositoryPackageReference = exports.ProfileGroup = exports.ListItemType = exports.ComponentSettings = exports.FileDescriptor = exports.Resource = exports.PluginTypeSelectorControl = exports.PictureControl = exports.PasswordControl = exports.MultiSelectControl = exports.DropdownControl = exports.EnabledControl = exports.DirectoryPathControl = exports.FilePathControl = exports.ComboBoxControl = exports.TextBoxControl = exports.DataGridControl = exports.DataGridReferenceControl = exports.CheckBoxControl = exports.AvailableValue = exports.ButtonsControl = exports.ButtonControl = exports.ExternalParameter = exports.MetaData = exports.DisplayAttribute = exports.VisualStatus = exports.Icon = exports.ColumnDisplayName = exports.LayoutMode = exports.Layout = exports.Setting = exports.ComponentSettingsListItem = exports.AnnotatedObject = exports.ComponentSettingsList = exports.ComponentSettingsIdentifier = exports.ComponentSettingsBase = exports.Links = exports.Session = exports.ImageResolveErrorResponse = exports.ErrorResponse = exports.PackageSpecifier = exports.Image = void 0;
 exports.BreakEventArgs = exports.TestStepChangeEventArgs = exports.SettingsChangedEventArgs = exports.TestPlanExecutionStateChangedEventArgs = exports.TestPlanChangeEventArgs = exports.StoppedEventArgs = exports.StoppingEventArgs = exports.StartedEventArgs = exports.StartingEventArgs = exports.SessionTimeoutEventArgs = exports.SessionEventType = exports.SessionEvent = exports.MetricValue = exports.MetricsConfiguration = exports.SessionMetricInfo = exports.MetricsPollRate = exports.SessionMetricType = exports.SessionMetricKind = exports.ResultColumn = exports.Result = exports.LogEvent = exports.TestStepRun = exports.TestRun = exports.WatchDog = exports.Parameter = exports.BreakPoints = exports.InstalledFile = exports.Interaction = exports.CommonContext = exports.CommonSettings = exports.ValidationError = exports.TestStepValidationError = exports.TestStepCopy = exports.TestStepType = exports.TestStep = exports.TestPlan = exports.ExecutionState = exports.Verdict = exports.RunStatus = exports.MissingLicenseResponse = exports.LogEntry = exports.LogList = exports.ApiException = exports.ImageCreationFailed = exports.ImageCreated = exports.ImageCreating = exports.ImageEventArgs = exports.SessionInactivityLimitHit = exports.SessionShutdownFailed = exports.SessionShutdown = void 0;
-exports.RunnerDeletedEvent = exports.RunnerUpdatedEvent = exports.RunnerRegisteredEvent = exports.RunnerEvent = exports.TestPlanRunCompletedEventArgs = exports.TestPlanRunStartEventArgs = exports.TestPlanRunEvent = exports.TestStepRunCompletedEventArgs = exports.TestStepRunStartEventArgs = exports.TestStepRunEvent = exports.OnTestStepRun = exports.OnTestPlanRun = exports.MetricsConfigurationChangedEventArgs = exports.HeartbeatEventArgs = exports.TestPlanSettingsChangedEventArgs = exports.UserInputRequestCompletedEventArgs = exports.UserInputRequestEventArgs = void 0;
+exports.MetadataUpdatedEvent = exports.RunnerDeletedEvent = exports.RunnerUpdatedEvent = exports.RunnerRegisteredEvent = exports.RunnerEvent = exports.TestPlanRunCompletedEventArgs = exports.TestPlanRunStartEventArgs = exports.TestPlanRunEvent = exports.TestStepRunCompletedEventArgs = exports.TestStepRunStartEventArgs = exports.TestStepRunEvent = exports.OnTestStepRun = exports.OnTestPlanRun = exports.MetricsConfigurationChangedEventArgs = exports.HeartbeatEventArgs = exports.TestPlanSettingsChangedEventArgs = exports.UserInputRequestCompletedEventArgs = exports.UserInputRequestEventArgs = void 0;
 var Image = /** @class */ (function () {
     function Image(data) {
         this.packages = [];
@@ -4105,3 +4105,33 @@ var RunnerDeletedEvent = /** @class */ (function (_super) {
     return RunnerDeletedEvent;
 }(RunnerEvent));
 exports.RunnerDeletedEvent = RunnerDeletedEvent;
+var MetadataUpdatedEvent = /** @class */ (function () {
+    function MetadataUpdatedEvent(data) {
+        if (data) {
+            for (var property in data) {
+                if (Object.prototype.hasOwnProperty.call(data, property))
+                    this[property] = data[property];
+            }
+        }
+    }
+    MetadataUpdatedEvent.prototype.init = function (_data) {
+        if (_data) {
+            this.sessionId = _data['SessionId'];
+            this.metadata = _data['Metadata'];
+        }
+    };
+    MetadataUpdatedEvent.fromJS = function (data) {
+        data = typeof data === 'object' ? data : {};
+        var result = new MetadataUpdatedEvent();
+        result.init(data);
+        return result;
+    };
+    MetadataUpdatedEvent.prototype.toJSON = function (data) {
+        data = typeof data === 'object' ? data : {};
+        data['SessionId'] = this.sessionId;
+        data['Metadata'] = this.metadata;
+        return data;
+    };
+    return MetadataUpdatedEvent;
+}());
+exports.MetadataUpdatedEvent = MetadataUpdatedEvent;

package/dist/cjs/RunnerClient.js

@@ -14,8 +14,20 @@ 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);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RunnerClient = void 0;
+var nats_ws_1 = require("nats.ws");
 var DTOs_1 = require("./DTOs");
 var BaseClient_1 = require("./BaseClient");
 var RunnerClient = /** @class */ (function (_super) {
@@ -200,6 +212,29 @@ var RunnerClient = /** @class */ (function (_super) {
     RunnerClient.prototype.updateRunner = function (runnerUpdateRequest) {
         return this.request('UpdateRunner', runnerUpdateRequest).then(this.success()).catch(this.error());
     };
+    /**
+     * Subscribe to the MetadataUpdated event
+     * @param  {(event:MetadataUpdatedEvent|undefined,err:NatsError|Error|null)=>void} handler
+     * @param  {SubscriptionOptions} options?
+     * @returns Subscription
+     */
+    RunnerClient.prototype.connectMetadataUpdatedEvents = function (handler, options) {
+        return this.subscribe('Events.MetadataUpdated', __assign(__assign({}, options), { callback: function (error, encodedMessage) {
+                if (error) {
+                    handler(undefined, error);
+                    return;
+                }
+                try {
+                    var jsonCodec = (0, nats_ws_1.JSONCodec)();
+                    var metadataEventJson = jsonCodec.decode(encodedMessage === null || encodedMessage === void 0 ? void 0 : encodedMessage.data);
+                    var metadataEvent = DTOs_1.MetadataUpdatedEvent.fromJS(metadataEventJson);
+                    handler(metadataEvent, error);
+                }
+                catch (error) {
+                    handler(undefined, error);
+                }
+            } }));
+    };
     return RunnerClient;
 }(BaseClient_1.BaseClient));
 exports.RunnerClient = RunnerClient;

package/dist/mjs/DTOs.d.ts

@@ -1455,3 +1455,19 @@ export declare class RunnerDeletedEvent extends RunnerEvent implements IRunnerDe
     static fromJS(data: any): RunnerDeletedEvent;
     toJSON(data?: any): any;
 }
+export declare class MetadataUpdatedEvent implements IMetadataUpdatedEvent {
+    sessionId: string;
+    metadata: {
+        [key: string]: string;
+    } | undefined;
+    constructor(data?: IMetadataUpdatedEvent);
+    init(_data?: any): void;
+    static fromJS(data: any): MetadataUpdatedEvent;
+    toJSON(data?: any): any;
+}
+export interface IMetadataUpdatedEvent {
+    sessionId: string;
+    metadata: {
+        [key: string]: string;
+    } | undefined;
+}

package/dist/mjs/DTOs.js

@@ -3605,3 +3605,31 @@ export class RunnerDeletedEvent extends RunnerEvent {
         return data;
     }
 }
+export class MetadataUpdatedEvent {
+    constructor(data) {
+        if (data) {
+            for (const property in data) {
+                if (Object.prototype.hasOwnProperty.call(data, property))
+                    this[property] = data[property];
+            }
+        }
+    }
+    init(_data) {
+        if (_data) {
+            this.sessionId = _data['SessionId'];
+            this.metadata = _data['Metadata'];
+        }
+    }
+    static fromJS(data) {
+        data = typeof data === 'object' ? data : {};
+        const result = new MetadataUpdatedEvent();
+        result.init(data);
+        return result;
+    }
+    toJSON(data) {
+        data = typeof data === 'object' ? data : {};
+        data['SessionId'] = this.sessionId;
+        data['Metadata'] = this.metadata;
+        return data;
+    }
+}

package/dist/mjs/RunnerClient.d.ts

@@ -1,7 +1,7 @@
+import { ConnectionOptions, NatsError, Subscription, SubscriptionOptions } from 'nats.ws';
 import { RunnerUpdateRequest } from './requestDTOs';
-import { ISession, Image, RepositoryPackageReference, Session } from './DTOs';
+import { ISession, Image, MetadataUpdatedEvent, RepositoryPackageReference, Session } from './DTOs';
 import { BaseClient } from './BaseClient';
-import { ConnectionOptions } from 'nats.ws';
 export declare class RunnerClient extends BaseClient {
     default: {
         startSession: (testPlanRepositoryReference?: RepositoryPackageReference, timeout?: number) => Promise<Session>;
@@ -71,4 +71,11 @@ export declare class RunnerClient extends BaseClient {
      * @returns {{Promise<void>}}
      */
     updateRunner(runnerUpdateRequest: RunnerUpdateRequest): Promise<void>;
+    /**
+     * Subscribe to the MetadataUpdated event
+     * @param  {(event:MetadataUpdatedEvent|undefined,err:NatsError|Error|null)=>void} handler
+     * @param  {SubscriptionOptions} options?
+     * @returns Subscription
+     */
+    connectMetadataUpdatedEvents(handler: (event: MetadataUpdatedEvent | undefined, err: NatsError | Error | null) => void, options?: SubscriptionOptions): Subscription;
 }

package/dist/mjs/RunnerClient.js

@@ -1,4 +1,5 @@
-import { Image, RepositoryPackageReference, Session } from './DTOs';
+import { JSONCodec } from 'nats.ws';
+import { Image, MetadataUpdatedEvent, RepositoryPackageReference, Session, } from './DTOs';
 import { BaseClient } from './BaseClient';
 export class RunnerClient extends BaseClient {
     constructor(baseSubject, options) {
@@ -178,4 +179,27 @@ export class RunnerClient extends BaseClient {
     updateRunner(runnerUpdateRequest) {
         return this.request('UpdateRunner', runnerUpdateRequest).then(this.success()).catch(this.error());
     }
+    /**
+     * Subscribe to the MetadataUpdated event
+     * @param  {(event:MetadataUpdatedEvent|undefined,err:NatsError|Error|null)=>void} handler
+     * @param  {SubscriptionOptions} options?
+     * @returns Subscription
+     */
+    connectMetadataUpdatedEvents(handler, options) {
+        return this.subscribe('Events.MetadataUpdated', Object.assign(Object.assign({}, options), { callback(error, encodedMessage) {
+                if (error) {
+                    handler(undefined, error);
+                    return;
+                }
+                try {
+                    const jsonCodec = JSONCodec();
+                    const metadataEventJson = jsonCodec.decode(encodedMessage === null || encodedMessage === void 0 ? void 0 : encodedMessage.data);
+                    const metadataEvent = MetadataUpdatedEvent.fromJS(metadataEventJson);
+                    handler(metadataEvent, error);
+                }
+                catch (error) {
+                    handler(undefined, error);
+                }
+            } }));
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opentap/runner-client",
-  "version": "2.24.0-alpha.1.3.11013598225",
+  "version": "2.24.0",
   "description": "This is the web client for the OpenTAP Runner.",
   "main": "./dist/cjs/index.js",
   "module": "./dist/mjs/index.js",