@eodash/eodash 5.0.0-processing → 5.0.0-rc.1

package/core/client/types.d.ts

@@ -1,279 +0,0 @@
-/** @group Eodash */
-export interface WebComponentProps<T extends ExecutionTime = "compiletime"> {
-  /**
-   * Imports web component file, either using a URL or an import function.
-   *
-   * @example
-   *   importing `eox-itemfilter` web component, after installing `@eox/itemfilter` it can be
-   *   referenced:
-   *   ```js
-   *   link: async() => import("@eox/itemfilter")
-   *   ```
-   *
-   *   ::: warning
-   *   import maps are not available in runtime config
-   *   :::
-   */
-  link: T extends "runtime" ? string : string | (() => Promise<unknown>);
-  /**
-   * Exported Constructor, needs to be provided if the web component is not
-   * registered in by the [link](#link) provided
-   */
-  constructorProp?: string;
-  tagName: `${string}-${string}`;
-  /** Object defining all the properties and attributes of the web component */
-  properties?: Record<string, unknown>;
-  /**
-   * Triggered when the web component is mounted in the DOM.
-   *
-   * @param el - Web component
-   * @param store - Return value of the core STAC pinia store in
-   *   `/core/client/store/stac.ts`
-   */
-  onMounted?: (
-    el: Element | null,
-    store: ReturnType<typeof import("./store/stac.js").useSTAcStore>,
-  ) => Promise<void> | void;
-  /**
-   * Triggered when the web component is unmounted from the DOM.
-   *
-   * @param el - Web component
-   * @param store - Return value of the core STAC pinia store in
-   *   `/core/client/store/stac.ts`
-   */
-  onUnmounted?: (
-    el: Element | null,
-    store: ReturnType<typeof import("./store/stac.js").useSTAcStore>,
-  ) => Promise<void> | void;
-}
-
-/** @ignore */
-export interface WidgetsContainerProps {
-  widgets: Omit<Widget, "layout">[];
-}
-
-// eodash types:
-/** Properties of EOxLayoutItem used for setting the position and size of panels */
-export interface Layout {
-  /** Horizontal start position. Integer between 1 and 12 */
-  x: number;
-  /** Vertical start position. Integer between 1 and 12 */
-  y: number;
-  /** Width. Integer between 1 and 12 */
-  w: number;
-  /** Height. Integer between 1 and 12 */
-  h: number;
-}
-/**
- * Widget type: `web-component` API
- *
- * @group Eodash
- */
-export interface WebComponentWidget<T extends ExecutionTime = "compiletime"> {
-  id: number | string | symbol;
-  title: string;
-  /** Widget position and size. */
-  layout: Layout;
-  widget: WebComponentProps<T>;
-  type: "web-component";
-}
-
-/**
- * Widget type: `internal` API. Internal widgets are Vue components provided by
- * eodash.
- *
- * @group Eodash
- */
-export interface InternalComponentWidget {
-  id: number | string | symbol;
-  title: string;
-  /** Widget position and size. */
-  layout: Layout;
-  widget: {
-    /**
-     * Internal Vue Components inside the
-     * [widgets](https://github.com/eodash/eodash/tree/main/widgets) folder.
-     * Referenced using their name without the .vue extention
-     */
-    name: string;
-    /** Specified Vue component props */
-    properties?: Record<string, unknown>;
-  };
-  type: "internal";
-}
-
-/** Widget type: `iframe` API Renders an external HTML file as a widget. */
-/** @group Eodash */
-export interface IFrameWidget {
-  id: number | string | symbol;
-  title: string;
-  /** Widget position and size. */
-  layout: Layout;
-  widget: {
-    /** The URL of the page to embed */
-    src: string;
-  };
-  type: "iframe";
-}
-/** @group Eodash */
-export interface FunctionalWidget<T extends ExecutionTime = "compiletime"> {
-  /**
-   * Provides a functional definition of widgets, gets triggered whenever a STAC
-   * object is selected, and only renders the returned configuration if the `id`
-   * doesn't match the currently rendered `id`
-   *
-   * @param selectedSTAC - Currently selected STAC object
-   */
-  defineWidget: (
-    selectedSTAC:
-      | import("stac-ts").StacCatalog
-      | import("stac-ts").StacCollection
-      | import("stac-ts").StacItem
-      | null,
-  ) => StaticWidget<T> | undefined | null;
-}
-/**
- * There are 3 types of Widgets:
- *
- * @group Eodash
- */
-export type StaticWidget<T extends ExecutionTime = "compiletime"> =
-  | WebComponentWidget<T>
-  | InternalComponentWidget
-  | IFrameWidget;
-/**
- * Widgets can be defined in 2 forms:
- *
- * 1. {@link StaticWidget} : This is defined as an object once, and is considered
- *    the default form.
- * 2. {@link FunctionalWidget} : a special form which contains the
- *    {@link FunctionalWidget.defineWidget `defineWidget`} function that runs
- *    when {@link EodashStore.stac `loadSelectedSTAC`} function is triggered, and
- *    returns a value of a Static Widget or null or undefined.
- *
- * @group Eodash
- */
-export type Widget<T extends ExecutionTime = "compiletime"> =
-  | StaticWidget<T>
-  | FunctionalWidget<T>;
-
-/** @group Eodash */
-export type BackgroundWidget<T extends ExecutionTime = "compiletime"> =
-  | Omit<WebComponentWidget<T>, "layout" | "title" | "slidable">
-  | Omit<InternalComponentWidget, "layout" | "title" | "slidable">
-  | Omit<IFrameWidget, "layout" | "title" | "slidable">
-  | Omit<FunctionalWidget<T>, "layout" | "slidable">;
-/**
- * Dashboard rendered widgets specification. 3 types of widgets are supported:
- * `"iframe"`, `"internal"`, and `"web-component"`. A specific object should be
- * provided based on the type of the widget.
- *
- * @group Eodash
- */
-export interface Template<T extends ExecutionTime = "compiletime"> {
-  /** Gap between widgets */
-  gap?: number;
-  /** Loading widget */
-  loading?: BackgroundWidget<T>;
-  /**
-   * Widget rendered as the dashboard background. Has the same specifications of
-   * {@link Widget} without the `title` and `layout` properties
-   */
-  background?: BackgroundWidget<T>;
-  /** Array of widgets that will be rendered as dashboard panels. */
-  widgets: Widget<T>[];
-}
-
-/** @ignore */
-export type StacEndpoint = `${"https://" | "http://"}${string}/catalog.json`;
-
-/** @group Eodash */
-type ExecutionTime = "runtime" | "compiletime";
-
-/**
- * Eodash instance API
- *
- * @group Eodash
- */
-export interface Eodash<T extends ExecutionTime = "compiletime"> {
-  /** Instance ID. */
-  id?: string;
-  /** Root STAC catalog endpoint */
-  stacEndpoint: StacEndpoint;
-  /** Brand specifications. */
-  brand: {
-    /** Removes the dashboard layout */
-    noLayout?: boolean;
-    /** Custom error message to alert the users if something crashes */
-    errorMessage?: string;
-    /** Fetches the specified font family from the specified `link` property. */
-    font?: {
-      /**
-       * Link to stylesheet that defines font-face. Could be either a relative
-       * or absolute URL.
-       */
-      link: string;
-      /** Font family name. */
-      family: string;
-    };
-    /** Title that will be shown in the app header */
-    name: string;
-    /** Brand logo */
-    logo?: string;
-    /**
-     * Dashboard theme as a custom [vuetifyJs
-     * theme](https://vuetifyjs.com/en/features/theme/).
-     */
-    theme?: import("vuetify/lib/index.mjs").ThemeDefinition;
-    /** Text applied to the footer. */
-    footerText?: string;
-  };
-  /** Template configuration */
-  template: Template<T>;
-}
-/////////
-
-/// eodash store types
-/** @group EodashStore */
-export interface EodashStore {
-  /** Stateful Reactive variables */
-  states: {
-    /** Currently selected STAC endpoint */
-    currentUrl: import("vue").Ref<string>;
-    /** Currently selected datetime */
-    datetime: import("vue").Ref<string>;
-    /** Currently selected indicator */
-    indicator: import("vue").Ref<string>;
-
-    registeredProjections: `EPSG${number}`[];
-
-    /** available projection to be rendered by the Map */
-    availableMapProjection: import("vue").Ref<string>;
-  };
-  actions: {
-    /**
-     * returns the layers of the `eox-map`
-     * @param [el] - `eox-map` element selector
-     */
-    getLayers: (el?: string) => object[];
-
-    /**
-     * Register EPSG projection in `eox-map` and adds it to  `availableMapProjection`
-     * */
-    registerProjection: (
-      code?: number | string | { name: string; def: string },
-    ) => Promise<void>;
-
-    /** Change `eox-map` projection from an `EPSG` code */
-    changeMapProjection: (
-      code?: number | string | { name: string; def: string },
-    ) => Promise<void>;
-  };
-
-  /** Pinia store definition used to navigate the root STAC catalog. */
-  stac: {
-    useSTAcStore: typeof import("./store/stac.js").useSTAcStore;
-  };
-}
-///////
-export { createEodash, store } from "./main.js";

package/dist/client/EodashItemFilter-CugWNQ86.js

@@ -1,194 +0,0 @@
-import { ref, onMounted, openBlock, createElementBlock, mergeProps, createElementVNode, toDisplayString } from 'vue';
-import { a0 as useSTAcStore } from './asWebComponent-DUUoR7MZ.js';
-import '@eox/itemfilter';
-
-const _hoisted_1 = {
-  slot: "filterstitle",
-  style: {"margin":"14px 8px"}
-};
-const _hoisted_2 = {
-  slot: "resultstitle",
-  style: {"margin":"14px 8px"}
-};
-
-const defaultStyle =
-  "float:right; height:15px; padding:4px;  margin-top:-4px; background-color:white;";
-const highlightStyle =
-  "float:right; height:15px; padding:4px;  margin-top:-4px; background-color:#9bcaeb;";
-
-
-const _sfc_main = {
-  __name: 'EodashItemFilter',
-  props: {
-  enableCompare: {
-    type: Boolean,
-    default: false,
-  },
-  filtersTitle: {
-    type: String,
-    default: "Indicators",
-  },
-  resultsTitle: {
-    type: String,
-    default: "",
-  },
-  titleProperty: {
-    type: String,
-    default: "title",
-  },
-
-  aggregateResults: {
-    type: String,
-    default: "themes",
-  },
-  enableHighlighting: { type: Boolean, default: true },
-  expandMultipleFilters: { type: Boolean, default: true },
-  expandMultipleResults: { type: Boolean, default: true },
-  filterProperties: {
-    /** @type {import("vue").PropType<{
-     * keys:string[];
-     * title:string;
-     * type:string;
-     * expanded?:boolean
-     * }[]> }*/
-    type: Array,
-    default: () => [
-      {
-        keys: ["title", "themes", "description"],
-        title: "Search",
-        type: "text",
-      },
-      {
-        key: "themes",
-        title: "Theme Filter",
-        type: "multiselect",
-      },
-    ],
-  },
-},
-  setup(__props) {
-
-const props = __props;
-/** @param {any} evt*/
-const onSelect = async (evt) => {
-  // reset the style of all compare buttons
-  eoxItemFilter.value?.shadowRoot
-    ?.querySelectorAll(".compareMapButton")
-    .forEach((res) => res.setAttribute("style", defaultStyle));
-  const item = /** @type {import('stac-ts').StacLink} */ evt.detail;
-  if (item) {
-    // Reset compare stac to empty
-    store.resetSelectedCompareSTAC();
-    await store.loadSelectedSTAC(item.href);
-  }
-};
-const config = {
-  titleProperty: props.titleProperty,
-  filterProperties: props.filterProperties,
-  aggregateResults: props.aggregateResults,
-  enableHighlighting: props.enableHighlighting,
-  expandMultipleFilters: props.expandMultipleFilters,
-  expandMultipleResults: props.expandMultipleResults,
-};
-/** @type {import("vue").Ref<HTMLElement & Record<string,any> | null>} */
-const eoxItemFilter = ref(null);
-
-const store = useSTAcStore();
-
-const injectCompareButtons = () => {
-  setTimeout(() => {
-    /** @type {any} */
-    (eoxItemFilter.value)?.shadowRoot
-      .querySelectorAll("details>summary")
-      .forEach((/** @type {HTMLElement} */ el) =>
-        el.setAttribute("style", "width: 100%"),
-      );
-    /** @type {any} */
-    (eoxItemFilter.value)?.shadowRoot
-      .querySelectorAll("details>div li")
-      .forEach((/** @type {HTMLElement} */ res) => {
-        let compareButton = document.createElement("button");
-        compareButton.className = "compareMapButton";
-        compareButton.dataset.id = res.children[0].id;
-
-        compareButton.onclick = async (
-          /** {Event & { currentTarget: HTMLElement }} */ evt,
-        ) => {
-          // reset the style of all compare buttons
-          eoxItemFilter.value?.shadowRoot
-            ?.querySelectorAll(".compareMapButton")
-            .forEach((res) => {
-              res.setAttribute("style", defaultStyle);
-            });
-          const currentTarget = /** @type {HTMLElement}*/ (evt.currentTarget);
-          currentTarget?.setAttribute("style", highlightStyle);
-          const selected = eoxItemFilter.value?.items.find(
-            (/** @type {HTMLElement} */ it) =>
-              it.id === currentTarget?.dataset.id,
-          );
-          if (selected) {
-            await store.loadSelectedCompareSTAC(selected.href);
-          }
-        };
-        compareButton.setAttribute("style", defaultStyle);
-        const svgIcon = document.createElementNS(
-          "http://www.w3.org/2000/svg",
-          "svg",
-        );
-        const iconPath = document.createElementNS(
-          "http://www.w3.org/2000/svg",
-          "path",
-        );
-        svgIcon.setAttribute("width", "15");
-        svgIcon.setAttribute("height", "15");
-        svgIcon.setAttribute("viewBox", "0 0 24 24");
-        iconPath.setAttribute(
-          "d",
-          "M19,3H14V5H19V18L14,12V21H19A2,2 0 0,0 21,19V5C21,3.89 20.1,3 19,3M10,18H5L10,12M10,3H5C3.89,3 3,3.89 3,5V19A2,2 0 0,0 5,21H10V23H12V1H10V3Z",
-        );
-        svgIcon.appendChild(iconPath);
-        compareButton.appendChild(svgIcon);
-        res.append(compareButton);
-      });
-  }, 100);
-};
-
-onMounted(() => {
-  const style = document.createElement("style");
-  style.innerHTML = `
-    section {
-      margin: 0 !important;
-    }
-    section button#filter-reset {
-      padding: 0 8px;
-      top: 8px;
-      right: 8px;
-    }
-  `;
-  eoxItemFilter.value?.shadowRoot?.appendChild(style);
-
-  // Only list child elements in list
-  const items = store.stac?.filter((item) => item.rel === "child");
-  /** @type {any} */
-  (eoxItemFilter.value).items = items;
-  if (props.enableCompare) {
-    injectCompareButtons();
-  }
-});
-
-return (_ctx, _cache) => {
-  return (openBlock(), createElementBlock("eox-itemfilter", mergeProps({ class: "fill-height" }, config, {
-    ref_key: "eoxItemFilter",
-    ref: eoxItemFilter,
-    style: {"overflow":"auto"},
-    onSelect: onSelect
-  }), [
-    createElementVNode("h4", _hoisted_1, toDisplayString(__props.filtersTitle), 1 /* TEXT */),
-    createElementVNode("h4", _hoisted_2, toDisplayString(__props.resultsTitle), 1 /* TEXT */)
-  ], 16 /* FULL_PROPS */))
-}
-}
-
-};
-
-export { _sfc_main as default };

package/dist/client/EodashMapBtns-uaRwFtfB.js

@@ -1,66 +0,0 @@
-import { ref, openBlock, createElementBlock, createBlock, unref, createCommentVNode } from 'vue';
-import { _ as _export_sfc, ab as makePanelTransparent, V as VBtn, ac as availableMapProjection, ad as changeMapProjection } from './asWebComponent-DUUoR7MZ.js';
-import { mdiMapPlus, mdiEarthBox } from '@mdi/js';
-import ExportState from './ExportState-BT8MLAW7.js';
-
-const _sfc_main = {
-  __name: 'EodashMapBtns',
-  props: {
-  exportMap: {
-    type: Boolean,
-    default: true,
-  },
-  changeProjection: {
-    type: Boolean,
-    default: true,
-  },
-},
-  setup(__props) {
-
-
-
-const showMapState = ref(false);
-
-/** @type {import("vue").Ref<HTMLDivElement|null>} */
-const rootRef = ref(null);
-makePanelTransparent(rootRef);
-
-return (_ctx, _cache) => {
-                                                     
-
-  return (openBlock(), createElementBlock("div", {
-    ref_key: "rootRef",
-    ref: rootRef,
-    class: "d-flex flex-column align-end justify-end my-3 pa-2"
-  }, [
-    (__props.exportMap)
-      ? (openBlock(), createBlock(VBtn, {
-          key: 0,
-          class: "map-btn",
-          icon: [unref(mdiMapPlus)],
-          onClick: _cache[0] || (_cache[0] = $event => (showMapState.value = !showMapState.value))
-        }, null, 8 /* PROPS */, ["icon"]))
-      : createCommentVNode("v-if", true),
-    (__props.exportMap)
-      ? (openBlock(), createBlock(ExportState, {
-          key: 1,
-          modelValue: showMapState.value,
-          "onUpdate:modelValue": _cache[1] || (_cache[1] = $event => ((showMapState).value = $event))
-        }, null, 8 /* PROPS */, ["modelValue"]))
-      : createCommentVNode("v-if", true),
-    (__props.changeProjection && !!unref(availableMapProjection))
-      ? (openBlock(), createBlock(VBtn, {
-          key: 2,
-          class: "map-btn",
-          icon: [unref(mdiEarthBox)],
-          onClick: _cache[2] || (_cache[2] = $event => (unref(changeMapProjection)(unref(availableMapProjection))))
-        }, null, 8 /* PROPS */, ["icon"]))
-      : createCommentVNode("v-if", true)
-  ], 512 /* NEED_PATCH */))
-}
-}
-
-};
-const EodashMapBtns = /*#__PURE__*/_export_sfc(_sfc_main, [['__scopeId',"data-v-d7a01370"]]);
-
-export { EodashMapBtns as default };