@opentap/runner-client 4.9.0-beta.2.40698646911 → 4.10.0-beta.1.41599260584

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.
@@ -1649,15 +1649,25 @@ export declare class AssetUpdatedEvent extends RunnerEvent implements IAssetUpda
1649
1649
  static fromJS(data: any): AssetUpdatedEvent;
1650
1650
  toJSON(data?: any): any;
1651
1651
  }
1652
+ export interface ComponentSettingsSelector {
1653
+ groupName: string;
1654
+ name: string;
1655
+ }
1652
1656
  export interface ISaveDefaultSettings {
1653
1657
  sessionId: string;
1654
1658
  /** @deprecated Ignored by the Runner. */
1655
1659
  repository?: string;
1660
+ /** Groups to save. When both `groups` and `settings` are empty, every setting is saved. Requires Runner 2.9.0-beta.34 or later. */
1661
+ groups?: string[];
1662
+ /** Settings to save. When both `groups` and `settings` are empty, every setting is saved. Requires Runner 2.9.0-beta.34 or later. */
1663
+ settings?: ComponentSettingsSelector[];
1656
1664
  }
1657
1665
  export declare class SaveDefaultSettings implements ISaveDefaultSettings {
1658
1666
  sessionId: string;
1659
1667
  /** @deprecated Ignored by the Runner. */
1660
1668
  repository?: string;
1669
+ groups?: string[];
1670
+ settings?: ComponentSettingsSelector[];
1661
1671
  constructor(data: ISaveDefaultSettings);
1662
1672
  static fromJS(data: any): SaveDefaultSettings;
1663
1673
  toJSON(data?: any): any;
package/dist/cjs/DTOs.js CHANGED
@@ -25,6 +25,15 @@ var __rest = (this && this.__rest) || function (s, e) {
25
25
  }
26
26
  return t;
27
27
  };
28
+ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
29
+ if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
30
+ if (ar || !(i in from)) {
31
+ if (!ar) ar = Array.prototype.slice.call(from, 0, i);
32
+ ar[i] = from[i];
33
+ }
34
+ }
35
+ return to.concat(ar || Array.prototype.slice.call(from));
36
+ };
28
37
  Object.defineProperty(exports, "__esModule", { value: true });
29
38
  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.SessionConfigurationFailed = exports.SessionConfigurationSucceeded = exports.SessionConfigurationStarted = exports.SessionConfigurationProgress = exports.SessionConfigurationProgressEvent = exports.SessionConfiguration = exports.EmptyTestPlanProvision = exports.TestPlanReferenceProvision = exports.SettingsProvision = exports.AdditionalPackagesProvision = exports.ExactProvision = exports.SessionProvision = exports.Session = exports.LifecyclePolicy = exports.ImageResolveErrorResponse = exports.NoResponderError = exports.ErrorResponse = exports.PackageSpecifier = exports.Image = void 0;
30
39
  exports.ResultColumn = exports.Result = exports.LogEvent = exports.TestStepRun = 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.SessionState = exports.Verdict = exports.EditStatus = 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 = exports.SessionStartInitiated = exports.SessionEventArgs = exports.SettingsTapPackage = exports.SaveTestPlanToRepositoryResponse = exports.GetTestPlanReferenceResponse = exports.RepositorySettingsPackageDefinition = exports.RepositoryPackageDefinition = exports.RepositoryPackageReference = exports.ProfileGroup = exports.ListItemType = exports.ComponentSettings = exports.FileDescriptor = exports.Resource = exports.PluginTypeSelectorControl = exports.PictureControl = void 0;
@@ -4624,12 +4633,18 @@ var SaveDefaultSettings = /** @class */ (function () {
4624
4633
  function SaveDefaultSettings(data) {
4625
4634
  this.sessionId = data.sessionId;
4626
4635
  this.repository = data.repository;
4636
+ this.groups = data.groups;
4637
+ this.settings = data.settings;
4627
4638
  }
4628
4639
  SaveDefaultSettings.fromJS = function (data) {
4629
4640
  data = typeof data === 'object' ? data : {};
4630
4641
  var result = new SaveDefaultSettings({
4631
4642
  sessionId: data['SessionId'],
4632
4643
  repository: data['Repository'],
4644
+ groups: Array.isArray(data['Groups']) ? __spreadArray([], data['Groups'], true) : undefined,
4645
+ settings: Array.isArray(data['Settings'])
4646
+ ? data['Settings'].map(function (item) { return ({ groupName: item['GroupName'], name: item['Name'] }); })
4647
+ : undefined,
4633
4648
  });
4634
4649
  return result;
4635
4650
  };
@@ -4637,6 +4652,12 @@ var SaveDefaultSettings = /** @class */ (function () {
4637
4652
  data = typeof data === 'object' ? data : {};
4638
4653
  data['SessionId'] = this.sessionId;
4639
4654
  data['Repository'] = this.repository;
4655
+ if (Array.isArray(this.groups)) {
4656
+ data['Groups'] = __spreadArray([], this.groups, true);
4657
+ }
4658
+ if (Array.isArray(this.settings)) {
4659
+ data['Settings'] = this.settings.map(function (item) { return ({ GroupName: item.groupName, Name: item.name }); });
4660
+ }
4640
4661
  return data;
4641
4662
  };
4642
4663
  return SaveDefaultSettings;
@@ -52,7 +52,7 @@ export declare class RunnerClient extends BaseClient {
52
52
  * @param {ConfigureSessionRequest} configureSessionRequest
53
53
  * @returns {{Promise<void>}}
54
54
  */
55
- configureSession(configureSessionRequest: ConfigureSessionRequest): Promise<void>;
55
+ configureSession(configureSessionRequest: ConfigureSessionRequest, timeout?: number): Promise<void>;
56
56
  /**
57
57
  * Create a OpenTAP package configuration image from a list image inputs consisting of user specified packages and repositories.
58
58
  * @param {Image[]} images List of images
@@ -108,7 +108,7 @@ export declare class RunnerClient extends BaseClient {
108
108
  * @param {NewSessionRequest} sessionRequest
109
109
  * @returns {{Promise<Session>}}
110
110
  */
111
- newSession(sessionRequest?: NewSessionRequest): Promise<Session>;
111
+ newSession(sessionRequest?: NewSessionRequest, timeout?: number): Promise<Session>;
112
112
  /**
113
113
  * Resumes a stopped session as it is. A session that is not stopped is an error; change a session with {@link configureSession}.
114
114
  * @param {ResumeSessionRequest} resumeSessionRequest
@@ -119,7 +119,7 @@ export declare class RunnerClient extends BaseClient {
119
119
  * Start a session
120
120
  * @returns {{Promise<Session>}}
121
121
  */
122
- startSession(): Promise<Session>;
122
+ startSession(timeout?: number): Promise<Session>;
123
123
  /**
124
124
  * Get the session manager image.
125
125
  * @returns {{Promise<Image>}}
@@ -130,7 +130,7 @@ export declare class RunnerClient extends BaseClient {
130
130
  * @param imageId
131
131
  * @returns {{Promise<Session>}}
132
132
  */
133
- startImageSession(image: Image): Promise<Session>;
133
+ startImageSession(image: Image, timeout?: number): Promise<Session>;
134
134
  /**
135
135
  * Update the `Runner` plugin to the given version
136
136
  * @param runnerUpdateRequest
@@ -135,7 +135,7 @@ var RunnerClient = /** @class */ (function (_super) {
135
135
  setSettings: function (repositoryPackageReference) {
136
136
  return _this.request('SetDefaultSettings', repositoryPackageReference).then(_this.success()).catch(_this.error());
137
137
  },
138
- /* Saves the default settings in the repository. */
138
+ /* Saves the default settings in the repository. Set `groups` or `settings` to save only the selected component settings. */
139
139
  saveDefaultSettings: function (defaultSettings) {
140
140
  return _this.request('SaveDefaultSettingsInRepository', defaultSettings).then(_this.success()).catch(_this.error());
141
141
  },
@@ -205,13 +205,13 @@ var RunnerClient = /** @class */ (function (_super) {
205
205
  * @param {ConfigureSessionRequest} configureSessionRequest
206
206
  * @returns {{Promise<void>}}
207
207
  */
208
- RunnerClient.prototype.configureSession = function (configureSessionRequest) {
208
+ RunnerClient.prototype.configureSession = function (configureSessionRequest, timeout) {
209
209
  var sessionId = configureSessionRequest.sessionId, sessionConfiguration = configureSessionRequest.sessionConfiguration;
210
210
  return (sessionId === null || sessionId === void 0 ? void 0 : sessionId.length) > 0
211
211
  ? this.request('ConfigureSession', {
212
212
  SessionId: sessionId,
213
213
  SessionConfiguration: sessionConfiguration ? new DTOs_1.SessionConfiguration(sessionConfiguration) : undefined,
214
- })
214
+ }, { timeout: timeout })
215
215
  .then(this.success())
216
216
  .catch(this.error())
217
217
  : Promise.reject('sessionId is not defined');
@@ -317,8 +317,8 @@ var RunnerClient = /** @class */ (function (_super) {
317
317
  * @param {NewSessionRequest} sessionRequest
318
318
  * @returns {{Promise<Session>}}
319
319
  */
320
- RunnerClient.prototype.newSession = function (sessionRequest) {
321
- return this.request('NewSession', sessionRequest)
320
+ RunnerClient.prototype.newSession = function (sessionRequest, timeout) {
321
+ return this.request('NewSession', sessionRequest, { timeout: timeout })
322
322
  .then(function (response) { return DTOs_1.Session.fromJS(response.Session); })
323
323
  .then(this.success())
324
324
  .catch(this.error());
@@ -341,8 +341,8 @@ var RunnerClient = /** @class */ (function (_super) {
341
341
  * Start a session
342
342
  * @returns {{Promise<Session>}}
343
343
  */
344
- RunnerClient.prototype.startSession = function () {
345
- return this.request('StartSession')
344
+ RunnerClient.prototype.startSession = function (timeout) {
345
+ return this.request('StartSession', undefined, { timeout: timeout })
346
346
  .then(function (sessionJs) { return DTOs_1.Session.fromJS(sessionJs); })
347
347
  .then(this.success())
348
348
  .catch(this.error());
@@ -362,9 +362,9 @@ var RunnerClient = /** @class */ (function (_super) {
362
362
  * @param imageId
363
363
  * @returns {{Promise<Session>}}
364
364
  */
365
- RunnerClient.prototype.startImageSession = function (image) {
365
+ RunnerClient.prototype.startImageSession = function (image, timeout) {
366
366
  return image
367
- ? this.request('StartImageSession', image)
367
+ ? this.request('StartImageSession', image, { timeout: timeout })
368
368
  .then(function (sessionJs) { return DTOs_1.Session.fromJS(sessionJs); })
369
369
  .then(this.success())
370
370
  .catch(this.error())
@@ -1,4 +1,4 @@
1
- import { CommonContext, ComponentSettingsBase, ComponentSettingsListItem, DataGridControl, Image, ISessionConfiguration, LifecyclePolicy, Parameter, RepositoryPackageDefinition, RepositoryPackageReference, SessionConfiguration, Setting, WatchDog } from './DTOs';
1
+ import { CommonContext, ComponentSettingsBase, ComponentSettingsListItem, ComponentSettingsSelector, DataGridControl, Image, ISessionConfiguration, LifecyclePolicy, Parameter, RepositoryPackageDefinition, RepositoryPackageReference, SessionConfiguration, Setting, WatchDog } from './DTOs';
2
2
  export interface DefaultSessionRequest {
3
3
  imageOverride: Image | null;
4
4
  testPlanReference: RepositoryPackageReference | null;
@@ -100,10 +100,6 @@ export interface SaveSelectedComponentSettingsRequest {
100
100
  groups?: string[];
101
101
  settings?: ComponentSettingsSelector[];
102
102
  }
103
- export interface ComponentSettingsSelector {
104
- groupName: string;
105
- name: string;
106
- }
107
103
  type ShutdownMode = 'Graceful' | 'Force';
108
104
  export interface DeleteSessionRequest {
109
105
  sessionId: string;
@@ -1649,15 +1649,25 @@ export declare class AssetUpdatedEvent extends RunnerEvent implements IAssetUpda
1649
1649
  static fromJS(data: any): AssetUpdatedEvent;
1650
1650
  toJSON(data?: any): any;
1651
1651
  }
1652
+ export interface ComponentSettingsSelector {
1653
+ groupName: string;
1654
+ name: string;
1655
+ }
1652
1656
  export interface ISaveDefaultSettings {
1653
1657
  sessionId: string;
1654
1658
  /** @deprecated Ignored by the Runner. */
1655
1659
  repository?: string;
1660
+ /** Groups to save. When both `groups` and `settings` are empty, every setting is saved. Requires Runner 2.9.0-beta.34 or later. */
1661
+ groups?: string[];
1662
+ /** Settings to save. When both `groups` and `settings` are empty, every setting is saved. Requires Runner 2.9.0-beta.34 or later. */
1663
+ settings?: ComponentSettingsSelector[];
1656
1664
  }
1657
1665
  export declare class SaveDefaultSettings implements ISaveDefaultSettings {
1658
1666
  sessionId: string;
1659
1667
  /** @deprecated Ignored by the Runner. */
1660
1668
  repository?: string;
1669
+ groups?: string[];
1670
+ settings?: ComponentSettingsSelector[];
1661
1671
  constructor(data: ISaveDefaultSettings);
1662
1672
  static fromJS(data: any): SaveDefaultSettings;
1663
1673
  toJSON(data?: any): any;
package/dist/mjs/DTOs.js CHANGED
@@ -4066,12 +4066,18 @@ export class SaveDefaultSettings {
4066
4066
  constructor(data) {
4067
4067
  this.sessionId = data.sessionId;
4068
4068
  this.repository = data.repository;
4069
+ this.groups = data.groups;
4070
+ this.settings = data.settings;
4069
4071
  }
4070
4072
  static fromJS(data) {
4071
4073
  data = typeof data === 'object' ? data : {};
4072
4074
  const result = new SaveDefaultSettings({
4073
4075
  sessionId: data['SessionId'],
4074
4076
  repository: data['Repository'],
4077
+ groups: Array.isArray(data['Groups']) ? [...data['Groups']] : undefined,
4078
+ settings: Array.isArray(data['Settings'])
4079
+ ? data['Settings'].map((item) => ({ groupName: item['GroupName'], name: item['Name'] }))
4080
+ : undefined,
4075
4081
  });
4076
4082
  return result;
4077
4083
  }
@@ -4079,6 +4085,12 @@ export class SaveDefaultSettings {
4079
4085
  data = typeof data === 'object' ? data : {};
4080
4086
  data['SessionId'] = this.sessionId;
4081
4087
  data['Repository'] = this.repository;
4088
+ if (Array.isArray(this.groups)) {
4089
+ data['Groups'] = [...this.groups];
4090
+ }
4091
+ if (Array.isArray(this.settings)) {
4092
+ data['Settings'] = this.settings.map(item => ({ GroupName: item.groupName, Name: item.name }));
4093
+ }
4082
4094
  return data;
4083
4095
  }
4084
4096
  }
@@ -52,7 +52,7 @@ export declare class RunnerClient extends BaseClient {
52
52
  * @param {ConfigureSessionRequest} configureSessionRequest
53
53
  * @returns {{Promise<void>}}
54
54
  */
55
- configureSession(configureSessionRequest: ConfigureSessionRequest): Promise<void>;
55
+ configureSession(configureSessionRequest: ConfigureSessionRequest, timeout?: number): Promise<void>;
56
56
  /**
57
57
  * Create a OpenTAP package configuration image from a list image inputs consisting of user specified packages and repositories.
58
58
  * @param {Image[]} images List of images
@@ -108,7 +108,7 @@ export declare class RunnerClient extends BaseClient {
108
108
  * @param {NewSessionRequest} sessionRequest
109
109
  * @returns {{Promise<Session>}}
110
110
  */
111
- newSession(sessionRequest?: NewSessionRequest): Promise<Session>;
111
+ newSession(sessionRequest?: NewSessionRequest, timeout?: number): Promise<Session>;
112
112
  /**
113
113
  * Resumes a stopped session as it is. A session that is not stopped is an error; change a session with {@link configureSession}.
114
114
  * @param {ResumeSessionRequest} resumeSessionRequest
@@ -119,7 +119,7 @@ export declare class RunnerClient extends BaseClient {
119
119
  * Start a session
120
120
  * @returns {{Promise<Session>}}
121
121
  */
122
- startSession(): Promise<Session>;
122
+ startSession(timeout?: number): Promise<Session>;
123
123
  /**
124
124
  * Get the session manager image.
125
125
  * @returns {{Promise<Image>}}
@@ -130,7 +130,7 @@ export declare class RunnerClient extends BaseClient {
130
130
  * @param imageId
131
131
  * @returns {{Promise<Session>}}
132
132
  */
133
- startImageSession(image: Image): Promise<Session>;
133
+ startImageSession(image: Image, timeout?: number): Promise<Session>;
134
134
  /**
135
135
  * Update the `Runner` plugin to the given version
136
136
  * @param runnerUpdateRequest
@@ -76,7 +76,7 @@ export class RunnerClient extends BaseClient {
76
76
  setSettings: (repositoryPackageReference) => {
77
77
  return this.request('SetDefaultSettings', repositoryPackageReference).then(this.success()).catch(this.error());
78
78
  },
79
- /* Saves the default settings in the repository. */
79
+ /* Saves the default settings in the repository. Set `groups` or `settings` to save only the selected component settings. */
80
80
  saveDefaultSettings: (defaultSettings) => {
81
81
  return this.request('SaveDefaultSettingsInRepository', defaultSettings).then(this.success()).catch(this.error());
82
82
  },
@@ -145,13 +145,13 @@ export class RunnerClient extends BaseClient {
145
145
  * @param {ConfigureSessionRequest} configureSessionRequest
146
146
  * @returns {{Promise<void>}}
147
147
  */
148
- configureSession(configureSessionRequest) {
148
+ configureSession(configureSessionRequest, timeout) {
149
149
  const { sessionId, sessionConfiguration } = configureSessionRequest;
150
150
  return (sessionId === null || sessionId === void 0 ? void 0 : sessionId.length) > 0
151
151
  ? this.request('ConfigureSession', {
152
152
  SessionId: sessionId,
153
153
  SessionConfiguration: sessionConfiguration ? new SessionConfiguration(sessionConfiguration) : undefined,
154
- })
154
+ }, { timeout })
155
155
  .then(this.success())
156
156
  .catch(this.error())
157
157
  : Promise.reject('sessionId is not defined');
@@ -178,7 +178,7 @@ export class RunnerClient extends BaseClient {
178
178
  */
179
179
  resolveImageDryRun(images, timeout) {
180
180
  return (images === null || images === void 0 ? void 0 : images.length) > 0
181
- ? this.request('ResolveImageDryRun', images, { timeout: timeout })
181
+ ? this.request('ResolveImageDryRun', images, { timeout })
182
182
  .then(imageJs => Image.fromJS(imageJs))
183
183
  .then(this.success())
184
184
  .catch(this.error())
@@ -256,8 +256,8 @@ export class RunnerClient extends BaseClient {
256
256
  * @param {NewSessionRequest} sessionRequest
257
257
  * @returns {{Promise<Session>}}
258
258
  */
259
- newSession(sessionRequest) {
260
- return this.request('NewSession', sessionRequest)
259
+ newSession(sessionRequest, timeout) {
260
+ return this.request('NewSession', sessionRequest, { timeout })
261
261
  .then(response => Session.fromJS(response.Session))
262
262
  .then(this.success())
263
263
  .catch(this.error());
@@ -280,8 +280,8 @@ export class RunnerClient extends BaseClient {
280
280
  * Start a session
281
281
  * @returns {{Promise<Session>}}
282
282
  */
283
- startSession() {
284
- return this.request('StartSession')
283
+ startSession(timeout) {
284
+ return this.request('StartSession', undefined, { timeout })
285
285
  .then(sessionJs => Session.fromJS(sessionJs))
286
286
  .then(this.success())
287
287
  .catch(this.error());
@@ -301,9 +301,9 @@ export class RunnerClient extends BaseClient {
301
301
  * @param imageId
302
302
  * @returns {{Promise<Session>}}
303
303
  */
304
- startImageSession(image) {
304
+ startImageSession(image, timeout) {
305
305
  return image
306
- ? this.request('StartImageSession', image)
306
+ ? this.request('StartImageSession', image, { timeout })
307
307
  .then(sessionJs => Session.fromJS(sessionJs))
308
308
  .then(this.success())
309
309
  .catch(this.error())
@@ -1,4 +1,4 @@
1
- import { CommonContext, ComponentSettingsBase, ComponentSettingsListItem, DataGridControl, Image, ISessionConfiguration, LifecyclePolicy, Parameter, RepositoryPackageDefinition, RepositoryPackageReference, SessionConfiguration, Setting, WatchDog } from './DTOs';
1
+ import { CommonContext, ComponentSettingsBase, ComponentSettingsListItem, ComponentSettingsSelector, DataGridControl, Image, ISessionConfiguration, LifecyclePolicy, Parameter, RepositoryPackageDefinition, RepositoryPackageReference, SessionConfiguration, Setting, WatchDog } from './DTOs';
2
2
  export interface DefaultSessionRequest {
3
3
  imageOverride: Image | null;
4
4
  testPlanReference: RepositoryPackageReference | null;
@@ -100,10 +100,6 @@ export interface SaveSelectedComponentSettingsRequest {
100
100
  groups?: string[];
101
101
  settings?: ComponentSettingsSelector[];
102
102
  }
103
- export interface ComponentSettingsSelector {
104
- groupName: string;
105
- name: string;
106
- }
107
103
  type ShutdownMode = 'Graceful' | 'Force';
108
104
  export interface DeleteSessionRequest {
109
105
  sessionId: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@opentap/runner-client",
3
- "version": "4.9.0-beta.2.40698646911",
3
+ "version": "4.10.0-beta.1.41599260584",
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",