@eodash/eodash 5.0.0-alpha.2.9 → 5.0.0-processing

package/core/client/utils/eodashSTAC.js

@@ -1,43 +1,34 @@
 import { Collection, Item } from "stac-js";
 import { toAbsolute } from "stac-js/src/http.js";
-import { generateFeatures } from "./helpers";
-import axios from "axios";
-
-/**
- * Function to extract collection urls from an indicator
- * @param {import("stac-ts").StacCatalog
- *   | import("stac-ts").StacCollection
- *   | import("stac-ts").StacItem
- *   | null
- * } stacObject
- * @param {string} basepath
- * @returns {string[]}
- */
-export function extractCollectionUrls(stacObject, basepath) {
-  const collectionUrls = [];
-  // Support for two structure types, flat and indicator, simplified here:
-  // Flat assumes Catalog-Collection-Item
-  // Indicator assumes Catalog-Collection-Collection-Item
-  // TODO: this is not the most stable test approach,
-  // we should discuss potential other approaches
-  //
-  if (stacObject?.links && stacObject?.links[1].rel === "item") {
-    collectionUrls.push(basepath);
-  } else if (stacObject?.links[1].rel === "child") {
-    // TODO: Iterate through all children to create collections
-    stacObject.links.forEach((link) => {
-      if (link.rel === "child") {
-        collectionUrls.push(toAbsolute(link.href, basepath));
-      }
-    });
-  }
-  return collectionUrls;
-}
+import {
+  extractLayerConfig,
+  extractLayerDatetime,
+  extractRoles,
+  fetchStyle,
+  findLayer,
+  generateFeatures,
+  replaceLayer,
+} from "./helpers";
+import {
+  getLayers,
+  getCompareLayers,
+  registerProjection,
+} from "@/store/Actions";
+import { createLayersFromAssets, createLayersFromLinks } from "./createLayers";
+import axios from "@/plugins/axios";
+import log from "loglevel";
+
 export class EodashCollection {
-  /** @type {string} */
   #collectionUrl = "";
+
   /** @type {import("stac-ts").StacCollection | undefined} */
   #collectionStac;
+
+  //  read only
+  get collectionStac() {
+    return this.#collectionStac;
+  }
+
   /**
    * @type {import("stac-ts").StacLink
    *   | import("stac-ts").StacItem
@@ -49,175 +40,225 @@ export class EodashCollection {
   constructor(collectionUrl) {
     this.#collectionUrl = collectionUrl;
   }
+
   /**
    * @async
-   * @param {any} item
+   * @param {import('stac-ts').StacLink | Date} [linkOrDate]
    * @returns
    */
-  createLayersJson = async (item = null) => {
-    /** @type {import("stac-ts").StacLink | undefined} */
-    let stacItem,
-      /** @type {import("stac-ts").StacCollection | undefined} */
-      stac;
+  createLayersJson = async (linkOrDate) => {
+    /**
+     * @type {import("stac-ts").StacLink | undefined}
+     **/
+    let stacItem;
+
+    /**
+     * @type {import("stac-ts").StacCollection | undefined}
+     **/
+    let stac;
     // TODO get auxiliary layers from collection
-    /** @type {object[]} */
-    let layersJson = [
-      /*{
-        type: "Tile",
-        properties: {
-          id: "OSM",
-        },
-        source: {
-          type: "OSM",
-        },
-      },*/
-    ];
+    /** @type {Record<string,any>[]} */
+    let layersJson = [];
+
     // Load collectionstac if not yet initialized
-    if (!this.#collectionStac) {
-      const response = await axios.get(this.#collectionUrl);
-      stac = await response.data;
-      this.#collectionStac = new Collection(stac);
-    }
+    stac = await this.fetchCollection();
 
-    if (stac && stac.endpointtype === "GeoDB") {
-      // Special handling of point based data
-      const allFeatures = generateFeatures(stac.links);
-      layersJson.unshift({
-        type: "Vector",
-        properties: {
-          id: stac.id,
-        },
-        source: {
-          type: "Vector",
-          url: "data:," + encodeURIComponent(JSON.stringify(allFeatures)),
-          format: "GeoJSON",
-        },
-        style: {
-          "circle-radius": 5,
-          "circle-fill-color": "#00417077",
-          "circle-stroke-color": "#004170",
-          "fill-color": "#00417077",
-          "stroke-color": "#004170",
-        },
-      });
-      return layersJson;
+    const isGeoDB = stac?.endpointtype === "GeoDB";
+
+    if (linkOrDate instanceof Date) {
+      // if collectionStac not yet initialized we do it here
+      stacItem = this.getItem(linkOrDate);
     } else {
-      if (item instanceof Date) {
-        // if collectionStac not yet initialized we do it here
-        stacItem = this.getItems()?.sort((a, b) => {
-          const distanceA = Math.abs(
-            new Date(/** @type {number} */ (a.datetime)).getTime() -
-              item.getTime(),
-          );
-          const distanceB = Math.abs(
-            new Date(/** @type {number} */ (b.datetime)).getTime() -
-              item.getTime(),
-          );
-          return distanceA - distanceB;
-        })[0];
-        this.selectedItem = stacItem;
+      stacItem = linkOrDate;
+    }
+
+    const stacItemUrl = stacItem
+      ? toAbsolute(stacItem.href, this.#collectionUrl)
+      : this.#collectionUrl;
+
+    stac = await axios.get(stacItemUrl).then((resp) => resp.data);
+
+    if (!stacItem) {
+      // no specific item was requested; render last item
+      this.#collectionStac = new Collection(stac);
+      this.selectedItem = this.getItem();
+
+      if (this.selectedItem) {
+        layersJson = /** @type {Record<string,any>[]} */ (
+          await this.createLayersJson(this.selectedItem)
+        );
       } else {
-        stacItem = item;
+        console.warn(
+          "[eodash] the selected collection does not include any items",
+        );
       }
-      const response = await fetch(
-        stacItem
-          ? toAbsolute(stacItem.href, this.#collectionUrl)
-          : this.#collectionUrl,
+      return [];
+    } else {
+      // specific item was requested
+      const item = new Item(stac);
+      this.selectedItem = item;
+      const title =
+        this.#collectionStac?.title || this.#collectionStac?.id || "";
+      layersJson.unshift(
+        ...(await this.buildJsonArray(item, stacItemUrl, title, isGeoDB)),
       );
-      stac = await response.json();
-
-      if (!stacItem) {
-        // no specific item was requested; render last item
-        this.#collectionStac = new Collection(stac);
-        const items = this.getItems();
-        this.selectedItem = items?.[items.length - 1];
-        if (this.selectedItem) {
-          layersJson = await this.createLayersJson(this.selectedItem);
-        } else {
-          if (import.meta.env.DEV) {
-            console.warn(
-              "[eodash] the selected collection does not include any items",
-            );
-          }
-        }
-        return [];
-      } else {
-        // specific item was requested
-        const item = new Item(stac);
-        this.selectedItem = item;
-        layersJson.unshift(...this.buildJsonArray(item));
-        return layersJson;
-      }
+      return layersJson;
     }
   };
 
-  /** @param {import("stac-ts").StacItem} item */
-  buildJsonArray(item) {
+  /**
+   * @param {import("stac-ts").StacItem} item
+   * @param {string} itemUrl
+   * @param {string} title
+   * @param {boolean} isGeoDB
+   * @param {string} [itemDatetime]
+   * @returns {Promise<Record<string,any>[]>} arrays
+   * */
+  async buildJsonArray(item, itemUrl, title, isGeoDB, itemDatetime) {
+    log.debug(
+      "Building JSON array",
+      item,
+      itemUrl,
+      title,
+      isGeoDB,
+      itemDatetime,
+    );
+    await this.fetchCollection();
+    // registering top level indicator projection
+    const indicatorProjection =
+      item?.["proj:epsg"] || item?.["eodash:proj4_def"];
+    await registerProjection(
+      /** @type {number | string | {name: string, def: string; extent: number[] | undefined;} } */ (
+        indicatorProjection
+      ),
+    );
+
     const jsonArray = [];
-    // TODO: this currently assumes only one layer will be extracted
-    //       from an item, although it think this is currently true
-    //       potentially this could return multiple layers
-    // TODO: implement other types, such as COG
+
+    if (isGeoDB) {
+      const allFeatures = generateFeatures(this.#collectionStac?.links);
+
+      return [
+        {
+          type: "Vector",
+          properties: {
+            id: this.#collectionStac?.id ?? "",
+            title: this.#collectionStac?.title || item.id,
+          },
+          source: {
+            type: "Vector",
+            url: "data:," + encodeURIComponent(JSON.stringify(allFeatures)),
+            format: "GeoJSON",
+          },
+          style: {
+            "circle-radius": 5,
+            "circle-fill-color": "#00417077",
+            "circle-stroke-color": "#004170",
+            "fill-color": "#00417077",
+            "stroke-color": "#004170",
+          },
+          interactions: [],
+        },
+      ];
+    }
 
     // I propose following approach, we "manually" create configurations
     // for the rendering options we know and expect.
     // If we don't find any we fallback to using the STAC ol item that
     // will try to extract anything it supports but for which we have
     // less control.
-    const wms = item.links.find((l) => l.rel === "wms");
-    // const projDef = false; // TODO: add capability to find projection in item
-    if (wms) {
-      let json = {
-        type: "Tile",
-        properties: {
-          id: item.id,
-        },
-        source: {
-          // if no projection information is provided we should
-          // assume one, else for WMS requests it will try to get
-          // the map projection that might not be supported
-          // projection: projDef ? projDef : "EPSG:4326",
-          type: "TileWMS",
-          url: wms.href,
-          params: {
-            LAYERS: wms["wms:layers"],
-            TILED: true,
-          },
-        },
-      };
-      if ("wms:dimensions" in wms) {
-        // @ts-expect-error: waiting for eox-map to provide type definition
-        json.source.params.time = wms["wms:dimensions"];
+
+    let { layerConfig, style } = extractLayerConfig(
+      await fetchStyle(item, itemUrl),
+    );
+
+    const layerDatetime = extractLayerDatetime(
+      this.getItems(),
+      item.properties?.datetime ?? itemDatetime,
+    );
+
+    const dataAssets = Object.keys(item?.assets ?? {}).reduce((data, ast) => {
+      if (item.assets[ast].roles?.includes("data")) {
+        data[ast] = item.assets[ast];
       }
-      jsonArray.push(json);
-    } else if (item.links.find((l) => l.rel === "wmts" || l.rel === "xyz")) {
-      jsonArray.push({
+      return data;
+    }, /** @type {Record<string,import('stac-ts').StacAsset>} */ ({}));
+    const isSupported =
+      item.links.some((link) => ["wms", "xyz", "wmts"].includes(link.rel)) ||
+      Object.keys(dataAssets).length;
+
+    if (isSupported) {
+      // Checking for potential legend asset
+      let extraProperties = null;
+      if (this.#collectionStac?.assets?.legend?.href) {
+        extraProperties = {
+          description: `<div style="text-align:center; width: 100%">
+            <img src="${this.#collectionStac.assets.legend.href}" style="max-height:70px; margin-top:-15px; margin-bottom:-20px;" />
+          </div>`,
+        };
+      }
+      // Check if collection has eox:colorlegend definition, if yes overwrite legend description
+      if (this.#collectionStac && this.#collectionStac["eox:colorlegend"]) {
+        extraProperties = {
+          layerLegend: this.#collectionStac["eox:colorlegend"],
+        };
+      }
+      const links = await createLayersFromLinks(
+        this.#collectionStac?.id ?? "",
+        title,
+        item,
+        layerDatetime,
+        extraProperties,
+      );
+      jsonArray.push(
+        ...links,
+        ...(await createLayersFromAssets(
+          this.#collectionStac?.id ?? "",
+          title || this.#collectionStac?.title || item.id,
+          dataAssets,
+          item,
+          style,
+          layerConfig,
+          layerDatetime,
+          extraProperties,
+        )),
+      );
+    } else {
+      // fallback to STAC
+      const json = {
         type: "STAC",
         displayWebMapLink: true,
         displayFootprint: false,
         data: item,
         properties: {
-          id: item.id,
-        },
-      });
-    } else {
-      // fall back to rendering the feature
-      jsonArray.push({
-        type: "Vector",
-        source: {
-          type: "Vector",
-          url: "data:," + encodeURIComponent(JSON.stringify(item.geometry)),
-          format: "GeoJSON",
-        },
-        properties: {
-          id: item.id,
+          id: this.#collectionStac?.id ?? "",
+          title: title || item.id,
+          layerConfig,
         },
-      });
+        style,
+      };
+      extractRoles(
+        json.properties,
+        //@ts-expect-error using the item incase no self link is found
+        item.links.find((link) => link.rel === "self") ?? item,
+      );
+      jsonArray.push(json);
     }
 
     return jsonArray;
   }
 
+  async fetchCollection() {
+    if (!this.#collectionStac) {
+      log.debug("Fetching collection file", this.#collectionUrl);
+      const col = await axios
+        .get(this.#collectionUrl)
+        .then((resp) => resp.data);
+      this.#collectionStac = new Collection(col);
+    }
+    return this.#collectionStac;
+  }
+
   getItems() {
     return (
       this.#collectionStac?.links
@@ -246,4 +287,113 @@ export class EodashCollection {
         .map((i) => new Date(/** @type {number} */ (i.datetime)))
     );
   }
+
+  async getExtent() {
+    await this.fetchCollection();
+    return this.#collectionStac?.extent;
+  }
+
+  /**
+   * Get closest Item Link from a certain date,
+   * get the latest if no date provided
+   *  @param {Date} [date]
+   **/
+  getItem(date) {
+    return date
+      ? this.getItems()?.sort((a, b) => {
+          const distanceA = Math.abs(
+            new Date(/** @type {number} */ (a.datetime)).getTime() -
+              date.getTime(),
+          );
+          const distanceB = Math.abs(
+            new Date(/** @type {number} */ (b.datetime)).getTime() -
+              date.getTime(),
+          );
+          return distanceA - distanceB;
+        })[0]
+      : this.getItems()?.at(-1);
+  }
+
+  /**
+   *
+   * @param {string} datetime
+   * @param {string} layer
+   * @param {string} map
+   */
+  async updateLayerJson(datetime, layer, map) {
+    await this.fetchCollection();
+
+    // get the link of the specified date
+    const specifiedLink = this.getItems()?.find(
+      (item) =>
+        typeof item.datetime === "string" &&
+        new Date(item.datetime).toISOString() === datetime,
+    );
+
+    if (!specifiedLink) {
+      console.warn(
+        "[eodash] no Item found for the provided datetime",
+        datetime,
+      );
+      return;
+    }
+
+    // create json layers from the item
+    const newLayers = await this.createLayersJson(specifiedLink);
+
+    let currentLayers = getLayers();
+    if (map === "second") {
+      currentLayers = getCompareLayers();
+    }
+
+    const oldLayer = findLayer(currentLayers, layer);
+
+    const updatedLayers = replaceLayer(
+      currentLayers,
+      /** @type {Record<string,any> & { properties:{ id:string; title:string } } } */
+      (oldLayer),
+      newLayers,
+    );
+
+    return updatedLayers;
+  }
+
+  /**
+   * Returns base layers and overlay layers of a STAC Collection
+   *
+   * @param {import("stac-ts").StacCollection} indicator */
+  static async getIndicatorLayers(indicator) {
+    const indicatorAssets = Object.keys(indicator?.assets ?? {}).reduce(
+      (assets, ast) => {
+        if (
+          indicator.assets?.[ast].roles?.includes("baselayer") ||
+          indicator.assets?.[ast].roles?.includes("overlay")
+        ) {
+          assets[ast] = indicator.assets[ast];
+        }
+        return assets;
+      },
+      /** @type {Record<string,import('stac-ts').StacAsset>} */ ({}),
+    );
+
+    return [
+      ...(await createLayersFromLinks(
+        indicator?.id ?? "",
+        indicator?.title || indicator.id,
+        //@ts-expect-error indicator instead of item
+        indicator,
+        // layerDatetime,
+      )),
+      ...(await createLayersFromAssets(
+        indicator?.id ?? "",
+        indicator?.title || indicator.id,
+        indicatorAssets,
+        //@ts-expect-error indicator instead of item
+        indicator,
+        // style,
+        // layerConfig,
+        // layerDatetime,
+      )),
+    ];
+  }
 }