@opentap/runner-client 1.0.0-beta.54 → 1.0.0-beta.55
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.
- package/lib/BaseClient.d.ts +155 -0
- package/lib/BaseClient.js +295 -0
- package/lib/RunnerClient.d.ts +1 -114
- package/lib/RunnerClient.js +8 -1070
- package/lib/SessionClient.d.ts +52 -332
- package/lib/SessionClient.js +288 -4831
- package/lib/requestDTOs.d.ts +70 -70
- package/lib/requestDTOs.js +1 -131
- package/package.json +2 -9
package/lib/BaseClient.d.ts
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { RequestOptions } from 'nats.ws';
|
|
2
|
+
import { ComponentSettingsBase, ComponentSettingsIdentifier, ComponentSettingsListItem, DataGridControl, ErrorResponse, FileParameter, FileResponse, ListItemType, ProfileGroup, RepositoryPackageReference, RepositorySettingsPackageDefinition, SettingsTapPackage } from './DTOs';
|
|
2
3
|
export declare class BaseClient {
|
|
3
4
|
private _accessToken;
|
|
4
5
|
/** Get access token */
|
|
@@ -41,4 +42,158 @@ export declare class BaseClient {
|
|
|
41
42
|
* @param accessToken
|
|
42
43
|
*/
|
|
43
44
|
protected setDomainAccessToken(domain: string, accessToken: string): void;
|
|
45
|
+
/**
|
|
46
|
+
* Generic error callback function.
|
|
47
|
+
* @returns
|
|
48
|
+
*/
|
|
49
|
+
protected error(): ((reason: any) => PromiseLike<never>) | null | undefined;
|
|
50
|
+
/**
|
|
51
|
+
* Generic success callback function.
|
|
52
|
+
* @returns
|
|
53
|
+
*/
|
|
54
|
+
protected success<T>(): ((value: T) => T | PromiseLike<T>) | null | undefined;
|
|
55
|
+
/**
|
|
56
|
+
* Retrieve component settings overview
|
|
57
|
+
* @returns {{Promise<ComponentSettingsIdentifier[]>}}
|
|
58
|
+
*/
|
|
59
|
+
getComponentSettingsOverview(): Promise<ComponentSettingsIdentifier[]>;
|
|
60
|
+
/**
|
|
61
|
+
* Change componentsettings
|
|
62
|
+
* @param groupName
|
|
63
|
+
* @param name
|
|
64
|
+
* @param returnedSettings
|
|
65
|
+
* @returns {{Promise<ComponentSettingsBase>}}
|
|
66
|
+
*/
|
|
67
|
+
setComponentSettings(groupName: string, name: string, returnedSettings: ComponentSettingsBase): Promise<ComponentSettingsBase>;
|
|
68
|
+
/**
|
|
69
|
+
* Retrieve componentsettings
|
|
70
|
+
* @param groupName
|
|
71
|
+
* @param name
|
|
72
|
+
* @returns {{Promise<ComponentSettingsBase>}}
|
|
73
|
+
*/
|
|
74
|
+
getComponentSettings(groupName: string, name: string): Promise<ComponentSettingsBase>;
|
|
75
|
+
/**
|
|
76
|
+
* Retrieve componentsettings list item
|
|
77
|
+
* @param groupName
|
|
78
|
+
* @param name
|
|
79
|
+
* @param index
|
|
80
|
+
* @returns {{Promise<ComponentSettingsListItem>}}
|
|
81
|
+
*/
|
|
82
|
+
getComponentSettingsListItem(groupName: string, name: string, index: number): Promise<ComponentSettingsListItem>;
|
|
83
|
+
/**
|
|
84
|
+
* Set componentsettings list item settings
|
|
85
|
+
* @param {string} groupName
|
|
86
|
+
* @param {string} name
|
|
87
|
+
* @param {number} index
|
|
88
|
+
* @param {ComponentSettingsListItem} item
|
|
89
|
+
* @returns {Promise<ComponentSettingsListItem>}
|
|
90
|
+
*/
|
|
91
|
+
setComponentSettingsListItem(groupName: string, name: string, index: number, item: ComponentSettingsListItem): Promise<ComponentSettingsListItem>;
|
|
92
|
+
/**
|
|
93
|
+
* Get component setting data grid
|
|
94
|
+
* @param {string} groupName
|
|
95
|
+
* @param {string} name
|
|
96
|
+
* @param {number} index
|
|
97
|
+
* @param {string} propertyName
|
|
98
|
+
* @returns {Promise<DataGridControl>}
|
|
99
|
+
*/
|
|
100
|
+
getComponentSettingDataGrid(groupName: string, name: string, index: number, propertyName: string): Promise<DataGridControl>;
|
|
101
|
+
/**
|
|
102
|
+
* Set component setting data grid
|
|
103
|
+
* @param {string} groupName
|
|
104
|
+
* @param {string} name
|
|
105
|
+
* @param {number} index
|
|
106
|
+
* @param {string} propertyName
|
|
107
|
+
* @param {DataGridControl} dataGridControl
|
|
108
|
+
* @returns {{Promise<DataGridControl>}}
|
|
109
|
+
*/
|
|
110
|
+
setComponentSettingDataGrid(groupName: string, name: string, index: number, propertyName: string, dataGridControl: DataGridControl): Promise<DataGridControl>;
|
|
111
|
+
/**
|
|
112
|
+
* Add component setting item type to data grid
|
|
113
|
+
* @param {string} groupName
|
|
114
|
+
* @param {string} name
|
|
115
|
+
* @param {number} index
|
|
116
|
+
* @param {string} propertyName
|
|
117
|
+
* @param {string} typeName
|
|
118
|
+
* @returns {Promise<DataGridControl>}
|
|
119
|
+
*/
|
|
120
|
+
addComponentSettingDataGridItemType(groupName: string, name: string, index: number, propertyName: string, typeName: string): Promise<DataGridControl>;
|
|
121
|
+
/**
|
|
122
|
+
* Add component setting item to data grid
|
|
123
|
+
* @param {string} groupName
|
|
124
|
+
* @param {string} name
|
|
125
|
+
* @param {number} index
|
|
126
|
+
* @param {string} propertyName
|
|
127
|
+
* @returns {Promise<DataGridControl>}
|
|
128
|
+
*/
|
|
129
|
+
addComponentSettingDataGridItem(groupName: string, name: string, index: number, propertyName: string): Promise<DataGridControl>;
|
|
130
|
+
/**
|
|
131
|
+
* Get item types available in the component setting data grid
|
|
132
|
+
* @param groupName
|
|
133
|
+
* @param name
|
|
134
|
+
* @param index
|
|
135
|
+
* @param propertyName
|
|
136
|
+
* @returns {Promise<ListItemType[]>}
|
|
137
|
+
*/
|
|
138
|
+
getComponentSettingDataGridTypes(groupName: string, name: string, index: number, propertyName: string): Promise<ListItemType[]>;
|
|
139
|
+
/**
|
|
140
|
+
* Change componentsettings profiles
|
|
141
|
+
* @param {ProfileGroup[]} returnedSettings
|
|
142
|
+
* @returns {Promise<ProfileGroup[]>}
|
|
143
|
+
*/
|
|
144
|
+
setComponentSettingsProfiles(returnedSettings: ProfileGroup[]): Promise<ProfileGroup[]>;
|
|
145
|
+
/**
|
|
146
|
+
* Get componentsettings profiles
|
|
147
|
+
* @returns {Promise<ProfileGroup[]>}
|
|
148
|
+
*/
|
|
149
|
+
getComponentSettingsProfiles(): Promise<ProfileGroup[]>;
|
|
150
|
+
/**
|
|
151
|
+
* Upload exported OpenTAP Settings files
|
|
152
|
+
* @param {FileParameter} file
|
|
153
|
+
* @returns {Promise<void>}
|
|
154
|
+
*/
|
|
155
|
+
uploadComponentSettings(file: FileParameter): Promise<void>;
|
|
156
|
+
/**
|
|
157
|
+
* Load a component settings TapPackage by referencing a package in a package repository
|
|
158
|
+
* @param {RepositoryPackageReference} packageReference
|
|
159
|
+
* @returns {Promise<ErrorResponse[]>}
|
|
160
|
+
*/
|
|
161
|
+
loadComponentSettingsFromRepository(packageReference: RepositoryPackageReference): Promise<ErrorResponse[]>;
|
|
162
|
+
/**
|
|
163
|
+
* Save a TapPackage containing component settings in a package repository
|
|
164
|
+
* @param {RepositorySettingsPackageDefinition} repositoryPackageDefinition
|
|
165
|
+
* @returns {Promise<void>}
|
|
166
|
+
*/
|
|
167
|
+
saveComponentSettingsToRepository(repositoryPackageDefinition: RepositorySettingsPackageDefinition): Promise<void>;
|
|
168
|
+
/**
|
|
169
|
+
* Retrieve types available to be added to specified component settings list
|
|
170
|
+
* @param {string} groupName
|
|
171
|
+
* @param {string} name
|
|
172
|
+
* @returns {Promise<ListItemType[]>}
|
|
173
|
+
*/
|
|
174
|
+
getComponentSettingsListAvailableTypes(groupName: string, name: string): Promise<ListItemType[]>;
|
|
175
|
+
/**
|
|
176
|
+
* Adds a new item to a component settings list
|
|
177
|
+
* @param {string} groupName
|
|
178
|
+
* @param {string} name
|
|
179
|
+
* @param {string} typeName
|
|
180
|
+
* @returns {Promise<ListItemType[]>}
|
|
181
|
+
*/
|
|
182
|
+
addComponentSettingsListItem(groupName: string, name: string, typeName: string): Promise<ListItemType[]>;
|
|
183
|
+
/**
|
|
184
|
+
* Get settings package files
|
|
185
|
+
* @returns {Promise<string[]>}
|
|
186
|
+
*/
|
|
187
|
+
getSettingsPackageFiles(): Promise<string[]>;
|
|
188
|
+
/**
|
|
189
|
+
* Get settings package types
|
|
190
|
+
* @returns {Promise<string[]>}
|
|
191
|
+
*/
|
|
192
|
+
settingsPackageTypes(): Promise<string[]>;
|
|
193
|
+
/**
|
|
194
|
+
* Download a TapPackage containing settings files
|
|
195
|
+
* @param {SettingsPackage} settingsTapPackage
|
|
196
|
+
* @returns {Promise<FileResponse>}
|
|
197
|
+
*/
|
|
198
|
+
downloadSettingsPackage(settingsTapPackage: SettingsTapPackage): Promise<FileResponse>;
|
|
44
199
|
}
|
package/lib/BaseClient.js
CHANGED
|
@@ -176,6 +176,301 @@ var BaseClient = /** @class */ (function () {
|
|
|
176
176
|
return;
|
|
177
177
|
this.domainAccess.set(domain, accessToken);
|
|
178
178
|
};
|
|
179
|
+
/**
|
|
180
|
+
* Generic error callback function.
|
|
181
|
+
* @returns
|
|
182
|
+
*/
|
|
183
|
+
BaseClient.prototype.error = function () {
|
|
184
|
+
return function (error) {
|
|
185
|
+
throw new Error(error);
|
|
186
|
+
};
|
|
187
|
+
};
|
|
188
|
+
/**
|
|
189
|
+
* Generic success callback function.
|
|
190
|
+
* @returns
|
|
191
|
+
*/
|
|
192
|
+
BaseClient.prototype.success = function () {
|
|
193
|
+
return function (response) { return response; };
|
|
194
|
+
};
|
|
195
|
+
/**
|
|
196
|
+
* Retrieve component settings overview
|
|
197
|
+
* @returns {{Promise<ComponentSettingsIdentifier[]>}}
|
|
198
|
+
*/
|
|
199
|
+
BaseClient.prototype.getComponentSettingsOverview = function () {
|
|
200
|
+
return this.request('GetComponentSettingsOverview').then(this.success()).catch(this.error());
|
|
201
|
+
};
|
|
202
|
+
/**
|
|
203
|
+
* Change componentsettings
|
|
204
|
+
* @param groupName
|
|
205
|
+
* @param name
|
|
206
|
+
* @param returnedSettings
|
|
207
|
+
* @returns {{Promise<ComponentSettingsBase>}}
|
|
208
|
+
*/
|
|
209
|
+
BaseClient.prototype.setComponentSettings = function (groupName, name, returnedSettings) {
|
|
210
|
+
var setComponentSettingsRequest = { groupName: groupName, name: name, returnedSettings: returnedSettings };
|
|
211
|
+
return groupName && name && returnedSettings
|
|
212
|
+
? this.request('SetComponentSettings', setComponentSettingsRequest)
|
|
213
|
+
.then(this.success())
|
|
214
|
+
.catch(this.error())
|
|
215
|
+
: Promise.reject('all parameters must be defined');
|
|
216
|
+
};
|
|
217
|
+
/**
|
|
218
|
+
* Retrieve componentsettings
|
|
219
|
+
* @param groupName
|
|
220
|
+
* @param name
|
|
221
|
+
* @returns {{Promise<ComponentSettingsBase>}}
|
|
222
|
+
*/
|
|
223
|
+
BaseClient.prototype.getComponentSettings = function (groupName, name) {
|
|
224
|
+
var getComponentSettingsRequest = { groupName: groupName, name: name };
|
|
225
|
+
return groupName && name
|
|
226
|
+
? this.request('GetComponentSettings', getComponentSettingsRequest)
|
|
227
|
+
.then(this.success())
|
|
228
|
+
.catch(this.error())
|
|
229
|
+
: Promise.reject('all parameters must be defined');
|
|
230
|
+
};
|
|
231
|
+
/**
|
|
232
|
+
* Retrieve componentsettings list item
|
|
233
|
+
* @param groupName
|
|
234
|
+
* @param name
|
|
235
|
+
* @param index
|
|
236
|
+
* @returns {{Promise<ComponentSettingsListItem>}}
|
|
237
|
+
*/
|
|
238
|
+
BaseClient.prototype.getComponentSettingsListItem = function (groupName, name, index) {
|
|
239
|
+
var getComponentSettingsListItemRequest = { groupName: groupName, name: name, index: index };
|
|
240
|
+
return groupName && name
|
|
241
|
+
? this.request('GetComponentSettingsListItem', getComponentSettingsListItemRequest)
|
|
242
|
+
.then(this.success())
|
|
243
|
+
.catch(this.error())
|
|
244
|
+
: Promise.reject('all parameters must be defined');
|
|
245
|
+
};
|
|
246
|
+
/**
|
|
247
|
+
* Set componentsettings list item settings
|
|
248
|
+
* @param {string} groupName
|
|
249
|
+
* @param {string} name
|
|
250
|
+
* @param {number} index
|
|
251
|
+
* @param {ComponentSettingsListItem} item
|
|
252
|
+
* @returns {Promise<ComponentSettingsListItem>}
|
|
253
|
+
*/
|
|
254
|
+
BaseClient.prototype.setComponentSettingsListItem = function (groupName, name, index, item) {
|
|
255
|
+
var setComponentSettingsListItemRequest = { groupName: groupName, name: name, index: index, item: item };
|
|
256
|
+
return groupName && name && item
|
|
257
|
+
? this.request('SetComponentSettingsListItem', setComponentSettingsListItemRequest)
|
|
258
|
+
.then(this.success())
|
|
259
|
+
.catch(this.error())
|
|
260
|
+
: Promise.reject('all parameters must be defined');
|
|
261
|
+
};
|
|
262
|
+
/**
|
|
263
|
+
* Get component setting data grid
|
|
264
|
+
* @param {string} groupName
|
|
265
|
+
* @param {string} name
|
|
266
|
+
* @param {number} index
|
|
267
|
+
* @param {string} propertyName
|
|
268
|
+
* @returns {Promise<DataGridControl>}
|
|
269
|
+
*/
|
|
270
|
+
BaseClient.prototype.getComponentSettingDataGrid = function (groupName, name, index, propertyName) {
|
|
271
|
+
var getComponentSettingDataGridRequest = {
|
|
272
|
+
groupName: groupName,
|
|
273
|
+
name: name,
|
|
274
|
+
index: index,
|
|
275
|
+
propertyName: propertyName,
|
|
276
|
+
};
|
|
277
|
+
return groupName && name && propertyName
|
|
278
|
+
? this.request('GetComponentSettingDataGrid', getComponentSettingDataGridRequest)
|
|
279
|
+
.then(this.success())
|
|
280
|
+
.catch(this.error())
|
|
281
|
+
: Promise.reject('all parameters must be defined');
|
|
282
|
+
};
|
|
283
|
+
/**
|
|
284
|
+
* Set component setting data grid
|
|
285
|
+
* @param {string} groupName
|
|
286
|
+
* @param {string} name
|
|
287
|
+
* @param {number} index
|
|
288
|
+
* @param {string} propertyName
|
|
289
|
+
* @param {DataGridControl} dataGridControl
|
|
290
|
+
* @returns {{Promise<DataGridControl>}}
|
|
291
|
+
*/
|
|
292
|
+
BaseClient.prototype.setComponentSettingDataGrid = function (groupName, name, index, propertyName, dataGridControl) {
|
|
293
|
+
var setComponentSettingDataGridRequest = {
|
|
294
|
+
groupName: groupName,
|
|
295
|
+
name: name,
|
|
296
|
+
index: index,
|
|
297
|
+
propertyName: propertyName,
|
|
298
|
+
dataGridControl: dataGridControl,
|
|
299
|
+
};
|
|
300
|
+
return groupName && name && propertyName && dataGridControl
|
|
301
|
+
? this.request('SetComponentSettingDataGrid', setComponentSettingDataGridRequest)
|
|
302
|
+
.then(this.success())
|
|
303
|
+
.catch(this.error())
|
|
304
|
+
: Promise.reject('all parameters must be defined');
|
|
305
|
+
};
|
|
306
|
+
/**
|
|
307
|
+
* Add component setting item type to data grid
|
|
308
|
+
* @param {string} groupName
|
|
309
|
+
* @param {string} name
|
|
310
|
+
* @param {number} index
|
|
311
|
+
* @param {string} propertyName
|
|
312
|
+
* @param {string} typeName
|
|
313
|
+
* @returns {Promise<DataGridControl>}
|
|
314
|
+
*/
|
|
315
|
+
BaseClient.prototype.addComponentSettingDataGridItemType = function (groupName, name, index, propertyName, typeName) {
|
|
316
|
+
var addComponentSettingDataGridItemTypeRequest = {
|
|
317
|
+
groupName: groupName,
|
|
318
|
+
name: name,
|
|
319
|
+
index: index,
|
|
320
|
+
propertyName: propertyName,
|
|
321
|
+
typeName: typeName,
|
|
322
|
+
};
|
|
323
|
+
return groupName && name && propertyName && typeName
|
|
324
|
+
? this.request('AddComponentSettingDataGridItemType', addComponentSettingDataGridItemTypeRequest)
|
|
325
|
+
.then(this.success())
|
|
326
|
+
.catch(this.error())
|
|
327
|
+
: Promise.reject('all parameters must be defined');
|
|
328
|
+
};
|
|
329
|
+
/**
|
|
330
|
+
* Add component setting item to data grid
|
|
331
|
+
* @param {string} groupName
|
|
332
|
+
* @param {string} name
|
|
333
|
+
* @param {number} index
|
|
334
|
+
* @param {string} propertyName
|
|
335
|
+
* @returns {Promise<DataGridControl>}
|
|
336
|
+
*/
|
|
337
|
+
BaseClient.prototype.addComponentSettingDataGridItem = function (groupName, name, index, propertyName) {
|
|
338
|
+
var getComponentSettingDataGridRequest = {
|
|
339
|
+
groupName: groupName,
|
|
340
|
+
name: name,
|
|
341
|
+
index: index,
|
|
342
|
+
propertyName: propertyName,
|
|
343
|
+
};
|
|
344
|
+
return groupName && name && propertyName
|
|
345
|
+
? this.request('AddComponentSettingDataGridItem', getComponentSettingDataGridRequest)
|
|
346
|
+
.then(this.success())
|
|
347
|
+
.catch(this.error())
|
|
348
|
+
: Promise.reject('all parameters must be defined');
|
|
349
|
+
};
|
|
350
|
+
/**
|
|
351
|
+
* Get item types available in the component setting data grid
|
|
352
|
+
* @param groupName
|
|
353
|
+
* @param name
|
|
354
|
+
* @param index
|
|
355
|
+
* @param propertyName
|
|
356
|
+
* @returns {Promise<ListItemType[]>}
|
|
357
|
+
*/
|
|
358
|
+
BaseClient.prototype.getComponentSettingDataGridTypes = function (groupName, name, index, propertyName) {
|
|
359
|
+
var getComponentSettingDataGridRequest = {
|
|
360
|
+
groupName: groupName,
|
|
361
|
+
name: name,
|
|
362
|
+
index: index,
|
|
363
|
+
propertyName: propertyName,
|
|
364
|
+
};
|
|
365
|
+
return groupName && name && propertyName
|
|
366
|
+
? this.request('GetComponentSettingDataGridTypes', getComponentSettingDataGridRequest)
|
|
367
|
+
.then(this.success())
|
|
368
|
+
.catch(this.error())
|
|
369
|
+
: Promise.reject('all parameters must be defined');
|
|
370
|
+
};
|
|
371
|
+
/**
|
|
372
|
+
* Change componentsettings profiles
|
|
373
|
+
* @param {ProfileGroup[]} returnedSettings
|
|
374
|
+
* @returns {Promise<ProfileGroup[]>}
|
|
375
|
+
*/
|
|
376
|
+
BaseClient.prototype.setComponentSettingsProfiles = function (returnedSettings) {
|
|
377
|
+
return returnedSettings
|
|
378
|
+
? this.request('SetComponentSettingsProfiles', returnedSettings).then(this.success()).catch(this.error())
|
|
379
|
+
: Promise.reject('returnedSettings must be defined');
|
|
380
|
+
};
|
|
381
|
+
/**
|
|
382
|
+
* Get componentsettings profiles
|
|
383
|
+
* @returns {Promise<ProfileGroup[]>}
|
|
384
|
+
*/
|
|
385
|
+
BaseClient.prototype.getComponentSettingsProfiles = function () {
|
|
386
|
+
return this.request('GetComponentSettingsProfiles').then(this.success()).catch(this.error());
|
|
387
|
+
};
|
|
388
|
+
/**
|
|
389
|
+
* Upload exported OpenTAP Settings files
|
|
390
|
+
* @param {FileParameter} file
|
|
391
|
+
* @returns {Promise<void>}
|
|
392
|
+
*/
|
|
393
|
+
BaseClient.prototype.uploadComponentSettings = function (file) {
|
|
394
|
+
var uploadFileRequest = { file: file, fileName: file === null || file === void 0 ? void 0 : file.fileName };
|
|
395
|
+
return file
|
|
396
|
+
? this.request('UploadComponentSettings', uploadFileRequest).then(this.success()).catch(this.error())
|
|
397
|
+
: Promise.reject('file must be defined');
|
|
398
|
+
};
|
|
399
|
+
/**
|
|
400
|
+
* Load a component settings TapPackage by referencing a package in a package repository
|
|
401
|
+
* @param {RepositoryPackageReference} packageReference
|
|
402
|
+
* @returns {Promise<ErrorResponse[]>}
|
|
403
|
+
*/
|
|
404
|
+
BaseClient.prototype.loadComponentSettingsFromRepository = function (packageReference) {
|
|
405
|
+
return packageReference
|
|
406
|
+
? this.request('LoadComponentSettingsFromRepository', packageReference)
|
|
407
|
+
.then(this.success())
|
|
408
|
+
.catch(this.error())
|
|
409
|
+
: Promise.reject('packageReference must be defined');
|
|
410
|
+
};
|
|
411
|
+
/**
|
|
412
|
+
* Save a TapPackage containing component settings in a package repository
|
|
413
|
+
* @param {RepositorySettingsPackageDefinition} repositoryPackageDefinition
|
|
414
|
+
* @returns {Promise<void>}
|
|
415
|
+
*/
|
|
416
|
+
BaseClient.prototype.saveComponentSettingsToRepository = function (repositoryPackageDefinition) {
|
|
417
|
+
return repositoryPackageDefinition
|
|
418
|
+
? this.request('SaveComponentSettingsToRepository', repositoryPackageDefinition).then(this.success()).catch(this.error())
|
|
419
|
+
: Promise.reject('repositoryPackageDefinition must be defined');
|
|
420
|
+
};
|
|
421
|
+
/**
|
|
422
|
+
* Retrieve types available to be added to specified component settings list
|
|
423
|
+
* @param {string} groupName
|
|
424
|
+
* @param {string} name
|
|
425
|
+
* @returns {Promise<ListItemType[]>}
|
|
426
|
+
*/
|
|
427
|
+
BaseClient.prototype.getComponentSettingsListAvailableTypes = function (groupName, name) {
|
|
428
|
+
var getComponentSettingsRequest = { groupName: groupName, name: name };
|
|
429
|
+
return groupName && name
|
|
430
|
+
? this.request('GetComponentSettingsListAvailableTypes', getComponentSettingsRequest)
|
|
431
|
+
.then(this.success())
|
|
432
|
+
.catch(this.error())
|
|
433
|
+
: Promise.reject('all parameters must be defined');
|
|
434
|
+
};
|
|
435
|
+
/**
|
|
436
|
+
* Adds a new item to a component settings list
|
|
437
|
+
* @param {string} groupName
|
|
438
|
+
* @param {string} name
|
|
439
|
+
* @param {string} typeName
|
|
440
|
+
* @returns {Promise<ListItemType[]>}
|
|
441
|
+
*/
|
|
442
|
+
BaseClient.prototype.addComponentSettingsListItem = function (groupName, name, typeName) {
|
|
443
|
+
var addComponentSettingsListItemRequest = { groupName: groupName, name: name, typeName: typeName };
|
|
444
|
+
return groupName && name && typeName
|
|
445
|
+
? this.request('AddComponentSettingsListItem', addComponentSettingsListItemRequest)
|
|
446
|
+
.then(this.success())
|
|
447
|
+
.catch(this.error())
|
|
448
|
+
: Promise.reject('all parameters must be defined');
|
|
449
|
+
};
|
|
450
|
+
/**
|
|
451
|
+
* Get settings package files
|
|
452
|
+
* @returns {Promise<string[]>}
|
|
453
|
+
*/
|
|
454
|
+
BaseClient.prototype.getSettingsPackageFiles = function () {
|
|
455
|
+
return this.request('GetSettingsPackageFiles').then(this.success()).catch(this.error());
|
|
456
|
+
};
|
|
457
|
+
/**
|
|
458
|
+
* Get settings package types
|
|
459
|
+
* @returns {Promise<string[]>}
|
|
460
|
+
*/
|
|
461
|
+
BaseClient.prototype.settingsPackageTypes = function () {
|
|
462
|
+
return this.request('SettingsPackageTypes').then(this.success()).catch(this.error());
|
|
463
|
+
};
|
|
464
|
+
/**
|
|
465
|
+
* Download a TapPackage containing settings files
|
|
466
|
+
* @param {SettingsPackage} settingsTapPackage
|
|
467
|
+
* @returns {Promise<FileResponse>}
|
|
468
|
+
*/
|
|
469
|
+
BaseClient.prototype.downloadSettingsPackage = function (settingsTapPackage) {
|
|
470
|
+
return settingsTapPackage
|
|
471
|
+
? this.request('DownloadSettingsPackage', settingsTapPackage).then(this.success()).catch(this.error())
|
|
472
|
+
: Promise.reject('settingsTapPackage must be defined');
|
|
473
|
+
};
|
|
179
474
|
return BaseClient;
|
|
180
475
|
}());
|
|
181
476
|
export { BaseClient };
|
package/lib/RunnerClient.d.ts
CHANGED
|
@@ -1,20 +1,10 @@
|
|
|
1
1
|
import { BaseClient } from './BaseClient';
|
|
2
|
-
import {
|
|
2
|
+
import { Image, Links, Session } from './DTOs';
|
|
3
3
|
export declare class RunnerClient extends BaseClient {
|
|
4
4
|
private http;
|
|
5
5
|
private baseUrl;
|
|
6
6
|
protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
|
|
7
7
|
constructor(baseSubject: string, server: string);
|
|
8
|
-
/**
|
|
9
|
-
* Generic error callback function.
|
|
10
|
-
* @returns
|
|
11
|
-
*/
|
|
12
|
-
private error;
|
|
13
|
-
/**
|
|
14
|
-
* Generic success callback function.
|
|
15
|
-
* @returns
|
|
16
|
-
*/
|
|
17
|
-
private success;
|
|
18
8
|
/**
|
|
19
9
|
* Get the created image with the specified ID.
|
|
20
10
|
* @param imageId
|
|
@@ -74,112 +64,9 @@ export declare class RunnerClient extends BaseClient {
|
|
|
74
64
|
*/
|
|
75
65
|
getLinks(): Promise<Links>;
|
|
76
66
|
protected processGetLinks(response: Response): Promise<Links>;
|
|
77
|
-
/**
|
|
78
|
-
* Retrieve component settings overview
|
|
79
|
-
*/
|
|
80
|
-
getComponentSettingsOverview(): Promise<ComponentSettingsIdentifier[]>;
|
|
81
|
-
protected processGetComponentSettingsOverview(response: Response): Promise<ComponentSettingsIdentifier[]>;
|
|
82
|
-
/**
|
|
83
|
-
* Change componentsettings
|
|
84
|
-
*/
|
|
85
|
-
setComponentSettings(groupName: string | null, name: string | null, returnedSettings: ComponentSettingsBase): Promise<ComponentSettingsBase>;
|
|
86
|
-
protected processSetComponentSettings(response: Response): Promise<ComponentSettingsBase>;
|
|
87
|
-
/**
|
|
88
|
-
* Retrieve componentsettings
|
|
89
|
-
*/
|
|
90
|
-
getComponentSettings(groupName: string | null, name: string | null): Promise<ComponentSettingsBase>;
|
|
91
|
-
protected processGetComponentSettings(response: Response): Promise<ComponentSettingsBase>;
|
|
92
|
-
/**
|
|
93
|
-
* Retrieve componentsettings list item
|
|
94
|
-
*/
|
|
95
|
-
getComponentSettingsListItem(groupName: string | null, name: string | null, index: number): Promise<ComponentSettingsListItem>;
|
|
96
|
-
protected processGetComponentSettingsListItem(response: Response): Promise<ComponentSettingsListItem>;
|
|
97
|
-
/**
|
|
98
|
-
* Set componentsettings list item settings
|
|
99
|
-
*/
|
|
100
|
-
setComponentSettingsListItem(groupName: string | null, name: string | null, index: number, item: ComponentSettingsListItem): Promise<ComponentSettingsListItem>;
|
|
101
|
-
protected processSetComponentSettingsListItem(response: Response): Promise<ComponentSettingsListItem>;
|
|
102
|
-
/**
|
|
103
|
-
* Get component setting data grid
|
|
104
|
-
* @return Get component setting data grid
|
|
105
|
-
*/
|
|
106
|
-
getComponentSettingDataGrid(groupName: string | null, name: string | null, index: number, propertyName: string | null): Promise<DataGridControl>;
|
|
107
|
-
protected processGetComponentSettingDataGrid(response: Response): Promise<DataGridControl>;
|
|
108
|
-
/**
|
|
109
|
-
* Set component setting data grid
|
|
110
|
-
* @return Set data grid
|
|
111
|
-
*/
|
|
112
|
-
setComponentSettingDataGrid(groupName: string | null, name: string | null, index: number, propertyName: string | null, dataGridControl: DataGridControl): Promise<DataGridControl>;
|
|
113
|
-
protected processSetComponentSettingDataGrid(response: Response): Promise<DataGridControl>;
|
|
114
|
-
/**
|
|
115
|
-
* Add component setting item to data grid
|
|
116
|
-
* @return Add component setting data grid item
|
|
117
|
-
*/
|
|
118
|
-
addComponentSettingDataGridItemType(groupName: string | null, name: string | null, index: number, propertyName: string | null, typeName: string | null): Promise<DataGridControl>;
|
|
119
|
-
protected processAddComponentSettingDataGridItemType(response: Response): Promise<DataGridControl>;
|
|
120
|
-
/**
|
|
121
|
-
* Add component setting item to data grid
|
|
122
|
-
* @return Add component setting data grid item
|
|
123
|
-
*/
|
|
124
|
-
addComponentSettingDataGridItem(groupName: string | null, name: string | null, index: number, propertyName: string | null): Promise<DataGridControl>;
|
|
125
|
-
protected processAddComponentSettingDataGridItem(response: Response): Promise<DataGridControl>;
|
|
126
|
-
/**
|
|
127
|
-
* Get item types available in the component setting data grid
|
|
128
|
-
* @return Get component setting data grid types
|
|
129
|
-
*/
|
|
130
|
-
getComponentSettingDataGridTypes(groupName: string | null, name: string | null, index: number, propertyName: string | null): Promise<ListItemType[]>;
|
|
131
|
-
protected processGetComponentSettingDataGridTypes(response: Response): Promise<ListItemType[]>;
|
|
132
|
-
/**
|
|
133
|
-
* Change componentsettings profiles
|
|
134
|
-
*/
|
|
135
|
-
setComponentSettingsProfiles(returnedSettings: ProfileGroup[]): Promise<ProfileGroup[]>;
|
|
136
|
-
protected processSetComponentSettingsProfiles(response: Response): Promise<ProfileGroup[]>;
|
|
137
|
-
/**
|
|
138
|
-
* Get componentsettings profiles
|
|
139
|
-
*/
|
|
140
|
-
getComponentSettingsProfiles(): Promise<ProfileGroup[]>;
|
|
141
|
-
protected processGetComponentSettingsProfiles(response: Response): Promise<ProfileGroup[]>;
|
|
142
|
-
/**
|
|
143
|
-
* Upload exported OpenTAP Settings files
|
|
144
|
-
* @param file (optional)
|
|
145
|
-
*/
|
|
146
|
-
uploadComponentSettings(file: FileParameter | null | undefined): Promise<void>;
|
|
147
|
-
protected processUploadComponentSettings(response: Response): Promise<void>;
|
|
148
|
-
/**
|
|
149
|
-
* DEPRECATED: Use /componentsettings/load (LoadComponentSettingsFromRepository) instead
|
|
150
|
-
* @deprecated
|
|
151
|
-
*/
|
|
152
|
-
loadComponentSettingsFromPackageReference(packageReference: RepositoryPackageReference): Promise<ErrorResponse[]>;
|
|
153
|
-
protected processLoadComponentSettingsFromPackageReference(response: Response): Promise<ErrorResponse[]>;
|
|
154
|
-
/**
|
|
155
|
-
* Load a component settings TapPackage by referencing a package in a package repository
|
|
156
|
-
*/
|
|
157
|
-
loadComponentSettingsFromRepository(packageReference: RepositoryPackageReference): Promise<ErrorResponse[]>;
|
|
158
|
-
protected processLoadComponentSettingsFromRepository(response: Response): Promise<ErrorResponse[]>;
|
|
159
|
-
/**
|
|
160
|
-
* Save a TapPackage containing component settings in a package repository
|
|
161
|
-
* @return Settings TapPackage uploaded.
|
|
162
|
-
*/
|
|
163
|
-
saveComponentSettingsToRepository(repositoryPackageDefinition: RepositorySettingsPackageDefinition): Promise<void>;
|
|
164
|
-
protected processSaveComponentSettingsToRepository(response: Response): Promise<void>;
|
|
165
|
-
/**
|
|
166
|
-
* Retrieve types available to be added to specified component settings list
|
|
167
|
-
*/
|
|
168
|
-
getComponentSettingsListAvailableTypes(groupName: string | null, name: string | null): Promise<ListItemType[]>;
|
|
169
|
-
protected processGetComponentSettingsListAvailableTypes(response: Response): Promise<ListItemType[]>;
|
|
170
|
-
/**
|
|
171
|
-
* Adds a new item to a component settings list
|
|
172
|
-
*/
|
|
173
|
-
addComponentSettingsListItem(groupName: string | null, name: string | null, typeName: string | null): Promise<ComponentSettingsBase>;
|
|
174
|
-
protected processAddComponentSettingsListItem(response: Response): Promise<ComponentSettingsBase>;
|
|
175
67
|
/**
|
|
176
68
|
* Retrieve settings types used in creating a Settings TapPackage
|
|
177
69
|
*/
|
|
178
70
|
getSettingsTypes(): Promise<string[]>;
|
|
179
71
|
protected processGetSettingsTypes(response: Response): Promise<string[]>;
|
|
180
|
-
/**
|
|
181
|
-
* Download a TapPackage containing settings files
|
|
182
|
-
*/
|
|
183
|
-
downloadSettingsPackage(settingsTapPackage: SettingsTapPackage): Promise<FileResponse>;
|
|
184
|
-
protected processDownloadSettingsPackage(response: Response): Promise<FileResponse>;
|
|
185
72
|
}
|