ol-stac 1.0.0-beta.7 → 1.0.0-beta.9

package/events/ErrorEvent.d.ts

@@ -0,0 +1,20 @@
+export default ErrorEvent;
+/**
+ * @classdesc
+ * Event emitted on configuration or loading error.
+ * @api
+ */
+declare class ErrorEvent extends BaseEvent {
+    /**
+     * @param {Error} error error object.
+     * @api
+     */
+    constructor(error: Error);
+    /**
+     * @type {Error}
+     * @api
+     */
+    error: Error;
+}
+import BaseEvent from 'ol/events/Event.js';
+//# sourceMappingURL=ErrorEvent.d.ts.map

package/events/ErrorEvent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ErrorEvent.d.ts","sourceRoot":"","sources":["../../../src/ol/events/ErrorEvent.js"],"names":[],"mappings":";AAMA;;;;GAIG;AACH;IACE;;;OAGG;IACH,mBAHW,KAAK,EAWf;IALC;;;OAGG;IACH,OAHU,KAAK,CAGG;CAErB;sBAtBqB,oBAAoB"}

package/{src/ol/events → events}/ErrorEvent.js

@@ -3,26 +3,24 @@
  */
 import BaseEvent from 'ol/events/Event.js';
 import EventType from 'ol/events/EventType.js';
-
 /**
  * @classdesc
  * Event emitted on configuration or loading error.
  * @api
  */
 class ErrorEvent extends BaseEvent {
-  /**
-   * @param {Error} error error object.
-   * @api
-   */
-  constructor(error) {
-    super(EventType.ERROR);
-
     /**
-     * @type {Error}
+     * @param {Error} error error object.
      * @api
      */
-    this.error = error;
-  }
+    constructor(error) {
+        super(EventType.ERROR);
+        /**
+         * @type {Error}
+         * @api
+         */
+        this.error = error;
+    }
 }
-
 export default ErrorEvent;
+//# sourceMappingURL=ErrorEvent.js.map

package/events/ErrorEvent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ErrorEvent.js","sourceRoot":"","sources":["../../../src/ol/events/ErrorEvent.js"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,SAAS,MAAM,oBAAoB,CAAC;AAC3C,OAAO,SAAS,MAAM,wBAAwB,CAAC;AAE/C;;;;GAIG;AACH,MAAM,UAAW,SAAQ,SAAS;IAChC;;;OAGG;IACH,YAAY,KAAK;QACf,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAEvB;;;WAGG;QACH,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;CACF;AAED,eAAe,UAAU,CAAC"}

package/layer/STAC.d.ts

@@ -0,0 +1,421 @@
+export default STACLayer;
+export type Extent = import("ol/extent.js").Extent;
+export type Layer = import("ol/layer.js").Layer;
+export type Link = any;
+export type Style = import('ol/style.js').Style;
+export type SourceOptions = import('../source/type.js').SourceOptions;
+export type Options = {
+    /**
+     * The STAC URL. Any of `url` and `data` must be provided.
+     * Can also be used as url for data, if it is absolute and doesn't contain a self link.
+     */
+    url?: string | undefined;
+    /**
+     * The STAC metadata. Any of `url` and `data` must be provided.
+     * `data` take precedence over `url`.
+     */
+    data?: STAC | Asset | any;
+    /**
+     * The selector for the assets to be rendered,
+     * only for STAC Items and Collections.
+     * This can be an array of strings corresponding to asset keys or Asset objects.
+     * null shows the default asset, an empty array shows no asset.
+     */
+    assets?: any[] | null | undefined;
+    /**
+     * The (one-based) bands to show.
+     */
+    bands?: number[] | undefined;
+    /**
+     * Optional function that can be used to configure the underlying sources. The function can do any additional work
+     * and return the completed options or a promise for the same. The function will be called with the current source options
+     * and the STAC Asset or Link.
+     * This can be useful for adding auth information such as an API token, either via query parameter or HTTP headers.
+     * Please be aware that sending HTTP headers may not be supported by all sources.
+     */
+    getSourceOptions?: ((arg0: SourceType, arg1: SourceOptions, arg2: (Asset | Link)) => (SourceOptions | Promise<SourceOptions>)) | undefined;
+    /**
+     * Allows to hide the footprints (bounding box/geometry) of the STAC object
+     * by default.
+     */
+    displayFootprint?: boolean | undefined;
+    /**
+     * Allow to choose non-cloud-optimized GeoTiffs as default image to show,
+     * which might not work well for larger files or larger amounts of files.
+     */
+    displayGeoTiffByDefault?: boolean | undefined;
+    /**
+     * Allow to display images that a browser can display (e.g. PNG, JPEG),
+     * usually assets with role `thumbnail` or the link with relation type `preview`.
+     * The previews are usually not covering the full extents and as such may be placed incorrectly on the map.
+     * For performance reasons, it is recommended to enable this option if you pass in STAC API Items.
+     */
+    displayPreview?: boolean | undefined;
+    /**
+     * Allow to display COGs and, if `displayGeoTiffByDefault` is enabled, GeoTiffs,
+     * usually the assets with role `overview` or `visual`.
+     */
+    displayOverview?: boolean | undefined;
+    /**
+     * Allow to display a layer
+     * based on the information provided through the web map links extension.
+     * If an array of links or link ids (property `id` in a Link Object) is provided, all corresponding layers will be shown.
+     * If set to true or to a specific type of web map link (`pmtiles`, `tilejson`, `wms`, `wmts`, `xyz`),
+     * it lets this library choose a web map link to show, but only if no other data is shown.
+     * To disable the functionality set this to `false`.
+     */
+    displayWebMapLink?: string | boolean | any[] | undefined;
+    /**
+     * The style for the overall bounds / footprint.
+     */
+    boundsStyle?: import("ol/style/Style.js").default | undefined;
+    /**
+     * The style for individual items in a list of STAC Items or Collections.
+     */
+    collectionStyle?: import("ol/style/Style.js").default | undefined;
+    /**
+     * For thumbnails: The `crossOrigin` attribute for loaded images / tiles.
+     * See https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail.
+     */
+    crossOrigin?: string | null | undefined;
+    /**
+     * A function that generates a URL template for a tile server (XYZ),
+     * which will be used instead of the client-side GeoTIFF rendering (except if `useTileLayerAsFallback` is `true`).
+     */
+    buildTileUrlTemplate?: ((arg0: Asset) => string | null) | undefined;
+    /**
+     * Uses the given URL template only when the client-side GeoTIFF rendering fails.
+     */
+    useTileLayerAsFallback?: boolean | undefined;
+    /**
+     * Opacity (0, 1).
+     */
+    opacity?: number | undefined;
+    /**
+     * Visibility.
+     */
+    visible?: boolean | undefined;
+    /**
+     * The bounding extent for layer rendering.  The layer will not be
+     * rendered outside of this extent.
+     */
+    extent?: import("ol/extent.js").Extent | undefined;
+    /**
+     * The z-index for layer rendering.  At rendering time, the layers
+     * will be ordered, first by Z-index and then by position. When `undefined`, a `zIndex` of 0 is assumed
+     * for layers that are added to the map's `layers` collection, or `Infinity` when the layer's `setMap()`
+     * method was used.
+     */
+    zIndex?: number | undefined;
+    /**
+     * The minimum resolution (inclusive) at which this layer will be
+     * visible.
+     */
+    minResolution?: number | undefined;
+    /**
+     * The maximum resolution (exclusive) below which this layer will
+     * be visible.
+     */
+    maxResolution?: number | undefined;
+    /**
+     * The minimum view zoom level (exclusive) above which this layer will be
+     * visible.
+     */
+    minZoom?: number | undefined;
+    /**
+     * The maximum view zoom level (inclusive) at which this layer will
+     * be visible.
+     */
+    maxZoom?: number | undefined;
+    /**
+     * Arbitrary observable properties. Can be accessed with `#get()` and `#set()`. `stac` and `bounds` are reserved and may be overridden.
+     */
+    properties?: {
+        [x: string]: any;
+    } | undefined;
+};
+/**
+ * @typedef {import("ol/extent.js").Extent} Extent
+ */
+/**
+ * @typedef {import("ol/layer.js").Layer} Layer
+ */
+/**
+ * @typedef {import("stac-js").Link} Link
+ */
+/**
+ * @typedef {import('ol/style.js').Style} Style
+ */
+/**
+ * @typedef {import('../source/type.js').SourceOptions} SourceOptions
+ */
+/**
+ * @typedef {Object} Options
+ * @property {string} [url] The STAC URL. Any of `url` and `data` must be provided.
+ * Can also be used as url for data, if it is absolute and doesn't contain a self link.
+ * @property {STAC|Asset|Object} [data] The STAC metadata. Any of `url` and `data` must be provided.
+ * `data` take precedence over `url`.
+ * @property {Array<string|Asset>|null} [assets=null] The selector for the assets to be rendered,
+ * only for STAC Items and Collections.
+ * This can be an array of strings corresponding to asset keys or Asset objects.
+ * null shows the default asset, an empty array shows no asset.
+ * @property {Array<number>} [bands] The (one-based) bands to show.
+ * @property {function(SourceType, SourceOptions, (Asset|Link)):(SourceOptions|Promise<SourceOptions>)} [getSourceOptions]
+ * Optional function that can be used to configure the underlying sources. The function can do any additional work
+ * and return the completed options or a promise for the same. The function will be called with the current source options
+ * and the STAC Asset or Link.
+ * This can be useful for adding auth information such as an API token, either via query parameter or HTTP headers.
+ * Please be aware that sending HTTP headers may not be supported by all sources.
+ * @property {boolean} [displayFootprint=true] Allows to hide the footprints (bounding box/geometry) of the STAC object
+ * by default.
+ * @property {boolean} [displayGeoTiffByDefault=false] Allow to choose non-cloud-optimized GeoTiffs as default image to show,
+ * which might not work well for larger files or larger amounts of files.
+ * @property {boolean} [displayPreview=false] Allow to display images that a browser can display (e.g. PNG, JPEG),
+ * usually assets with role `thumbnail` or the link with relation type `preview`.
+ * The previews are usually not covering the full extents and as such may be placed incorrectly on the map.
+ * For performance reasons, it is recommended to enable this option if you pass in STAC API Items.
+ * @property {boolean} [displayOverview=true] Allow to display COGs and, if `displayGeoTiffByDefault` is enabled, GeoTiffs,
+ * usually the assets with role `overview` or `visual`.
+ * @property {string|boolean|Array<Link|string>} [displayWebMapLink=false] Allow to display a layer
+ * based on the information provided through the web map links extension.
+ * If an array of links or link ids (property `id` in a Link Object) is provided, all corresponding layers will be shown.
+ * If set to true or to a specific type of web map link (`pmtiles`, `tilejson`, `wms`, `wmts`, `xyz`),
+ * it lets this library choose a web map link to show, but only if no other data is shown.
+ * To disable the functionality set this to `false`.
+ * @property {Style} [boundsStyle] The style for the overall bounds / footprint.
+ * @property {Style} [collectionStyle] The style for individual items in a list of STAC Items or Collections.
+ * @property {null|string} [crossOrigin] For thumbnails: The `crossOrigin` attribute for loaded images / tiles.
+ * See https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail.
+ * @property {function(Asset):string|null} [buildTileUrlTemplate=null] A function that generates a URL template for a tile server (XYZ),
+ * which will be used instead of the client-side GeoTIFF rendering (except if `useTileLayerAsFallback` is `true`).
+ * @property {boolean} [useTileLayerAsFallback=false] Uses the given URL template only when the client-side GeoTIFF rendering fails.
+ * @property {number} [opacity=1] Opacity (0, 1).
+ * @property {boolean} [visible=true] Visibility.
+ * @property {Extent} [extent] The bounding extent for layer rendering.  The layer will not be
+ * rendered outside of this extent.
+ * @property {number} [zIndex] The z-index for layer rendering.  At rendering time, the layers
+ * will be ordered, first by Z-index and then by position. When `undefined`, a `zIndex` of 0 is assumed
+ * for layers that are added to the map's `layers` collection, or `Infinity` when the layer's `setMap()`
+ * method was used.
+ * @property {number} [minResolution] The minimum resolution (inclusive) at which this layer will be
+ * visible.
+ * @property {number} [maxResolution] The maximum resolution (exclusive) below which this layer will
+ * be visible.
+ * @property {number} [minZoom] The minimum view zoom level (exclusive) above which this layer will be
+ * visible.
+ * @property {number} [maxZoom] The maximum view zoom level (inclusive) at which this layer will
+ * be visible.
+ * @property {Object<string, *>} [properties] Arbitrary observable properties. Can be accessed with `#get()` and `#set()`. `stac` and `bounds` are reserved and may be overridden.
+ */
+/**
+ * @classdesc
+ * Renders STAC entities such as STAC Items, Collectons or lists of them as returned by APIs.
+ * The layers created by this LayerGroup all have a 'stac' value that can be retrieved using `layer.get('stac')`.
+ *
+ * @extends LayerGroup
+ * @fires sourceready
+ * @fires assetsready
+ * @fires ErorEvent#event:error
+ * @api
+ */
+declare class STACLayer extends LayerGroup {
+    /**
+     * @param {Options} options Layer options.
+     * @api
+     */
+    constructor(options: Options);
+    /**
+     * @type {function(SourceType, SourceOptions, (Asset|Link)):(SourceOptions|Promise<SourceOptions>)}
+     * @private
+     */
+    private getSourceOptions_;
+    /**
+     * @type {STAC|Asset}
+     * @private
+     */
+    private data_;
+    /**
+     * @type {Array<Asset> | null}
+     * @private
+     */
+    private assets_;
+    /**
+     * @type {Array<number>}
+     * @private
+     */
+    private bands_;
+    /**
+     * @type {string | null}
+     * @private
+     */
+    private crossOrigin_;
+    /**
+     * @type {boolean}
+     * @private
+     */
+    private displayFootprint_;
+    /**
+     * @type {boolean}
+     * @private
+     */
+    private displayGeoTiffByDefault_;
+    /**
+     * @type {boolean}
+     * @private
+     */
+    private displayPreview_;
+    /**
+     * @type {boolean}
+     * @private
+     */
+    private displayOverview_;
+    /**
+     * @type {string|boolean|Array<Link|string>}
+     */
+    displayWebMapLink_: string | boolean | Array<Link | string>;
+    /**
+     * @type {function(Asset):string|null}
+     * @private
+     */
+    private buildTileUrlTemplate_;
+    /**
+     * @type {boolean}
+     * @private
+     */
+    private useTileLayerAsFallback_;
+    /**
+     * @type {Style}
+     * @private
+     */
+    private boundsStyle_;
+    /**
+     * @type {Style}
+     * @private
+     */
+    private collectionStyle_;
+    /**
+     * @type {VectorLayer|null}
+     * @private
+     */
+    private boundsLayer_;
+    /**
+     * Returns the vector layer that visualizes the bounds / footprint.
+     * @return {VectorLayer|null} The vector layer for the bounds
+     * @api
+     */
+    getBoundsLayer(): VectorLayer<any> | null;
+    /**
+     * @private
+     * @param {Error} error The error.
+     */
+    private handleError_;
+    /**
+     * @private
+     * @param {STAC|Asset|Object} data The STAC data.
+     * @param {string} url The url to the data.
+     * @param {Array<Asset|string> | null} assets The assets to show.
+     * @param {Array<number>} bands The (one-based) bands to show.
+     */
+    private configure_;
+    /**
+     * @private
+     * @return {Promise} Resolves when complete.
+     */
+    private addApiCollection_;
+    /**
+     * @private
+     * @return {Promise} Resolves when complete.
+     */
+    private addStacAssets_;
+    /**
+     * @private
+     * @param {Asset|Link} [ref] A STAC Link or Asset
+     * @return {Promise<Layer|undefined>} Resolves with a Layer or undefined when complete.
+     */
+    private addImagery_;
+    /**
+     * @private
+     * @param {Asset|Link} [thumbnail] A STAC Link or Asset
+     * @return {Promise<ImageLayer|undefined>} Resolves with am ImageLayer or udnefined when complete.
+     */
+    private addThumbnail_;
+    /**
+     * Adds a layer for the web map links available in the STAC links.
+     * @return {Promise<Array<Layer>|undefined>} Resolves with a Layer or undefined when complete.
+     */
+    addWebMapLinks_(): Promise<Array<Layer> | undefined>;
+    /**
+     * Adds a layer for a link that implements the web-map-links extension.
+     * Supports: PMTiles, TileJSON, WMS, WMTS, XYZ
+     * @see https://github.com/stac-extensions/web-map-links
+     * @param {Link} link A web map link
+     * @return {Promise<Array<Layer>|undefined>} Resolves with a list of layers or undefined when complete.
+     * @api
+     */
+    addLayerForLink(link: any): Promise<Array<Layer> | undefined>;
+    /**
+     * @private
+     * @param {Asset} [asset] A STAC Asset
+     * @return {Promise<Layer|undefined>} Resolves with a Layer or undefined when complete.
+     */
+    private addGeoTiff_;
+    /**
+     * @private
+     * @param {Asset|Link} [data] A STAC Asset or Link
+     * @return {Promise<TileLayer>} Resolves with a TileLayer when complete.
+     */
+    private addTileLayerForImagery_;
+    /**
+     * @param {Layer|LayerGroup} [layer] A Layer to add to the LayerGroup
+     * @param {import("stac-js").STACObject} [data] The STAC object, can be any class exposed by stac-js
+     * @param {number} [zIndex=0] The z-index for the layer
+     * @private
+     */
+    private addLayer_;
+    /**
+     * @private
+     * @return {VectorLayer|null} The vector layer showing the geometry/bbox.
+     */
+    private addFootprint_;
+    /**
+     * @private
+     */
+    private updateLayers_;
+    /**
+     * Indicates whether the LayerGroup shows only the bounds layer (i.e. no imagery/tile layers).
+     * @return {boolean} `true` if only the bounds layer is shown, `false` otherwise.
+     * @api
+     */
+    hasOnlyBounds(): boolean;
+    /**
+     * Returns all potential web map links based on the given value for `displayWebMapLink`.
+     * @return {Array<Link>} An array of links.
+     * @api
+     */
+    getWebMapLinks(): Array<Link>;
+    /**
+     * Update the assets to be rendered.
+     * @param {Array<string|Asset>|null} assets The assets to show.
+     * @return {Promise} Resolves when all assets are rendered.
+     * @api
+     */
+    setAssets(assets: Array<string | Asset> | null): Promise<any>;
+    /**
+     * Get the STAC object.
+     *
+     * @return {STAC|Asset} The STAC object.
+     * @api
+     */
+    getData(): STAC | Asset;
+    /**
+     * Get the STAC assets shown.
+     *
+     * @return {Array<Asset>} The STAC assets.
+     * @api
+     */
+    getAssets(): Array<Asset>;
+}
+import SourceType from '../source/type.js';
+import LayerGroup from 'ol/layer/Group.js';
+import VectorLayer from 'ol/layer/Vector.js';
+//# sourceMappingURL=STAC.d.ts.map

package/layer/STAC.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"STAC.d.ts","sourceRoot":"","sources":["../../../src/ol/layer/STAC.js"],"names":[],"mappings":";qBAoCa,OAAO,cAAc,EAAE,MAAM;oBAG7B,OAAO,aAAa,EAAE,KAAK;;oBAM3B,OAAO,aAAa,EAAE,KAAK;4BAG3B,OAAO,mBAAmB,EAAE,aAAa;;;;;;;;;;;WAOxC,kBAAiB;;;;;;;;;;;;;;;;;;;+BAOR,UAAU,QAAE,aAAa,QAAE,CAAC,QAAM,IAAI,CAAC,KAAE,CAAC,aAAa,GAAC,QAAQ,aAAa,CAAC,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;6CA0BxE,MAAM,GAAC,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AArDzC;;GAEG;AACH;;GAEG;AACH;;GAEG;AACH;;GAEG;AACH;;GAEG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyDG;AAEH;;;;;;;;;;GAUG;AACH;IACE;;;OAGG;IACH,qBAHW,OAAO,EAmIjB;IAjHC;;;OAGG;IACH,0BAAiD;IAEjD;;;OAGG;IACH,cAAU;IAEV;;;OAGG;IACH,gBAAmB;IAEnB;;;OAGG;IACH,eAAgB;IAEhB;;;OAGG;IACH,qBAA+C;IAE/C;;;OAGG;IACH,0BAA0E;IAE1E;;;OAGG;IACH,iCAAwE;IAExE;;;OAGG;IACH,wBAAsD;IAEtD;;;OAGG;IACH,yBAAwE;IAExE;;OAEG;IACH,oBAFU,MAAM,GAAC,OAAO,GAAC,MAAM,IAAI,GAAC,MAAM,CAAC,CAEiB;IAE5D;;;OAGG;IACH,8BAAiE;IAEjE;;;OAGG;IACH,gCAAsE;IAEtE;;;OAGG;IACH,qBAA6D;IAE7D;;;OAGG;IACH,yBAAyE;IAEzE;;;OAGG;IACH,qBAAwB;IA4B1B;;;;OAIG;IACH,kBAHY,mBAAY,IAAI,CAK3B;IAED;;;OAGG;IACH,qBASC;IAED;;;;;;OAMG;IACH,mBAuCC;IAED;;;OAGG;IACH,0BAiBC;IAED;;;OAGG;IACH,uBAsBC;IAED;;;;OAIG;IACH,oBAUC;IAED;;;;OAIG;IACH,sBA0BC;IAED;;;OAGG;IACH,mBAFY,QAAQ,MAAM,KAAK,CAAC,GAAC,SAAS,CAAC,CAO1C;IAED;;;;;;;OAOG;IACH,4BAHY,QAAQ,MAAM,KAAK,CAAC,GAAC,SAAS,CAAC,CAuI1C;IAED;;;;OAIG;IACH,oBA+DC;IAED;;;;OAIG;IACH,gCAgBC;IAED;;;;;OAKG;IACH,kBAIC;IAED;;;OAGG;IACH,sBA+BC;IAED;;OAEG;IACH,sBAwBC;IAED;;;;OAIG;IACH,iBAHY,OAAO,CASlB;IAED;;;;OAIG;IACH,kBAHY,MAAM,IAAI,CAAC,CA+BtB;IAED;;;;;OAKG;IACH,kBAJW,MAAM,MAAM,QAAM,CAAC,GAAC,IAAI,gBAmBlC;IAED;;;;;OAKG;IACH,WAHY,YAAU,CAKrB;IAED;;;;;OAKG;IACH,aAHY,YAAY,CAKvB;CAoCF;uBAr2BsB,mBAAmB;uBADnB,mBAAmB;wBAKlB,oBAAoB"}