@openeo/js-client 2.7.0 → 2.9.0
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/README.md +2 -2
- package/openeo.d.ts +293 -128
- package/openeo.js +8575 -6014
- package/openeo.min.js +1 -1
- package/package.json +3 -2
- package/src/capabilities.js +77 -1
- package/src/connection.js +13 -1
- package/src/openeo.js +1 -1
- package/src/pages.js +1 -1
- package/src/typedefs.js +21 -3
package/openeo.d.ts
CHANGED
|
@@ -3,8 +3,9 @@
|
|
|
3
3
|
import { User, UserManager } from 'oidc-client';
|
|
4
4
|
import { ProcessRegistry } from '@openeo/js-commons';
|
|
5
5
|
import { Readable } from 'stream';
|
|
6
|
+
import axios from 'axios';
|
|
6
7
|
|
|
7
|
-
declare
|
|
8
|
+
declare namespace OpenEO {
|
|
8
9
|
/**
|
|
9
10
|
* The base class for authentication providers such as Basic and OpenID Connect.
|
|
10
11
|
*
|
|
@@ -123,12 +124,12 @@ declare module OpenEO {
|
|
|
123
124
|
* @protected
|
|
124
125
|
* @type {object.<string, string>}
|
|
125
126
|
*/
|
|
126
|
-
protected apiToClientNames:
|
|
127
|
+
protected apiToClientNames: Record<string, string>;
|
|
127
128
|
/**
|
|
128
129
|
* @protected
|
|
129
130
|
* @type {object.<string, string>}
|
|
130
131
|
*/
|
|
131
|
-
protected clientToApiNames:
|
|
132
|
+
protected clientToApiNames: Record<string, string>;
|
|
132
133
|
/**
|
|
133
134
|
* @protected
|
|
134
135
|
* @type {number}
|
|
@@ -140,20 +141,20 @@ declare module OpenEO {
|
|
|
140
141
|
* @protected
|
|
141
142
|
* @type {object.<string, *>}
|
|
142
143
|
*/
|
|
143
|
-
protected extra:
|
|
144
|
+
protected extra: Record<string, any>;
|
|
144
145
|
/**
|
|
145
146
|
* Returns a JSON serializable representation of the data that is API compliant.
|
|
146
147
|
*
|
|
147
148
|
* @returns {object.<string, *>}
|
|
148
149
|
*/
|
|
149
|
-
toJSON():
|
|
150
|
+
toJSON(): Record<string, any>;
|
|
150
151
|
/**
|
|
151
152
|
* Converts the data from an API response into data suitable for our JS client models.
|
|
152
153
|
*
|
|
153
154
|
* @param {object.<string, *>} metadata - JSON object originating from an API response.
|
|
154
155
|
* @returns {BaseEntity} Returns the object itself.
|
|
155
156
|
*/
|
|
156
|
-
setAll(metadata:
|
|
157
|
+
setAll(metadata: Record<string, any>): BaseEntity;
|
|
157
158
|
/**
|
|
158
159
|
* Returns the age of the data in seconds.
|
|
159
160
|
*
|
|
@@ -165,7 +166,7 @@ declare module OpenEO {
|
|
|
165
166
|
*
|
|
166
167
|
* @returns {object.<string, *>}
|
|
167
168
|
*/
|
|
168
|
-
getAll():
|
|
169
|
+
getAll(): Record<string, any>;
|
|
169
170
|
/**
|
|
170
171
|
* Get a value from the additional data that is not part of the core model, i.e. from proprietary extensions.
|
|
171
172
|
*
|
|
@@ -180,7 +181,7 @@ declare module OpenEO {
|
|
|
180
181
|
* @returns {object.<string, *>}
|
|
181
182
|
* @protected
|
|
182
183
|
*/
|
|
183
|
-
protected _convertToRequest(parameters:
|
|
184
|
+
protected _convertToRequest(parameters: Record<string, any>): Record<string, any>;
|
|
184
185
|
/**
|
|
185
186
|
* Checks whether a features is supported by the API.
|
|
186
187
|
*
|
|
@@ -204,7 +205,7 @@ declare module OpenEO {
|
|
|
204
205
|
* @type {object}
|
|
205
206
|
* @static
|
|
206
207
|
*/
|
|
207
|
-
static axios:
|
|
208
|
+
static axios: typeof axios;
|
|
208
209
|
/**
|
|
209
210
|
* Returns the name of the Environment, `Node` or `Browser`.
|
|
210
211
|
*
|
|
@@ -279,7 +280,7 @@ declare module OpenEO {
|
|
|
279
280
|
* @param {string} targetFolder
|
|
280
281
|
* @throws {Error}
|
|
281
282
|
*/
|
|
282
|
-
static downloadResults(con: Connection, assets: Array<
|
|
283
|
+
static downloadResults(con: Connection, assets: Array<Record<string, any>>, targetFolder: string): Promise<void>;
|
|
283
284
|
/**
|
|
284
285
|
* Streams data into a file (node) or offers data to download (browser).
|
|
285
286
|
*
|
|
@@ -329,7 +330,7 @@ declare module OpenEO {
|
|
|
329
330
|
* @param {object.<string, *>} data - A capabilities response compatible to the API specification for `GET /`.
|
|
330
331
|
* @throws {Error}
|
|
331
332
|
*/
|
|
332
|
-
constructor(data:
|
|
333
|
+
constructor(data: Record<string, any>);
|
|
333
334
|
/**
|
|
334
335
|
* @private
|
|
335
336
|
* @type {object.<string, *>}
|
|
@@ -366,7 +367,7 @@ declare module OpenEO {
|
|
|
366
367
|
*
|
|
367
368
|
* @returns {object.<string, *>} - A reference to the capabilities response.
|
|
368
369
|
*/
|
|
369
|
-
toJSON():
|
|
370
|
+
toJSON(): Record<string, any>;
|
|
370
371
|
/**
|
|
371
372
|
* Returns the openEO API version implemented by the back-end.
|
|
372
373
|
*
|
|
@@ -409,6 +410,20 @@ declare module OpenEO {
|
|
|
409
410
|
* @returns {Array.<FederationBackend>} Array of backends
|
|
410
411
|
*/
|
|
411
412
|
listFederation(): Array<FederationBackend>;
|
|
413
|
+
/**
|
|
414
|
+
* Given just the string ID of a backend within the federation, returns that backend's full details as a FederationBackend object.
|
|
415
|
+
*
|
|
416
|
+
* @param {string} backendId - The ID of a backend within the federation
|
|
417
|
+
* @returns {FederationBackend} The full details of the backend
|
|
418
|
+
*/
|
|
419
|
+
getFederationBackend(backendId: string): FederationBackend;
|
|
420
|
+
/**
|
|
421
|
+
* Given a list of string IDs of backends within the federation, returns those backends' full details as FederationBackend objects.
|
|
422
|
+
*
|
|
423
|
+
* @param {Array<string>} backendIds - The IDs of backends within the federation
|
|
424
|
+
* @returns {Array<FederationBackend>} An array in the same order as the input, containing for each position the full details of the backend
|
|
425
|
+
*/
|
|
426
|
+
getFederationBackends(backendIds: Array<string>): Array<FederationBackend>;
|
|
412
427
|
/**
|
|
413
428
|
* Lists all supported features.
|
|
414
429
|
*
|
|
@@ -422,6 +437,15 @@ declare module OpenEO {
|
|
|
422
437
|
* @returns {boolean} `true` if the feature is supported, otherwise `false`.
|
|
423
438
|
*/
|
|
424
439
|
hasFeature(methodName: string): boolean;
|
|
440
|
+
/**
|
|
441
|
+
* Check whether a conformance class is supported by the back-end.
|
|
442
|
+
*
|
|
443
|
+
* Use `*` as a wildcard character for e.g. version numbers.
|
|
444
|
+
*
|
|
445
|
+
* @param {string|Array.<string>} uris - Conformance class URI(s) - any of them must match.
|
|
446
|
+
* @returns {boolean} `true` if any of the conformance classes is supported, otherwise `false`.
|
|
447
|
+
*/
|
|
448
|
+
hasConformance(uris: string | Array<string>): boolean;
|
|
425
449
|
/**
|
|
426
450
|
* Get the billing currency.
|
|
427
451
|
*
|
|
@@ -442,6 +466,8 @@ declare module OpenEO {
|
|
|
442
466
|
* @returns {AxiosResponse}
|
|
443
467
|
*/
|
|
444
468
|
protected migrate(response: AxiosResponse): AxiosResponse;
|
|
469
|
+
|
|
470
|
+
static Conformance: Record<string, string | Array<string>>;
|
|
445
471
|
}
|
|
446
472
|
/**
|
|
447
473
|
* The Authentication Provider for OpenID Connect.
|
|
@@ -480,7 +506,7 @@ declare module OpenEO {
|
|
|
480
506
|
* @throws {Error}
|
|
481
507
|
* @see https://github.com/IdentityModel/oidc-client-js/wiki#other-optional-settings
|
|
482
508
|
*/
|
|
483
|
-
static signinCallback(provider?: OidcProvider, options?:
|
|
509
|
+
static signinCallback(provider?: OidcProvider, options?: Record<string, any>): Promise<User | null>;
|
|
484
510
|
/**
|
|
485
511
|
* Creates a new OidcProvider instance to authenticate using OpenID Connect.
|
|
486
512
|
*
|
|
@@ -580,7 +606,7 @@ declare module OpenEO {
|
|
|
580
606
|
* @see https://github.com/IdentityModel/oidc-client-js/wiki#other-optional-settings
|
|
581
607
|
* @see {OidcProvider#refreshTokenScope}
|
|
582
608
|
*/
|
|
583
|
-
login(options?:
|
|
609
|
+
login(options?: Record<string, any>, requestRefreshToken?: boolean): Promise<void>;
|
|
584
610
|
/**
|
|
585
611
|
* Returns the options for the OIDC client library.
|
|
586
612
|
*
|
|
@@ -592,7 +618,7 @@ declare module OpenEO {
|
|
|
592
618
|
* @returns {object.<string, *>}
|
|
593
619
|
* @see {OidcProvider#refreshTokenScope}
|
|
594
620
|
*/
|
|
595
|
-
protected getOptions(options?:
|
|
621
|
+
protected getOptions(options?: Record<string, any>, requestRefreshToken?: boolean): Record<string, any>;
|
|
596
622
|
/**
|
|
597
623
|
* Get the response_type based on the grant type.
|
|
598
624
|
*
|
|
@@ -672,13 +698,13 @@ declare module OpenEO {
|
|
|
672
698
|
*
|
|
673
699
|
* @returns {object.<string, FileType>}
|
|
674
700
|
*/
|
|
675
|
-
getInputTypes():
|
|
701
|
+
getInputTypes(): Record<string, FileType>;
|
|
676
702
|
/**
|
|
677
703
|
* Returns the output file formats.
|
|
678
704
|
*
|
|
679
705
|
* @returns {object.<string, FileType>}
|
|
680
706
|
*/
|
|
681
|
-
getOutputTypes():
|
|
707
|
+
getOutputTypes(): Record<string, FileType>;
|
|
682
708
|
/**
|
|
683
709
|
* Returns a single input file format for a given identifier.
|
|
684
710
|
*
|
|
@@ -1056,7 +1082,7 @@ declare module OpenEO {
|
|
|
1056
1082
|
* @returns {Promise<object.<string, *>>} The JSON-based response compatible to the API specification, but also including a `costs` property if present in the headers.
|
|
1057
1083
|
* @throws {Error}
|
|
1058
1084
|
*/
|
|
1059
|
-
getResultsAsStac(): Promise<
|
|
1085
|
+
getResultsAsStac(): Promise<Record<string, any>>;
|
|
1060
1086
|
/**
|
|
1061
1087
|
* Retrieves download links.
|
|
1062
1088
|
*
|
|
@@ -1123,14 +1149,14 @@ declare module OpenEO {
|
|
|
1123
1149
|
* @readonly
|
|
1124
1150
|
* @type {?Array.<object.<string, *>>}
|
|
1125
1151
|
*/
|
|
1126
|
-
public readonly parameters: Array<
|
|
1152
|
+
public readonly parameters: Array<Record<string, any>> | null;
|
|
1127
1153
|
/**
|
|
1128
1154
|
* Description of the data that is returned by this process.
|
|
1129
1155
|
* @public
|
|
1130
1156
|
* @readonly
|
|
1131
1157
|
* @type {?object.<string, *>}
|
|
1132
1158
|
*/
|
|
1133
|
-
public readonly returns:
|
|
1159
|
+
public readonly returns: Record<string, any> | null;
|
|
1134
1160
|
/**
|
|
1135
1161
|
* Specifies that the process or parameter is deprecated with the potential to be removed in any of the next versions.
|
|
1136
1162
|
* @public
|
|
@@ -1151,13 +1177,13 @@ declare module OpenEO {
|
|
|
1151
1177
|
* @readonly
|
|
1152
1178
|
* @type {?object.<string, *>}
|
|
1153
1179
|
*/
|
|
1154
|
-
public readonly exceptions:
|
|
1180
|
+
public readonly exceptions: Record<string, any> | null;
|
|
1155
1181
|
/**
|
|
1156
1182
|
* @public
|
|
1157
1183
|
* @readonly
|
|
1158
1184
|
* @type {?Array.<object.<string, *>>}
|
|
1159
1185
|
*/
|
|
1160
|
-
public readonly examples: Array<
|
|
1186
|
+
public readonly examples: Array<Record<string, any>> | null;
|
|
1161
1187
|
/**
|
|
1162
1188
|
* Links related to this process.
|
|
1163
1189
|
* @public
|
|
@@ -1170,7 +1196,7 @@ declare module OpenEO {
|
|
|
1170
1196
|
* @readonly
|
|
1171
1197
|
* @type {?object.<string, *>}
|
|
1172
1198
|
*/
|
|
1173
|
-
public readonly processGraph:
|
|
1199
|
+
public readonly processGraph: Record<string, any> | null;
|
|
1174
1200
|
/**
|
|
1175
1201
|
* Updates the data stored in this object by requesting the process graph metadata from the back-end.
|
|
1176
1202
|
*
|
|
@@ -1268,14 +1294,14 @@ declare module OpenEO {
|
|
|
1268
1294
|
* @readonly
|
|
1269
1295
|
* @type {?object.<string, *>}
|
|
1270
1296
|
*/
|
|
1271
|
-
public readonly configuration:
|
|
1297
|
+
public readonly configuration: Record<string, any> | null;
|
|
1272
1298
|
/**
|
|
1273
1299
|
* Additional attributes of the secondary web service, e.g. available layers for a WMS based on the bands in the underlying GeoTiff.
|
|
1274
1300
|
* @public
|
|
1275
1301
|
* @readonly
|
|
1276
1302
|
* @type {?object.<string, *>}
|
|
1277
1303
|
*/
|
|
1278
|
-
public readonly attributes:
|
|
1304
|
+
public readonly attributes: Record<string, any> | null;
|
|
1279
1305
|
/**
|
|
1280
1306
|
* Date and time of creation, formatted as a RFC 3339 date-time.
|
|
1281
1307
|
* @public
|
|
@@ -1332,7 +1358,7 @@ declare module OpenEO {
|
|
|
1332
1358
|
title: string;
|
|
1333
1359
|
description: string;
|
|
1334
1360
|
enabled: boolean;
|
|
1335
|
-
configuration:
|
|
1361
|
+
configuration: Record<string, any>;
|
|
1336
1362
|
plan: string;
|
|
1337
1363
|
budget: number;
|
|
1338
1364
|
}): Promise<Service>;
|
|
@@ -1415,7 +1441,7 @@ declare module OpenEO {
|
|
|
1415
1441
|
* @param {string} description - A description for the parameter
|
|
1416
1442
|
* @param {*} defaultValue - An optional default Value for the parameter. If set, make the parameter optional. If not set, the parameter is required. Defaults to `undefined`.
|
|
1417
1443
|
*/
|
|
1418
|
-
constructor(name: string, schema?:
|
|
1444
|
+
constructor(name: string, schema?: Record<string, any> | string, description?: string, defaultValue?: any);
|
|
1419
1445
|
name: string;
|
|
1420
1446
|
spec: {
|
|
1421
1447
|
name: string;
|
|
@@ -1427,7 +1453,7 @@ declare module OpenEO {
|
|
|
1427
1453
|
*
|
|
1428
1454
|
* @returns {object.<string, *>}
|
|
1429
1455
|
*/
|
|
1430
|
-
toJSON():
|
|
1456
|
+
toJSON(): Record<string, any>;
|
|
1431
1457
|
/**
|
|
1432
1458
|
* Returns the reference object for this parameter.
|
|
1433
1459
|
*
|
|
@@ -1483,7 +1509,7 @@ declare module OpenEO {
|
|
|
1483
1509
|
/**
|
|
1484
1510
|
* @type {object.<string, *>}
|
|
1485
1511
|
*/
|
|
1486
|
-
tree:
|
|
1512
|
+
tree: Record<string, any>;
|
|
1487
1513
|
/**
|
|
1488
1514
|
* @type {Builder | null}
|
|
1489
1515
|
*/
|
|
@@ -1512,7 +1538,7 @@ declare module OpenEO {
|
|
|
1512
1538
|
* @returns {object.<string, *>}
|
|
1513
1539
|
* @throws {Error}
|
|
1514
1540
|
*/
|
|
1515
|
-
protected parseTree(tree:
|
|
1541
|
+
protected parseTree(tree: Record<string, any>): Record<string, any>;
|
|
1516
1542
|
/**
|
|
1517
1543
|
* Gets the reference for a value, e.g. from_node or from_parameter.
|
|
1518
1544
|
*
|
|
@@ -1530,10 +1556,10 @@ declare module OpenEO {
|
|
|
1530
1556
|
* @returns {BuilderNode}
|
|
1531
1557
|
* @throws {Error}
|
|
1532
1558
|
*/
|
|
1533
|
-
addOperatorProcess(operator: string, left: number |
|
|
1559
|
+
addOperatorProcess(operator: string, left: number | Record<string, any>, right: number | Record<string, any>): BuilderNode;
|
|
1534
1560
|
}
|
|
1535
1561
|
export namespace Formula {
|
|
1536
|
-
let operatorMapping:
|
|
1562
|
+
let operatorMapping: Record<string, string>;
|
|
1537
1563
|
}
|
|
1538
1564
|
/**
|
|
1539
1565
|
* A class that represents a process node and also a result from a process.
|
|
@@ -1548,7 +1574,7 @@ declare module OpenEO {
|
|
|
1548
1574
|
* @param {?string} [processDescription=null]
|
|
1549
1575
|
* @param {?string} [processNamespace=null]
|
|
1550
1576
|
*/
|
|
1551
|
-
constructor(parent: Builder, processId: string, processArgs?:
|
|
1577
|
+
constructor(parent: Builder, processId: string, processArgs?: Record<string, any>, processDescription?: string | null, processNamespace?: string | null);
|
|
1552
1578
|
/**
|
|
1553
1579
|
* The parent builder.
|
|
1554
1580
|
* @type {Builder}
|
|
@@ -1574,7 +1600,7 @@ declare module OpenEO {
|
|
|
1574
1600
|
* The arguments for the process.
|
|
1575
1601
|
* @type {object.<string, *>}
|
|
1576
1602
|
*/
|
|
1577
|
-
arguments:
|
|
1603
|
+
arguments: Record<string, any>;
|
|
1578
1604
|
/**
|
|
1579
1605
|
* @ignore
|
|
1580
1606
|
*/
|
|
@@ -1591,13 +1617,13 @@ declare module OpenEO {
|
|
|
1591
1617
|
* @returns {object.<string, *>}
|
|
1592
1618
|
* @throws {Error}
|
|
1593
1619
|
*/
|
|
1594
|
-
namedArguments(processArgs: Array<
|
|
1620
|
+
namedArguments(processArgs: Array<Record<string, any>>): Record<string, any>;
|
|
1595
1621
|
/**
|
|
1596
1622
|
* Checks the arguments given for parameters and add them to the process.
|
|
1597
1623
|
*
|
|
1598
1624
|
* @param {object.<string, *>|Array} processArgs
|
|
1599
1625
|
*/
|
|
1600
|
-
addParametersToProcess(processArgs:
|
|
1626
|
+
addParametersToProcess(processArgs: Record<string, any> | any[]): void;
|
|
1601
1627
|
/**
|
|
1602
1628
|
* Gets/Sets a description for the node.
|
|
1603
1629
|
*
|
|
@@ -1643,13 +1669,13 @@ declare module OpenEO {
|
|
|
1643
1669
|
* @returns {object.<string, *>}
|
|
1644
1670
|
* @throws {Error}
|
|
1645
1671
|
*/
|
|
1646
|
-
protected exportCallback(arg: Function, name: string):
|
|
1672
|
+
protected exportCallback(arg: Function, name: string): Record<string, any>;
|
|
1647
1673
|
/**
|
|
1648
1674
|
* Returns a JSON serializable representation of the data that is API compliant.
|
|
1649
1675
|
*
|
|
1650
1676
|
* @returns {object.<string, *>}
|
|
1651
1677
|
*/
|
|
1652
|
-
toJSON():
|
|
1678
|
+
toJSON(): Record<string, any>;
|
|
1653
1679
|
/**
|
|
1654
1680
|
* Returns the reference object for this node.
|
|
1655
1681
|
*
|
|
@@ -1824,7 +1850,7 @@ declare module OpenEO {
|
|
|
1824
1850
|
* @returns {Array.<object.<string,*>>}
|
|
1825
1851
|
* @todo Should this also pass callback parameters from parents until root is reached?
|
|
1826
1852
|
*/
|
|
1827
|
-
getParentCallbackParameters(): Array<
|
|
1853
|
+
getParentCallbackParameters(): Array<Record<string, any>>;
|
|
1828
1854
|
/**
|
|
1829
1855
|
* Adds a parameter to the list of process parameters.
|
|
1830
1856
|
*
|
|
@@ -1833,7 +1859,7 @@ declare module OpenEO {
|
|
|
1833
1859
|
* @param {object.<string, *>} parameter - The parameter spec to add, must comply to the API.
|
|
1834
1860
|
* @param {boolean} [root=true] - Adds the parameter to the root process if set to `true`, otherwise to the process constructed by this builder. Usually you want to add it to the root.
|
|
1835
1861
|
*/
|
|
1836
|
-
addParameter(parameter:
|
|
1862
|
+
addParameter(parameter: Record<string, any>, root?: boolean): void;
|
|
1837
1863
|
/**
|
|
1838
1864
|
* Returns the process specification for the given process identifier and namespace (or `null`).
|
|
1839
1865
|
*
|
|
@@ -1869,7 +1895,7 @@ declare module OpenEO {
|
|
|
1869
1895
|
* @param {?string} [description=null] - An optional description for the process call.
|
|
1870
1896
|
* @returns {BuilderNode}
|
|
1871
1897
|
*/
|
|
1872
|
-
process(processId: string, args?:
|
|
1898
|
+
process(processId: string, args?: Record<string, any> | any[], description?: string | null): BuilderNode;
|
|
1873
1899
|
/**
|
|
1874
1900
|
* Returns a JSON serializable representation of the data that is API compliant.
|
|
1875
1901
|
*
|
|
@@ -1887,6 +1913,158 @@ declare module OpenEO {
|
|
|
1887
1913
|
*/
|
|
1888
1914
|
generateId(prefix?: string): string;
|
|
1889
1915
|
}
|
|
1916
|
+
/**
|
|
1917
|
+
* A class to handle pagination of resources.
|
|
1918
|
+
*
|
|
1919
|
+
* @abstract
|
|
1920
|
+
*/
|
|
1921
|
+
export class Pages {
|
|
1922
|
+
/**
|
|
1923
|
+
* Creates an instance of Pages.
|
|
1924
|
+
*
|
|
1925
|
+
* @param {Connection} connection
|
|
1926
|
+
* @param {string} endpoint
|
|
1927
|
+
* @param {string} key
|
|
1928
|
+
* @param {Constructor} cls - Class
|
|
1929
|
+
* @param {object} [params={}]
|
|
1930
|
+
* @param {string} primaryKey
|
|
1931
|
+
*/
|
|
1932
|
+
constructor(connection: Connection, endpoint: string, key: string, cls: Constructor, params?: object, primaryKey?: string);
|
|
1933
|
+
connection: Connection;
|
|
1934
|
+
nextUrl: string;
|
|
1935
|
+
key: string;
|
|
1936
|
+
primaryKey: string;
|
|
1937
|
+
cls: Constructor;
|
|
1938
|
+
params: any;
|
|
1939
|
+
/**
|
|
1940
|
+
* Returns true if there are more pages to fetch.
|
|
1941
|
+
*
|
|
1942
|
+
* @returns {boolean}
|
|
1943
|
+
*/
|
|
1944
|
+
hasNextPage(): boolean;
|
|
1945
|
+
/**
|
|
1946
|
+
* Returns the next page of resources.
|
|
1947
|
+
*
|
|
1948
|
+
* @async
|
|
1949
|
+
* @param {Array.<object>} oldObjects - Existing objects to update, if any.
|
|
1950
|
+
* @param {boolean} [toArray=true] - Whether to return the objects as a simplified array or as an object with all information.
|
|
1951
|
+
* @returns {Array.<object>}
|
|
1952
|
+
* @throws {Error}
|
|
1953
|
+
*/
|
|
1954
|
+
nextPage(oldObjects?: Array<object>, toArray?: boolean): Array<object>;
|
|
1955
|
+
/**
|
|
1956
|
+
* Ensures a variable is an array.
|
|
1957
|
+
*
|
|
1958
|
+
* @protected
|
|
1959
|
+
* @param {*} x
|
|
1960
|
+
* @returns {Array}
|
|
1961
|
+
*/
|
|
1962
|
+
protected _ensureArray(x: any): any[];
|
|
1963
|
+
/**
|
|
1964
|
+
* Creates a facade for the object, if needed.
|
|
1965
|
+
*
|
|
1966
|
+
* @protected
|
|
1967
|
+
* @param {object} obj
|
|
1968
|
+
* @returns {object}
|
|
1969
|
+
*/
|
|
1970
|
+
protected _createObject(obj: object): object;
|
|
1971
|
+
/**
|
|
1972
|
+
* Caches the plain objects if needed.
|
|
1973
|
+
*
|
|
1974
|
+
* @param {Array.<object>} objects
|
|
1975
|
+
* @returns {Array.<object>}
|
|
1976
|
+
*/
|
|
1977
|
+
_cache(objects: Array<object>): Array<object>;
|
|
1978
|
+
/**
|
|
1979
|
+
* Get the URL of the next page from a response.
|
|
1980
|
+
*
|
|
1981
|
+
* @protected
|
|
1982
|
+
* @param {AxiosResponse} response
|
|
1983
|
+
* @returns {string | null}
|
|
1984
|
+
*/
|
|
1985
|
+
protected _getNextLink(response: AxiosResponse): string | null;
|
|
1986
|
+
/**
|
|
1987
|
+
* Makes this class asynchronously iterable.
|
|
1988
|
+
*
|
|
1989
|
+
* @returns {AsyncIterator}
|
|
1990
|
+
*/
|
|
1991
|
+
[Symbol.asyncIterator](): AsyncIterator<any, any, any>;
|
|
1992
|
+
}
|
|
1993
|
+
/**
|
|
1994
|
+
* Paginate through collections.
|
|
1995
|
+
*/
|
|
1996
|
+
export class CollectionPages extends Pages {
|
|
1997
|
+
/**
|
|
1998
|
+
* Paginate through collections.
|
|
1999
|
+
*
|
|
2000
|
+
* @param {Connection} connection
|
|
2001
|
+
* @param {?number} limit
|
|
2002
|
+
*/
|
|
2003
|
+
constructor(connection: Connection, limit?: number | null);
|
|
2004
|
+
}
|
|
2005
|
+
/**
|
|
2006
|
+
* Paginate through collection items.
|
|
2007
|
+
*/
|
|
2008
|
+
export class ItemPages extends Pages {
|
|
2009
|
+
/**
|
|
2010
|
+
* Paginate through collection items.
|
|
2011
|
+
*
|
|
2012
|
+
* @param {Connection} connection
|
|
2013
|
+
* @param {string} collectionId
|
|
2014
|
+
* @param {object} params
|
|
2015
|
+
*/
|
|
2016
|
+
constructor(connection: Connection, collectionId: string, params: object);
|
|
2017
|
+
}
|
|
2018
|
+
/**
|
|
2019
|
+
* Paginate through jobs.
|
|
2020
|
+
*/
|
|
2021
|
+
export class JobPages extends Pages {
|
|
2022
|
+
/**
|
|
2023
|
+
* Paginate through jobs.
|
|
2024
|
+
*
|
|
2025
|
+
* @param {Connection} connection
|
|
2026
|
+
* @param {?number} limit
|
|
2027
|
+
*/
|
|
2028
|
+
constructor(connection: Connection, limit?: number | null);
|
|
2029
|
+
}
|
|
2030
|
+
/**
|
|
2031
|
+
* Paginate through processes.
|
|
2032
|
+
*/
|
|
2033
|
+
export class ProcessPages extends Pages {
|
|
2034
|
+
/**
|
|
2035
|
+
* Paginate through processes.
|
|
2036
|
+
*
|
|
2037
|
+
* @param {Connection} connection
|
|
2038
|
+
* @param {?number} limit
|
|
2039
|
+
* @param {?string} namespace
|
|
2040
|
+
*/
|
|
2041
|
+
constructor(connection: Connection, limit?: number | null, namespace?: string | null);
|
|
2042
|
+
namespace: string;
|
|
2043
|
+
}
|
|
2044
|
+
/**
|
|
2045
|
+
* Paginate through services.
|
|
2046
|
+
*/
|
|
2047
|
+
export class ServicePages extends Pages {
|
|
2048
|
+
/**
|
|
2049
|
+
* Paginate through services.
|
|
2050
|
+
*
|
|
2051
|
+
* @param {Connection} connection
|
|
2052
|
+
* @param {?number} limit
|
|
2053
|
+
*/
|
|
2054
|
+
constructor(connection: Connection, limit?: number | null);
|
|
2055
|
+
}
|
|
2056
|
+
/**
|
|
2057
|
+
* Paginate through user files.
|
|
2058
|
+
*/
|
|
2059
|
+
export class UserFilePages extends Pages {
|
|
2060
|
+
/**
|
|
2061
|
+
* Paginate through user files.
|
|
2062
|
+
*
|
|
2063
|
+
* @param {Connection} connection
|
|
2064
|
+
* @param {?number} limit
|
|
2065
|
+
*/
|
|
2066
|
+
constructor(connection: Connection, limit?: number | null);
|
|
2067
|
+
}
|
|
1890
2068
|
/**
|
|
1891
2069
|
* A connection to a back-end.
|
|
1892
2070
|
*/
|
|
@@ -1942,7 +2120,7 @@ declare module OpenEO {
|
|
|
1942
2120
|
* @protected
|
|
1943
2121
|
* @type {object.<string|Function>}
|
|
1944
2122
|
*/
|
|
1945
|
-
protected listeners:
|
|
2123
|
+
protected listeners: Record<string, Function>;
|
|
1946
2124
|
/**
|
|
1947
2125
|
* Additional options for the connection.
|
|
1948
2126
|
*
|
|
@@ -2000,6 +2178,14 @@ declare module OpenEO {
|
|
|
2000
2178
|
* @throws {Error}
|
|
2001
2179
|
*/
|
|
2002
2180
|
listFileTypes(): Promise<FileTypes>;
|
|
2181
|
+
/**
|
|
2182
|
+
* List the supported output file formats.
|
|
2183
|
+
*
|
|
2184
|
+
* @async
|
|
2185
|
+
* @returns {Promise<ProcessingParameters>} A response compatible to the API specification.
|
|
2186
|
+
* @throws {Error}
|
|
2187
|
+
*/
|
|
2188
|
+
listProcessingParameters(): Promise<ProcessingParameters>;
|
|
2003
2189
|
/**
|
|
2004
2190
|
* List the supported secondary service types.
|
|
2005
2191
|
*
|
|
@@ -2007,7 +2193,7 @@ declare module OpenEO {
|
|
|
2007
2193
|
* @returns {Promise<object.<string, ServiceType>>} A response compatible to the API specification.
|
|
2008
2194
|
* @throws {Error}
|
|
2009
2195
|
*/
|
|
2010
|
-
listServiceTypes(): Promise<
|
|
2196
|
+
listServiceTypes(): Promise<Record<string, ServiceType>>;
|
|
2011
2197
|
/**
|
|
2012
2198
|
* List the supported UDF runtimes.
|
|
2013
2199
|
*
|
|
@@ -2015,7 +2201,7 @@ declare module OpenEO {
|
|
|
2015
2201
|
* @returns {Promise<object.<string, UdfRuntime>>} A response compatible to the API specification.
|
|
2016
2202
|
* @throws {Error}
|
|
2017
2203
|
*/
|
|
2018
|
-
listUdfRuntimes(): Promise<
|
|
2204
|
+
listUdfRuntimes(): Promise<Record<string, UdfRuntime>>;
|
|
2019
2205
|
/**
|
|
2020
2206
|
* List all collections available on the back-end.
|
|
2021
2207
|
*
|
|
@@ -2030,15 +2216,12 @@ declare module OpenEO {
|
|
|
2030
2216
|
/**
|
|
2031
2217
|
* Paginate through the collections available on the back-end.
|
|
2032
2218
|
*
|
|
2033
|
-
* The collections returned always
|
|
2034
|
-
* This function adds a self link to the response if not present.
|
|
2219
|
+
* The collections returned always comply to the latest STAC version (currently 1.0.0).
|
|
2035
2220
|
*
|
|
2036
|
-
* @async
|
|
2037
2221
|
* @param {?number} [limit=50] - The number of collections per request/page as integer. If `null`, requests all collections.
|
|
2038
|
-
* @
|
|
2039
|
-
* @throws {Error}
|
|
2222
|
+
* @returns {CollectionPages} A paged list of collections.
|
|
2040
2223
|
*/
|
|
2041
|
-
paginateCollections(limit?: number | null):
|
|
2224
|
+
paginateCollections(limit?: number | null): CollectionPages;
|
|
2042
2225
|
/**
|
|
2043
2226
|
* Get further information about a single collection.
|
|
2044
2227
|
*
|
|
@@ -2051,7 +2234,7 @@ declare module OpenEO {
|
|
|
2051
2234
|
*/
|
|
2052
2235
|
describeCollection(collectionId: string): Promise<Collection>;
|
|
2053
2236
|
/**
|
|
2054
|
-
*
|
|
2237
|
+
* Paginate through items for a specific collection.
|
|
2055
2238
|
*
|
|
2056
2239
|
* May not be available for all collections.
|
|
2057
2240
|
*
|
|
@@ -2069,10 +2252,10 @@ declare module OpenEO {
|
|
|
2069
2252
|
* each must be either an RFC 3339 compatible string or a Date object.
|
|
2070
2253
|
* Also supports open intervals by setting one of the boundaries to `null`, but never both.
|
|
2071
2254
|
* @param {?number} [limit=null] - The amount of items per request/page as integer. If `null` (default), the back-end decides.
|
|
2072
|
-
* @
|
|
2255
|
+
* @returns {Promise<ItemPages>} A response compatible to the API specification.
|
|
2073
2256
|
* @throws {Error}
|
|
2074
2257
|
*/
|
|
2075
|
-
listCollectionItems(collectionId: string, spatialExtent?: Array<number> | null, temporalExtent?: any[] | null, limit?: number | null):
|
|
2258
|
+
listCollectionItems(collectionId: string, spatialExtent?: Array<number> | null, temporalExtent?: any[] | null, limit?: number | null): Promise<ItemPages>;
|
|
2076
2259
|
/**
|
|
2077
2260
|
* Normalisation of the namespace to a value that is compatible with the OpenEO specs - EXPERIMENTAL.
|
|
2078
2261
|
*
|
|
@@ -2113,15 +2296,11 @@ declare module OpenEO {
|
|
|
2113
2296
|
* Note: The list of namespaces can be retrieved by calling `listProcesses` without a namespace given.
|
|
2114
2297
|
* The namespaces are then listed in the property `namespaces`.
|
|
2115
2298
|
*
|
|
2116
|
-
* This function adds a self link to the response if not present.
|
|
2117
|
-
*
|
|
2118
|
-
* @async
|
|
2119
2299
|
* @param {?string} [namespace=null] - Namespace of the processes (default to `null`, i.e. pre-defined processes). EXPERIMENTAL!
|
|
2120
2300
|
* @param {?number} [limit=50] - The number of processes per request/page as integer. If `null`, requests all processes.
|
|
2121
|
-
* @
|
|
2122
|
-
* @throws {Error}
|
|
2301
|
+
* @returns {ProcessPages} A paged list of processes.
|
|
2123
2302
|
*/
|
|
2124
|
-
paginateProcesses(namespace?: string | null, limit?: number | null):
|
|
2303
|
+
paginateProcesses(namespace?: string | null, limit?: number | null): ProcessPages;
|
|
2125
2304
|
/**
|
|
2126
2305
|
* Get information about a single process.
|
|
2127
2306
|
*
|
|
@@ -2281,12 +2460,10 @@ declare module OpenEO {
|
|
|
2281
2460
|
/**
|
|
2282
2461
|
* Paginate through the files from the user workspace.
|
|
2283
2462
|
*
|
|
2284
|
-
* @async
|
|
2285
2463
|
* @param {?number} [limit=50] - The number of files per request/page as integer. If `null`, requests all files.
|
|
2286
|
-
* @
|
|
2287
|
-
* @throws {Error}
|
|
2464
|
+
* @returns {ServicePages} A paged list of files.
|
|
2288
2465
|
*/
|
|
2289
|
-
paginateFiles(limit?: number | null):
|
|
2466
|
+
paginateFiles(limit?: number | null): ServicePages;
|
|
2290
2467
|
/**
|
|
2291
2468
|
* A callback that is executed on upload progress updates.
|
|
2292
2469
|
*
|
|
@@ -2329,7 +2506,7 @@ declare module OpenEO {
|
|
|
2329
2506
|
* @returns {object.<string, *>}
|
|
2330
2507
|
* @protected
|
|
2331
2508
|
*/
|
|
2332
|
-
protected _normalizeUserProcess(process: UserProcess | BuilderNode |
|
|
2509
|
+
protected _normalizeUserProcess(process: UserProcess | BuilderNode | Record<string, any>, additional?: Record<string, any>): Record<string, any>;
|
|
2333
2510
|
/**
|
|
2334
2511
|
* Validates a user-defined process at the back-end.
|
|
2335
2512
|
*
|
|
@@ -2351,13 +2528,10 @@ declare module OpenEO {
|
|
|
2351
2528
|
/**
|
|
2352
2529
|
* Paginates through the user-defined processes of the authenticated user.
|
|
2353
2530
|
*
|
|
2354
|
-
* @async
|
|
2355
2531
|
* @param {?number} [limit=50] - The number of processes per request/page as integer. If `null`, requests all processes.
|
|
2356
|
-
* @
|
|
2357
|
-
* @yields {Promise<ResponseArray.<UserProcess>>} A list of user-defined processes.
|
|
2358
|
-
* @throws {Error}
|
|
2532
|
+
* @returns {ProcessPages} A paged list of user-defined processes.
|
|
2359
2533
|
*/
|
|
2360
|
-
paginateUserProcesses(limit?: number | null
|
|
2534
|
+
paginateUserProcesses(limit?: number | null): ProcessPages;
|
|
2361
2535
|
/**
|
|
2362
2536
|
* Creates a new stored user-defined process at the back-end.
|
|
2363
2537
|
*
|
|
@@ -2390,7 +2564,7 @@ declare module OpenEO {
|
|
|
2390
2564
|
* @param {object.<string, *>} [additional={}] - Other parameters to pass for the batch job, e.g. `log_level`.
|
|
2391
2565
|
* @returns {Promise<SyncResult>} - An object with the data and some metadata.
|
|
2392
2566
|
*/
|
|
2393
|
-
computeResult(process: Process, plan?: string | null, budget?: number | null, abortController?: AbortController | null, additional?:
|
|
2567
|
+
computeResult(process: Process, plan?: string | null, budget?: number | null, abortController?: AbortController | null, additional?: Record<string, any>): Promise<SyncResult>;
|
|
2394
2568
|
/**
|
|
2395
2569
|
* Executes a process synchronously and downloads to result the given path.
|
|
2396
2570
|
*
|
|
@@ -2421,13 +2595,10 @@ declare module OpenEO {
|
|
|
2421
2595
|
/**
|
|
2422
2596
|
* Paginate through the batch jobs of the authenticated user.
|
|
2423
2597
|
*
|
|
2424
|
-
* @async
|
|
2425
2598
|
* @param {?number} [limit=50] - The number of jobs per request/page as integer. If `null`, requests all jobs.
|
|
2426
|
-
* @
|
|
2427
|
-
* @yields {Promise<ResponseArray.<Job>>} A list of jobs.
|
|
2428
|
-
* @throws {Error}
|
|
2599
|
+
* @returns {JobPages} A paged list of jobs.
|
|
2429
2600
|
*/
|
|
2430
|
-
paginateJobs(limit?: number | null
|
|
2601
|
+
paginateJobs(limit?: number | null): JobPages;
|
|
2431
2602
|
/**
|
|
2432
2603
|
* Creates a new batch job at the back-end.
|
|
2433
2604
|
*
|
|
@@ -2441,7 +2612,7 @@ declare module OpenEO {
|
|
|
2441
2612
|
* @returns {Promise<Job>} The stored batch job.
|
|
2442
2613
|
* @throws {Error}
|
|
2443
2614
|
*/
|
|
2444
|
-
createJob(process: Process, title?: string | null, description?: string | null, plan?: string | null, budget?: number | null, additional?:
|
|
2615
|
+
createJob(process: Process, title?: string | null, description?: string | null, plan?: string | null, budget?: number | null, additional?: Record<string, any>): Promise<Job>;
|
|
2445
2616
|
/**
|
|
2446
2617
|
* Get all information about a batch job.
|
|
2447
2618
|
*
|
|
@@ -2456,20 +2627,17 @@ declare module OpenEO {
|
|
|
2456
2627
|
*
|
|
2457
2628
|
* @async
|
|
2458
2629
|
* @param {Array.<Service>} [oldServices=[]] - A list of existing services to update.
|
|
2459
|
-
* @returns {Promise<ResponseArray.<
|
|
2630
|
+
* @returns {Promise<ResponseArray.<Service>>} A list of services.
|
|
2460
2631
|
* @throws {Error}
|
|
2461
2632
|
*/
|
|
2462
|
-
listServices(oldServices?: Array<Service>): Promise<ResponseArray<
|
|
2633
|
+
listServices(oldServices?: Array<Service>): Promise<ResponseArray<Service>>;
|
|
2463
2634
|
/**
|
|
2464
2635
|
* Paginate through the secondary web services of the authenticated user.
|
|
2465
2636
|
*
|
|
2466
|
-
* @async
|
|
2467
2637
|
* @param {?number} [limit=50] - The number of services per request/page as integer. If `null` (default), requests all services.
|
|
2468
|
-
* @
|
|
2469
|
-
* @yields {Promise<ResponseArray.<Job>>} A list of services.
|
|
2470
|
-
* @throws {Error}
|
|
2638
|
+
* @returns {ServicePages} A paged list of services.
|
|
2471
2639
|
*/
|
|
2472
|
-
paginateServices(limit?: number | null
|
|
2640
|
+
paginateServices(limit?: number | null): ServicePages;
|
|
2473
2641
|
/**
|
|
2474
2642
|
* Creates a new secondary web service at the back-end.
|
|
2475
2643
|
*
|
|
@@ -2486,7 +2654,7 @@ declare module OpenEO {
|
|
|
2486
2654
|
* @returns {Promise<Service>} The stored service.
|
|
2487
2655
|
* @throws {Error}
|
|
2488
2656
|
*/
|
|
2489
|
-
createService(process: Process, type: string, title?: string | null, description?: string | null, enabled?: boolean, configuration?:
|
|
2657
|
+
createService(process: Process, type: string, title?: string | null, description?: string | null, enabled?: boolean, configuration?: Record<string, any>, plan?: string | null, budget?: number | null, additional?: Record<string, any>): Promise<Service>;
|
|
2490
2658
|
/**
|
|
2491
2659
|
* Get all information about a secondary web service.
|
|
2492
2660
|
*
|
|
@@ -2496,18 +2664,6 @@ declare module OpenEO {
|
|
|
2496
2664
|
* @throws {Error}
|
|
2497
2665
|
*/
|
|
2498
2666
|
getService(id: string): Promise<Service>;
|
|
2499
|
-
/**
|
|
2500
|
-
* Adds additional response details to the array.
|
|
2501
|
-
*
|
|
2502
|
-
* Adds links and federation:missing.
|
|
2503
|
-
*
|
|
2504
|
-
* @protected
|
|
2505
|
-
* @param {Array.<*>} arr
|
|
2506
|
-
* @param {object.<string, *>} response
|
|
2507
|
-
* @param {string} selfUrl
|
|
2508
|
-
* @returns {ResponseArray}
|
|
2509
|
-
*/
|
|
2510
|
-
protected _toResponseArray(arr: Array<any>, response: object<string, any>, selfUrl: string): ResponseArray;
|
|
2511
2667
|
/**
|
|
2512
2668
|
* Get the a link with the given rel type.
|
|
2513
2669
|
*
|
|
@@ -2518,22 +2674,6 @@ declare module OpenEO {
|
|
|
2518
2674
|
* @throws {Error}
|
|
2519
2675
|
*/
|
|
2520
2676
|
protected _getLinkHref(links: Array<Link>, rel: string | Array<string>): string | null;
|
|
2521
|
-
/**
|
|
2522
|
-
* Get the URL of the next page from a response.
|
|
2523
|
-
*
|
|
2524
|
-
* @protected
|
|
2525
|
-
* @param {AxiosResponse} response
|
|
2526
|
-
* @returns {string | null}
|
|
2527
|
-
*/
|
|
2528
|
-
protected _getNextLink(response: AxiosResponse): string | null;
|
|
2529
|
-
/**
|
|
2530
|
-
* Add a self link to the response if not present.
|
|
2531
|
-
*
|
|
2532
|
-
* @param {object} data - The body of the response as an object.
|
|
2533
|
-
* @param {string} selfUrl - The URL of the current request.
|
|
2534
|
-
* @returns {object} The modified object.
|
|
2535
|
-
*/
|
|
2536
|
-
_addSelfLink(data: object, selfUrl: string): object;
|
|
2537
2677
|
/**
|
|
2538
2678
|
* Makes all links in the list absolute.
|
|
2539
2679
|
*
|
|
@@ -2555,7 +2695,7 @@ declare module OpenEO {
|
|
|
2555
2695
|
* @throws {Error}
|
|
2556
2696
|
* @see https://github.com/axios/axios#request-config
|
|
2557
2697
|
*/
|
|
2558
|
-
protected _get(path: string, query:
|
|
2698
|
+
protected _get(path: string, query: Record<string, any>, responseType: string, abortController?: AbortController | null): Promise<AxiosResponse>;
|
|
2559
2699
|
/**
|
|
2560
2700
|
* Sends a POST request.
|
|
2561
2701
|
*
|
|
@@ -2619,7 +2759,7 @@ declare module OpenEO {
|
|
|
2619
2759
|
* @protected
|
|
2620
2760
|
* @returns {object.<string, string>}
|
|
2621
2761
|
*/
|
|
2622
|
-
protected _getAuthHeaders():
|
|
2762
|
+
protected _getAuthHeaders(): Record<string, string>;
|
|
2623
2763
|
/**
|
|
2624
2764
|
* Sends a HTTP request.
|
|
2625
2765
|
*
|
|
@@ -2640,7 +2780,7 @@ declare module OpenEO {
|
|
|
2640
2780
|
* @throws {Error}
|
|
2641
2781
|
* @see https://github.com/axios/axios
|
|
2642
2782
|
*/
|
|
2643
|
-
protected _send(options:
|
|
2783
|
+
protected _send(options: Record<string, any>, abortController?: AbortController | null): Promise<AxiosResponse>;
|
|
2644
2784
|
}
|
|
2645
2785
|
namespace Connection {
|
|
2646
2786
|
export { oidcProviderFactoryFunction, uploadStatusCallback };
|
|
@@ -2736,7 +2876,7 @@ declare module OpenEO {
|
|
|
2736
2876
|
status: number;
|
|
2737
2877
|
statusText: string;
|
|
2738
2878
|
headers: any;
|
|
2739
|
-
config:
|
|
2879
|
+
config: Record<string, any>;
|
|
2740
2880
|
request: any;
|
|
2741
2881
|
};
|
|
2742
2882
|
export type BillingPlan = {
|
|
@@ -2769,22 +2909,22 @@ declare module OpenEO {
|
|
|
2769
2909
|
*/
|
|
2770
2910
|
"federation:missing": Array<string>;
|
|
2771
2911
|
};
|
|
2772
|
-
export type Collection =
|
|
2912
|
+
export type Collection = Record<string, any>;
|
|
2773
2913
|
export type FileTypesAPI = {
|
|
2774
2914
|
/**
|
|
2775
2915
|
* - File types supported to import
|
|
2776
2916
|
*/
|
|
2777
|
-
input:
|
|
2917
|
+
input: Record<string, FileType>;
|
|
2778
2918
|
/**
|
|
2779
2919
|
* - File types supported to export
|
|
2780
2920
|
*/
|
|
2781
|
-
output:
|
|
2921
|
+
output: Record<string, FileType>;
|
|
2782
2922
|
};
|
|
2783
2923
|
export type FileType = {
|
|
2784
2924
|
title: string;
|
|
2785
2925
|
description: string;
|
|
2786
2926
|
gis_data_types: Array<string>;
|
|
2787
|
-
parameters:
|
|
2927
|
+
parameters: Record<string, any>;
|
|
2788
2928
|
links: Array<Link>;
|
|
2789
2929
|
};
|
|
2790
2930
|
/**
|
|
@@ -2805,7 +2945,7 @@ declare module OpenEO {
|
|
|
2805
2945
|
*/
|
|
2806
2946
|
from_parameter: string;
|
|
2807
2947
|
};
|
|
2808
|
-
export type Item =
|
|
2948
|
+
export type Item = Record<string, any>;
|
|
2809
2949
|
export type ItemCollection = {
|
|
2810
2950
|
/**
|
|
2811
2951
|
* - The items in the collection.
|
|
@@ -2879,7 +3019,7 @@ declare module OpenEO {
|
|
|
2879
3019
|
level: string;
|
|
2880
3020
|
message: string;
|
|
2881
3021
|
data: any;
|
|
2882
|
-
path: Array<
|
|
3022
|
+
path: Array<Record<string, string | null>>;
|
|
2883
3023
|
links: Array<Link>;
|
|
2884
3024
|
};
|
|
2885
3025
|
/**
|
|
@@ -2956,11 +3096,36 @@ declare module OpenEO {
|
|
|
2956
3096
|
/**
|
|
2957
3097
|
* An openEO processing chain.
|
|
2958
3098
|
*/
|
|
2959
|
-
export type Process =
|
|
3099
|
+
export type Process = Record<string, any>;
|
|
3100
|
+
/**
|
|
3101
|
+
* A specific processing parameter.
|
|
3102
|
+
*/
|
|
3103
|
+
type ProcessingParameter = object<string, any>;
|
|
2960
3104
|
/**
|
|
2961
|
-
*
|
|
3105
|
+
* All types of processing parameters.
|
|
3106
|
+
*/
|
|
3107
|
+
type ProcessingParameters = {
|
|
3108
|
+
/**
|
|
3109
|
+
* Processing parameters for batch jobs.
|
|
3110
|
+
*/
|
|
3111
|
+
create_job_parameters: Array<ProcessingParameter>;
|
|
3112
|
+
/**
|
|
3113
|
+
* Processing parameters for secondary web services.
|
|
3114
|
+
*/
|
|
3115
|
+
create_service_parameters: Array<ProcessingParameter>;
|
|
3116
|
+
/**
|
|
3117
|
+
* Processing parameters for synchronous processing.
|
|
3118
|
+
*/
|
|
3119
|
+
create_synchronous_parameters: Array<ProcessingParameter>;
|
|
3120
|
+
};
|
|
3121
|
+
/**
|
|
3122
|
+
* A back-end in the federation.
|
|
2962
3123
|
*/
|
|
2963
3124
|
export type FederationBackend = {
|
|
3125
|
+
/**
|
|
3126
|
+
* ID of the back-end within the federation.
|
|
3127
|
+
*/
|
|
3128
|
+
id: string;
|
|
2964
3129
|
/**
|
|
2965
3130
|
* URL to the versioned API endpoint of the back-end.
|
|
2966
3131
|
*/
|
|
@@ -2974,7 +3139,7 @@ declare module OpenEO {
|
|
|
2974
3139
|
*/
|
|
2975
3140
|
description: string;
|
|
2976
3141
|
/**
|
|
2977
|
-
* Current status of the back-
|
|
3142
|
+
* Current status of the back-end (online or offline).
|
|
2978
3143
|
*/
|
|
2979
3144
|
status: string;
|
|
2980
3145
|
/**
|
|
@@ -2997,10 +3162,10 @@ declare module OpenEO {
|
|
|
2997
3162
|
/**
|
|
2998
3163
|
* An array, but enriched with additional details from an openEO API response.
|
|
2999
3164
|
*
|
|
3000
|
-
* Adds
|
|
3165
|
+
* Adds two properties: `links` and `federation:missing`.
|
|
3001
3166
|
*/
|
|
3002
3167
|
export type ResponseArray = any;
|
|
3003
|
-
export type ServiceType =
|
|
3168
|
+
export type ServiceType = Record<string, any>;
|
|
3004
3169
|
export type SyncResult = {
|
|
3005
3170
|
/**
|
|
3006
3171
|
* The data as `Stream` in NodeJS environments or as `Blob` in browsers.
|
|
@@ -3019,7 +3184,7 @@ declare module OpenEO {
|
|
|
3019
3184
|
*/
|
|
3020
3185
|
logs: Array<Log>;
|
|
3021
3186
|
};
|
|
3022
|
-
export type UdfRuntime =
|
|
3187
|
+
export type UdfRuntime = Record<string, any>;
|
|
3023
3188
|
export type UserAccountStorage = {
|
|
3024
3189
|
/**
|
|
3025
3190
|
* in bytes as integer
|