@eodash/eodash 5.6.0 → 5.7.0

package/widgets/EodashTimeSlider/index.vue

@@ -0,0 +1,152 @@
+<template>
+  <eox-timecontrol
+    v-if="hasMultipleItems"
+    :key="unref(mapEl)"
+    ref="eoxTimecontrol"
+    .for="mapEl"
+    @select="onSelect"
+    titleKey="title"
+    .externalMapRendering="true"
+    .animate="animate"
+    .initDate="initDate"
+  >
+    <div class="d-flex g-10 align-center">
+      <eox-timecontrol-date class="flex-grow-1"></eox-timecontrol-date>
+      <eox-timecontrol-picker
+        .range="false"
+        .showDots="true"
+        .showItems="true"
+        .popup="true"
+      ></eox-timecontrol-picker>
+
+      <eox-itemfilter
+        v-if="filters.length"
+        .inlineMode="true"
+        :showResults="false"
+        .filterProperties="filters"
+      ></eox-itemfilter>
+      <eox-timecontrol-timelapse @export="onExport"></eox-timecontrol-timelapse>
+    </div>
+
+    <eox-timecontrol-timeline class="mt-2"></eox-timecontrol-timeline>
+  </eox-timecontrol>
+</template>
+<script setup>
+import { datetime, mapEl } from "@/store/states";
+import { eodashCollections } from "@/utils/states";
+import "@eox/timecontrol";
+import "@eox/itemfilter";
+
+import { computed, onMounted, ref, unref, useTemplateRef } from "vue";
+import { storeToRefs } from "pinia";
+import { useSTAcStore } from "@/store/stac";
+import { createAnimationLayers } from "./methods";
+
+const { animate } = defineProps({
+  filters: {
+    /** @type {import("vue").PropType<import("@eox/itemfilter").EOxItemFilter["filterProperties"]>} */
+    type: Array,
+    default: () => [],
+  },
+  animate: {
+    type: Boolean,
+    default: true,
+  },
+});
+
+/** @type {import("vue").ShallowRef<HTMLElement>} */
+const timesliderEl = useTemplateRef("eoxTimecontrol");
+
+const startDate = new Date(datetime.value);
+const endDate = new Date(startDate.getTime() + 24 * 60 * 60 * 1000);
+
+const selectedRange = /** @type {import("vue").Ref<[string, string]>} */ (
+  ref([startDate, endDate].map((d) => d.toISOString()))
+);
+const initDate = [startDate.toISOString().split("T")[0]];
+
+const hasMultipleItems = computed(() => {
+  return eodashCollections.some((ec) => {
+    const itemLinks = ec.collectionStac?.links.filter((l) => l.rel === "item");
+    const itemsLink = ec.collectionStac?.links.some((l) => l.rel === "items");
+    return (itemLinks && itemLinks.length > 1) || itemsLink;
+  });
+});
+
+/**
+ * Handles the selection event from the time control component.
+ * It finds the closest item to the "from" selected date
+ * and updates the global datetime state with that item's original date.
+ *
+ * @param {CustomEvent<import("./types").TimelineSelectionEventDetail>} e
+ */
+const onSelect = (e) => {
+  const { selectedItems, date } = e.detail;
+  // Update the selected range with the new dates
+  selectedRange.value = date;
+
+  const allItems = Object.keys(selectedItems ?? {}).flatMap(
+    (id) => selectedItems[id],
+  );
+  if (!allItems.length) {
+    return;
+  }
+  const [from, _to] = date;
+  const fromDate = new Date(from).getTime();
+
+  const closestItem = allItems.reduce((prev, curr) => {
+    const prevDiff = Math.abs(new Date(prev.originalDate).getTime() - fromDate);
+    const currDiff = Math.abs(new Date(curr.originalDate).getTime() - fromDate);
+    return currDiff < prevDiff ? curr : prev;
+  });
+
+  if (closestItem) {
+    datetime.value = closestItem.originalDate;
+  }
+};
+
+const { selectedStac, stacEndpoint } = storeToRefs(useSTAcStore());
+
+/**
+ *
+ * @param {CustomEvent<import("./types").TimelineExportEventDetail>} evt
+ */
+const onExport = async (evt) => {
+  const { generate, selectedRangeItems, filters } = evt.detail;
+
+  if (!stacEndpoint.value) {
+    return;
+  }
+
+  const mapLayers = await createAnimationLayers(
+    stacEndpoint.value,
+    selectedRange.value,
+    selectedRangeItems,
+    selectedStac,
+    filters,
+  );
+
+  if (!mapLayers?.length) {
+    console.warn("[eodash] No map layers generated for the animation.");
+    return;
+  }
+
+  generate({
+    mapLayers,
+  });
+};
+
+onMounted(() => {
+  const parentDiv = timesliderEl.value?.parentElement;
+  const layoutItem = parentDiv?.parentElement;
+  if (parentDiv && layoutItem && animate) {
+    parentDiv.style.overflow = "visible";
+    layoutItem.style.overflow = "visible";
+  }
+});
+</script>
+<style scoped>
+eox-itemfilter {
+  --inline-container-height: 40px;
+}
+</style>

package/widgets/EodashTimeSlider/methods/index.js

@@ -0,0 +1,279 @@
+import { createLayersConfig } from "^/EodashMap/methods/create-layers-config";
+import { eodashCollections } from "@/utils/states";
+import axios from "@/plugins/axios";
+import { mapEl } from "@/store/states";
+import { removeLayers, sanitizeBbox } from "@/eodashSTAC/helpers";
+import { getLayers } from "@/store/actions";
+
+/**
+ * @param {string} stacEndpoint
+ * @param {[string, string]} selectedRange
+ * @param {import("../types").TimelineExportEventDetail["selectedRangeItems"]} selectedRangeItems
+ * @param {import("vue").Ref<import("stac-ts").StacCollection|null>} selectedStac
+ * @param {Record<string, import("../types").Filter>} filters
+ */
+export async function createAnimationLayers(
+  stacEndpoint,
+  selectedRange,
+  selectedRangeItems,
+  selectedStac,
+  filters,
+) {
+  if (eodashCollections[0].isAPI) {
+    return await createAPILayers(
+      stacEndpoint,
+      { min: selectedRange[0], max: selectedRange[1] },
+      mapEl.value?.lonLatExtent,
+      selectedStac,
+      filters,
+    );
+  }
+  const { collections: hiddenCollections, layers: hiddenLayers } =
+    getHiddenLayers([...getLayers()]);
+
+  return await Promise.all(
+    Object.values(selectedRangeItems).flatMap(async (itemSet) => {
+      /** @type {Array<{ layers: Record<string, any>[]; date: string }>} */
+      const mapLayersArr = [];
+      for (const dateItem of itemSet) {
+        await createLayersConfig(
+          selectedStac.value,
+          eodashCollections.filter(
+            (collection) =>
+              !hiddenCollections.includes(collection.collectionStac?.id ?? ""),
+          ),
+          dateItem.originalDate,
+        ).then((layers) => {
+          //@ts-expect-error createLayersConfig is not typed strictly
+          layers = removeLayers(layers, hiddenLayers);
+          //@ts-expect-error createLayersConfig is not typed strictly
+          layers = restoreLayersVisibility(layers);
+          layers = anonimizeLayersCORS(layers);
+          mapLayersArr.push({
+            layers,
+            date: dateItem.originalDate,
+          });
+        });
+      }
+      return mapLayersArr;
+    }),
+  ).then((results) => results.flat());
+}
+/**
+ *
+ * @param {string} stacEndpoint
+ * @param {{min: string, max: string}} date
+ * @param {number[] | undefined} bbox
+ * @param {import("vue").Ref<import("stac-ts").StacCollection|null>} selectedStac
+ * @param {Record<string, import("../types").Filter>} filters
+ * @return {Promise<Array<{ layers: Record<string, any>[]; date: string }>>}
+ */
+async function createAPILayers(
+  stacEndpoint,
+  date = { min: "", max: "" },
+  bbox,
+  selectedStac,
+  filters,
+) {
+  if (!bbox) {
+    return [];
+  }
+  const url = new URL(stacEndpoint + "/search");
+  url.searchParams.set("limit", "100");
+  url.searchParams.set("collections", selectedStac.value?.id ?? "");
+  url.searchParams.set(
+    "datetime",
+    `${new Date(date.min).toISOString()}/${new Date(date.max).toISOString()}`,
+  );
+  url.searchParams.set("bbox", sanitizeBbox(bbox).join(","));
+
+  const stacFilter = buildStacFilters(filters);
+  if (stacFilter) {
+    url.searchParams.set("filter", stacFilter);
+  }
+
+  /** @type {import("stac-ts").StacItem[]} */
+  const items = await axios
+    .get(url.href)
+    .then((res) => res.data.features)
+    .catch((err) => {
+      console.error("[eodash] Error fetching items for animation:", err);
+      return [];
+    });
+  if (!items || !items.length) {
+    console.warn("[eodash] No items found for animation.");
+    return [];
+  }
+  const { collections: hiddenCollections, layers: hiddenLayers } =
+    getHiddenLayers([...getLayers()]);
+  return await Promise.all(
+    items.map(async (item) => {
+      /** @type {Array<{ layers: Record<string, any>[]; date: string }>} */
+      const mapLayersArr = [];
+      await createLayersConfig(
+        selectedStac.value,
+        eodashCollections.filter(
+          (collection) =>
+            !hiddenCollections.includes(collection.collectionStac?.id ?? ""),
+        ),
+        item,
+      ).then((layers) => {
+        //@ts-expect-error createLayersConfig is not typed strictly
+        layers = removeLayers(layers, hiddenLayers);
+        //@ts-expect-error createLayersConfig is not typed strictly
+        layers = restoreLayersVisibility(layers);
+        layers = anonimizeLayersCORS(layers);
+        mapLayersArr.push({
+          layers,
+          date: /** @type {string} */ (item.properties.datetime),
+        });
+        return mapLayersArr;
+      });
+      return mapLayersArr;
+    }),
+  ).then((results) => results.flat());
+}
+/**
+ *
+ * @param {Record<string, any>[]} layers
+ * @returns {Record<string, any>[]}
+ */
+export function anonimizeLayersCORS(layers) {
+  return layers.map((layer) => {
+    if (layer.type === "Group") {
+      layer.layers = anonimizeLayersCORS(layer.layers);
+      return layer;
+    }
+    if (layer.source) {
+      layer.source.crossOrigin = "anonymous";
+    }
+    return layer;
+  });
+}
+/**
+ * returns the list of layers that has visibility hidden
+ * @param {import("@eox/map").EoxLayer[]} layers
+ * @returns {{ collections: string[]; layers: string[] }}
+ */
+export function getHiddenLayers(layers) {
+  /** @type {{ collections: string[]; layers: string[] }} */
+  const result = { collections: [], layers: [] };
+
+  for (const layer of layers) {
+    // check inner layers if it's a group layer first
+    if (layer.type === "Group" && Array.isArray(layer.layers)) {
+      const childResult = getHiddenLayers(layer.layers);
+      for (const col of childResult.collections) {
+        if (!result.collections.includes(col)) {
+          result.collections.push(col);
+        }
+      }
+      for (const lyr of childResult.layers) {
+        if (!result.layers.includes(lyr)) {
+          result.layers.push(lyr);
+        }
+      }
+    }
+
+    if (!layer.properties?.id) {
+      continue;
+    }
+
+    const olLayer = mapEl.value?.getLayerById(layer.properties?.id);
+    if (!olLayer) {
+      continue;
+    }
+
+    if (olLayer.getVisible() === false) {
+      const refId = layer.properties.id;
+      if (refId) {
+        if (refId.includes(";:;")) {
+          // Check if this looks like a typical eodash collection ID with separator
+          const parts = refId.split(";:;");
+          if (parts.length > 2) {
+            const prefix = parts[0];
+            if (!result.collections.includes(prefix)) {
+              result.collections.push(prefix);
+            }
+          } else {
+            // It has a separator but might just be a base layer like `layerId;:;EPSG`
+            if (!result.layers.includes(refId)) {
+              result.layers.push(refId);
+            }
+          }
+        } else {
+          if (!result.layers.includes(refId)) {
+            result.layers.push(refId);
+          }
+        }
+      }
+    }
+  }
+
+  return result;
+}
+
+/**
+ * Iterates through a list of layers and updates layer.properties.visible to true
+ * if it is set to false
+ * @param {import("@eox/map").EoxLayer[]} layers
+ * @returns {import("@eox/map").EoxLayer[]}
+ */
+export function restoreLayersVisibility(layers) {
+  for (const layer of layers) {
+    if (layer.properties && layer.properties.visible === false) {
+      layer.properties.visible = true;
+    }
+
+    if (layer.type === "Group" && Array.isArray(layer.layers)) {
+      restoreLayersVisibility(layer.layers);
+    }
+  }
+  return layers;
+}
+
+/**
+ * Build STAC API filter string from TimeSlider filters
+ * @param {Record<string, import("../types").Filter>} filters
+ * @returns {string}
+ */
+export function buildStacFilters(filters) {
+  if (!filters) return "";
+
+  /** @type {string[]} */
+  const stacFilters = [];
+
+  Object.values(filters).forEach((filter) => {
+    if (!filter || !filter.key) return;
+
+    // strip 'properties.' from key if present
+    const propName = filter.key.startsWith("properties.")
+      ? filter.key.replace("properties.", "")
+      : filter.key;
+
+    if (filter.type === "range" && filter.state) {
+      if (
+        filter.state.min !== undefined &&
+        filter.state.min > (filter.min ?? -Infinity)
+      ) {
+        stacFilters.push(`${propName}>=${filter.state.min}`);
+      }
+      if (
+        filter.state.max !== undefined &&
+        filter.state.max < (filter.max ?? Infinity)
+      ) {
+        stacFilters.push(`${propName}<=${filter.state.max}`);
+      }
+    } else if (filter.type === "multiselect" && filter.stringifiedState) {
+      if (filter.stringifiedState.length > 0) {
+        stacFilters.push(`${propName} IN (${filter.stringifiedState})`);
+      }
+    } else if (filter.type === "select" && filter.stringifiedState) {
+      if (filter.stringifiedState) {
+        stacFilters.push(`${propName}='${filter.stringifiedState}'`);
+      }
+    }
+  });
+
+  return stacFilters.join(" AND ");
+}

package/widgets/EodashTimeSlider/types.ts

@@ -0,0 +1,64 @@
+export interface TimelineSelectionEventDetail {
+  date: [string, string];
+  instances: {
+    // this is inaccurate, the type should include all possible sources and layers,
+    layer: import("ol/layer/Layer").default;
+    source: import("ol/source/Source").default;
+  };
+  filters: Record<string, Filter>;
+  selectedItems: {
+    [layerId: string]: SelectedItem[];
+  };
+}
+export interface SelectedItem {
+  className: string;
+  date: string;
+  group: string;
+  // unique UUID for this item, generated by the timeline component
+  id: string;
+  itemId: string;
+  local: string;
+  originalDate: string;
+  property: string;
+  start: string;
+  type: string;
+  utc: string;
+}
+
+export interface TimelineExportEventDetail {
+  eoxMapConfig: {
+    layers: Record<string, any>[];
+    zoom: number;
+    center: [number, number];
+  };
+  filters: Record<string, Filter>;
+  instances: {
+    layer: import("ol/layer/Layer").default;
+    source: import("ol/source/Source").default;
+  };
+  selectedRangeItems: {
+    [layerId: string]: SelectedItem[];
+  };
+  generate: (args: {
+    mapLayers: Array<{ layers: Record<string, any>[]; date: string }>;
+    center?: [number, number];
+    zoom?: number;
+  }) => Promise<void>;
+}
+
+export interface Filter {
+  key: string;
+  title: string;
+  type: "range" | "multiselect" | "select";
+  expanded: boolean;
+  min: number;
+  max: number;
+  step: number;
+  // this state is mainly for range filters, select and multiselect to be added.
+  state: {
+    min: number;
+    max: number;
+  };
+  dirty: boolean;
+  stringifiedState: string;
+}