@eodash/eodash 5.0.0-rc.2.5 → 5.0.0

package/dist/types/core/client/composables/EodashProcess.d.ts

@@ -1,162 +0,0 @@
-/**
- * Polls the process status and fetches a result item when the process is successful.
- *
- * @param {Object} params - Parameters for polling the process status.
- * @param {string} params.processUrl - The URL of the process JSON report.
- * @param {import("vue").Ref<boolean>} params.isPolling - checks wether the polling should continue
- * @param {number} [params.pollInterval=5000] - The interval (in milliseconds) between polling attempts.
- * @param {number} [params.maxRetries=60] - The maximum number of polling attempts.
- * @returns {Promise<JSON>} The fetched results JSON.
- * @throws {Error} If the process does not complete successfully within the maximum retries.
- */
-export function pollProcessStatus({ processUrl, isPolling, pollInterval, maxRetries, }: {
-    processUrl: string;
-    isPolling: import("vue").Ref<boolean>;
-    pollInterval?: number | undefined;
-    maxRetries?: number | undefined;
-}): Promise<JSON>;
-/**
- * Auto execute the process when the jsonform has the execute option
- *
- * @param {import("vue").Ref<boolean>} autoExec
- * @param {import("vue").Ref<import("@eox/jsonform").EOxJSONForm | null>} jsonformEl
- * @param {import("vue").Ref<Record<string,any> | null>} jsonformSchema
- * @param {() => Promise<void>} startProcess
- **/
-export function useAutoExec(autoExec: import("vue").Ref<boolean>, jsonformEl: import("vue").Ref<import("@eox/jsonform").EOxJSONForm | null>, jsonformSchema: import("vue").Ref<Record<string, any> | null>, startProcess: () => Promise<void>): void;
-/**
- * @param {Record<string,any> |null} [jsonformSchema]
- **/
-export function getBboxProperty(jsonformSchema?: Record<string, any> | null): string;
-/**
- * Extracts the keys of type "geojson" from the jsonform schema
- * @param {Record<string,any> |null} [jsonformSchema]
- **/
-export function getGeoJsonProperties(jsonformSchema?: Record<string, any> | null): string[];
-/**
- * Converts jsonform geojson values to stringified geometries
- * @param {Record<string,any> |null} [jsonformSchema]
- * @param {Record<string,any>} jsonformValue
- **/
-export function extractGeometries(jsonformValue: Record<string, any>, jsonformSchema?: Record<string, any> | null): void;
-/**
- * Injects CSS to remove the borders of the jsonform from inside the shadowRoot
- * @param {import("@eox/jsonform").EOxJSONForm | null} jsonFormEl
- **/
-export function injectJsonformCSS(jsonFormEl: import("@eox/jsonform").EOxJSONForm | null): void;
-/**
- * @param {import("stac-ts").StacLink[] | undefined} links
- * @param {Record<string,any>|undefined} jsonformValue
- * @param {number[]} origBbox
- */
-export function processImage(links: import("stac-ts").StacLink[] | undefined, jsonformValue: Record<string, any> | undefined, origBbox: number[]): {
-    type: string;
-    properties: {
-        id: unknown;
-        title: string;
-    };
-    source: {
-        type: string;
-        imageExtent: number[];
-        url: string;
-    };
-}[] | undefined;
-/**
- * @param {import("stac-ts").StacLink[] | undefined} links
- * @param {Record<string,any> | undefined} jsonformValue
- * @param {string} layerId
- */
-export function processVector(links: import("stac-ts").StacLink[] | undefined, jsonformValue: Record<string, any> | undefined, layerId: string): Promise<Record<string, any>[] | undefined>;
-/**
- * @param {import("stac-ts").StacLink[] | undefined} links
- * @param {Record<string,any> | undefined} jsonformValue
- * @param {import("vue").Ref<boolean>} isPolling
- * @param {string} layerId
- */
-export function processGeoTiff(links: import("stac-ts").StacLink[] | undefined, jsonformValue: Record<string, any> | undefined, layerId: string, isPolling: import("vue").Ref<boolean>): Promise<{
-    style?: Record<string, any> | undefined;
-    type: string;
-    source: {
-        type: string;
-        normalize: boolean;
-        sources: {
-            url: string;
-        }[];
-    };
-    properties: {
-        layerConfig?: Record<string, any> | undefined;
-        id: string;
-        title: string;
-    };
-} | undefined>;
-/**
- * @param {import("stac-ts").StacLink[] | undefined} links
- * @param {Record<string,any> | undefined} jsonformValue
- * @param {string} specUrl
- * @returns {Promise<[import("@eox/chart").EOxChart["spec"] | null,Record<string,any>|null]>}
- **/
-export function getChartValues(links: import("stac-ts").StacLink[] | undefined, jsonformValue: Record<string, any> | undefined, specUrl: string): Promise<[import("@eox/chart").EOxChart["spec"] | null, Record<string, any> | null]>;
-/**
- * @param {Object} params
- * @param {import("vue").Ref<boolean>} params.loading
- * @param {import("vue").Ref<import("stac-ts").StacCollection | null>} params.selectedStac
- * @param {import("vue").Ref<import("@eox/jsonform").EOxJSONForm | null>} params.jsonformEl
- * @param {import("vue").Ref<Record<string,any>|null>} params.jsonformSchema
- * @param {import("vue").Ref<import("@eox/chart").EOxChart["spec"] | null>} params.chartSpec
- * @param {import("vue").Ref<Record<string, any> | null>} params.chartData
- * @param {import("vue").Ref<boolean>} params.isPolling
- * @param {import("vue").Ref<any[]>} params.processResults
- */
-export function handleProcesses({ loading, selectedStac, jsonformEl, jsonformSchema, chartSpec, chartData, isPolling, processResults, }: {
-    loading: import("vue").Ref<boolean>;
-    selectedStac: import("vue").Ref<import("stac-ts").StacCollection | null>;
-    jsonformEl: import("vue").Ref<import("@eox/jsonform").EOxJSONForm | null>;
-    jsonformSchema: import("vue").Ref<Record<string, any> | null>;
-    chartSpec: import("vue").Ref<import("@eox/chart").EOxChart["spec"] | null>;
-    chartData: import("vue").Ref<Record<string, any> | null>;
-    isPolling: import("vue").Ref<boolean>;
-    processResults: import("vue").Ref<any[]>;
-}): Promise<void>;
-/**
- * Reset the process state
- * @param {Object} params
- * @param {import("vue").Ref<boolean>} params.loading
- * @param {import("vue").Ref<boolean>} params.isProcessed
- * @param {import("vue").Ref<import("@eox/chart").EOxChart["spec"] | null>} params.chartSpec
- * @param {import("vue").Ref<boolean>} params.isPolling
- * @param {import("vue").Ref<any[]>} params.processResults
- * @param {import("vue").Ref<Record<string,any>|null>} params.jsonformSchema
- */
-export function resetProcess({ loading, isProcessed, chartSpec, jsonformSchema, processResults, isPolling, }: {
-    loading: import("vue").Ref<boolean>;
-    isProcessed: import("vue").Ref<boolean>;
-    chartSpec: import("vue").Ref<import("@eox/chart").EOxChart["spec"] | null>;
-    isPolling: import("vue").Ref<boolean>;
-    processResults: import("vue").Ref<any[]>;
-    jsonformSchema: import("vue").Ref<Record<string, any> | null>;
-}): void;
-/**
- * Description placeholder
- *
- * @export
- * @async
- * @param {Object} params
- * @param {import("vue").Ref<import("stac-ts").StacCollection>} params.selectedStac
- * @param {import("vue").Ref<import("@eox/jsonform").EOxJSONForm | null>} params.jsonformEl
- * @param {import("vue").Ref<Record<string,any> | null>} params.jsonformSchema
- * @param {import("vue").Ref<import("@eox/chart").EOxChart["spec"] | null>} params.chartSpec
- * @param {import("vue").Ref<any[]>} params.processResults
- * @param {import("vue").Ref<boolean>} params.isProcessed
- * @param {import("vue").Ref<boolean>} params.loading
- * @param {import("vue").Ref<boolean>} params.isPolling
- */
-export function initProcess({ selectedStac, jsonformEl, jsonformSchema, chartSpec, isProcessed, processResults, loading, isPolling, }: {
-    selectedStac: import("vue").Ref<import("stac-ts").StacCollection>;
-    jsonformEl: import("vue").Ref<import("@eox/jsonform").EOxJSONForm | null>;
-    jsonformSchema: import("vue").Ref<Record<string, any> | null>;
-    chartSpec: import("vue").Ref<import("@eox/chart").EOxChart["spec"] | null>;
-    processResults: import("vue").Ref<any[]>;
-    isProcessed: import("vue").Ref<boolean>;
-    loading: import("vue").Ref<boolean>;
-    isPolling: import("vue").Ref<boolean>;
-}): Promise<void>;

package/widgets/EodashProcess.vue

@@ -1,206 +0,0 @@
-<template>
-  <div ref="container" class="process-container">
-    <eox-jsonform
-      v-if="jsonformSchema"
-      ref="jsonformEl"
-      .schema="jsonformSchema"
-    ></eox-jsonform>
-    <eox-chart
-      class="chart"
-      v-if="isProcessed && chartSpec"
-      .spec="toRaw(chartSpec)"
-      .dataValues="toRaw(chartData)"
-      :style="chartStyles"
-    />
-    <v-container>
-      <span>
-        <v-btn
-          v-if="!autoExec"
-          :loading="loading"
-          style="float: right; margin-right: 20px"
-          @click="startProcess"
-          color="primary"
-        >
-          Execute
-        </v-btn>
-        <v-btn
-          v-if="processResults.length && isProcessed"
-          color="primary"
-          @click="downloadResults"
-        >
-          Download
-        </v-btn>
-      </span>
-    </v-container>
-  </div>
-</template>
-<script setup>
-import "@eox/chart";
-import "@eox/drawtools";
-import "@eox/jsonform";
-
-import { computed, onMounted, ref, toRaw, useTemplateRef } from "vue";
-import { useSTAcStore } from "@/store/stac";
-import { storeToRefs } from "pinia";
-import { mapEl } from "@/store/states";
-import { useOnLayersUpdate } from "@/composables";
-import { useEventBus } from "@vueuse/core";
-import { eoxLayersKey } from "@/utils/keys";
-import {
-  handleProcesses,
-  initProcess,
-  useAutoExec,
-} from "@/composables/EodashProcess";
-
-const layersEvents = useEventBus(eoxLayersKey);
-const { selectedStac } = storeToRefs(useSTAcStore());
-
-/** @type {import("vue").Ref<import("vega").Spec|null>} */
-const chartSpec = ref(null);
-
-/** @type {import("vue").Ref<Record<string,any>|null>}  */
-const chartData = ref(null);
-const isProcessed = ref(false);
-
-/** @type {import("vue").Ref<Record<string,any>|null>} */
-const jsonformSchema = ref(null);
-
-/** @type {import("vue").Ref<import("@eox/jsonform").EOxJSONForm | null>} */
-const jsonformEl = ref(null);
-
-const containerEl = useTemplateRef("container");
-
-const loading = ref(false);
-
-const autoExec = ref(false);
-
-const isPolling = ref(false);
-/** @type {import("vue").Ref<any[]>} */
-const processResults = ref([]);
-
-const downloadResults = () => {
-  processResults.value.forEach((result) => {
-    if (!result) {
-      return;
-    }
-    let url = "";
-    let downloadFile = "";
-    if (typeof result === "string") {
-      url = result;
-      //@ts-expect-error TODO
-      downloadFile = url.includes("/") ? url.split("/").pop() : url;
-      downloadFile = downloadFile.includes("?")
-        ? downloadFile.split("?")[0]
-        : downloadFile;
-    } else {
-      result = JSON.stringify(result);
-      const blob = new Blob([result], { type: "text" });
-      url = URL.createObjectURL(blob);
-      downloadFile = selectedStac.value?.id + "_process_results.json";
-    }
-    const link = document.createElement("a");
-    if (confirm(`Would you like to download ${downloadFile}?`)) {
-      link.href = url;
-      link.download = downloadFile;
-      link.click();
-    }
-    URL.revokeObjectURL(url);
-    link.remove();
-  });
-};
-onMounted(async () => {
-  // wait for the layers to be rendered
-  if (mapEl.value?.layers.length > 1) {
-    await initProcess({
-      //@ts-expect-error TODO
-      selectedStac,
-      jsonformEl,
-      jsonformSchema,
-      chartSpec,
-      isProcessed,
-      processResults,
-      loading,
-      isPolling,
-    });
-  } else {
-    layersEvents.once(async () => {
-      await initProcess({
-        //@ts-expect-error TODO
-        selectedStac,
-        jsonformEl,
-        jsonformSchema,
-        chartSpec,
-        isProcessed,
-        loading,
-        processResults,
-        isPolling,
-      });
-    });
-  }
-});
-
-useOnLayersUpdate(async (evt, _payload) => {
-  if (evt === "layers:updated") {
-    await initProcess({
-      //@ts-expect-error TODO
-      selectedStac,
-      jsonformEl,
-      jsonformSchema,
-      chartSpec,
-      isProcessed,
-      processResults,
-      loading,
-      isPolling,
-    });
-  }
-});
-
-const startProcess = async () => {
-  const errors = jsonformEl.value?.editor.validate();
-  if (errors?.length) {
-    console.warn("[eodash] Form validation failed", errors);
-    return;
-  }
-  processResults.value = [];
-  await handleProcesses({
-    jsonformEl,
-    jsonformSchema,
-    chartSpec,
-    chartData,
-    loading,
-    //@ts-expect-error TODO
-    selectedStac,
-    isProcessed,
-    isPolling,
-    processResults,
-  });
-  isProcessed.value = true;
-};
-useAutoExec(autoExec, jsonformEl, jsonformSchema, startProcess);
-
-const chartStyles = computed(() => {
-  /** @type {Record<string,string> }*/
-  const styles = {};
-  if (!chartSpec.value?.["height"]) {
-    styles["height"] =
-      Math.max(
-        (containerEl.value?.offsetHeight ?? 0) -
-          (jsonformEl.value?.offsetHeight ?? 0),
-        200,
-      ) + "px";
-  }
-  return styles;
-});
-</script>
-<style>
-.process-container {
-  height: 100%;
-  overflow-y: auto;
-}
-eox-chart {
-  --background-color: transparent;
-}
-eox-jsonform {
-  padding: 0.7em;
-}
-</style>