@eodash/eodash 5.7.0 → 5.7.1

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

@@ -1,3 +1,6 @@
+/**
+ * @module Configuration
+ */
 /** @group Eodash */
 export interface WebComponentProps {
     /**
@@ -11,7 +14,8 @@ export interface WebComponentProps {
      *   ```
      *
      *   ::: warning
-     *   import maps are not available in runtime config
+     *   Importing by package name only works when a bundler resolves it (build-time configs,
+     *   or runtime configs bundled into your app). Otherwise import by URL.
      *   :::
      */
     link?: string | (() => Promise<unknown>);
@@ -83,87 +87,87 @@ export interface WebComponentWidget {
     widget: WebComponentProps;
     type: "web-component";
 }
-/** @group Widgets */
+/** @group Widget Config */
 export interface TEodashMap {
     name: "EodashMap";
     properties?: InstanceType<typeof import("../../widgets/EodashMap/index.vue").default>["$props"];
 }
-/** @group Widgets */
+/** @group Widget Config */
 export interface TEodashDatePicker {
     name: "EodashDatePicker";
     properties?: InstanceType<typeof import("../../widgets/EodashDatePicker.vue").default>["$props"];
 }
-/** @group Widgets */
+/** @group Widget Config */
 export interface TEodashTimeSlider {
     name: "EodashTimeSlider";
     properties?: InstanceType<typeof import("../../widgets/EodashTimeSlider/index.vue").default>["$props"];
 }
-/** @group Widgets */
+/** @group Widget Config */
 export interface TEodashItemFilter {
     name: "EodashItemFilter";
     properties?: InstanceType<typeof import("../../widgets/EodashItemFilter.vue").default>["$props"];
 }
-/** @group Widgets */
+/** @group Widget Config */
 export interface TEodashLayerControl {
     name: "EodashLayerControl";
     properties?: InstanceType<typeof import("../../widgets/EodashLayerControl.vue").default>["$props"];
 }
-/** @group Widgets */
+/** @group Widget Config */
 export interface TEodashStacInfo {
     name: "EodashStacInfo";
     properties?: InstanceType<typeof import("../../widgets/EodashStacInfo.vue").default>["$props"];
 }
-/** @group Widgets */
+/** @group Widget Config */
 export interface TEodashProcess {
     name: "EodashProcess";
     properties?: InstanceType<typeof import("../../widgets/EodashProcess/index.vue").default>["$props"];
 }
-/** @group Widgets */
+/** @group Widget Config */
 export interface TEodashChart {
     name: "EodashChart";
     properties?: InstanceType<typeof import("../../widgets/EodashChart.vue").default>["$props"];
 }
-/** @group Widgets */
-export interface TEodashMapBtns {
-    name: "EodashMapBtns";
-    properties?: InstanceType<typeof import("^/EodashMapBtns.vue").default>["$props"];
-}
-/** @group Widgets */
+/** @group Widget Config */
 export interface TEodashTools {
     name: "EodashTools";
     properties?: InstanceType<typeof import("../../widgets/EodashTools.vue").default>["$props"];
 }
-/** @group Widgets */
+/** @group Widget Config */
 export interface TEodashLayoutSwitcher {
     name: "EodashLayoutSwitcher";
     properties?: InstanceType<typeof import("../../widgets/EodashLayoutSwitcher.vue").default>["$props"];
 }
+/** @group Widget Config */
 export interface TEodashItemCatalog {
     name: "EodashItemCatalog";
     properties?: InstanceType<typeof import("../../widgets/EodashItemCatalog/index.vue").default>["$props"];
 }
-/** @group Widgets */
+/** @group Widget Config */
 export interface TExportState {
     name: "ExportState";
     properties?: InstanceType<typeof import("../../widgets/ExportState.vue").default>["$props"];
 }
-/** @group Widgets */
+/** @group Widget Config */
 export interface TPopUp {
     name: "PopUp";
     properties?: InstanceType<typeof import("../../widgets/PopUp.vue").default>["$props"];
 }
-/** @group Widgets */
+/** @group Widget Config */
 export interface TWidgetsContainer {
     name: "WidgetsContainer";
     properties?: InstanceType<typeof import("../../widgets/WidgetsContainer.vue").default>["$props"];
 }
+export interface TEodashLayoutSwitcher {
+    name: "EodashLayoutSwitcher";
+    properties?: InstanceType<typeof import("../../widgets/EodashLayoutSwitcher.vue").default>["$props"];
+}
 /**
  * Internal Vue Components inside the
  * [widgets](https://github.com/eodash/eodash/tree/main/widgets) folder.
  * Referenced using their name without the .vue extention
- * @group Widgets
+ * @group Widget Config
  */
-export type ComponentWidget = TEodashMap | TEodashDatePicker | TEodashItemFilter | TEodashLayerControl | TEodashStacInfo | TEodashProcess | TEodashChart | TEodashMapBtns | TEodashTools | TEodashLayoutSwitcher | TEodashItemCatalog | TExportState | TPopUp | TWidgetsContainer | TEodashTimeSlider;
+export type ComponentWidget = TEodashMap | TEodashDatePicker | TEodashItemFilter | TEodashLayerControl | TEodashStacInfo | TEodashProcess | TEodashChart | TEodashTools | TEodashLayoutSwitcher | TEodashItemCatalog | TExportState | TPopUp | TWidgetsContainer | TEodashLayoutSwitcher | TEodashTimeSlider;
 /**
  * Widget type: `internal` API. Internal widgets are Vue components provided by
  * eodash.
@@ -251,7 +255,10 @@ export type StacEndpoint = string | {
     api?: boolean;
     rasterEndpoint?: string;
     vectorEndpoint?: string;
-    supportedUpscalingEndpoints?: string[];
+    supportedUpscalingEndpoints?: Array<string | {
+        url: string;
+        titilerVersion?: 1 | 2;
+    }>;
 };
 /** @group Eodash */
 export interface EodashFont {
@@ -274,6 +281,13 @@ export type Eodash = {
     /** Object containing potential special configuration options */
     options?: {
         useSubCode?: boolean;
+        /**
+         * TiTiler render presets, keyed by collection id then render name,
+         * following the STAC `renders` extension shape. Used to render a
+         * collection's raster data when the collection itself does not expose
+         * `renders`.
+         */
+        renders?: Record<string, Record<string, Render>>;
     };
     /** Root STAC catalog endpoint */
     stacEndpoint: StacEndpoint;
@@ -376,10 +390,20 @@ export declare function register(): void;
  * @group WebComponent
  */
 export declare const store: typeof import("./store").default;
-export * from "./main.js";
 /**
+ * Creates an eodash instance configuration. Accepts a config object directly,
+ * or an async factory that receives the eodash store and returns the config.
+ *
  * @group Eodash
  */
+export { createEodash } from "./main.js";
+/**
+ * eodash flat style: an OpenLayers flat style extended with interactive
+ * `variables`, a `jsonform`, a `legend`, and `tooltip` configuration.
+ *
+ * @group STAC
+ * @see [eodash Flat Styles](/STAC#eodash-flat-styles)
+ */
 export type EodashStyleJson = import("ol/style/flat").FlatStyleLike & {
     variables?: Record<string, string | number | boolean | null | undefined>;
     legend?: import("@eox/layercontrol/src/components/layer-config.js").EOxLayerControlLayerConfig["layerConfig"]["legend"];
@@ -391,6 +415,9 @@ export type EodashStyleJson = import("ol/style/flat").FlatStyleLike & {
         decimals?: number;
     }[];
 };
+/**
+ * @ignore
+ */
 export type EodashRasterJSONForm = {
     jsonform: Record<string, any>;
     legend?: import("@eox/layercontrol/src/components/layer-config.js").EOxLayerControlLayerConfig["layerConfig"]["legend"];
@@ -412,10 +439,63 @@ export interface SearchParams {
     /** Maximum number of results to return */
     limit?: number;
 }
+/**
+ * @ignore
+ */
 export interface StacItemsAPIResponse {
     type: "FeatureCollection";
     features: import("stac-ts").StacItem[];
 }
+export interface AggregationCollection {
+    type: "AggregationCollection";
+    aggregations?: Array<{
+        key?: string;
+        interval?: string;
+        buckets?: Array<{
+            key: string;
+            value: number;
+        }>;
+    }>;
+}
+/** Itemfilter filter kind emitted in filter events. */
+export type ItemFilterFilterType = "range" | "multiselect" | "select" | "text" | "spatial";
+export interface ItemFilterBase {
+    key: string;
+    title?: string;
+    expanded?: boolean;
+    dirty?: boolean;
+    stringifiedState?: string;
+}
+export interface ItemFilterRange extends ItemFilterBase {
+    type: "range";
+    min?: number;
+    max?: number;
+    step?: number;
+    state?: {
+        min?: number;
+        max?: number;
+    };
+}
+export interface ItemFilterSelect extends ItemFilterBase {
+    type: "select";
+    state?: Record<string, string | number | boolean | null | undefined>;
+}
+export interface ItemFilterMultiSelect extends ItemFilterBase {
+    type: "multiselect";
+    state?: Record<string, string | number | boolean | null | undefined>;
+}
+export interface ItemFilterText extends ItemFilterBase {
+    type: "text";
+    state?: Record<string, string | number | boolean | null | undefined>;
+}
+export interface ItemFilterSpatial extends ItemFilterBase {
+    type: "spatial";
+    state?: Record<string, string | number | boolean | null | undefined>;
+}
+/** Normalized filter object emitted by `eox-itemfilter` in filter events. */
+export type ItemFilterFilter = ItemFilterRange | ItemFilterSelect | ItemFilterMultiSelect | ItemFilterText | ItemFilterSpatial;
+/** Itemfilter filter map keyed by filter key. */
+export type ItemFilterFilters = Record<string, ItemFilterFilter>;
 /** @ignore */
 export interface Render {
     /** REQUIRED. Array of asset keys referencing the assets that are used to make the rendering */
@@ -500,6 +580,7 @@ export interface GeoJsonFeatureCollection<T = Record<string, any>, G = GeoJSON.G
 /**
  * Partial STAC Authentication Extension v1.1.0
  * Generated from https://stac-extensions.github.io/authentication/v1.1.0/schema.json
+ * @ignore
  */
 export interface AuthScheme {
     /** Scheme keyword, e.g. http, s3, signedUrl, oauth2, apiKey, openIdConnect */
@@ -511,13 +592,19 @@ export interface AuthScheme {
     flows?: Record<string, OAuth2Flow | SignedUrlFlow>;
     openIdConnectUrl?: string;
 }
+/**
+ * @ignore
+ */
 export interface OAuth2Flow {
     authorizationUrl?: string;
     tokenUrl?: string;
     refreshUrl?: string;
     scopes: Record<string, string>;
 }
-/** Signed URL flow configuration */
+/**
+ * Signed URL flow configuration
+ * @ignore
+ */
 export interface SignedUrlFlow {
     authorizationApi: string;
     method: string;
@@ -529,20 +616,32 @@ export interface SignedUrlFlow {
         schema?: object;
     }>;
 }
+/**
+ * @ignore
+ */
 export interface ApiKeyAuthScheme extends AuthScheme {
     type: "apiKey";
     name: string;
     in: string;
 }
 import { StacItem, StacLink, StacAsset } from "stac-ts";
+/**
+ * @ignore
+ */
 export interface StacAuthItem extends StacItem {
     "auth:schemes": {
         [key: string]: AuthScheme;
     };
 }
+/**
+ * @ignore
+ */
 export interface StacAuthLink extends StacLink {
     "auth:refs": [string];
 }
+/**
+ * @ignore
+ */
 export interface StacAuthAsset extends StacAsset {
     "auth:refs": [string];
 }

package/dist/types/core/client/utils/states.d.ts

@@ -115,3 +115,15 @@ export const dataThemesBrands: {
         color: string;
     };
 };
+/** @type {Map<string, import("stac-ts").StacItem[]>} */
+export const itemsCache: Map<string, import("stac-ts").StacItem[]>;
+/**
+ * Split items cache stores items with their time range metadata
+ * @type {Map<string, {items: import("stac-ts").StacItem[], minTime: number, maxTime: number}>}
+ */
+export const splitItemsCache: Map<string, {
+    items: import("stac-ts").StacItem[];
+    minTime: number;
+    maxTime: number;
+}>;
+export const timesliderUpdateRef: import("vue").Ref<number, number>;

package/dist/types/templates/baseConfig.d.ts

@@ -1,103 +1,4 @@
-export function getBaseConfig(config: import("vega-lite").DeepPartial<import("../core/client/types").Eodash>): ({
-    id?: string;
-    options?: {
-        useSubCode?: boolean;
-    };
-    stacEndpoint: import("../core/client/types").StacEndpoint;
-    brand: {
-        noLayout?: boolean;
-        errorMessage?: string;
-        font?: import("../core/client/types").EodashFont | {
-            body: import("../core/client/types").EodashFont;
-            headers: import("../core/client/types").EodashFont;
-        };
-        name: string;
-        logo?: string;
-        theme?: import("vuetify").ThemeDefinition & {
-            collectionsPalette?: string[];
-        };
-        feedback?: {
-            endpoint: string;
-            schema?: any;
-        };
-        footerText?: string;
-    };
-} & {
-    templates: import("../core/client/types").MultiTemplates;
-}) | {
-    id?: string | undefined;
-    options?: {
-        useSubCode?: boolean;
-    } | undefined;
-    stacEndpoint: import("../core/client/types").StacEndpoint & (string | {
-        endpoint: string;
-        api?: boolean;
-        rasterEndpoint?: string;
-        vectorEndpoint?: string;
-        supportedUpscalingEndpoints?: string[];
-    });
-    brand: {
-        noLayout?: boolean;
-        errorMessage?: string;
-        font?: import("../core/client/types").EodashFont | {
-            body: import("../core/client/types").EodashFont;
-            headers: import("../core/client/types").EodashFont;
-        };
-        name: string;
-        logo?: string;
-        theme?: import("vuetify").ThemeDefinition & {
-            collectionsPalette?: string[];
-        };
-        feedback?: {
-            endpoint: string;
-            schema?: any;
-        };
-        footerText?: string;
-    } & {
-        name: string;
-        font?: import("../core/client/types").EodashFont | {
-            body: import("../core/client/types").EodashFont;
-            headers: import("../core/client/types").EodashFont;
-        } | undefined;
-        theme?: ({
-            dark?: boolean | undefined;
-            colors?: {
-                [x: string]: string | undefined;
-                background?: string | undefined;
-                surface?: string | undefined;
-                primary?: string | undefined;
-                secondary?: string | undefined;
-                success?: string | undefined;
-                warning?: string | undefined;
-                error?: string | undefined;
-                info?: string | undefined;
-                'on-background'?: string | undefined;
-                'on-surface'?: string | undefined;
-                'on-primary'?: string | undefined;
-                'on-secondary'?: string | undefined;
-                'on-success'?: string | undefined;
-                'on-warning'?: string | undefined;
-                'on-error'?: string | undefined;
-                'on-info'?: string | undefined;
-            } | undefined;
-            variables?: {
-                [x: string]: string | number | undefined;
-            } | undefined;
-        } & {
-            collectionsPalette?: string[];
-        }) | undefined;
-        noLayout?: boolean | undefined;
-        errorMessage?: string | undefined;
-        logo?: string | undefined;
-        feedback?: {
-            endpoint: string;
-            schema?: any;
-        } | undefined;
-        footerText?: string | undefined;
-    };
-    template: import("../core/client/types").Template;
-    templates: import("../core/client/types").MultiTemplates;
-};
+export function getBaseConfig(config: import("vega-lite").DeepPartial<import("../core/client/types").Eodash>): import("../core/client/types").Eodash;
 export default baseConfig;
 /** @type {import("../core/client/types").Eodash} */
 declare const baseConfig: import("../core/client/types").Eodash;

package/dist/types/templates/compare.d.ts

@@ -21,6 +21,24 @@ declare const _default: {
             name: "EodashMap";
             properties: {
                 enableCompare: true;
+                baseLayers: {
+                    type: "Group";
+                    properties: {
+                        id: string;
+                        title: string;
+                    };
+                    layers: {
+                        type: "Tile";
+                        properties: {
+                            id: string;
+                            title: string;
+                        };
+                        source: {
+                            type: "XYZ";
+                            url: string;
+                        };
+                    }[];
+                }[];
             };
         };
     };
@@ -188,10 +206,21 @@ declare const _default: {
             };
             title: string;
             widget: {
-                name: "EodashDatePicker";
+                name: "EodashTimeSlider";
                 properties: {
-                    hintText: string;
-                    toggleCalendar: true;
+                    filters: {
+                        key: string;
+                        title: string;
+                        type: string;
+                        expanded: boolean;
+                        min: number;
+                        max: number;
+                        step: number;
+                        state: {
+                            min: number;
+                            max: number;
+                        };
+                    }[];
                 };
             };
         } | null;

package/dist/types/templates/expert.d.ts

@@ -19,6 +19,24 @@ declare const _default: {
         widget: {
             name: "EodashMap";
             properties: {
+                baseLayers: {
+                    type: "Group";
+                    properties: {
+                        id: string;
+                        title: string;
+                    };
+                    layers: {
+                        type: "Tile";
+                        properties: {
+                            id: string;
+                            title: string;
+                        };
+                        source: {
+                            type: "XYZ";
+                            url: string;
+                        };
+                    }[];
+                }[];
                 enableCompare: true;
                 zoomToExtent: true;
                 btns: {

package/dist/types/templates/explore.d.ts

@@ -20,6 +20,7 @@ declare const _default: {
         widget: {
             name: "EodashMap";
             properties: {
+                zoomToExtent: false;
                 enableCompare: true;
                 btns: {
                     enableZoom: true;
@@ -27,11 +28,13 @@ declare const _default: {
                     enableChangeProjection: true;
                     enableCompareIndicators: {
                         fallbackTemplate: string;
+                        compareTemplate: string;
                         itemFilterConfig: {
                             imageProperty: string;
                         };
                     };
-                    enableSearch: true;
+                    enableBackToPOIs: false;
+                    enableSearch: false;
                 };
             };
         };
@@ -48,6 +51,7 @@ declare const _default: {
         };
         widget: {
             name: "EodashLayerControl";
+            properties?: undefined;
         };
     } | {
         id: string;
@@ -61,6 +65,10 @@ declare const _default: {
         };
         widget: {
             name: "EodashItemCatalog";
+            properties: {
+                layoutTarget: undefined;
+                hoverProperties: string[];
+            };
         };
     })[];
 };

package/dist/types/templates/lite.d.ts

@@ -20,6 +20,17 @@ declare const _default: {
         widget: {
             name: "EodashMap";
             properties: {
+                baseLayers: {
+                    type: "Tile";
+                    properties: {
+                        id: string;
+                        title: string;
+                    };
+                    source: {
+                        type: "XYZ";
+                        url: string;
+                    };
+                }[];
                 enableCompare: true;
                 enableCursorCoordinates: false;
                 enableScaleLine: false;

package/dist/types/widgets/EodashChart.vue.d.ts

@@ -6,7 +6,8 @@ declare const __VLS_export: import("vue").DefineComponent<import("vue").ExtractP
         default: boolean;
     };
     vegaEmbedOptions: {
-        type: ObjectConstructor;
+        /** @type {import("vue").PropType<import("vega-embed").EmbedOptions>} */
+        type: import("vue").PropType<import("vega-embed").EmbedOptions>;
         default(): {
             actions: boolean;
         };
@@ -17,12 +18,13 @@ declare const __VLS_export: import("vue").DefineComponent<import("vue").ExtractP
         default: boolean;
     };
     vegaEmbedOptions: {
-        type: ObjectConstructor;
+        /** @type {import("vue").PropType<import("vega-embed").EmbedOptions>} */
+        type: import("vue").PropType<import("vega-embed").EmbedOptions>;
         default(): {
             actions: boolean;
         };
     };
 }>> & Readonly<{}>, {
     enableCompare: boolean;
-    vegaEmbedOptions: Record<string, any>;
+    vegaEmbedOptions: import("vega-embed").EmbedOptions<string, import("vega-typings").Renderers>;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;