@openeo/js-client 2.5.0 → 2.6.0

package/openeo.d.ts

@@ -3,7 +3,6 @@
 import { User, UserManager } from 'oidc-client';
 import { ProcessRegistry } from '@openeo/js-commons';
 import { Readable } from 'stream';
-import { AbortController } from "node-abort-controller";
 
 declare module OpenEO {
     /**
@@ -36,6 +35,12 @@ declare module OpenEO {
          * @returns {string}
          */
         getId(): string;
+        /**
+         * Returns a display name for the authenticated user.
+         *
+         * @returns {string?} Name of the user or `null`
+         */
+        getDisplayName(): string | null;
         /**
          * Returns the type of the authentication procedure as specified by the API, e.g. `oidc` or `basic`.
          *
@@ -78,6 +83,14 @@ declare module OpenEO {
          * @param {?string} token
          */
         setToken(token: string | null): void;
+        /**
+         * Abstract method that extending classes implement the login process with.
+         *
+         * @async
+         * @param {...*} args
+         * @throws {Error}
+         */
+        login(...args: any[]): Promise<void>;
         /**
          * Logout from the established session.
          *
@@ -98,9 +111,9 @@ declare module OpenEO {
          * Creates an instance of this object.
          *
          * @param {Connection} connection - A Connection object representing an established connection to an openEO back-end.
-         * @param {Array} properties - A mapping from the API property names to the JS client property names (usually to convert between snake_case and camelCase), e.g. `["id", "title", ["process_graph", "processGraph"]]`
+         * @param {Array.<string|Array.<string>>} properties - A mapping from the API property names to the JS client property names (usually to convert between snake_case and camelCase), e.g. `["id", "title", ["process_graph", "processGraph"]]`
          */
-        constructor(connection: Connection, properties?: any[]);
+        constructor(connection: Connection, properties?: Array<string | Array<string>>);
         /**
          * @protected
          * @type {Connection}
@@ -286,6 +299,7 @@ declare module OpenEO {
          * @param {Connection} connection - A Connection object representing an established connection to an openEO back-end.
          */
         constructor(connection: Connection);
+        username: string;
         /**
          * Authenticate with HTTP Basic.
          * 
@@ -313,17 +327,32 @@ declare module OpenEO {
          * @type {object.<string, *>}
          */
         private data;
+        /**
+         * @private
+         * @ignore
+         * @type {object.<string, string>}
+         */
+        private featureMap;
         /**
          * @private
          * @type {Array.<string>}
          */
         private features;
         /**
-         * @private
-         * @ignore
-         * @type {object.<string, string>}
+         * Validates the capabilities.
+         *
+         * Throws an error in case of an issue, otherwise just passes.
+         *
+         * @protected
+         * @throws {Error}
          */
-        private featureMap;
+        protected validate(): void;
+        /**
+         * Initializes the class.
+         *
+         * @protected
+         */
+        protected init(): void;
         /**
          * Returns the capabilities response as a JSON serializable representation of the data that is API compliant.
          *
@@ -391,6 +420,14 @@ declare module OpenEO {
          * @returns {Array.<BillingPlan>} Billing plans
          */
         listPlans(): Array<BillingPlan>;
+        /**
+         * Migrates a response, if required.
+         *
+         * @param {AxiosResponse} response
+         * @protected
+         * @returns {AxiosResponse}
+         */
+        protected migrate(response: AxiosResponse): AxiosResponse;
     }
     /**
      * The Authentication Provider for OpenID Connect.
@@ -516,6 +553,20 @@ declare module OpenEO {
          * @see OidcProvider#addListener
          */
         removeListener(event: string, scope?: string): void;
+        /**
+         * Authenticate with OpenID Connect (OIDC).
+         *
+         * Supported only in Browser environments.
+         *
+         * @async
+         * @param {object.<string, *>} [options={}] - Object with authentication options.
+         * @param {boolean} [requestRefreshToken=false] - If set to `true`, adds a scope to request a refresh token.
+         * @returns {Promise<void>}
+         * @throws {Error}
+         * @see https://github.com/IdentityModel/oidc-client-js/wiki#other-optional-settings
+         * @see {OidcProvider#refreshTokenScope}
+         */
+        login(options?: object<string, any>, requestRefreshToken?: boolean): Promise<void>;
         /**
          * Returns the options for the OIDC client library.
          *
@@ -568,25 +619,11 @@ declare module OpenEO {
          * @see OidcProvider#setClientId
          */
         detectDefaultClient(): OidcClient | null;
-        /**
-         * Authenticate with OpenID Connect (OIDC).
-         * 
-         * Supported only in Browser environments.
-         * 
-         * @async
-         * @param {object.<string, *>} [options={}] - Object with authentication options.
-         * @param {boolean} [requestRefreshToken=false] - If set to `true`, adds a scope to request a refresh token.
-         * @returns {Promise<void>}
-         * @throws {Error}
-         * @see https://github.com/IdentityModel/oidc-client-js/wiki#other-optional-settings
-         * @see {OidcProvider#refreshTokenScope}
-         */
-        login(options?: any, requestRefreshToken?: boolean) : void;
     }
     export namespace OidcProvider {
-        const uiMethod: string;
-        const redirectUrl: string;
-        const grants: Array<string>;
+        let uiMethod: string;
+        let redirectUrl: string;
+        let grants: Array<string>;
     }
     /**
      * Manages the files types supported by the back-end.
@@ -761,8 +798,9 @@ declare module OpenEO {
          *
          * @param {Connection} connection - A Connection object representing an established connection to an openEO back-end.
          * @param {string} endpoint - The relative endpoint to request the logs from, usually `/jobs/.../logs` or `/services/.../logs` with `...` being the actual job or service id.
+         * @param {?string} [level=null] - Minimum level of logs to return.
          */
-        constructor(connection: Connection, endpoint: string);
+        constructor(connection: Connection, endpoint: string, level?: string | null);
         /**
          * @protected
          * @type {Connection}
@@ -770,6 +808,7 @@ declare module OpenEO {
         protected connection: Connection;
         endpoint: string;
         lastId: string;
+        level: string;
         /**
          * Retrieves the next log entries since the last request.
          *
@@ -829,7 +868,7 @@ declare module OpenEO {
          * @readonly
          * @type {?Process}
          */
-        public readonly process: Process;
+        public readonly process: Process | null;
         /**
          * The current status of a batch job.
          * One of "created", "queued", "running", "canceled", "finished" or "error".
@@ -926,9 +965,10 @@ declare module OpenEO {
         /**
          * Get logs for the batch job from the back-end.
          *
+         * @param {?string} [level=null] - Minimum level of logs to return.
          * @returns {Logs}
          */
-        debugJob(): Logs;
+        debugJob(level?: string | null): Logs;
         /**
          * Checks for status changes and new log entries every x seconds.
          *
@@ -1049,7 +1089,7 @@ declare module OpenEO {
          * @readonly
          * @type {?object.<string, *>}
          */
-        public readonly returns: object<string, any>;
+        public readonly returns: object<string, any> | null;
         /**
          * Specifies that the process or parameter is deprecated with the potential to be removed in any of the next versions.
          * @public
@@ -1070,7 +1110,7 @@ declare module OpenEO {
          * @readonly
          * @type {?object.<string, *>}
          */
-        public readonly exceptions: object<string, any>;
+        public readonly exceptions: object<string, any> | null;
         /**
          * @public
          * @readonly
@@ -1089,7 +1129,7 @@ declare module OpenEO {
          * @readonly
          * @type {?object.<string, *>}
          */
-        public readonly processGraph: object<string, any>;
+        public readonly processGraph: object<string, any> | null;
         /**
          * Updates the data stored in this object by requesting the process graph metadata from the back-end.
          *
@@ -1160,7 +1200,7 @@ declare module OpenEO {
          * @readonly
          * @type {?Process}
          */
-        public readonly process: Process;
+        public readonly process: Process | null;
         /**
          * URL at which the secondary web service is accessible
          * @public
@@ -1187,14 +1227,14 @@ declare module OpenEO {
          * @readonly
          * @type {?object.<string, *>}
          */
-        public readonly configuration: object<string, any>;
+        public readonly configuration: object<string, any> | null;
         /**
          * Additional attributes of the secondary web service, e.g. available layers for a WMS based on the bands in the underlying GeoTiff.
          * @public
          * @readonly
          * @type {?object.<string, *>}
          */
-        public readonly attributes: object<string, any>;
+        public readonly attributes: object<string, any> | null;
         /**
          * Date and time of creation, formatted as a RFC 3339 date-time.
          * @public
@@ -1265,9 +1305,10 @@ declare module OpenEO {
         /**
          * Get logs for the secondary web service from the back-end.
          *
+         * @param {?string} [level=null] - Minimum level of logs to return.
          * @returns {Logs}
          */
-        debugService(): Logs;
+        debugService(level?: string | null): Logs;
         /**
          * Checks for new log entries every x seconds.
          *
@@ -1451,7 +1492,7 @@ declare module OpenEO {
         addOperatorProcess(operator: string, left: number | object<string, any>, right: number | object<string, any>): BuilderNode;
     }
     export namespace Formula {
-        const operatorMapping: object<string, string>;
+        let operatorMapping: object<string, string>;
     }
     /**
      * A class that represents a process node and also a result from a process.
@@ -1505,11 +1546,11 @@ declare module OpenEO {
         /**
          * Converts a sorted array of arguments to an object with the respective parameter names.
          *
-         * @param {Array} processArgs
+         * @param {Array.<object.<string, *>>} processArgs
          * @returns {object.<string, *>}
          * @throws {Error}
          */
-        namedArguments(processArgs: any[]): object<string, any>;
+        namedArguments(processArgs: Array<object<string, any>>): object<string, any>;
         /**
          * Checks the arguments given for parameters and add them to the process.
          *
@@ -1739,10 +1780,10 @@ declare module OpenEO {
         /**
          * Gets the callback parameter specifics from the parent process.
          *
-         * @returns {Array}
+         * @returns {Array.<object.<string,*>>}
          * @todo Should this also pass callback parameters from parents until root is reached?
          */
-        getParentCallbackParameters(): any[];
+        getParentCallbackParameters(): Array<object<string, any>>;
         /**
          * Adds a parameter to the list of process parameters.
          *
@@ -1881,11 +1922,12 @@ declare module OpenEO {
          * @async
          * @protected
          * @returns {Promise<Capabilities>} Capabilities
+         * @throws {Error}
          */
         protected init(): Promise<Capabilities>;
         /**
          * Refresh the cache for processes.
-         * 
+         *
          * @async
          * @protected
          * @returns {Promise}
@@ -1969,7 +2011,7 @@ declare module OpenEO {
          * 2. Lower left corner, coordinate axis 2
          * 3. Upper right corner, coordinate axis 1
          * 4. Upper right corner, coordinate axis 2
-         * @param {?Array.<*>} [temporalExtent=null] - Limits the items to the specified temporal interval.
+         * @param {?Array} [temporalExtent=null] - Limits the items to the specified temporal interval.
          * The interval has to be specified as an array with exactly two elements (start, end) and
          * each must be either an RFC 3339 compatible string or a Date object.
          * Also supports open intervals by setting one of the boundaries to `null`, but never both.
@@ -1977,7 +2019,7 @@ declare module OpenEO {
          * @yields {Promise<ItemCollection>} A response compatible to the API specification.
          * @throws {Error}
          */
-        listCollectionItems(collectionId: string, spatialExtent?: Array<number> | null, temporalExtent?: Array<any> | null, limit?: number | null): AsyncGenerator<any, void, unknown>;
+        listCollectionItems(collectionId: string, spatialExtent?: Array<number> | null, temporalExtent?: any[] | null, limit?: number | null): AsyncGenerator<any, void, unknown>;
         /**
          * Normalisation of the namespace to a value that is compatible with the OpenEO specs - EXPERIMENTAL.
          *
@@ -2253,9 +2295,10 @@ declare module OpenEO {
          * @param {?string} [plan=null] - The billing plan to use for this computation.
          * @param {?number} [budget=null] - The maximum budget allowed to spend for this computation.
          * @param {?AbortController} [abortController=null] - An AbortController object that can be used to cancel the processing request.
+         * @param {object.<string, *>} [additional={}] - Other parameters to pass for the batch job, e.g. `log_level`.
          * @returns {Promise<SyncResult>} - An object with the data and some metadata.
          */
-        computeResult(process: Process, plan?: string | null, budget?: number | null, abortController?: AbortController | null): Promise<SyncResult>;
+        computeResult(process: Process, plan?: string | null, budget?: number | null, abortController?: AbortController | null, additional?: object<string, any>): Promise<SyncResult>;
         /**
          * Executes a process synchronously and downloads to result the given path.
          *
@@ -2292,7 +2335,7 @@ declare module OpenEO {
          * @param {?string} [description=null] - A description for the batch job.
          * @param {?string} [plan=null] - The billing plan to use for this batch job.
          * @param {?number} [budget=null] - The maximum budget allowed to spend for this batch job.
-         * @param {object.<string, *>} [additional={}] - Proprietary parameters to pass for the batch job.
+         * @param {object.<string, *>} [additional={}] - Other parameters to pass for the batch job, e.g. `log_level`.
          * @returns {Promise<Job>} The stored batch job.
          * @throws {Error}
          */
@@ -2327,11 +2370,11 @@ declare module OpenEO {
          * @param {object.<string, *>} [configuration={}] - Configuration parameters to pass to the service.
          * @param {?string} [plan=null] - The billing plan to use for this service.
          * @param {?number} [budget=null] - The maximum budget allowed to spend for this service.
-         * @param {object.<string, *>} [additional={}] - Proprietary parameters to pass for the batch job.
+         * @param {object.<string, *>} [additional={}] - Other parameters to pass for the service, e.g. `log_level`.
          * @returns {Promise<Service>} The stored service.
          * @throws {Error}
          */
-        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>;
+        createService(process: Process, type: string, title?: string | null, description?: string | null, enabled?: boolean, configuration?: object<string, any>, plan?: string | null, budget?: number | null, additional?: object<string, any>): Promise<Service>;
         /**
          * Get all information about a secondary web service.
          *
@@ -2347,21 +2390,29 @@ declare module OpenEO {
          * Adds links and federation:missing.
          *
          * @protected
-         * @param {Array} arr
+         * @param {Array.<*>} arr
          * @param {object.<string, *>} response
          * @returns {ResponseArray}
          */
-        protected _toResponseArray(arr: any[], response: object<string, any>): any;
+        protected _toResponseArray(arr: Array<any>, response: object<string, any>): ResponseArray;
         /**
          * Get the a link with the given rel type.
          *
          * @protected
          * @param {Array.<Link>} links - An array of links.
-         * @param {string} rel - Relation type to find, defaults to `next`.
+         * @param {string|Array.<string>} rel - Relation type(s) to find.
          * @returns {string | null}
          * @throws {Error}
          */
-        protected _getLinkHref(links: Array<Link>, rel?: string): string | null;
+        protected _getLinkHref(links: Array<Link>, rel: string | Array<string>): string | null;
+        /**
+         * Makes all links in the list absolute.
+         * 
+         * @param {Array.<Link>} links - An array of links.
+         * @param {?string|AxiosResponse} [base=null] - The base url to use for relative links, or an response to derive the url from.
+         * @returns {Array.<Link>}
+         */
+        makeLinksAbsolute(links: Array<Link>, base?: (string | AxiosResponse) | null): Array<Link>;
         /**
          * Sends a GET request.
          *
@@ -2370,11 +2421,12 @@ declare module OpenEO {
          * @param {string} path
          * @param {object.<string, *>} query
          * @param {string} responseType - Response type according to axios, defaults to `json`.
+         * @param {?AbortController} [abortController=null] - An AbortController object that can be used to cancel the request.
          * @returns {Promise<AxiosResponse>}
          * @throws {Error}
          * @see https://github.com/axios/axios#request-config
          */
-        protected _get(path: string, query: object<string, any>, responseType: string): Promise<AxiosResponse>;
+        protected _get(path: string, query: object<string, any>, responseType: string, abortController?: AbortController | null): Promise<AxiosResponse>;
         /**
          * Sends a POST request.
          *
@@ -2432,6 +2484,13 @@ declare module OpenEO {
          * @throws {Error}
          */
         download(url: string, authorize: boolean): Promise<Readable | Blob>;
+        /**
+         * Get the authorization header for requests.
+         * 
+         * @protected
+         * @returns {object.<string, string>}
+         */
+        protected _getAuthHeaders() : object<string, string>;
         /**
          * Sends a HTTP request.
          *
@@ -2548,7 +2607,7 @@ declare module OpenEO {
         status: number;
         statusText: string;
         headers: any;
-    config: object<string, any>;
+        config: object<string, any>;
         request: any;
     };
     export type BillingPlan = {
@@ -2687,7 +2746,7 @@ declare module OpenEO {
         level: string;
         message: string;
         data: any;
-        path: Array<object<string, string>>;
+        path: Array<object<string, string | null>>;
         links: Array<Link>;
     };
     /**