@opentap/runner-client 2.29.3 → 2.30.0-alpha.1.1.13996074647

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -249,5 +249,11 @@ export declare class BaseClient {
249
249
  * @returns {Promise<string[]>}
250
250
  */
251
251
  settingsPackageTypes(): Promise<string[]>;
252
+ /**
253
+ * Dispatches a request with the given subject and returns a Promise of type T
254
+ * @param subject The subject to send the request to
255
+ * @returns Promise<T> The response from the request
256
+ */
257
+ dispatchRequest<T>(subject: string): Promise<T>;
252
258
  }
253
259
  export {};
@@ -682,6 +682,18 @@ var BaseClient = /** @class */ (function () {
682
682
  BaseClient.prototype.settingsPackageTypes = function () {
683
683
  return this.request('SettingsPackageTypes').then(this.success()).catch(this.error());
684
684
  };
685
+ /**
686
+ * Dispatches a request with the given subject and returns a Promise of type T
687
+ * @param subject The subject to send the request to
688
+ * @returns Promise<T> The response from the request
689
+ */
690
+ BaseClient.prototype.dispatchRequest = function (subject) {
691
+ return __awaiter(this, void 0, void 0, function () {
692
+ return __generator(this, function (_a) {
693
+ return [2 /*return*/, this.request(subject)];
694
+ });
695
+ });
696
+ };
685
697
  return BaseClient;
686
698
  }());
687
699
  exports.BaseClient = BaseClient;
@@ -1507,3 +1507,14 @@ export interface IMetadataUpdatedEvent {
1507
1507
  [key: string]: string;
1508
1508
  } | undefined;
1509
1509
  }
1510
+ export interface IAssetUpdatedEvent extends IRunnerEvent {
1511
+ assets?: string[] | undefined;
1512
+ }
1513
+ export declare class AssetUpdatedEvent extends RunnerEvent implements IAssetUpdatedEvent {
1514
+ assets?: string[] | undefined;
1515
+ protected _discriminator: string;
1516
+ constructor(data?: IAssetUpdatedEvent);
1517
+ init(_data?: any): void;
1518
+ static fromJS(data: any): AssetUpdatedEvent;
1519
+ toJSON(data?: any): any;
1520
+ }
package/dist/cjs/DTOs.js CHANGED
@@ -17,7 +17,7 @@ var __extends = (this && this.__extends) || (function () {
17
17
  Object.defineProperty(exports, "__esModule", { value: true });
18
18
  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.UnitAttribute = exports.Icon = exports.ColumnDisplayName = exports.LayoutMode = exports.Layout = exports.Setting = exports.ComponentSettingsListItem = exports.AnnotatedObject = exports.ComponentSettingsList = exports.DisplayMode = exports.ComponentSettingsIdentifier = exports.ComponentSettingsBase = exports.Links = exports.Session = exports.ImageResolveErrorResponse = exports.NoResponderError = exports.ErrorResponse = exports.PackageSpecifier = exports.Image = void 0;
19
19
  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 = exports.SessionShutdownInitiated = exports.SessionStartFailed = exports.SessionStarted = void 0;
20
- 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 = exports.BreakEventArgs = exports.TestStepChangeEventArgs = exports.SettingsChangedEventArgs = void 0;
20
+ exports.AssetUpdatedEvent = 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 = exports.BreakEventArgs = exports.TestStepChangeEventArgs = exports.SettingsChangedEventArgs = void 0;
21
21
  var Image = /** @class */ (function () {
22
22
  function Image(data) {
23
23
  this.packages = [];
@@ -4197,3 +4197,43 @@ var MetadataUpdatedEvent = /** @class */ (function () {
4197
4197
  return MetadataUpdatedEvent;
4198
4198
  }());
4199
4199
  exports.MetadataUpdatedEvent = MetadataUpdatedEvent;
4200
+ var AssetUpdatedEvent = /** @class */ (function (_super) {
4201
+ __extends(AssetUpdatedEvent, _super);
4202
+ function AssetUpdatedEvent(data) {
4203
+ var _this = _super.call(this, data) || this;
4204
+ _this._discriminator = 'AssetUpdatedEvent';
4205
+ return _this;
4206
+ }
4207
+ AssetUpdatedEvent.prototype.init = function (_data) {
4208
+ _super.prototype.init.call(this, _data);
4209
+ if (_data) {
4210
+ if (Array.isArray(_data['Assets'])) {
4211
+ this.assets = [];
4212
+ for (var _i = 0, _a = _data['Assets']; _i < _a.length; _i++) {
4213
+ var item = _a[_i];
4214
+ this.assets.push(item);
4215
+ }
4216
+ }
4217
+ }
4218
+ };
4219
+ AssetUpdatedEvent.fromJS = function (data) {
4220
+ data = typeof data === 'object' ? data : {};
4221
+ var result = new AssetUpdatedEvent();
4222
+ result.init(data);
4223
+ return result;
4224
+ };
4225
+ AssetUpdatedEvent.prototype.toJSON = function (data) {
4226
+ data = typeof data === 'object' ? data : {};
4227
+ if (Array.isArray(this.assets)) {
4228
+ data['Assets'] = [];
4229
+ for (var _i = 0, _a = this.assets; _i < _a.length; _i++) {
4230
+ var item = _a[_i];
4231
+ data['Assets'].push(item);
4232
+ }
4233
+ }
4234
+ _super.prototype.toJSON.call(this, data);
4235
+ return data;
4236
+ };
4237
+ return AssetUpdatedEvent;
4238
+ }(RunnerEvent));
4239
+ exports.AssetUpdatedEvent = AssetUpdatedEvent;
@@ -1,5 +1,5 @@
1
1
  import { ConnectionOptions, Subscription, SubscriptionOptions } from 'nats.ws';
2
- import { ErrorResponse, RunnerEvent, TestPlanRunCompletedEventArgs, TestPlanRunStartEventArgs, TestStepRunCompletedEventArgs, TestStepRunStartEventArgs } from './DTOs';
2
+ import { ErrorResponse, RunnerEvent, TestPlanRunCompletedEventArgs, TestPlanRunStartEventArgs, TestStepRunCompletedEventArgs, TestStepRunStartEventArgs, AssetUpdatedEvent } from './DTOs';
3
3
  import { BaseClient } from './BaseClient';
4
4
  export interface RunnerLifetimeEvent {
5
5
  RunnerId: string;
@@ -59,4 +59,12 @@ export declare class SystemClient extends BaseClient {
59
59
  * @param {SubscriptionOptions} options?
60
60
  */
61
61
  subscribeTestPlanRunCompletedEventListener(runnerId: string, runId: string, listener: (error: ErrorResponse | null, message: TestPlanRunCompletedEventArgs | null) => void, options?: SubscriptionOptions): Subscription;
62
+ /**
63
+ * Subscribe to the asset update events for the given Runner ID.
64
+ * Wildcard can be used to receive all asset update events.
65
+ * @param {string} runnerId
66
+ * @param {(error:ErrorResponse|null,message:AssetUpdatedEvent|null)=>void} listener
67
+ * @param {SubscriptionOptions} options?
68
+ */
69
+ subscribeAssetUpdatedEvents(runnerId: string, listener: (error: ErrorResponse | null, message: AssetUpdatedEvent | null) => void, options?: SubscriptionOptions): Subscription;
62
70
  }
@@ -192,6 +192,31 @@ var SystemClient = /** @class */ (function (_super) {
192
192
  }
193
193
  } }));
194
194
  };
195
+ /**
196
+ * Subscribe to the asset update events for the given Runner ID.
197
+ * Wildcard can be used to receive all asset update events.
198
+ * @param {string} runnerId
199
+ * @param {(error:ErrorResponse|null,message:AssetUpdatedEvent|null)=>void} listener
200
+ * @param {SubscriptionOptions} options?
201
+ */
202
+ SystemClient.prototype.subscribeAssetUpdatedEvents = function (runnerId, listener, options) {
203
+ var _this = this;
204
+ var subject = "OpenTap.RunnerRegistry.".concat(runnerId, ".Events.AssetsUpdated");
205
+ return this.subscribe(subject, __assign(__assign({}, options), { callback: function (error, message) {
206
+ if (error) {
207
+ listener(_this.natsErrorHandler(error, subject), null);
208
+ return;
209
+ }
210
+ try {
211
+ var jsonCodec = (0, nats_ws_1.JSONCodec)();
212
+ var data = DTOs_1.AssetUpdatedEvent.fromJS(jsonCodec.decode(message === null || message === void 0 ? void 0 : message.data));
213
+ listener(null, data);
214
+ }
215
+ catch (error) {
216
+ listener(_this.natsErrorHandler(error, subject), null);
217
+ }
218
+ } }));
219
+ };
195
220
  return SystemClient;
196
221
  }(BaseClient_1.BaseClient));
197
222
  exports.SystemClient = SystemClient;
@@ -249,5 +249,11 @@ export declare class BaseClient {
249
249
  * @returns {Promise<string[]>}
250
250
  */
251
251
  settingsPackageTypes(): Promise<string[]>;
252
+ /**
253
+ * Dispatches a request with the given subject and returns a Promise of type T
254
+ * @param subject The subject to send the request to
255
+ * @returns Promise<T> The response from the request
256
+ */
257
+ dispatchRequest<T>(subject: string): Promise<T>;
252
258
  }
253
259
  export {};
@@ -606,4 +606,14 @@ export class BaseClient {
606
606
  settingsPackageTypes() {
607
607
  return this.request('SettingsPackageTypes').then(this.success()).catch(this.error());
608
608
  }
609
+ /**
610
+ * Dispatches a request with the given subject and returns a Promise of type T
611
+ * @param subject The subject to send the request to
612
+ * @returns Promise<T> The response from the request
613
+ */
614
+ dispatchRequest(subject) {
615
+ return __awaiter(this, void 0, void 0, function* () {
616
+ return this.request(subject);
617
+ });
618
+ }
609
619
  }
@@ -1507,3 +1507,14 @@ export interface IMetadataUpdatedEvent {
1507
1507
  [key: string]: string;
1508
1508
  } | undefined;
1509
1509
  }
1510
+ export interface IAssetUpdatedEvent extends IRunnerEvent {
1511
+ assets?: string[] | undefined;
1512
+ }
1513
+ export declare class AssetUpdatedEvent extends RunnerEvent implements IAssetUpdatedEvent {
1514
+ assets?: string[] | undefined;
1515
+ protected _discriminator: string;
1516
+ constructor(data?: IAssetUpdatedEvent);
1517
+ init(_data?: any): void;
1518
+ static fromJS(data: any): AssetUpdatedEvent;
1519
+ toJSON(data?: any): any;
1520
+ }
package/dist/mjs/DTOs.js CHANGED
@@ -3690,3 +3690,35 @@ export class MetadataUpdatedEvent {
3690
3690
  return data;
3691
3691
  }
3692
3692
  }
3693
+ export class AssetUpdatedEvent extends RunnerEvent {
3694
+ constructor(data) {
3695
+ super(data);
3696
+ this._discriminator = 'AssetUpdatedEvent';
3697
+ }
3698
+ init(_data) {
3699
+ super.init(_data);
3700
+ if (_data) {
3701
+ if (Array.isArray(_data['Assets'])) {
3702
+ this.assets = [];
3703
+ for (const item of _data['Assets'])
3704
+ this.assets.push(item);
3705
+ }
3706
+ }
3707
+ }
3708
+ static fromJS(data) {
3709
+ data = typeof data === 'object' ? data : {};
3710
+ const result = new AssetUpdatedEvent();
3711
+ result.init(data);
3712
+ return result;
3713
+ }
3714
+ toJSON(data) {
3715
+ data = typeof data === 'object' ? data : {};
3716
+ if (Array.isArray(this.assets)) {
3717
+ data['Assets'] = [];
3718
+ for (const item of this.assets)
3719
+ data['Assets'].push(item);
3720
+ }
3721
+ super.toJSON(data);
3722
+ return data;
3723
+ }
3724
+ }
@@ -1,5 +1,5 @@
1
1
  import { ConnectionOptions, Subscription, SubscriptionOptions } from 'nats.ws';
2
- import { ErrorResponse, RunnerEvent, TestPlanRunCompletedEventArgs, TestPlanRunStartEventArgs, TestStepRunCompletedEventArgs, TestStepRunStartEventArgs } from './DTOs';
2
+ import { ErrorResponse, RunnerEvent, TestPlanRunCompletedEventArgs, TestPlanRunStartEventArgs, TestStepRunCompletedEventArgs, TestStepRunStartEventArgs, AssetUpdatedEvent } from './DTOs';
3
3
  import { BaseClient } from './BaseClient';
4
4
  export interface RunnerLifetimeEvent {
5
5
  RunnerId: string;
@@ -59,4 +59,12 @@ export declare class SystemClient extends BaseClient {
59
59
  * @param {SubscriptionOptions} options?
60
60
  */
61
61
  subscribeTestPlanRunCompletedEventListener(runnerId: string, runId: string, listener: (error: ErrorResponse | null, message: TestPlanRunCompletedEventArgs | null) => void, options?: SubscriptionOptions): Subscription;
62
+ /**
63
+ * Subscribe to the asset update events for the given Runner ID.
64
+ * Wildcard can be used to receive all asset update events.
65
+ * @param {string} runnerId
66
+ * @param {(error:ErrorResponse|null,message:AssetUpdatedEvent|null)=>void} listener
67
+ * @param {SubscriptionOptions} options?
68
+ */
69
+ subscribeAssetUpdatedEvents(runnerId: string, listener: (error: ErrorResponse | null, message: AssetUpdatedEvent | null) => void, options?: SubscriptionOptions): Subscription;
62
70
  }
@@ -1,5 +1,5 @@
1
1
  import { JSONCodec } from 'nats.ws';
2
- import { RunnerEvent, TestPlanRunCompletedEventArgs, TestPlanRunStartEventArgs, TestStepRunCompletedEventArgs, TestStepRunStartEventArgs, } from './DTOs';
2
+ import { RunnerEvent, TestPlanRunCompletedEventArgs, TestPlanRunStartEventArgs, TestStepRunCompletedEventArgs, TestStepRunStartEventArgs, AssetUpdatedEvent, } from './DTOs';
3
3
  import { BaseClient } from './BaseClient';
4
4
  export class SystemClient extends BaseClient {
5
5
  constructor(baseSubject, options) {
@@ -156,4 +156,28 @@ export class SystemClient extends BaseClient {
156
156
  }
157
157
  } }));
158
158
  }
159
+ /**
160
+ * Subscribe to the asset update events for the given Runner ID.
161
+ * Wildcard can be used to receive all asset update events.
162
+ * @param {string} runnerId
163
+ * @param {(error:ErrorResponse|null,message:AssetUpdatedEvent|null)=>void} listener
164
+ * @param {SubscriptionOptions} options?
165
+ */
166
+ subscribeAssetUpdatedEvents(runnerId, listener, options) {
167
+ const subject = `OpenTap.RunnerRegistry.${runnerId}.Events.AssetsUpdated`;
168
+ return this.subscribe(subject, Object.assign(Object.assign({}, options), { callback: (error, message) => {
169
+ if (error) {
170
+ listener(this.natsErrorHandler(error, subject), null);
171
+ return;
172
+ }
173
+ try {
174
+ const jsonCodec = JSONCodec();
175
+ const data = AssetUpdatedEvent.fromJS(jsonCodec.decode(message === null || message === void 0 ? void 0 : message.data));
176
+ listener(null, data);
177
+ }
178
+ catch (error) {
179
+ listener(this.natsErrorHandler(error, subject), null);
180
+ }
181
+ } }));
182
+ }
159
183
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@opentap/runner-client",
3
- "version": "2.29.3",
3
+ "version": "2.30.0-alpha.1.1.13996074647",
4
4
  "description": "This is the web client for the OpenTAP Runner.",
5
5
  "main": "./dist/cjs/index.js",
6
6
  "module": "./dist/mjs/index.js",