@openeo/js-client 2.1.0 → 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/README.md +4 -3
- package/openeo.d.ts +194 -136
- package/openeo.js +4973 -7632
- package/openeo.min.js +1 -1
- package/package.json +7 -6
- package/src/authprovider.js +1 -0
- package/src/builder/builder.js +3 -3
- package/src/builder/formula.js +1 -1
- package/src/connection.js +110 -31
- package/src/job.js +6 -6
- package/src/oidcprovider.js +24 -7
- package/src/openeo.js +8 -3
- package/src/service.js +8 -8
- package/src/userfile.js +3 -2
- package/src/userprocess.js +7 -7
package/openeo.d.ts
CHANGED
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
import { User, UserManager } from 'oidc-client';
|
|
4
4
|
import { ProcessRegistry } from '@openeo/js-commons';
|
|
5
5
|
import { Readable } from 'stream';
|
|
6
|
+
import { AbortController } from "node-abort-controller";
|
|
6
7
|
|
|
7
8
|
declare module OpenEO {
|
|
8
9
|
/**
|
|
@@ -77,13 +78,6 @@ declare module OpenEO {
|
|
|
77
78
|
* @param {?string} token
|
|
78
79
|
*/
|
|
79
80
|
setToken(token: string | null): void;
|
|
80
|
-
/**
|
|
81
|
-
* Abstract method that extending classes implement the login process with.
|
|
82
|
-
*
|
|
83
|
-
* @param {...*} args
|
|
84
|
-
* @throws {Error}
|
|
85
|
-
*/
|
|
86
|
-
login(...args: any[]): Promise<void>;
|
|
87
81
|
/**
|
|
88
82
|
* Logout from the established session.
|
|
89
83
|
*
|
|
@@ -116,12 +110,12 @@ declare module OpenEO {
|
|
|
116
110
|
* @protected
|
|
117
111
|
* @type {object.<string, string>}
|
|
118
112
|
*/
|
|
119
|
-
protected apiToClientNames:
|
|
113
|
+
protected apiToClientNames: object<string, string>;
|
|
120
114
|
/**
|
|
121
115
|
* @protected
|
|
122
116
|
* @type {object.<string, string>}
|
|
123
117
|
*/
|
|
124
|
-
protected clientToApiNames:
|
|
118
|
+
protected clientToApiNames: object<string, string>;
|
|
125
119
|
/**
|
|
126
120
|
* @protected
|
|
127
121
|
* @type {number}
|
|
@@ -133,20 +127,20 @@ declare module OpenEO {
|
|
|
133
127
|
* @protected
|
|
134
128
|
* @type {object.<string, *>}
|
|
135
129
|
*/
|
|
136
|
-
protected extra: any
|
|
130
|
+
protected extra: object<string, any>;
|
|
137
131
|
/**
|
|
138
132
|
* Returns a JSON serializable representation of the data that is API compliant.
|
|
139
133
|
*
|
|
140
134
|
* @returns {object.<string, *>}
|
|
141
135
|
*/
|
|
142
|
-
toJSON(): any
|
|
136
|
+
toJSON(): object<string, any>;
|
|
143
137
|
/**
|
|
144
138
|
* Converts the data from an API response into data suitable for our JS client models.
|
|
145
139
|
*
|
|
146
140
|
* @param {object.<string, *>} metadata - JSON object originating from an API response.
|
|
147
141
|
* @returns {BaseEntity} Returns the object itself.
|
|
148
142
|
*/
|
|
149
|
-
setAll(metadata: any): BaseEntity;
|
|
143
|
+
setAll(metadata: object<string, any>): BaseEntity;
|
|
150
144
|
/**
|
|
151
145
|
* Returns the age of the data in seconds.
|
|
152
146
|
*
|
|
@@ -158,7 +152,7 @@ declare module OpenEO {
|
|
|
158
152
|
*
|
|
159
153
|
* @returns {object.<string, *>}
|
|
160
154
|
*/
|
|
161
|
-
getAll(): any
|
|
155
|
+
getAll(): object<string, any>;
|
|
162
156
|
/**
|
|
163
157
|
* Get a value from the additional data that is not part of the core model, i.e. from proprietary extensions.
|
|
164
158
|
*
|
|
@@ -173,7 +167,7 @@ declare module OpenEO {
|
|
|
173
167
|
* @returns {object.<string, *>}
|
|
174
168
|
* @protected
|
|
175
169
|
*/
|
|
176
|
-
protected _convertToRequest(parameters: any): any
|
|
170
|
+
protected _convertToRequest(parameters: object<string, any>): object<string, any>;
|
|
177
171
|
/**
|
|
178
172
|
* Checks whether a features is supported by the API.
|
|
179
173
|
*
|
|
@@ -264,7 +258,7 @@ declare module OpenEO {
|
|
|
264
258
|
* @param {string} targetFolder
|
|
265
259
|
* @throws {Error}
|
|
266
260
|
*/
|
|
267
|
-
static downloadResults(con:
|
|
261
|
+
static downloadResults(con: Connection, assets: Array<object<string, any>>, targetFolder: string): Promise<void>;
|
|
268
262
|
/**
|
|
269
263
|
* Streams data into a file (node) or offers data to download (browser).
|
|
270
264
|
*
|
|
@@ -313,7 +307,7 @@ declare module OpenEO {
|
|
|
313
307
|
* @param {object.<string, *>} data - A capabilities response compatible to the API specification for `GET /`.
|
|
314
308
|
* @throws {Error}
|
|
315
309
|
*/
|
|
316
|
-
constructor(data: any);
|
|
310
|
+
constructor(data: object<string, any>);
|
|
317
311
|
/**
|
|
318
312
|
* @private
|
|
319
313
|
* @type {object.<string, *>}
|
|
@@ -335,7 +329,7 @@ declare module OpenEO {
|
|
|
335
329
|
*
|
|
336
330
|
* @returns {object.<string, *>} - A reference to the capabilities response.
|
|
337
331
|
*/
|
|
338
|
-
toJSON(): any
|
|
332
|
+
toJSON(): object<string, any>;
|
|
339
333
|
/**
|
|
340
334
|
* Returns the openEO API version implemented by the back-end.
|
|
341
335
|
*
|
|
@@ -435,7 +429,7 @@ declare module OpenEO {
|
|
|
435
429
|
* @throws {Error}
|
|
436
430
|
* @see https://github.com/IdentityModel/oidc-client-js/wiki#other-optional-settings
|
|
437
431
|
*/
|
|
438
|
-
static signinCallback(provider?: OidcProvider, options?: any): Promise<User | null>;
|
|
432
|
+
static signinCallback(provider?: OidcProvider, options?: object<string, any>): Promise<User | null>;
|
|
439
433
|
/**
|
|
440
434
|
* Creates a new OidcProvider instance to authenticate using OpenID Connect.
|
|
441
435
|
*
|
|
@@ -454,7 +448,7 @@ declare module OpenEO {
|
|
|
454
448
|
/**
|
|
455
449
|
* The client ID to use for authentication.
|
|
456
450
|
*
|
|
457
|
-
* @type {
|
|
451
|
+
* @type {string | null}
|
|
458
452
|
*/
|
|
459
453
|
clientId: string | null;
|
|
460
454
|
/**
|
|
@@ -477,6 +471,12 @@ declare module OpenEO {
|
|
|
477
471
|
* @type {Array.<string>}
|
|
478
472
|
*/
|
|
479
473
|
scopes: Array<string>;
|
|
474
|
+
/**
|
|
475
|
+
* The scope that is used to request a refresh token.
|
|
476
|
+
*
|
|
477
|
+
* @type {string}
|
|
478
|
+
*/
|
|
479
|
+
refreshTokenScope: string;
|
|
480
480
|
/**
|
|
481
481
|
* Any additional links.
|
|
482
482
|
*
|
|
@@ -500,8 +500,8 @@ declare module OpenEO {
|
|
|
500
500
|
* Adds a listener to one of the following events:
|
|
501
501
|
*
|
|
502
502
|
* - AccessTokenExpiring: Raised prior to the access token expiring.
|
|
503
|
-
* -
|
|
504
|
-
* -
|
|
503
|
+
* - AccessTokenExpired: Raised after the access token has expired.
|
|
504
|
+
* - SilentRenewError: Raised when the automatic silent renew has failed.
|
|
505
505
|
*
|
|
506
506
|
* @param {string} event
|
|
507
507
|
* @param {Function} callback
|
|
@@ -523,9 +523,11 @@ declare module OpenEO {
|
|
|
523
523
|
*
|
|
524
524
|
* @protected
|
|
525
525
|
* @param {object.<string, *>} options
|
|
526
|
+
* @param {boolean} [requestRefreshToken=false] - If set to `true`, adds a scope to request a refresh token.
|
|
526
527
|
* @returns {object.<string, *>}
|
|
528
|
+
* @see {OidcProvider#refreshTokenScope}
|
|
527
529
|
*/
|
|
528
|
-
protected getOptions(options?: any): any
|
|
530
|
+
protected getOptions(options?: object<string, any>, requestRefreshToken?: boolean): object<string, any>;
|
|
529
531
|
/**
|
|
530
532
|
* Get the response_type based on the grant type.
|
|
531
533
|
*
|
|
@@ -566,6 +568,20 @@ declare module OpenEO {
|
|
|
566
568
|
* @see OidcProvider#setClientId
|
|
567
569
|
*/
|
|
568
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;
|
|
569
585
|
}
|
|
570
586
|
export namespace OidcProvider {
|
|
571
587
|
const uiMethod: string;
|
|
@@ -597,13 +613,13 @@ declare module OpenEO {
|
|
|
597
613
|
*
|
|
598
614
|
* @returns {object.<string, FileType>}
|
|
599
615
|
*/
|
|
600
|
-
getInputTypes():
|
|
616
|
+
getInputTypes(): object<string, FileType>;
|
|
601
617
|
/**
|
|
602
618
|
* Returns the output file formats.
|
|
603
619
|
*
|
|
604
620
|
* @returns {object.<string, FileType>}
|
|
605
621
|
*/
|
|
606
|
-
getOutputTypes():
|
|
622
|
+
getOutputTypes(): object<string, FileType>;
|
|
607
623
|
/**
|
|
608
624
|
* Returns a single input file format for a given identifier.
|
|
609
625
|
*
|
|
@@ -708,10 +724,11 @@ declare module OpenEO {
|
|
|
708
724
|
* @async
|
|
709
725
|
* @param {*} source - The source, see method description for details.
|
|
710
726
|
* @param {?uploadStatusCallback} statusCallback - Optionally, a callback that is executed on upload progress updates.
|
|
727
|
+
* @param {?AbortController} [abortController=null] - An AbortController object that can be used to cancel the upload process.
|
|
711
728
|
* @returns {Promise<UserFile>}
|
|
712
729
|
* @throws {Error}
|
|
713
730
|
*/
|
|
714
|
-
uploadFile(source: any, statusCallback?: uploadStatusCallback | null): Promise<UserFile>;
|
|
731
|
+
uploadFile(source: any, statusCallback?: uploadStatusCallback | null, abortController?: AbortController | null): Promise<UserFile>;
|
|
715
732
|
/**
|
|
716
733
|
* Deletes the file from the user workspace.
|
|
717
734
|
*
|
|
@@ -720,13 +737,13 @@ declare module OpenEO {
|
|
|
720
737
|
*/
|
|
721
738
|
deleteFile(): Promise<void>;
|
|
722
739
|
}
|
|
723
|
-
namespace UserFile {
|
|
724
|
-
export { uploadStatusCallback };
|
|
725
|
-
}
|
|
726
740
|
/**
|
|
727
741
|
* A callback that is executed on upload progress updates.
|
|
728
742
|
*/
|
|
729
743
|
type uploadStatusCallback = (percentCompleted: number, file: UserFile) => any;
|
|
744
|
+
namespace UserFile {
|
|
745
|
+
export { uploadStatusCallback };
|
|
746
|
+
}
|
|
730
747
|
/**
|
|
731
748
|
* Interface to loop through the logs.
|
|
732
749
|
*/
|
|
@@ -802,7 +819,7 @@ declare module OpenEO {
|
|
|
802
819
|
* The process chain to be executed.
|
|
803
820
|
* @public
|
|
804
821
|
* @readonly
|
|
805
|
-
* @type {Process}
|
|
822
|
+
* @type {?Process}
|
|
806
823
|
*/
|
|
807
824
|
public readonly process: Process;
|
|
808
825
|
/**
|
|
@@ -810,37 +827,37 @@ declare module OpenEO {
|
|
|
810
827
|
* One of "created", "queued", "running", "canceled", "finished" or "error".
|
|
811
828
|
* @public
|
|
812
829
|
* @readonly
|
|
813
|
-
* @type {string}
|
|
830
|
+
* @type {?string}
|
|
814
831
|
*/
|
|
815
|
-
public readonly status: string;
|
|
832
|
+
public readonly status: string | null;
|
|
816
833
|
/**
|
|
817
834
|
* Indicates the process of a running batch job in percent.
|
|
818
835
|
* @public
|
|
819
836
|
* @readonly
|
|
820
|
-
* @type {number}
|
|
837
|
+
* @type {?number}
|
|
821
838
|
*/
|
|
822
|
-
public readonly progress: number;
|
|
839
|
+
public readonly progress: number | null;
|
|
823
840
|
/**
|
|
824
841
|
* Date and time of creation, formatted as a RFC 3339 date-time.
|
|
825
842
|
* @public
|
|
826
843
|
* @readonly
|
|
827
|
-
* @type {string}
|
|
844
|
+
* @type {?string}
|
|
828
845
|
*/
|
|
829
|
-
public readonly created: string;
|
|
846
|
+
public readonly created: string | null;
|
|
830
847
|
/**
|
|
831
848
|
* Date and time of the last status change, formatted as a RFC 3339 date-time.
|
|
832
849
|
* @public
|
|
833
850
|
* @readonly
|
|
834
|
-
* @type {string}
|
|
851
|
+
* @type {?string}
|
|
835
852
|
*/
|
|
836
|
-
public readonly updated: string;
|
|
853
|
+
public readonly updated: string | null;
|
|
837
854
|
/**
|
|
838
855
|
* The billing plan to process and charge the batch job with.
|
|
839
856
|
* @public
|
|
840
857
|
* @readonly
|
|
841
|
-
* @type {string}
|
|
858
|
+
* @type {?string}
|
|
842
859
|
*/
|
|
843
|
-
public readonly plan: string;
|
|
860
|
+
public readonly plan: string | null;
|
|
844
861
|
/**
|
|
845
862
|
* An amount of money or credits in the currency specified by the back-end.
|
|
846
863
|
* @public
|
|
@@ -950,7 +967,7 @@ declare module OpenEO {
|
|
|
950
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.
|
|
951
968
|
* @throws {Error}
|
|
952
969
|
*/
|
|
953
|
-
getResultsAsStac(): Promise<any
|
|
970
|
+
getResultsAsStac(): Promise<object<string, any>>;
|
|
954
971
|
/**
|
|
955
972
|
* Retrieves download links.
|
|
956
973
|
*
|
|
@@ -1007,9 +1024,9 @@ declare module OpenEO {
|
|
|
1007
1024
|
* A list of categories.
|
|
1008
1025
|
* @public
|
|
1009
1026
|
* @readonly
|
|
1010
|
-
* @type {Array.<string>}
|
|
1027
|
+
* @type {?Array.<string>}
|
|
1011
1028
|
*/
|
|
1012
|
-
public readonly categories: Array<string
|
|
1029
|
+
public readonly categories: Array<string> | null;
|
|
1013
1030
|
/**
|
|
1014
1031
|
* A list of parameters.
|
|
1015
1032
|
*
|
|
@@ -1017,54 +1034,54 @@ declare module OpenEO {
|
|
|
1017
1034
|
* @readonly
|
|
1018
1035
|
* @type {?Array.<object.<string, *>>}
|
|
1019
1036
|
*/
|
|
1020
|
-
public readonly parameters: Array<any
|
|
1037
|
+
public readonly parameters: Array<object<string, any>> | null;
|
|
1021
1038
|
/**
|
|
1022
1039
|
* Description of the data that is returned by this process.
|
|
1023
1040
|
* @public
|
|
1024
1041
|
* @readonly
|
|
1025
1042
|
* @type {?object.<string, *>}
|
|
1026
1043
|
*/
|
|
1027
|
-
public readonly returns: any
|
|
1044
|
+
public readonly returns: object<string, any>;
|
|
1028
1045
|
/**
|
|
1029
1046
|
* Specifies that the process or parameter is deprecated with the potential to be removed in any of the next versions.
|
|
1030
1047
|
* @public
|
|
1031
1048
|
* @readonly
|
|
1032
|
-
* @type {boolean}
|
|
1049
|
+
* @type {?boolean}
|
|
1033
1050
|
*/
|
|
1034
|
-
public readonly deprecated: boolean;
|
|
1051
|
+
public readonly deprecated: boolean | null;
|
|
1035
1052
|
/**
|
|
1036
1053
|
* Declares the process or parameter to be experimental, which means that it is likely to change or may produce unpredictable behaviour.
|
|
1037
1054
|
* @public
|
|
1038
1055
|
* @readonly
|
|
1039
|
-
* @type {boolean}
|
|
1056
|
+
* @type {?boolean}
|
|
1040
1057
|
*/
|
|
1041
|
-
public readonly experimental: boolean;
|
|
1058
|
+
public readonly experimental: boolean | null;
|
|
1042
1059
|
/**
|
|
1043
1060
|
* Declares any exceptions (errors) that might occur during execution of this process.
|
|
1044
1061
|
* @public
|
|
1045
1062
|
* @readonly
|
|
1046
|
-
* @type {object.<string, *>}
|
|
1063
|
+
* @type {?object.<string, *>}
|
|
1047
1064
|
*/
|
|
1048
|
-
public readonly exceptions: any
|
|
1065
|
+
public readonly exceptions: object<string, any>;
|
|
1049
1066
|
/**
|
|
1050
1067
|
* @public
|
|
1051
1068
|
* @readonly
|
|
1052
|
-
* @type {Array.<object.<string, *>>}
|
|
1069
|
+
* @type {?Array.<object.<string, *>>}
|
|
1053
1070
|
*/
|
|
1054
|
-
public readonly examples: Array<any
|
|
1071
|
+
public readonly examples: Array<object<string, any>> | null;
|
|
1055
1072
|
/**
|
|
1056
1073
|
* Links related to this process.
|
|
1057
1074
|
* @public
|
|
1058
1075
|
* @readonly
|
|
1059
|
-
* @type {Array.<Link>}
|
|
1076
|
+
* @type {?Array.<Link>}
|
|
1060
1077
|
*/
|
|
1061
|
-
public readonly links: Array<Link
|
|
1078
|
+
public readonly links: Array<Link> | null;
|
|
1062
1079
|
/**
|
|
1063
1080
|
* @public
|
|
1064
1081
|
* @readonly
|
|
1065
|
-
* @type {object.<string, *>}
|
|
1082
|
+
* @type {?object.<string, *>}
|
|
1066
1083
|
*/
|
|
1067
|
-
public readonly processGraph: any
|
|
1084
|
+
public readonly processGraph: object<string, any>;
|
|
1068
1085
|
/**
|
|
1069
1086
|
* Updates the data stored in this object by requesting the process graph metadata from the back-end.
|
|
1070
1087
|
*
|
|
@@ -1133,57 +1150,57 @@ declare module OpenEO {
|
|
|
1133
1150
|
* The process chain to be executed.
|
|
1134
1151
|
* @public
|
|
1135
1152
|
* @readonly
|
|
1136
|
-
* @type {Process}
|
|
1153
|
+
* @type {?Process}
|
|
1137
1154
|
*/
|
|
1138
1155
|
public readonly process: Process;
|
|
1139
1156
|
/**
|
|
1140
1157
|
* URL at which the secondary web service is accessible
|
|
1141
1158
|
* @public
|
|
1142
1159
|
* @readonly
|
|
1143
|
-
* @type {string}
|
|
1160
|
+
* @type {?string}
|
|
1144
1161
|
*/
|
|
1145
|
-
public readonly url: string;
|
|
1162
|
+
public readonly url: string | null;
|
|
1146
1163
|
/**
|
|
1147
1164
|
* Web service type (protocol / standard) that is exposed.
|
|
1148
1165
|
* @public
|
|
1149
1166
|
* @readonly
|
|
1150
|
-
* @type {string}
|
|
1167
|
+
* @type {?string}
|
|
1151
1168
|
*/
|
|
1152
|
-
public readonly type: string;
|
|
1169
|
+
public readonly type: string | null;
|
|
1153
1170
|
/**
|
|
1154
1171
|
* @public
|
|
1155
1172
|
* @readonly
|
|
1156
|
-
* @type {boolean}
|
|
1173
|
+
* @type {?boolean}
|
|
1157
1174
|
*/
|
|
1158
|
-
public readonly enabled: boolean;
|
|
1175
|
+
public readonly enabled: boolean | null;
|
|
1159
1176
|
/**
|
|
1160
1177
|
* Map of configuration settings, i.e. the setting names supported by the secondary web service combined with actual values.
|
|
1161
1178
|
* @public
|
|
1162
1179
|
* @readonly
|
|
1163
|
-
* @type {object.<string, *>}
|
|
1180
|
+
* @type {?object.<string, *>}
|
|
1164
1181
|
*/
|
|
1165
|
-
public readonly configuration: any
|
|
1182
|
+
public readonly configuration: object<string, any>;
|
|
1166
1183
|
/**
|
|
1167
1184
|
* Additional attributes of the secondary web service, e.g. available layers for a WMS based on the bands in the underlying GeoTiff.
|
|
1168
1185
|
* @public
|
|
1169
1186
|
* @readonly
|
|
1170
|
-
* @type {object.<string, *>}
|
|
1187
|
+
* @type {?object.<string, *>}
|
|
1171
1188
|
*/
|
|
1172
|
-
public readonly attributes: any
|
|
1189
|
+
public readonly attributes: object<string, any>;
|
|
1173
1190
|
/**
|
|
1174
1191
|
* Date and time of creation, formatted as a RFC 3339 date-time.
|
|
1175
1192
|
* @public
|
|
1176
1193
|
* @readonly
|
|
1177
|
-
* @type {string}
|
|
1194
|
+
* @type {?string}
|
|
1178
1195
|
*/
|
|
1179
|
-
public readonly created: string;
|
|
1196
|
+
public readonly created: string | null;
|
|
1180
1197
|
/**
|
|
1181
1198
|
* The billing plan to process and charge the service with.
|
|
1182
1199
|
* @public
|
|
1183
1200
|
* @readonly
|
|
1184
|
-
* @type {string}
|
|
1201
|
+
* @type {?string}
|
|
1185
1202
|
*/
|
|
1186
|
-
public readonly plan: string;
|
|
1203
|
+
public readonly plan: string | null;
|
|
1187
1204
|
/**
|
|
1188
1205
|
* An amount of money or credits in the currency specified by the back-end.
|
|
1189
1206
|
* @public
|
|
@@ -1226,7 +1243,7 @@ declare module OpenEO {
|
|
|
1226
1243
|
title: string;
|
|
1227
1244
|
description: string;
|
|
1228
1245
|
enabled: boolean;
|
|
1229
|
-
configuration: any
|
|
1246
|
+
configuration: object<string, any>;
|
|
1230
1247
|
plan: string;
|
|
1231
1248
|
budget: number;
|
|
1232
1249
|
}): Promise<Service>;
|
|
@@ -1308,7 +1325,7 @@ declare module OpenEO {
|
|
|
1308
1325
|
* @param {string} description - A description for the parameter
|
|
1309
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`.
|
|
1310
1327
|
*/
|
|
1311
|
-
constructor(name: string, schema?: any | string, description?: string, defaultValue?: any);
|
|
1328
|
+
constructor(name: string, schema?: object<string, any> | string, description?: string, defaultValue?: any);
|
|
1312
1329
|
name: string;
|
|
1313
1330
|
spec: {
|
|
1314
1331
|
name: string;
|
|
@@ -1320,7 +1337,7 @@ declare module OpenEO {
|
|
|
1320
1337
|
*
|
|
1321
1338
|
* @returns {object.<string, *>}
|
|
1322
1339
|
*/
|
|
1323
|
-
toJSON(): any
|
|
1340
|
+
toJSON(): object<string, any>;
|
|
1324
1341
|
/**
|
|
1325
1342
|
* Returns the reference object for this parameter.
|
|
1326
1343
|
*
|
|
@@ -1376,9 +1393,9 @@ declare module OpenEO {
|
|
|
1376
1393
|
/**
|
|
1377
1394
|
* @type {object.<string, *>}
|
|
1378
1395
|
*/
|
|
1379
|
-
tree: any
|
|
1396
|
+
tree: object<string, any>;
|
|
1380
1397
|
/**
|
|
1381
|
-
* @type {
|
|
1398
|
+
* @type {Builder | null}
|
|
1382
1399
|
*/
|
|
1383
1400
|
builder: Builder | null;
|
|
1384
1401
|
/**
|
|
@@ -1405,7 +1422,7 @@ declare module OpenEO {
|
|
|
1405
1422
|
* @returns {object.<string, *>}
|
|
1406
1423
|
* @throws {Error}
|
|
1407
1424
|
*/
|
|
1408
|
-
protected parseTree(tree: any): any
|
|
1425
|
+
protected parseTree(tree: object<string, any>): object<string, any>;
|
|
1409
1426
|
/**
|
|
1410
1427
|
* Gets the reference for a value, e.g. from_node or from_parameter.
|
|
1411
1428
|
*
|
|
@@ -1423,10 +1440,10 @@ declare module OpenEO {
|
|
|
1423
1440
|
* @returns {BuilderNode}
|
|
1424
1441
|
* @throws {Error}
|
|
1425
1442
|
*/
|
|
1426
|
-
addOperatorProcess(operator: string, left: number |
|
|
1443
|
+
addOperatorProcess(operator: string, left: number | object<string, any>, right: number | object<string, any>): BuilderNode;
|
|
1427
1444
|
}
|
|
1428
1445
|
export namespace Formula {
|
|
1429
|
-
const operatorMapping:
|
|
1446
|
+
const operatorMapping: object<string, string>;
|
|
1430
1447
|
}
|
|
1431
1448
|
/**
|
|
1432
1449
|
* A class that represents a process node and also a result from a process.
|
|
@@ -1441,7 +1458,7 @@ declare module OpenEO {
|
|
|
1441
1458
|
* @param {?string} [processDescription=null]
|
|
1442
1459
|
* @param {?string} [processNamespace=null]
|
|
1443
1460
|
*/
|
|
1444
|
-
constructor(parent: Builder, processId: string, processArgs?:
|
|
1461
|
+
constructor(parent: Builder, processId: string, processArgs?: object<string, any>, processDescription?: string | null, processNamespace?: string | null);
|
|
1445
1462
|
/**
|
|
1446
1463
|
* The parent builder.
|
|
1447
1464
|
* @type {Builder}
|
|
@@ -1467,7 +1484,7 @@ declare module OpenEO {
|
|
|
1467
1484
|
* The arguments for the process.
|
|
1468
1485
|
* @type {object.<string, *>}
|
|
1469
1486
|
*/
|
|
1470
|
-
arguments: any
|
|
1487
|
+
arguments: object<string, any>;
|
|
1471
1488
|
/**
|
|
1472
1489
|
* @ignore
|
|
1473
1490
|
*/
|
|
@@ -1484,13 +1501,13 @@ declare module OpenEO {
|
|
|
1484
1501
|
* @returns {object.<string, *>}
|
|
1485
1502
|
* @throws {Error}
|
|
1486
1503
|
*/
|
|
1487
|
-
namedArguments(processArgs: any[]): any
|
|
1504
|
+
namedArguments(processArgs: any[]): object<string, any>;
|
|
1488
1505
|
/**
|
|
1489
1506
|
* Checks the arguments given for parameters and add them to the process.
|
|
1490
1507
|
*
|
|
1491
1508
|
* @param {object.<string, *>|Array} processArgs
|
|
1492
1509
|
*/
|
|
1493
|
-
addParametersToProcess(processArgs: any | any[]): void;
|
|
1510
|
+
addParametersToProcess(processArgs: object<string, any> | any[]): void;
|
|
1494
1511
|
/**
|
|
1495
1512
|
* Gets/Sets a description for the node.
|
|
1496
1513
|
*
|
|
@@ -1536,13 +1553,13 @@ declare module OpenEO {
|
|
|
1536
1553
|
* @returns {object.<string, *>}
|
|
1537
1554
|
* @throws {Error}
|
|
1538
1555
|
*/
|
|
1539
|
-
protected exportCallback(arg: Function, name: string): any
|
|
1556
|
+
protected exportCallback(arg: Function, name: string): object<string, any>;
|
|
1540
1557
|
/**
|
|
1541
1558
|
* Returns a JSON serializable representation of the data that is API compliant.
|
|
1542
1559
|
*
|
|
1543
1560
|
* @returns {object.<string, *>}
|
|
1544
1561
|
*/
|
|
1545
|
-
toJSON(): any
|
|
1562
|
+
toJSON(): object<string, any>;
|
|
1546
1563
|
/**
|
|
1547
1564
|
* Returns the reference object for this node.
|
|
1548
1565
|
*
|
|
@@ -1659,17 +1676,17 @@ declare module OpenEO {
|
|
|
1659
1676
|
public id: string;
|
|
1660
1677
|
/**
|
|
1661
1678
|
* The parent builder.
|
|
1662
|
-
* @type {
|
|
1679
|
+
* @type {Builder | null}
|
|
1663
1680
|
*/
|
|
1664
1681
|
parent: Builder | null;
|
|
1665
1682
|
/**
|
|
1666
1683
|
* The parent node.
|
|
1667
|
-
* @type {
|
|
1684
|
+
* @type {BuilderNode | null}
|
|
1668
1685
|
*/
|
|
1669
1686
|
parentNode: BuilderNode | null;
|
|
1670
1687
|
/**
|
|
1671
1688
|
* The parent parameter name.
|
|
1672
|
-
* @type {
|
|
1689
|
+
* @type {string | null}
|
|
1673
1690
|
*/
|
|
1674
1691
|
parentParameter: string | null;
|
|
1675
1692
|
nodes: {};
|
|
@@ -1687,7 +1704,7 @@ declare module OpenEO {
|
|
|
1687
1704
|
* @param {Process} process
|
|
1688
1705
|
* @throws {Error}
|
|
1689
1706
|
*/
|
|
1690
|
-
createFunction(process:
|
|
1707
|
+
createFunction(process: Process): void;
|
|
1691
1708
|
/**
|
|
1692
1709
|
* Adds a process specification to the builder so that it can be used to create a process graph.
|
|
1693
1710
|
*
|
|
@@ -1726,7 +1743,7 @@ declare module OpenEO {
|
|
|
1726
1743
|
* @param {object.<string, *>} parameter - The parameter spec to add, must comply to the API.
|
|
1727
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.
|
|
1728
1745
|
*/
|
|
1729
|
-
addParameter(parameter:
|
|
1746
|
+
addParameter(parameter: object<string, any>, root?: boolean): void;
|
|
1730
1747
|
/**
|
|
1731
1748
|
* Returns the process specification for the given process identifier and namespace (or `null`).
|
|
1732
1749
|
*
|
|
@@ -1762,7 +1779,7 @@ declare module OpenEO {
|
|
|
1762
1779
|
* @param {?string} [description=null] - An optional description for the process call.
|
|
1763
1780
|
* @returns {BuilderNode}
|
|
1764
1781
|
*/
|
|
1765
|
-
process(processId: string, args?: any | any[], description?: string | null): BuilderNode;
|
|
1782
|
+
process(processId: string, args?: object<string, any> | any[], description?: string | null): BuilderNode;
|
|
1766
1783
|
/**
|
|
1767
1784
|
* Returns a JSON serializable representation of the data that is API compliant.
|
|
1768
1785
|
*
|
|
@@ -1787,12 +1804,22 @@ declare module OpenEO {
|
|
|
1787
1804
|
/**
|
|
1788
1805
|
* Creates a new Connection.
|
|
1789
1806
|
*
|
|
1790
|
-
* @param {string} baseUrl - URL
|
|
1807
|
+
* @param {string} baseUrl - The versioned URL or the back-end instance.
|
|
1791
1808
|
* @param {Options} [options={}] - Additional options for the connection.
|
|
1809
|
+
* @param {?string} [url=null] - User-provided URL of the backend connected to.
|
|
1792
1810
|
*/
|
|
1793
|
-
constructor(baseUrl: string, options?: Options);
|
|
1811
|
+
constructor(baseUrl: string, options?: Options, url?: string | null);
|
|
1794
1812
|
/**
|
|
1795
|
-
* URL of the backend connected to.
|
|
1813
|
+
* User-provided URL of the backend connected to.
|
|
1814
|
+
*
|
|
1815
|
+
* `null` if not given and the connection was directly made to a versioned instance of the back-end.
|
|
1816
|
+
*
|
|
1817
|
+
* @protected
|
|
1818
|
+
* @type {string | null}
|
|
1819
|
+
*/
|
|
1820
|
+
protected url: string | null;
|
|
1821
|
+
/**
|
|
1822
|
+
* The versioned URL or the back-end instance.
|
|
1796
1823
|
*
|
|
1797
1824
|
* @protected
|
|
1798
1825
|
* @type {string}
|
|
@@ -1802,37 +1829,30 @@ declare module OpenEO {
|
|
|
1802
1829
|
* Auth Provider cache
|
|
1803
1830
|
*
|
|
1804
1831
|
* @protected
|
|
1805
|
-
* @type {
|
|
1832
|
+
* @type {Array.<AuthProvider> | null}
|
|
1806
1833
|
*/
|
|
1807
1834
|
protected authProviderList: Array<AuthProvider> | null;
|
|
1808
1835
|
/**
|
|
1809
1836
|
* Current auth provider
|
|
1810
1837
|
*
|
|
1811
1838
|
* @protected
|
|
1812
|
-
* @type {
|
|
1839
|
+
* @type {AuthProvider | null}
|
|
1813
1840
|
*/
|
|
1814
1841
|
protected authProvider: AuthProvider | null;
|
|
1815
1842
|
/**
|
|
1816
1843
|
* Capability cache
|
|
1817
1844
|
*
|
|
1818
1845
|
* @protected
|
|
1819
|
-
* @type {
|
|
1846
|
+
* @type {Capabilities | null}
|
|
1820
1847
|
*/
|
|
1821
1848
|
protected capabilitiesObject: Capabilities | null;
|
|
1822
|
-
/**
|
|
1823
|
-
* Process cache
|
|
1824
|
-
*
|
|
1825
|
-
* @protected
|
|
1826
|
-
* @type {ProcessRegistry}
|
|
1827
|
-
*/
|
|
1828
|
-
protected processes: any;
|
|
1829
1849
|
/**
|
|
1830
1850
|
* Listeners for events.
|
|
1831
1851
|
*
|
|
1832
1852
|
* @protected
|
|
1833
1853
|
* @type {object.<string|Function>}
|
|
1834
1854
|
*/
|
|
1835
|
-
protected listeners:
|
|
1855
|
+
protected listeners: object<string | Function>;
|
|
1836
1856
|
/**
|
|
1837
1857
|
* Additional options for the connection.
|
|
1838
1858
|
*
|
|
@@ -1840,19 +1860,41 @@ declare module OpenEO {
|
|
|
1840
1860
|
* @type {Options}
|
|
1841
1861
|
*/
|
|
1842
1862
|
protected options: Options;
|
|
1863
|
+
/**
|
|
1864
|
+
* Process cache
|
|
1865
|
+
*
|
|
1866
|
+
* @protected
|
|
1867
|
+
* @type {ProcessRegistry}
|
|
1868
|
+
*/
|
|
1869
|
+
protected processes: ProcessRegistry;
|
|
1843
1870
|
/**
|
|
1844
1871
|
* Initializes the connection by requesting the capabilities.
|
|
1845
1872
|
*
|
|
1846
1873
|
* @async
|
|
1874
|
+
* @protected
|
|
1847
1875
|
* @returns {Promise<Capabilities>} Capabilities
|
|
1848
1876
|
*/
|
|
1849
|
-
init(): Promise<Capabilities>;
|
|
1877
|
+
protected init(): Promise<Capabilities>;
|
|
1878
|
+
/**
|
|
1879
|
+
* Refresh the cache for processes.
|
|
1880
|
+
*
|
|
1881
|
+
* @async
|
|
1882
|
+
* @protected
|
|
1883
|
+
* @returns {Promise}
|
|
1884
|
+
*/
|
|
1885
|
+
protected refreshProcessCache(): Promise<any>;
|
|
1850
1886
|
/**
|
|
1851
|
-
* Returns the URL of the back-end currently connected to.
|
|
1887
|
+
* Returns the URL of the versioned back-end instance currently connected to.
|
|
1852
1888
|
*
|
|
1853
|
-
* @returns {string} The URL or the back-end.
|
|
1889
|
+
* @returns {string} The versioned URL or the back-end instance.
|
|
1854
1890
|
*/
|
|
1855
1891
|
getBaseUrl(): string;
|
|
1892
|
+
/**
|
|
1893
|
+
* Returns the user-provided URL of the back-end currently connected to.
|
|
1894
|
+
*
|
|
1895
|
+
* @returns {string} The URL or the back-end.
|
|
1896
|
+
*/
|
|
1897
|
+
getUrl(): string;
|
|
1856
1898
|
/**
|
|
1857
1899
|
* Returns the capabilities of the back-end.
|
|
1858
1900
|
*
|
|
@@ -1874,7 +1916,7 @@ declare module OpenEO {
|
|
|
1874
1916
|
* @returns {Promise<object.<string, ServiceType>>} A response compatible to the API specification.
|
|
1875
1917
|
* @throws {Error}
|
|
1876
1918
|
*/
|
|
1877
|
-
listServiceTypes(): Promise<
|
|
1919
|
+
listServiceTypes(): Promise<object<string, ServiceType>>;
|
|
1878
1920
|
/**
|
|
1879
1921
|
* List the supported UDF runtimes.
|
|
1880
1922
|
*
|
|
@@ -1882,7 +1924,7 @@ declare module OpenEO {
|
|
|
1882
1924
|
* @returns {Promise<object.<string, UdfRuntime>>} A response compatible to the API specification.
|
|
1883
1925
|
* @throws {Error}
|
|
1884
1926
|
*/
|
|
1885
|
-
listUdfRuntimes(): Promise<
|
|
1927
|
+
listUdfRuntimes(): Promise<object<string, UdfRuntime>>;
|
|
1886
1928
|
/**
|
|
1887
1929
|
* List all collections available on the back-end.
|
|
1888
1930
|
*
|
|
@@ -1928,6 +1970,20 @@ declare module OpenEO {
|
|
|
1928
1970
|
* @throws {Error}
|
|
1929
1971
|
*/
|
|
1930
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;
|
|
1931
1987
|
/**
|
|
1932
1988
|
* List processes available on the back-end.
|
|
1933
1989
|
*
|
|
@@ -2042,7 +2098,7 @@ declare module OpenEO {
|
|
|
2042
2098
|
* Currently supported:
|
|
2043
2099
|
* - authProviderChanged(provider): Raised when the auth provider has changed.
|
|
2044
2100
|
* - tokenChanged(token): Raised when the access token has changed.
|
|
2045
|
-
* - processesChanged(type, data, namespace): Raised when the process registry has changed (i.e. a process was added, updated or deleted)
|
|
2101
|
+
* - processesChanged(type, data, namespace): Raised when the process registry has changed (i.e. a process was added, updated or deleted).
|
|
2046
2102
|
*
|
|
2047
2103
|
* @param {string} event
|
|
2048
2104
|
* @param {Function} callback
|
|
@@ -2104,6 +2160,7 @@ declare module OpenEO {
|
|
|
2104
2160
|
*
|
|
2105
2161
|
* @callback uploadStatusCallback
|
|
2106
2162
|
* @param {number} percentCompleted - The percent (0-100) completed.
|
|
2163
|
+
* @param {UserFile} file - The file object corresponding to the callback.
|
|
2107
2164
|
*/
|
|
2108
2165
|
/**
|
|
2109
2166
|
* Uploads a file to the user workspace.
|
|
@@ -2117,10 +2174,11 @@ declare module OpenEO {
|
|
|
2117
2174
|
* @param {*} source - The source, see method description for details.
|
|
2118
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.
|
|
2119
2176
|
* @param {?uploadStatusCallback} [statusCallback=null] - Optionally, a callback that is executed on upload progress updates.
|
|
2177
|
+
* @param {?AbortController} [abortController=null] - An AbortController object that can be used to cancel the upload process.
|
|
2120
2178
|
* @returns {Promise<UserFile>}
|
|
2121
2179
|
* @throws {Error}
|
|
2122
2180
|
*/
|
|
2123
|
-
uploadFile(source: any, targetPath?: string | null, statusCallback?: uploadStatusCallback | null): Promise<UserFile>;
|
|
2181
|
+
uploadFile(source: any, targetPath?: string | null, statusCallback?: uploadStatusCallback | null, abortController?: AbortController | null): Promise<UserFile>;
|
|
2124
2182
|
/**
|
|
2125
2183
|
* Opens a (existing or non-existing) file without reading any information or creating a new file at the back-end.
|
|
2126
2184
|
*
|
|
@@ -2139,7 +2197,7 @@ declare module OpenEO {
|
|
|
2139
2197
|
* @returns {object.<string, *>}
|
|
2140
2198
|
* @protected
|
|
2141
2199
|
*/
|
|
2142
|
-
protected _normalizeUserProcess(process: UserProcess | BuilderNode |
|
|
2200
|
+
protected _normalizeUserProcess(process: UserProcess | BuilderNode | object<string, any>, additional?: object<string, any>): object<string, any>;
|
|
2143
2201
|
/**
|
|
2144
2202
|
* Validates a user-defined process at the back-end.
|
|
2145
2203
|
*
|
|
@@ -2185,9 +2243,10 @@ declare module OpenEO {
|
|
|
2185
2243
|
* @param {Process} process - A user-defined process.
|
|
2186
2244
|
* @param {?string} [plan=null] - The billing plan to use for this computation.
|
|
2187
2245
|
* @param {?number} [budget=null] - The maximum budget allowed to spend for this computation.
|
|
2246
|
+
* @param {?AbortController} [abortController=null] - An AbortController object that can be used to cancel the processing request.
|
|
2188
2247
|
* @returns {Promise<SyncResult>} - An object with the data and some metadata.
|
|
2189
2248
|
*/
|
|
2190
|
-
computeResult(process: Process, plan?: string | null, budget?: number | null): Promise<SyncResult>;
|
|
2249
|
+
computeResult(process: Process, plan?: string | null, budget?: number | null, abortController?: AbortController | null): Promise<SyncResult>;
|
|
2191
2250
|
/**
|
|
2192
2251
|
* Executes a process synchronously and downloads to result the given path.
|
|
2193
2252
|
*
|
|
@@ -2202,9 +2261,10 @@ declare module OpenEO {
|
|
|
2202
2261
|
* @param {string} targetPath - The target, see method description for details.
|
|
2203
2262
|
* @param {?string} [plan=null] - The billing plan to use for this computation.
|
|
2204
2263
|
* @param {?number} [budget=null] - The maximum budget allowed to spend for this computation.
|
|
2264
|
+
* @param {?AbortController} [abortController=null] - An AbortController object that can be used to cancel the processing request.
|
|
2205
2265
|
* @throws {Error}
|
|
2206
2266
|
*/
|
|
2207
|
-
downloadResult(process: Process, targetPath: string, plan?: string | null, budget?: number | null): Promise<void>;
|
|
2267
|
+
downloadResult(process: Process, targetPath: string, plan?: string | null, budget?: number | null, abortController?: AbortController | null): Promise<void>;
|
|
2208
2268
|
/**
|
|
2209
2269
|
* Lists all batch jobs of the authenticated user.
|
|
2210
2270
|
*
|
|
@@ -2226,7 +2286,7 @@ declare module OpenEO {
|
|
|
2226
2286
|
* @returns {Promise<Job>} The stored batch job.
|
|
2227
2287
|
* @throws {Error}
|
|
2228
2288
|
*/
|
|
2229
|
-
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>;
|
|
2230
2290
|
/**
|
|
2231
2291
|
* Get all information about a batch job.
|
|
2232
2292
|
*
|
|
@@ -2260,7 +2320,7 @@ declare module OpenEO {
|
|
|
2260
2320
|
* @returns {Promise<Service>} The stored service.
|
|
2261
2321
|
* @throws {Error}
|
|
2262
2322
|
*/
|
|
2263
|
-
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>;
|
|
2264
2324
|
/**
|
|
2265
2325
|
* Get all information about a secondary web service.
|
|
2266
2326
|
*
|
|
@@ -2290,7 +2350,7 @@ declare module OpenEO {
|
|
|
2290
2350
|
* @throws {Error}
|
|
2291
2351
|
* @see https://github.com/axios/axios#request-config
|
|
2292
2352
|
*/
|
|
2293
|
-
_get(path: string, query:
|
|
2353
|
+
_get(path: string, query: object<string, any>, responseType: string): Promise<AxiosResponse>;
|
|
2294
2354
|
/**
|
|
2295
2355
|
* Sends a POST request.
|
|
2296
2356
|
*
|
|
@@ -2298,11 +2358,12 @@ declare module OpenEO {
|
|
|
2298
2358
|
* @param {string} path
|
|
2299
2359
|
* @param {*} body
|
|
2300
2360
|
* @param {string} responseType - Response type according to axios, defaults to `json`.
|
|
2361
|
+
* @param {?AbortController} [abortController=null] - An AbortController object that can be used to cancel the request.
|
|
2301
2362
|
* @returns {Promise<AxiosResponse>}
|
|
2302
2363
|
* @throws {Error}
|
|
2303
2364
|
* @see https://github.com/axios/axios#request-config
|
|
2304
2365
|
*/
|
|
2305
|
-
_post(path: string, body: any, responseType: string): Promise<AxiosResponse>;
|
|
2366
|
+
_post(path: string, body: any, responseType: string, abortController?: AbortController | null): Promise<AxiosResponse>;
|
|
2306
2367
|
/**
|
|
2307
2368
|
* Sends a PUT request.
|
|
2308
2369
|
*
|
|
@@ -2357,11 +2418,12 @@ declare module OpenEO {
|
|
|
2357
2418
|
*
|
|
2358
2419
|
* @async
|
|
2359
2420
|
* @param {object.<string, *>} options
|
|
2421
|
+
* @param {?AbortController} [abortController=null] - An AbortController object that can be used to cancel the request.
|
|
2360
2422
|
* @returns {Promise<AxiosResponse>}
|
|
2361
2423
|
* @throws {Error}
|
|
2362
2424
|
* @see https://github.com/axios/axios
|
|
2363
2425
|
*/
|
|
2364
|
-
_send(options: any): Promise<AxiosResponse>;
|
|
2426
|
+
_send(options: any, abortController?: AbortController | null): Promise<AxiosResponse>;
|
|
2365
2427
|
}
|
|
2366
2428
|
namespace Connection {
|
|
2367
2429
|
export { oidcProviderFactoryFunction, uploadStatusCallback };
|
|
@@ -2377,10 +2439,6 @@ declare module OpenEO {
|
|
|
2377
2439
|
* May return `null` if the instance can't be created.
|
|
2378
2440
|
*/
|
|
2379
2441
|
type oidcProviderFactoryFunction = (providerInfo: any) => AuthProvider | null;
|
|
2380
|
-
/**
|
|
2381
|
-
* A callback that is executed on upload progress updates.
|
|
2382
|
-
*/
|
|
2383
|
-
type uploadStatusCallback = (percentCompleted: number) => any;
|
|
2384
2442
|
/**
|
|
2385
2443
|
* Main class to start with openEO. Allows to connect to a server.
|
|
2386
2444
|
*
|
|
@@ -2461,7 +2519,7 @@ declare module OpenEO {
|
|
|
2461
2519
|
status: number;
|
|
2462
2520
|
statusText: string;
|
|
2463
2521
|
headers: any;
|
|
2464
|
-
|
|
2522
|
+
config: object<string, any>;
|
|
2465
2523
|
request: any;
|
|
2466
2524
|
};
|
|
2467
2525
|
export type BillingPlan = {
|
|
@@ -2490,22 +2548,22 @@ declare module OpenEO {
|
|
|
2490
2548
|
collections: Array<Collection>;
|
|
2491
2549
|
links: Array<Link>;
|
|
2492
2550
|
};
|
|
2493
|
-
export type Collection = any
|
|
2551
|
+
export type Collection = object<string, any>;
|
|
2494
2552
|
export type FileTypesAPI = {
|
|
2495
2553
|
/**
|
|
2496
2554
|
* - File types supported to import
|
|
2497
2555
|
*/
|
|
2498
|
-
input:
|
|
2556
|
+
input: object<string, FileType>;
|
|
2499
2557
|
/**
|
|
2500
2558
|
* - File types supported to export
|
|
2501
2559
|
*/
|
|
2502
|
-
output:
|
|
2560
|
+
output: object<string, FileType>;
|
|
2503
2561
|
};
|
|
2504
2562
|
export type FileType = {
|
|
2505
2563
|
title: string;
|
|
2506
2564
|
description: string;
|
|
2507
2565
|
gis_data_types: Array<string>;
|
|
2508
|
-
parameters: any
|
|
2566
|
+
parameters: object<string, any>;
|
|
2509
2567
|
links: Array<Link>;
|
|
2510
2568
|
};
|
|
2511
2569
|
/**
|
|
@@ -2526,7 +2584,7 @@ declare module OpenEO {
|
|
|
2526
2584
|
*/
|
|
2527
2585
|
from_parameter: string;
|
|
2528
2586
|
};
|
|
2529
|
-
export type Item = any
|
|
2587
|
+
export type Item = object<string, any>;
|
|
2530
2588
|
export type ItemCollection = {
|
|
2531
2589
|
/**
|
|
2532
2590
|
* - The items in the collection.
|
|
@@ -2600,7 +2658,7 @@ declare module OpenEO {
|
|
|
2600
2658
|
level: string;
|
|
2601
2659
|
message: string;
|
|
2602
2660
|
data: any;
|
|
2603
|
-
path: Array<
|
|
2661
|
+
path: Array<object<string, string>>;
|
|
2604
2662
|
links: Array<Link>;
|
|
2605
2663
|
};
|
|
2606
2664
|
/**
|
|
@@ -2673,13 +2731,13 @@ declare module OpenEO {
|
|
|
2673
2731
|
/**
|
|
2674
2732
|
* An openEO processing chain.
|
|
2675
2733
|
*/
|
|
2676
|
-
export type Process = any
|
|
2677
|
-
export type ServiceType = any
|
|
2734
|
+
export type Process = object<string, any>;
|
|
2735
|
+
export type ServiceType = object<string, any>;
|
|
2678
2736
|
export type SyncResult = {
|
|
2679
2737
|
/**
|
|
2680
2738
|
* The data as `Stream` in NodeJS environments or as `Blob` in browsers.
|
|
2681
2739
|
*/
|
|
2682
|
-
data:
|
|
2740
|
+
data: Readable | Blob;
|
|
2683
2741
|
/**
|
|
2684
2742
|
* The costs for the request in the currency exposed by the back-end.
|
|
2685
2743
|
*/
|
|
@@ -2693,7 +2751,7 @@ declare module OpenEO {
|
|
|
2693
2751
|
*/
|
|
2694
2752
|
logs: Array<Log>;
|
|
2695
2753
|
};
|
|
2696
|
-
export type UdfRuntime = any
|
|
2754
|
+
export type UdfRuntime = object<string, any>;
|
|
2697
2755
|
export type UserAccountStorage = {
|
|
2698
2756
|
/**
|
|
2699
2757
|
* in bytes as integer
|
|
@@ -2707,7 +2765,7 @@ declare module OpenEO {
|
|
|
2707
2765
|
export type UserAccount = {
|
|
2708
2766
|
user_id: string;
|
|
2709
2767
|
name: string | null;
|
|
2710
|
-
|
|
2768
|
+
default_plan: string | null;
|
|
2711
2769
|
storage: UserAccountStorage | null;
|
|
2712
2770
|
budget: number | null;
|
|
2713
2771
|
links: Array<Link> | null;
|