@eodash/eodash 5.0.0-alpha.2.4 → 5.0.0-alpha.2.6

package/core/client/types.d.ts

@@ -1,342 +1,267 @@
-/**
- * @group Eodash
- */
+/** @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")
-   * ```
+   *   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>));
+   *   ::: 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}`
+   * 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>
+  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`
+   *
+   * @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").useSTAcStore>) => (Promise<void> | void)
+  onMounted?: (
+    el: Element | null,
+    store: ReturnType<typeof import("./store/stac").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`
+   *
+   * @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").useSTAcStore>) => (Promise<void> | void)
+  onUnmounted?: (
+    el: Element | null,
+    store: ReturnType<typeof import("./store/stac").useSTAcStore>,
+  ) => Promise<void> | void;
 }
 
-
 /** @ignore */
 export interface WidgetsContainerProps {
-  widgets: Omit<Widget, 'layout'>[]
+  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: {
-    /**
-     *  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: WebComponentProps<T>
-  type: 'web-component'
+  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.
+ * 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: {
-    /**
-     *  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
-  }
+  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
+     * 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'
+    /** Specified Vue component props */
+    properties?: Record<string, unknown>;
+  };
+  type: "internal";
 }
 
-/**
- * Widget type: `iframe` API
- * Renders an external HTML file as a widget.
- */
-/**
- * @group Eodash
- */
+/** 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: {
-    /**
-     *  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
-  }
+  id: number | string | symbol;
+  title: string;
+  /** Widget position and size. */
+  layout: Layout;
   widget: {
-    /**
-     * The URL of the page to embed
-     */
-    src: string
-  }
-  type: 'iframe'
+    /** The URL of the page to embed */
+    src: string;
+  };
+  type: "iframe";
 }
-/**
- * @group Eodash
- */
+/** @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`
+   * 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) => Omit<StaticWidget<T>, 'layout' | 'slidable'> | undefined | null
-  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
-  }
+  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
+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>
+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'>
+/** @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.
+ * 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 between widgets */
   gap?: number;
+  /** Loading widget */
+  loading?: BackgroundWidget<T>;
   /**
-   * loading widget
+   * Widget rendered as the dashboard background. Has the same specifications of
+   * {@link Widget} without the `title` and `layout` properties
    */
-  loading?: BackgroundWidget<T>
-  /**
-   * Widget rendered as the dashboard background.
-   * Has the same specifications of `Widget` without the `title` and  `layout` properties
-   * @see {@link Widget}
-   */
-  background?: BackgroundWidget<T>
-  /**
-   * Array of widgets that will be rendered as dashboard panels.
-   */
-  widgets: Widget<T>[]
+  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`
+export type StacEndpoint = `${"https://" | "http://"}${string}/catalog.json`;
 
-/**
- * @ignore
- * @group Eodash
- */
-export type ExecutionTime = "runtime" | "compiletime";
+/** @group Eodash */
+type ExecutionTime = "runtime" | "compiletime";
 
 /**
  * Eodash instance API
+ *
  * @group Eodash
  */
 export interface Eodash<T extends ExecutionTime = "compiletime"> {
-  /**
-   * Instance ID.
-   */
+  /** Instance ID. */
   id?: string;
-  /**
-   * Root STAC catalog endpoint
-   **/
-  stacEndpoint: StacEndpoint
-  /**
-   * Brand specifications.
-   */
+  /** 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
-    /**
-     * Automatically fetches the specified font family from google fonts. if the [link](#font-link) property is specified
-     * the font family will be fetched from the provided source instead.
-     */
+    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. Use FVD notation to include families. see https://github.com/typekit/fvd
+       * Link to stylesheet that defines font-face. Could be either a relative
+       * or absolute URL.
        */
-      family: string
-    }
-    /**
-     *  Title that will be shown in the app header
-     */
+      link: string;
+      /** Font family name. */
+      family: string;
+    };
+    /** Title that will be shown in the app header */
     name: string;
-    /**
-     * Brand logo
-     */
+    /** 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.
+     * 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>
+  };
+  /** Template configuration */
+  template: Template<T>;
 }
 /////////
 
 /// eodash store types
-/**
- * @group EodashStore
- */
+/** @group EodashStore */
 export interface EodashStore {
-  /**
-   * Stateful Reactive variables
-   */
+  /** 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>
-  }
-  actions: {};
-  /**
-   *  Pinia store definition used to navigate the root STAC catalog.
-   */
+    /** 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>;
+  };
+  actions: object;
+  /** Pinia store definition used to navigate the root STAC catalog. */
   stac: {
-    useSTAcStore: typeof import("./store/stac").useSTAcStore
-  }
+    useSTAcStore: typeof import("./store/stac.js").useSTAcStore;
+  };
 }
 ///////
 /**
- * the project's entry point should export this function as a default
- * to instantiate eodash
- * @group Eodash
+ * The project's entry point should export this function as a default to
+ * instantiate eodash
+ *
  * @param config
+ * @group Eodash
  */
-export declare const createEodash: (config: ((store: EodashStore) => Eodash | Promise<Eodash>) | Eodash) => Eodash | Promise<Eodash>
+export declare const createEodash: (
+  config: ((store: EodashStore) => Eodash | Promise<Eodash>) | Eodash,
+) => Eodash | Promise<Eodash>;
 
 /** @group EodashStore */
-export declare const store: EodashStore
+export declare const store: EodashStore;