@openeo/js-client 2.3.1 → 2.4.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/openeo.d.ts CHANGED
@@ -78,13 +78,6 @@ declare module OpenEO {
78
78
  * @param {?string} token
79
79
  */
80
80
  setToken(token: string | null): void;
81
- /**
82
- * Abstract method that extending classes implement the login process with.
83
- *
84
- * @param {...*} args
85
- * @throws {Error}
86
- */
87
- login(...args: any[]): Promise<void>;
88
81
  /**
89
82
  * Logout from the established session.
90
83
  *
@@ -117,12 +110,12 @@ declare module OpenEO {
117
110
  * @protected
118
111
  * @type {object.<string, string>}
119
112
  */
120
- protected apiToClientNames: any;
113
+ protected apiToClientNames: object<string, string>;
121
114
  /**
122
115
  * @protected
123
116
  * @type {object.<string, string>}
124
117
  */
125
- protected clientToApiNames: any;
118
+ protected clientToApiNames: object<string, string>;
126
119
  /**
127
120
  * @protected
128
121
  * @type {number}
@@ -134,20 +127,20 @@ declare module OpenEO {
134
127
  * @protected
135
128
  * @type {object.<string, *>}
136
129
  */
137
- protected extra: any;
130
+ protected extra: object<string, any>;
138
131
  /**
139
132
  * Returns a JSON serializable representation of the data that is API compliant.
140
133
  *
141
134
  * @returns {object.<string, *>}
142
135
  */
143
- toJSON(): any;
136
+ toJSON(): object<string, any>;
144
137
  /**
145
138
  * Converts the data from an API response into data suitable for our JS client models.
146
139
  *
147
140
  * @param {object.<string, *>} metadata - JSON object originating from an API response.
148
141
  * @returns {BaseEntity} Returns the object itself.
149
142
  */
150
- setAll(metadata: any): BaseEntity;
143
+ setAll(metadata: object<string, any>): BaseEntity;
151
144
  /**
152
145
  * Returns the age of the data in seconds.
153
146
  *
@@ -159,7 +152,7 @@ declare module OpenEO {
159
152
  *
160
153
  * @returns {object.<string, *>}
161
154
  */
162
- getAll(): any;
155
+ getAll(): object<string, any>;
163
156
  /**
164
157
  * Get a value from the additional data that is not part of the core model, i.e. from proprietary extensions.
165
158
  *
@@ -174,7 +167,7 @@ declare module OpenEO {
174
167
  * @returns {object.<string, *>}
175
168
  * @protected
176
169
  */
177
- protected _convertToRequest(parameters: any): any;
170
+ protected _convertToRequest(parameters: object<string, any>): object<string, any>;
178
171
  /**
179
172
  * Checks whether a features is supported by the API.
180
173
  *
@@ -265,7 +258,7 @@ declare module OpenEO {
265
258
  * @param {string} targetFolder
266
259
  * @throws {Error}
267
260
  */
268
- static downloadResults(con: any, assets: Array<any>, targetFolder: string): Promise<void>;
261
+ static downloadResults(con: Connection, assets: Array<object<string, any>>, targetFolder: string): Promise<void>;
269
262
  /**
270
263
  * Streams data into a file (node) or offers data to download (browser).
271
264
  *
@@ -314,7 +307,7 @@ declare module OpenEO {
314
307
  * @param {object.<string, *>} data - A capabilities response compatible to the API specification for `GET /`.
315
308
  * @throws {Error}
316
309
  */
317
- constructor(data: any);
310
+ constructor(data: object<string, any>);
318
311
  /**
319
312
  * @private
320
313
  * @type {object.<string, *>}
@@ -336,7 +329,7 @@ declare module OpenEO {
336
329
  *
337
330
  * @returns {object.<string, *>} - A reference to the capabilities response.
338
331
  */
339
- toJSON(): any;
332
+ toJSON(): object<string, any>;
340
333
  /**
341
334
  * Returns the openEO API version implemented by the back-end.
342
335
  *
@@ -436,7 +429,7 @@ declare module OpenEO {
436
429
  * @throws {Error}
437
430
  * @see https://github.com/IdentityModel/oidc-client-js/wiki#other-optional-settings
438
431
  */
439
- static signinCallback(provider?: OidcProvider, options?: any): Promise<User | null>;
432
+ static signinCallback(provider?: OidcProvider, options?: object<string, any>): Promise<User | null>;
440
433
  /**
441
434
  * Creates a new OidcProvider instance to authenticate using OpenID Connect.
442
435
  *
@@ -455,7 +448,7 @@ declare module OpenEO {
455
448
  /**
456
449
  * The client ID to use for authentication.
457
450
  *
458
- * @type {?string}
451
+ * @type {string | null}
459
452
  */
460
453
  clientId: string | null;
461
454
  /**
@@ -478,6 +471,12 @@ declare module OpenEO {
478
471
  * @type {Array.<string>}
479
472
  */
480
473
  scopes: Array<string>;
474
+ /**
475
+ * The scope that is used to request a refresh token.
476
+ *
477
+ * @type {string}
478
+ */
479
+ refreshTokenScope: string;
481
480
  /**
482
481
  * Any additional links.
483
482
  *
@@ -524,9 +523,11 @@ declare module OpenEO {
524
523
  *
525
524
  * @protected
526
525
  * @param {object.<string, *>} options
526
+ * @param {boolean} [requestRefreshToken=false] - If set to `true`, adds a scope to request a refresh token.
527
527
  * @returns {object.<string, *>}
528
+ * @see {OidcProvider#refreshTokenScope}
528
529
  */
529
- protected getOptions(options?: any): any;
530
+ protected getOptions(options?: object<string, any>, requestRefreshToken?: boolean): object<string, any>;
530
531
  /**
531
532
  * Get the response_type based on the grant type.
532
533
  *
@@ -567,6 +568,20 @@ declare module OpenEO {
567
568
  * @see OidcProvider#setClientId
568
569
  */
569
570
  detectDefaultClient(): OidcClient | null;
571
+ /**
572
+ * Authenticate with OpenID Connect (OIDC).
573
+ *
574
+ * Supported only in Browser environments.
575
+ *
576
+ * @async
577
+ * @param {object.<string, *>} [options={}] - Object with authentication options.
578
+ * @param {boolean} [requestRefreshToken=false] - If set to `true`, adds a scope to request a refresh token.
579
+ * @returns {Promise<void>}
580
+ * @throws {Error}
581
+ * @see https://github.com/IdentityModel/oidc-client-js/wiki#other-optional-settings
582
+ * @see {OidcProvider#refreshTokenScope}
583
+ */
584
+ login(options?: any, requestRefreshToken?: boolean) : void;
570
585
  }
571
586
  export namespace OidcProvider {
572
587
  const uiMethod: string;
@@ -598,13 +613,13 @@ declare module OpenEO {
598
613
  *
599
614
  * @returns {object.<string, FileType>}
600
615
  */
601
- getInputTypes(): any;
616
+ getInputTypes(): object<string, FileType>;
602
617
  /**
603
618
  * Returns the output file formats.
604
619
  *
605
620
  * @returns {object.<string, FileType>}
606
621
  */
607
- getOutputTypes(): any;
622
+ getOutputTypes(): object<string, FileType>;
608
623
  /**
609
624
  * Returns a single input file format for a given identifier.
610
625
  *
@@ -804,7 +819,7 @@ declare module OpenEO {
804
819
  * The process chain to be executed.
805
820
  * @public
806
821
  * @readonly
807
- * @type {Process}
822
+ * @type {?Process}
808
823
  */
809
824
  public readonly process: Process;
810
825
  /**
@@ -812,37 +827,37 @@ declare module OpenEO {
812
827
  * One of "created", "queued", "running", "canceled", "finished" or "error".
813
828
  * @public
814
829
  * @readonly
815
- * @type {string}
830
+ * @type {?string}
816
831
  */
817
- public readonly status: string;
832
+ public readonly status: string | null;
818
833
  /**
819
834
  * Indicates the process of a running batch job in percent.
820
835
  * @public
821
836
  * @readonly
822
- * @type {number}
837
+ * @type {?number}
823
838
  */
824
- public readonly progress: number;
839
+ public readonly progress: number | null;
825
840
  /**
826
841
  * Date and time of creation, formatted as a RFC 3339 date-time.
827
842
  * @public
828
843
  * @readonly
829
- * @type {string}
844
+ * @type {?string}
830
845
  */
831
- public readonly created: string;
846
+ public readonly created: string | null;
832
847
  /**
833
848
  * Date and time of the last status change, formatted as a RFC 3339 date-time.
834
849
  * @public
835
850
  * @readonly
836
- * @type {string}
851
+ * @type {?string}
837
852
  */
838
- public readonly updated: string;
853
+ public readonly updated: string | null;
839
854
  /**
840
855
  * The billing plan to process and charge the batch job with.
841
856
  * @public
842
857
  * @readonly
843
- * @type {string}
858
+ * @type {?string}
844
859
  */
845
- public readonly plan: string;
860
+ public readonly plan: string | null;
846
861
  /**
847
862
  * An amount of money or credits in the currency specified by the back-end.
848
863
  * @public
@@ -952,7 +967,7 @@ declare module OpenEO {
952
967
  * @returns {Promise<object.<string, *>>} The JSON-based response compatible to the API specification, but also including a `costs` property if present in the headers.
953
968
  * @throws {Error}
954
969
  */
955
- getResultsAsStac(): Promise<any>;
970
+ getResultsAsStac(): Promise<object<string, any>>;
956
971
  /**
957
972
  * Retrieves download links.
958
973
  *
@@ -1009,9 +1024,9 @@ declare module OpenEO {
1009
1024
  * A list of categories.
1010
1025
  * @public
1011
1026
  * @readonly
1012
- * @type {Array.<string>}
1027
+ * @type {?Array.<string>}
1013
1028
  */
1014
- public readonly categories: Array<string>;
1029
+ public readonly categories: Array<string> | null;
1015
1030
  /**
1016
1031
  * A list of parameters.
1017
1032
  *
@@ -1019,54 +1034,54 @@ declare module OpenEO {
1019
1034
  * @readonly
1020
1035
  * @type {?Array.<object.<string, *>>}
1021
1036
  */
1022
- public readonly parameters: Array<any> | null;
1037
+ public readonly parameters: Array<object<string, any>> | null;
1023
1038
  /**
1024
1039
  * Description of the data that is returned by this process.
1025
1040
  * @public
1026
1041
  * @readonly
1027
1042
  * @type {?object.<string, *>}
1028
1043
  */
1029
- public readonly returns: any;
1044
+ public readonly returns: object<string, any>;
1030
1045
  /**
1031
1046
  * Specifies that the process or parameter is deprecated with the potential to be removed in any of the next versions.
1032
1047
  * @public
1033
1048
  * @readonly
1034
- * @type {boolean}
1049
+ * @type {?boolean}
1035
1050
  */
1036
- public readonly deprecated: boolean;
1051
+ public readonly deprecated: boolean | null;
1037
1052
  /**
1038
1053
  * Declares the process or parameter to be experimental, which means that it is likely to change or may produce unpredictable behaviour.
1039
1054
  * @public
1040
1055
  * @readonly
1041
- * @type {boolean}
1056
+ * @type {?boolean}
1042
1057
  */
1043
- public readonly experimental: boolean;
1058
+ public readonly experimental: boolean | null;
1044
1059
  /**
1045
1060
  * Declares any exceptions (errors) that might occur during execution of this process.
1046
1061
  * @public
1047
1062
  * @readonly
1048
- * @type {object.<string, *>}
1063
+ * @type {?object.<string, *>}
1049
1064
  */
1050
- public readonly exceptions: any;
1065
+ public readonly exceptions: object<string, any>;
1051
1066
  /**
1052
1067
  * @public
1053
1068
  * @readonly
1054
- * @type {Array.<object.<string, *>>}
1069
+ * @type {?Array.<object.<string, *>>}
1055
1070
  */
1056
- public readonly examples: Array<any>;
1071
+ public readonly examples: Array<object<string, any>> | null;
1057
1072
  /**
1058
1073
  * Links related to this process.
1059
1074
  * @public
1060
1075
  * @readonly
1061
- * @type {Array.<Link>}
1076
+ * @type {?Array.<Link>}
1062
1077
  */
1063
- public readonly links: Array<Link>;
1078
+ public readonly links: Array<Link> | null;
1064
1079
  /**
1065
1080
  * @public
1066
1081
  * @readonly
1067
- * @type {object.<string, *>}
1082
+ * @type {?object.<string, *>}
1068
1083
  */
1069
- public readonly processGraph: any;
1084
+ public readonly processGraph: object<string, any>;
1070
1085
  /**
1071
1086
  * Updates the data stored in this object by requesting the process graph metadata from the back-end.
1072
1087
  *
@@ -1135,57 +1150,57 @@ declare module OpenEO {
1135
1150
  * The process chain to be executed.
1136
1151
  * @public
1137
1152
  * @readonly
1138
- * @type {Process}
1153
+ * @type {?Process}
1139
1154
  */
1140
1155
  public readonly process: Process;
1141
1156
  /**
1142
1157
  * URL at which the secondary web service is accessible
1143
1158
  * @public
1144
1159
  * @readonly
1145
- * @type {string}
1160
+ * @type {?string}
1146
1161
  */
1147
- public readonly url: string;
1162
+ public readonly url: string | null;
1148
1163
  /**
1149
1164
  * Web service type (protocol / standard) that is exposed.
1150
1165
  * @public
1151
1166
  * @readonly
1152
- * @type {string}
1167
+ * @type {?string}
1153
1168
  */
1154
- public readonly type: string;
1169
+ public readonly type: string | null;
1155
1170
  /**
1156
1171
  * @public
1157
1172
  * @readonly
1158
- * @type {boolean}
1173
+ * @type {?boolean}
1159
1174
  */
1160
- public readonly enabled: boolean;
1175
+ public readonly enabled: boolean | null;
1161
1176
  /**
1162
1177
  * Map of configuration settings, i.e. the setting names supported by the secondary web service combined with actual values.
1163
1178
  * @public
1164
1179
  * @readonly
1165
- * @type {object.<string, *>}
1180
+ * @type {?object.<string, *>}
1166
1181
  */
1167
- public readonly configuration: any;
1182
+ public readonly configuration: object<string, any>;
1168
1183
  /**
1169
1184
  * Additional attributes of the secondary web service, e.g. available layers for a WMS based on the bands in the underlying GeoTiff.
1170
1185
  * @public
1171
1186
  * @readonly
1172
- * @type {object.<string, *>}
1187
+ * @type {?object.<string, *>}
1173
1188
  */
1174
- public readonly attributes: any;
1189
+ public readonly attributes: object<string, any>;
1175
1190
  /**
1176
1191
  * Date and time of creation, formatted as a RFC 3339 date-time.
1177
1192
  * @public
1178
1193
  * @readonly
1179
- * @type {string}
1194
+ * @type {?string}
1180
1195
  */
1181
- public readonly created: string;
1196
+ public readonly created: string | null;
1182
1197
  /**
1183
1198
  * The billing plan to process and charge the service with.
1184
1199
  * @public
1185
1200
  * @readonly
1186
- * @type {string}
1201
+ * @type {?string}
1187
1202
  */
1188
- public readonly plan: string;
1203
+ public readonly plan: string | null;
1189
1204
  /**
1190
1205
  * An amount of money or credits in the currency specified by the back-end.
1191
1206
  * @public
@@ -1228,7 +1243,7 @@ declare module OpenEO {
1228
1243
  title: string;
1229
1244
  description: string;
1230
1245
  enabled: boolean;
1231
- configuration: any;
1246
+ configuration: object<string, any>;
1232
1247
  plan: string;
1233
1248
  budget: number;
1234
1249
  }): Promise<Service>;
@@ -1310,7 +1325,7 @@ declare module OpenEO {
1310
1325
  * @param {string} description - A description for the parameter
1311
1326
  * @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`.
1312
1327
  */
1313
- constructor(name: string, schema?: any | string, description?: string, defaultValue?: any);
1328
+ constructor(name: string, schema?: object<string, any> | string, description?: string, defaultValue?: any);
1314
1329
  name: string;
1315
1330
  spec: {
1316
1331
  name: string;
@@ -1322,7 +1337,7 @@ declare module OpenEO {
1322
1337
  *
1323
1338
  * @returns {object.<string, *>}
1324
1339
  */
1325
- toJSON(): any;
1340
+ toJSON(): object<string, any>;
1326
1341
  /**
1327
1342
  * Returns the reference object for this parameter.
1328
1343
  *
@@ -1378,9 +1393,9 @@ declare module OpenEO {
1378
1393
  /**
1379
1394
  * @type {object.<string, *>}
1380
1395
  */
1381
- tree: any;
1396
+ tree: object<string, any>;
1382
1397
  /**
1383
- * @type {?Builder}
1398
+ * @type {Builder | null}
1384
1399
  */
1385
1400
  builder: Builder | null;
1386
1401
  /**
@@ -1407,7 +1422,7 @@ declare module OpenEO {
1407
1422
  * @returns {object.<string, *>}
1408
1423
  * @throws {Error}
1409
1424
  */
1410
- protected parseTree(tree: any): any;
1425
+ protected parseTree(tree: object<string, any>): object<string, any>;
1411
1426
  /**
1412
1427
  * Gets the reference for a value, e.g. from_node or from_parameter.
1413
1428
  *
@@ -1425,10 +1440,10 @@ declare module OpenEO {
1425
1440
  * @returns {BuilderNode}
1426
1441
  * @throws {Error}
1427
1442
  */
1428
- addOperatorProcess(operator: string, left: number | any, right: number | any): BuilderNode;
1443
+ addOperatorProcess(operator: string, left: number | object<string, any>, right: number | object<string, any>): BuilderNode;
1429
1444
  }
1430
1445
  export namespace Formula {
1431
- const operatorMapping: any;
1446
+ const operatorMapping: object<string, string>;
1432
1447
  }
1433
1448
  /**
1434
1449
  * A class that represents a process node and also a result from a process.
@@ -1443,7 +1458,7 @@ declare module OpenEO {
1443
1458
  * @param {?string} [processDescription=null]
1444
1459
  * @param {?string} [processNamespace=null]
1445
1460
  */
1446
- constructor(parent: Builder, processId: string, processArgs?: any, processDescription?: string | null, processNamespace?: string | null);
1461
+ constructor(parent: Builder, processId: string, processArgs?: object<string, any>, processDescription?: string | null, processNamespace?: string | null);
1447
1462
  /**
1448
1463
  * The parent builder.
1449
1464
  * @type {Builder}
@@ -1469,7 +1484,7 @@ declare module OpenEO {
1469
1484
  * The arguments for the process.
1470
1485
  * @type {object.<string, *>}
1471
1486
  */
1472
- arguments: any;
1487
+ arguments: object<string, any>;
1473
1488
  /**
1474
1489
  * @ignore
1475
1490
  */
@@ -1486,13 +1501,13 @@ declare module OpenEO {
1486
1501
  * @returns {object.<string, *>}
1487
1502
  * @throws {Error}
1488
1503
  */
1489
- namedArguments(processArgs: any[]): any;
1504
+ namedArguments(processArgs: any[]): object<string, any>;
1490
1505
  /**
1491
1506
  * Checks the arguments given for parameters and add them to the process.
1492
1507
  *
1493
1508
  * @param {object.<string, *>|Array} processArgs
1494
1509
  */
1495
- addParametersToProcess(processArgs: any | any[]): void;
1510
+ addParametersToProcess(processArgs: object<string, any> | any[]): void;
1496
1511
  /**
1497
1512
  * Gets/Sets a description for the node.
1498
1513
  *
@@ -1538,13 +1553,13 @@ declare module OpenEO {
1538
1553
  * @returns {object.<string, *>}
1539
1554
  * @throws {Error}
1540
1555
  */
1541
- protected exportCallback(arg: Function, name: string): any;
1556
+ protected exportCallback(arg: Function, name: string): object<string, any>;
1542
1557
  /**
1543
1558
  * Returns a JSON serializable representation of the data that is API compliant.
1544
1559
  *
1545
1560
  * @returns {object.<string, *>}
1546
1561
  */
1547
- toJSON(): any;
1562
+ toJSON(): object<string, any>;
1548
1563
  /**
1549
1564
  * Returns the reference object for this node.
1550
1565
  *
@@ -1661,17 +1676,17 @@ declare module OpenEO {
1661
1676
  public id: string;
1662
1677
  /**
1663
1678
  * The parent builder.
1664
- * @type {?Builder}
1679
+ * @type {Builder | null}
1665
1680
  */
1666
1681
  parent: Builder | null;
1667
1682
  /**
1668
1683
  * The parent node.
1669
- * @type {?BuilderNode}
1684
+ * @type {BuilderNode | null}
1670
1685
  */
1671
1686
  parentNode: BuilderNode | null;
1672
1687
  /**
1673
1688
  * The parent parameter name.
1674
- * @type {?string}
1689
+ * @type {string | null}
1675
1690
  */
1676
1691
  parentParameter: string | null;
1677
1692
  nodes: {};
@@ -1689,7 +1704,7 @@ declare module OpenEO {
1689
1704
  * @param {Process} process
1690
1705
  * @throws {Error}
1691
1706
  */
1692
- createFunction(process: any): void;
1707
+ createFunction(process: Process): void;
1693
1708
  /**
1694
1709
  * Adds a process specification to the builder so that it can be used to create a process graph.
1695
1710
  *
@@ -1728,7 +1743,7 @@ declare module OpenEO {
1728
1743
  * @param {object.<string, *>} parameter - The parameter spec to add, must comply to the API.
1729
1744
  * @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.
1730
1745
  */
1731
- addParameter(parameter: any, root?: boolean): void;
1746
+ addParameter(parameter: object<string, any>, root?: boolean): void;
1732
1747
  /**
1733
1748
  * Returns the process specification for the given process identifier and namespace (or `null`).
1734
1749
  *
@@ -1764,7 +1779,7 @@ declare module OpenEO {
1764
1779
  * @param {?string} [description=null] - An optional description for the process call.
1765
1780
  * @returns {BuilderNode}
1766
1781
  */
1767
- process(processId: string, args?: any | any[], description?: string | null): BuilderNode;
1782
+ process(processId: string, args?: object<string, any> | any[], description?: string | null): BuilderNode;
1768
1783
  /**
1769
1784
  * Returns a JSON serializable representation of the data that is API compliant.
1770
1785
  *
@@ -1814,37 +1829,30 @@ declare module OpenEO {
1814
1829
  * Auth Provider cache
1815
1830
  *
1816
1831
  * @protected
1817
- * @type {?Array.<AuthProvider>}
1832
+ * @type {Array.<AuthProvider> | null}
1818
1833
  */
1819
1834
  protected authProviderList: Array<AuthProvider> | null;
1820
1835
  /**
1821
1836
  * Current auth provider
1822
1837
  *
1823
1838
  * @protected
1824
- * @type {?AuthProvider}
1839
+ * @type {AuthProvider | null}
1825
1840
  */
1826
1841
  protected authProvider: AuthProvider | null;
1827
1842
  /**
1828
1843
  * Capability cache
1829
1844
  *
1830
1845
  * @protected
1831
- * @type {?Capabilities}
1846
+ * @type {Capabilities | null}
1832
1847
  */
1833
1848
  protected capabilitiesObject: Capabilities | null;
1834
- /**
1835
- * Process cache
1836
- *
1837
- * @protected
1838
- * @type {ProcessRegistry}
1839
- */
1840
- protected processes: any;
1841
1849
  /**
1842
1850
  * Listeners for events.
1843
1851
  *
1844
1852
  * @protected
1845
1853
  * @type {object.<string|Function>}
1846
1854
  */
1847
- protected listeners: any;
1855
+ protected listeners: object<string | Function>;
1848
1856
  /**
1849
1857
  * Additional options for the connection.
1850
1858
  *
@@ -1852,6 +1860,13 @@ declare module OpenEO {
1852
1860
  * @type {Options}
1853
1861
  */
1854
1862
  protected options: Options;
1863
+ /**
1864
+ * Process cache
1865
+ *
1866
+ * @protected
1867
+ * @type {ProcessRegistry}
1868
+ */
1869
+ protected processes: ProcessRegistry;
1855
1870
  /**
1856
1871
  * Initializes the connection by requesting the capabilities.
1857
1872
  *
@@ -1859,7 +1874,7 @@ declare module OpenEO {
1859
1874
  * @protected
1860
1875
  * @returns {Promise<Capabilities>} Capabilities
1861
1876
  */
1862
- init(): Promise<Capabilities>;
1877
+ protected init(): Promise<Capabilities>;
1863
1878
  /**
1864
1879
  * Refresh the cache for processes.
1865
1880
  *
@@ -1867,7 +1882,7 @@ declare module OpenEO {
1867
1882
  * @protected
1868
1883
  * @returns {Promise}
1869
1884
  */
1870
- refreshProcessCache(): Promise;
1885
+ protected refreshProcessCache(): Promise<any>;
1871
1886
  /**
1872
1887
  * Returns the URL of the versioned back-end instance currently connected to.
1873
1888
  *
@@ -1901,7 +1916,7 @@ declare module OpenEO {
1901
1916
  * @returns {Promise<object.<string, ServiceType>>} A response compatible to the API specification.
1902
1917
  * @throws {Error}
1903
1918
  */
1904
- listServiceTypes(): Promise<any>;
1919
+ listServiceTypes(): Promise<object<string, ServiceType>>;
1905
1920
  /**
1906
1921
  * List the supported UDF runtimes.
1907
1922
  *
@@ -1909,7 +1924,7 @@ declare module OpenEO {
1909
1924
  * @returns {Promise<object.<string, UdfRuntime>>} A response compatible to the API specification.
1910
1925
  * @throws {Error}
1911
1926
  */
1912
- listUdfRuntimes(): Promise<any>;
1927
+ listUdfRuntimes(): Promise<object<string, UdfRuntime>>;
1913
1928
  /**
1914
1929
  * List all collections available on the back-end.
1915
1930
  *
@@ -1955,6 +1970,20 @@ declare module OpenEO {
1955
1970
  * @throws {Error}
1956
1971
  */
1957
1972
  listCollectionItems(collectionId: string, spatialExtent?: Array<number> | null, temporalExtent?: Array<any> | null, limit?: number | null): AsyncGenerator<any, void, unknown>;
1973
+ /**
1974
+ * Normalisation of the namespace to a value that is compatible with the OpenEO specs - EXPERIMENTAL.
1975
+ *
1976
+ * This is required to support UDP that are shared as public. These can only be executed with providing the full URL
1977
+ * (e.g. https://<backend>/processes/<namespace>/<process_id>) as the namespace value in the processing graph. For other
1978
+ * parts of the API (such as the listing of the processes, only the name of the namespace is required.
1979
+ *
1980
+ * This function will extract the short name of the namespace from a shareable URL.
1981
+ *
1982
+ * @protected
1983
+ * @param {?string} namespace - Namespace of the process
1984
+ * @returns {?string}
1985
+ */
1986
+ protected normalizeNamespace(namespace: string | null): string | null;
1958
1987
  /**
1959
1988
  * List processes available on the back-end.
1960
1989
  *
@@ -2131,6 +2160,7 @@ declare module OpenEO {
2131
2160
  *
2132
2161
  * @callback uploadStatusCallback
2133
2162
  * @param {number} percentCompleted - The percent (0-100) completed.
2163
+ * @param {UserFile} file - The file object corresponding to the callback.
2134
2164
  */
2135
2165
  /**
2136
2166
  * Uploads a file to the user workspace.
@@ -2144,7 +2174,7 @@ declare module OpenEO {
2144
2174
  * @param {*} source - The source, see method description for details.
2145
2175
  * @param {?string} [targetPath=null] - The target path on the server, relative to the user workspace. Defaults to the file name of the source file.
2146
2176
  * @param {?uploadStatusCallback} [statusCallback=null] - Optionally, a callback that is executed on upload progress updates.
2147
- * @param {?AbortController} [abortController=null] - An AbortController object that can be used to cancel the processing request.
2177
+ * @param {?AbortController} [abortController=null] - An AbortController object that can be used to cancel the upload process.
2148
2178
  * @returns {Promise<UserFile>}
2149
2179
  * @throws {Error}
2150
2180
  */
@@ -2167,7 +2197,7 @@ declare module OpenEO {
2167
2197
  * @returns {object.<string, *>}
2168
2198
  * @protected
2169
2199
  */
2170
- protected _normalizeUserProcess(process: UserProcess | BuilderNode | any, additional?: any): any;
2200
+ protected _normalizeUserProcess(process: UserProcess | BuilderNode | object<string, any>, additional?: object<string, any>): object<string, any>;
2171
2201
  /**
2172
2202
  * Validates a user-defined process at the back-end.
2173
2203
  *
@@ -2256,7 +2286,7 @@ declare module OpenEO {
2256
2286
  * @returns {Promise<Job>} The stored batch job.
2257
2287
  * @throws {Error}
2258
2288
  */
2259
- createJob(process: Process, title?: string | null, description?: string | null, plan?: string | null, budget?: number | null, additional?: any): Promise<Job>;
2289
+ createJob(process: Process, title?: string | null, description?: string | null, plan?: string | null, budget?: number | null, additional?: object<string, any>): Promise<Job>;
2260
2290
  /**
2261
2291
  * Get all information about a batch job.
2262
2292
  *
@@ -2290,7 +2320,7 @@ declare module OpenEO {
2290
2320
  * @returns {Promise<Service>} The stored service.
2291
2321
  * @throws {Error}
2292
2322
  */
2293
- createService(process: Process, type: string, title?: string | null, description?: string | null, enabled?: boolean, configuration?: any, plan?: string | null, budget?: number | null, additional?: any): Promise<Service>;
2323
+ createService(process: Process, type: string, title?: string | null, description?: string | null, enabled?: boolean, configuration?: any, plan?: string | null, budget?: number | null, additional?: object<string, any>): Promise<Service>;
2294
2324
  /**
2295
2325
  * Get all information about a secondary web service.
2296
2326
  *
@@ -2320,7 +2350,7 @@ declare module OpenEO {
2320
2350
  * @throws {Error}
2321
2351
  * @see https://github.com/axios/axios#request-config
2322
2352
  */
2323
- _get(path: string, query: any, responseType: string): Promise<AxiosResponse>;
2353
+ _get(path: string, query: object<string, any>, responseType: string): Promise<AxiosResponse>;
2324
2354
  /**
2325
2355
  * Sends a POST request.
2326
2356
  *
@@ -2489,7 +2519,7 @@ declare module OpenEO {
2489
2519
  status: number;
2490
2520
  statusText: string;
2491
2521
  headers: any;
2492
- config: any;
2522
+ config: object<string, any>;
2493
2523
  request: any;
2494
2524
  };
2495
2525
  export type BillingPlan = {
@@ -2518,22 +2548,22 @@ declare module OpenEO {
2518
2548
  collections: Array<Collection>;
2519
2549
  links: Array<Link>;
2520
2550
  };
2521
- export type Collection = any;
2551
+ export type Collection = object<string, any>;
2522
2552
  export type FileTypesAPI = {
2523
2553
  /**
2524
2554
  * - File types supported to import
2525
2555
  */
2526
- input: any;
2556
+ input: object<string, FileType>;
2527
2557
  /**
2528
2558
  * - File types supported to export
2529
2559
  */
2530
- output: any;
2560
+ output: object<string, FileType>;
2531
2561
  };
2532
2562
  export type FileType = {
2533
2563
  title: string;
2534
2564
  description: string;
2535
2565
  gis_data_types: Array<string>;
2536
- parameters: any;
2566
+ parameters: object<string, any>;
2537
2567
  links: Array<Link>;
2538
2568
  };
2539
2569
  /**
@@ -2554,7 +2584,7 @@ declare module OpenEO {
2554
2584
  */
2555
2585
  from_parameter: string;
2556
2586
  };
2557
- export type Item = any;
2587
+ export type Item = object<string, any>;
2558
2588
  export type ItemCollection = {
2559
2589
  /**
2560
2590
  * - The items in the collection.
@@ -2628,7 +2658,7 @@ declare module OpenEO {
2628
2658
  level: string;
2629
2659
  message: string;
2630
2660
  data: any;
2631
- path: Array<any>;
2661
+ path: Array<object<string, string>>;
2632
2662
  links: Array<Link>;
2633
2663
  };
2634
2664
  /**
@@ -2701,13 +2731,13 @@ declare module OpenEO {
2701
2731
  /**
2702
2732
  * An openEO processing chain.
2703
2733
  */
2704
- export type Process = any;
2705
- export type ServiceType = any;
2734
+ export type Process = object<string, any>;
2735
+ export type ServiceType = object<string, any>;
2706
2736
  export type SyncResult = {
2707
2737
  /**
2708
2738
  * The data as `Stream` in NodeJS environments or as `Blob` in browsers.
2709
2739
  */
2710
- data: any | Blob;
2740
+ data: Readable | Blob;
2711
2741
  /**
2712
2742
  * The costs for the request in the currency exposed by the back-end.
2713
2743
  */
@@ -2721,7 +2751,7 @@ declare module OpenEO {
2721
2751
  */
2722
2752
  logs: Array<Log>;
2723
2753
  };
2724
- export type UdfRuntime = any;
2754
+ export type UdfRuntime = object<string, any>;
2725
2755
  export type UserAccountStorage = {
2726
2756
  /**
2727
2757
  * in bytes as integer
@@ -2735,7 +2765,7 @@ declare module OpenEO {
2735
2765
  export type UserAccount = {
2736
2766
  user_id: string;
2737
2767
  name: string | null;
2738
- default_plan: string | null;
2768
+ default_plan: string | null;
2739
2769
  storage: UserAccountStorage | null;
2740
2770
  budget: number | null;
2741
2771
  links: Array<Link> | null;