@nasa-terra/components 0.0.88 → 0.0.89

package/dist/types/vue/index.d.ts

@@ -1,16 +1,16 @@
 import type { DefineComponent } from "vue";
 
-import type { TerraAlert } from "../../components/alert/alert.component.js";
 import type { TerraAccordion } from "../../components/accordion/accordion.component.js";
+import type { TerraAlert } from "../../components/alert/alert.component.js";
 import type { TerraButton } from "../../components/button/button.component.js";
-import type { TerraDataRods } from "../../components/data-rods/data-rods.component.js";
-import type { TerraBrowseVariables } from "../../components/browse-variables/browse-variables.component.js";
 import type { TerraCombobox } from "../../components/combobox/combobox.component.js";
 import type { TerraChip } from "../../components/chip/chip.component.js";
+import type { TerraBrowseVariables } from "../../components/browse-variables/browse-variables.component.js";
+import type { TerraDataRods } from "../../components/data-rods/data-rods.component.js";
 import type { TerraDataSubsetter } from "../../components/data-subsetter/data-subsetter.component.js";
 import type { TerraDataSubsetterHistory } from "../../components/data-subsetter-history/data-subsetter-history.component.js";
-import type { TerraDatePicker } from "../../components/date-picker/date-picker.component.js";
 import type { TerraDateRangeSlider } from "../../components/date-range-slider/date-range-slider.component.js";
+import type { TerraDatePicker } from "../../components/date-picker/date-picker.component.js";
 import type { TerraDialog } from "../../components/dialog/dialog.component.js";
 import type { TerraIcon } from "../../components/icon/icon.component.js";
 import type { TerraLoader } from "../../components/loader/loader.component.js";
@@ -20,10 +20,22 @@ import type { TerraPlot } from "../../components/plot/plot.component.js";
 import type { TerraPlotToolbar } from "../../components/plot-toolbar/plot-toolbar.component.js";
 import type { TerraSkeleton } from "../../components/skeleton/skeleton.component.js";
 import type { TerraSpatialPicker } from "../../components/spatial-picker/spatial-picker.component.js";
-import type { TerraVariableCombobox } from "../../components/variable-combobox/variable-combobox.component.js";
+import type { TerraTimeAverageMap } from "../../components/time-average-map/time-average-map.component.js";
 import type { TerraTimeSeries, CustomEvent } from "../../components/time-series/time-series.component.js";
+import type { TerraVariableCombobox } from "../../components/variable-combobox/variable-combobox.component.js";
 import type { TerraVariableKeywordSearch } from "../../components/variable-keyword-search/variable-keyword-search.component.js";
-import type { TerraTimeAverageMap } from "../../components/time-average-map/time-average-map.component.js";
+
+type TerraAccordionProps = {
+  /** The summary/header for the accordion. Use the property for simple text, or the slot for custom content. */
+  summary?: TerraAccordion["summary"];
+  /** Whether the accordion is open or not. This property is reflected as an attribute and can be controlled programmatically or by user interaction. */
+  open?: TerraAccordion["open"];
+  /**  */
+  showArrow?: TerraAccordion["showArrow"];
+
+  /** emitted when the accordion opens or closes */
+  onTerraAccordionToggle?: (e: CustomEvent<never>) => void;
+};
 
 type TerraAlertProps = {
   /** Indicates whether or not the alert is open. You can toggle this attribute to show and hide the alert, or you can
@@ -54,18 +66,6 @@ Typically used to indicate the remaining time before a whole app refresh. */
   onTerraAfterHide?: (e: CustomEvent<never>) => void;
 };
 
-type TerraAccordionProps = {
-  /** The summary/header for the accordion. Use the property for simple text, or the slot for custom content. */
-  summary?: TerraAccordion["summary"];
-  /** Whether the accordion is open or not. This property is reflected as an attribute and can be controlled programmatically or by user interaction. */
-  open?: TerraAccordion["open"];
-  /**  */
-  showArrow?: TerraAccordion["showArrow"];
-
-  /** emitted when the accordion opens or closes */
-  onTerraAccordionToggle?: (e: CustomEvent<never>) => void;
-};
-
 type TerraButtonProps = {
   /**  */
   title?: TerraButton["title"];
@@ -133,49 +133,6 @@ value of this attribute must be an id of a form in the same document or shadow r
   validationMessage?: TerraButton["validationMessage"];
 };
 
-type TerraDataRodsProps = {
-  /** a variable entry ID (ex: GPM_3IMERGHH_06_precipitationCal) */
-  "variable-entry-id"?: TerraDataRods["variableEntryId"];
-  /** a collection entry id (ex: GPM_3IMERGHH_06)
-only required if you don't include a variableEntryId */
-  collection?: TerraDataRods["collection"];
-  /** a variable short name to plot (ex: precipitationCal)
-only required if you don't include a variableEntryId */
-  variable?: TerraDataRods["variable"];
-  /** The start date for the time series plot. (ex: 2021-01-01) */
-  "start-date"?: TerraDataRods["startDate"];
-  /** The end date for the time series plot. (ex: 2021-01-01) */
-  "end-date"?: TerraDataRods["endDate"];
-  /** The point location in "lat,lon" format. */
-  location?: TerraDataRods["location"];
-  /** The token to be used for authentication with remote servers.
-The component provides the header "Authorization: Bearer" (the request header and authentication scheme).
-The property's value will be inserted after "Bearer" (the authentication scheme). */
-  "bearer-token"?: TerraDataRods["bearerToken"];
-  /**  */
-  catalogVariable?: TerraDataRods["catalogVariable"];
-  /**  */
-  _fetchVariableTask?: TerraDataRods["_fetchVariableTask"];
-  /** Emitted whenever the date range of the date slider is updated */
-  onTerraDateRangeChange?: (e: CustomEvent<never>) => void;
-};
-
-type TerraBrowseVariablesProps = {
-  /** Allows the user to switch the catalog between different providers
-TODO: add support for CMR catalog and make it the default */
-  catalog?: TerraBrowseVariables["catalog"];
-  /**  */
-  "selected-variable-entry-ids"?: TerraBrowseVariables["selectedVariableEntryIds"];
-  /**  */
-  searchQuery?: TerraBrowseVariables["searchQuery"];
-  /**  */
-  selectedFacets?: TerraBrowseVariables["selectedFacets"];
-  /**  */
-  selectedVariables?: TerraBrowseVariables["selectedVariables"];
-  /**  */
-  showVariablesBrowse?: TerraBrowseVariables["showVariablesBrowse"];
-};
-
 type TerraComboboxProps = {
   /** Label the combobox with this. */
   label?: TerraCombobox["label"];
@@ -207,6 +164,49 @@ type TerraChipProps = {
   size?: TerraChip["size"];
 };
 
+type TerraBrowseVariablesProps = {
+  /** Allows the user to switch the catalog between different providers
+TODO: add support for CMR catalog and make it the default */
+  catalog?: TerraBrowseVariables["catalog"];
+  /**  */
+  "selected-variable-entry-ids"?: TerraBrowseVariables["selectedVariableEntryIds"];
+  /**  */
+  searchQuery?: TerraBrowseVariables["searchQuery"];
+  /**  */
+  selectedFacets?: TerraBrowseVariables["selectedFacets"];
+  /**  */
+  selectedVariables?: TerraBrowseVariables["selectedVariables"];
+  /**  */
+  showVariablesBrowse?: TerraBrowseVariables["showVariablesBrowse"];
+};
+
+type TerraDataRodsProps = {
+  /** a variable entry ID (ex: GPM_3IMERGHH_06_precipitationCal) */
+  "variable-entry-id"?: TerraDataRods["variableEntryId"];
+  /** a collection entry id (ex: GPM_3IMERGHH_06)
+only required if you don't include a variableEntryId */
+  collection?: TerraDataRods["collection"];
+  /** a variable short name to plot (ex: precipitationCal)
+only required if you don't include a variableEntryId */
+  variable?: TerraDataRods["variable"];
+  /** The start date for the time series plot. (ex: 2021-01-01) */
+  "start-date"?: TerraDataRods["startDate"];
+  /** The end date for the time series plot. (ex: 2021-01-01) */
+  "end-date"?: TerraDataRods["endDate"];
+  /** The point location in "lat,lon" format. */
+  location?: TerraDataRods["location"];
+  /** The token to be used for authentication with remote servers.
+The component provides the header "Authorization: Bearer" (the request header and authentication scheme).
+The property's value will be inserted after "Bearer" (the authentication scheme). */
+  "bearer-token"?: TerraDataRods["bearerToken"];
+  /**  */
+  catalogVariable?: TerraDataRods["catalogVariable"];
+  /**  */
+  _fetchVariableTask?: TerraDataRods["_fetchVariableTask"];
+  /** Emitted whenever the date range of the date slider is updated */
+  onTerraDateRangeChange?: (e: CustomEvent<never>) => void;
+};
+
 type TerraDataSubsetterProps = {
   /**  */
   "collection-entry-id"?: TerraDataSubsetter["collectionEntryId"];
@@ -278,6 +278,25 @@ this prop allows you to override that behavior and always show the history panel
   _authController?: TerraDataSubsetterHistory["_authController"];
 };
 
+type TerraDateRangeSliderProps = {
+  /**  */
+  "time-scale"?: TerraDateRangeSlider["timeScale"];
+  /**  */
+  "min-date"?: TerraDateRangeSlider["minDate"];
+  /**  */
+  "max-date"?: TerraDateRangeSlider["maxDate"];
+  /** The start date for the time series plot. */
+  "start-date"?: TerraDateRangeSlider["startDate"];
+  /**  */
+  "end-date"?: TerraDateRangeSlider["endDate"];
+  /**  */
+  disabled?: TerraDateRangeSlider["disabled"];
+  /**  */
+  "has-pips"?: TerraDateRangeSlider["hasPips"];
+  /**  */
+  slider?: TerraDateRangeSlider["slider"];
+};
+
 type TerraDatePickerProps = {
   /**  */
   id?: TerraDatePicker["id"];
@@ -323,25 +342,6 @@ type TerraDatePickerProps = {
   selectedDates?: TerraDatePicker["selectedDates"];
 };
 
-type TerraDateRangeSliderProps = {
-  /**  */
-  "time-scale"?: TerraDateRangeSlider["timeScale"];
-  /**  */
-  "min-date"?: TerraDateRangeSlider["minDate"];
-  /**  */
-  "max-date"?: TerraDateRangeSlider["maxDate"];
-  /** The start date for the time series plot. */
-  "start-date"?: TerraDateRangeSlider["startDate"];
-  /**  */
-  "end-date"?: TerraDateRangeSlider["endDate"];
-  /**  */
-  disabled?: TerraDateRangeSlider["disabled"];
-  /**  */
-  "has-pips"?: TerraDateRangeSlider["hasPips"];
-  /**  */
-  slider?: TerraDateRangeSlider["slider"];
-};
-
 type TerraDialogProps = {
   /** the ID to be used for accessibility associations */
   id?: TerraDialog["id"];
@@ -532,39 +532,32 @@ the default is false, the map is positioned absolute under the input */
   spatialPicker?: TerraSpatialPicker["spatialPicker"];
 };
 
-type TerraVariableComboboxProps = {
-  /** Label the combobox with this. */
-  label?: TerraVariableCombobox["label"];
-  /** Set a placeholder for the combobox with this.
-Defaults to the label's value. */
-  placeholder?: TerraVariableCombobox["placeholder"];
-  /** Hide the combobox's help text.
-When hidden, not rendered at all. */
-  "hide-help"?: TerraVariableCombobox["hideHelp"];
-  /** Hide the combobox's label text.
-When hidden, still presents to screen readers. */
-  "hide-label"?: TerraVariableCombobox["hideLabel"];
-  /** Determines if the variable combobox uses tags or plain text to display the query. */
-  "use-tags"?: TerraVariableCombobox["useTags"];
-  /** Represents the EntryID (<collection-name>_<variable-name>) of the selected variable.
-Other components (like the time-series graphing component) will use this. */
-  value?: TerraVariableCombobox["value"];
-  /** The token to be used for authentication with remote servers.
-The component provides the header "Authorization: Bearer" (the request header and authentication scheme).
-The property's value will be inserted after "Bearer" (the authentication scheme). */
-  "bearer-token"?: TerraVariableCombobox["bearerToken"];
+type TerraTimeAverageMapProps = {
+  /** a collection entry id (ex: GPM_3IMERGHH_06) */
+  collection?: TerraTimeAverageMap["collection"];
   /**  */
-  isExpanded?: TerraVariableCombobox["isExpanded"];
+  variable?: TerraTimeAverageMap["variable"];
   /**  */
-  query?: TerraVariableCombobox["query"];
+  "start-date"?: TerraTimeAverageMap["startDate"];
   /**  */
-  searchResults?: TerraVariableCombobox["searchResults"];
+  "end-date"?: TerraTimeAverageMap["endDate"];
+  /** The point location in "lat,lon" format.
+Or the bounding box in "west,south,east,north" format. */
+  location?: TerraTimeAverageMap["location"];
   /**  */
-  tags?: TerraVariableCombobox["tags"];
+  long_name?: TerraTimeAverageMap["long_name"];
   /**  */
-  tagContainerWidth?: TerraVariableCombobox["tagContainerWidth"];
-  /** Emitted when an option is selected. */
-  onTerraComboboxChange?: (e: CustomEvent<never>) => void;
+  activeMenuItem?: TerraTimeAverageMap["activeMenuItem"];
+  /**  */
+  catalogVariable?: TerraTimeAverageMap["catalogVariable"];
+  /**  */
+  colormaps?: TerraTimeAverageMap["colormaps"];
+  /**  */
+  colorMapName?: TerraTimeAverageMap["colorMapName"];
+  /**  */
+  _authController?: TerraTimeAverageMap["_authController"];
+  /** anytime the collection or variable changes, we'll fetch the variable from the catalog to get all of it's metadata */
+  _fetchVariableTask?: TerraTimeAverageMap["_fetchVariableTask"];
 };
 
 type TerraTimeSeriesProps = {
@@ -607,6 +600,41 @@ The property's value will be inserted after "Bearer" (the authentication scheme)
   onTerraTimeSeriesDataChange?: (e: CustomEvent<never>) => void;
 };
 
+type TerraVariableComboboxProps = {
+  /** Label the combobox with this. */
+  label?: TerraVariableCombobox["label"];
+  /** Set a placeholder for the combobox with this.
+Defaults to the label's value. */
+  placeholder?: TerraVariableCombobox["placeholder"];
+  /** Hide the combobox's help text.
+When hidden, not rendered at all. */
+  "hide-help"?: TerraVariableCombobox["hideHelp"];
+  /** Hide the combobox's label text.
+When hidden, still presents to screen readers. */
+  "hide-label"?: TerraVariableCombobox["hideLabel"];
+  /** Determines if the variable combobox uses tags or plain text to display the query. */
+  "use-tags"?: TerraVariableCombobox["useTags"];
+  /** Represents the EntryID (<collection-name>_<variable-name>) of the selected variable.
+Other components (like the time-series graphing component) will use this. */
+  value?: TerraVariableCombobox["value"];
+  /** The token to be used for authentication with remote servers.
+The component provides the header "Authorization: Bearer" (the request header and authentication scheme).
+The property's value will be inserted after "Bearer" (the authentication scheme). */
+  "bearer-token"?: TerraVariableCombobox["bearerToken"];
+  /**  */
+  isExpanded?: TerraVariableCombobox["isExpanded"];
+  /**  */
+  query?: TerraVariableCombobox["query"];
+  /**  */
+  searchResults?: TerraVariableCombobox["searchResults"];
+  /**  */
+  tags?: TerraVariableCombobox["tags"];
+  /**  */
+  tagContainerWidth?: TerraVariableCombobox["tagContainerWidth"];
+  /** Emitted when an option is selected. */
+  onTerraComboboxChange?: (e: CustomEvent<never>) => void;
+};
+
 type TerraVariableKeywordSearchProps = {
   /** Label the combobox with this. */
   label?: TerraVariableKeywordSearch["label"];
@@ -632,35 +660,21 @@ When hidden, still presents to screen readers. */
   onTerraSearch?: (e: CustomEvent<never>) => void;
 };
 
-type TerraTimeAverageMapProps = {
-  /** a collection entry id (ex: GPM_3IMERGHH_06) */
-  collection?: TerraTimeAverageMap["collection"];
-  /**  */
-  variable?: TerraTimeAverageMap["variable"];
-  /**  */
-  "start-date"?: TerraTimeAverageMap["startDate"];
-  /**  */
-  "end-date"?: TerraTimeAverageMap["endDate"];
-  /** The point location in "lat,lon" format.
-Or the bounding box in "west,south,east,north" format. */
-  location?: TerraTimeAverageMap["location"];
-  /**  */
-  long_name?: TerraTimeAverageMap["long_name"];
-  /**  */
-  activeMenuItem?: TerraTimeAverageMap["activeMenuItem"];
-  /**  */
-  catalogVariable?: TerraTimeAverageMap["catalogVariable"];
-  /**  */
-  colormaps?: TerraTimeAverageMap["colormaps"];
-  /**  */
-  colorMapName?: TerraTimeAverageMap["colorMapName"];
-  /**  */
-  _authController?: TerraTimeAverageMap["_authController"];
-  /** anytime the collection or variable changes, we'll fetch the variable from the catalog to get all of it's metadata */
-  _fetchVariableTask?: TerraTimeAverageMap["_fetchVariableTask"];
-};
-
 export type CustomElements = {
+  /**
+   * A collapsible content panel for showing and hiding content.
+   * ---
+   *
+   *
+   * ### **Events:**
+   *  - **terra-accordion-toggle** - emitted when the accordion opens or closes
+   *
+   * ### **Slots:**
+   *  - _default_ - The default slot for accordion content.
+   * - **summary** - The summary/header for the accordion (optional, overrides summary property)
+   */
+  "terra-accordion": DefineComponent<TerraAccordionProps>;
+
   /**
    * Alerts are used to display important messages inline or as toast notifications.
    * ---
@@ -689,20 +703,6 @@ export type CustomElements = {
    */
   "terra-alert": DefineComponent<TerraAlertProps>;
 
-  /**
-   * A collapsible content panel for showing and hiding content.
-   * ---
-   *
-   *
-   * ### **Events:**
-   *  - **terra-accordion-toggle** - emitted when the accordion opens or closes
-   *
-   * ### **Slots:**
-   *  - _default_ - The default slot for accordion content.
-   * - **summary** - The summary/header for the accordion (optional, overrides summary property)
-   */
-  "terra-accordion": DefineComponent<TerraAccordionProps>;
-
   /**
    * Buttons represent actions that are available to the user.
    * ---
@@ -732,23 +732,6 @@ export type CustomElements = {
    */
   "terra-button": DefineComponent<TerraButtonProps>;
 
-  /**
-   * A component for visualizing Hydrology Data Rods time series using the GES DISC Giovanni API
-   * ---
-   *
-   *
-   * ### **Events:**
-   *  - **terra-date-range-change** - Emitted whenever the date range of the date slider is updated
-   */
-  "terra-data-rods": DefineComponent<TerraDataRodsProps>;
-
-  /**
-   * Browse through the NASA CMR or Giovanni catalogs.
-   * ---
-   *
-   */
-  "terra-browse-variables": DefineComponent<TerraBrowseVariablesProps>;
-
   /**
    * Fuzzy-search for combobox with list autocomplete.
    * ---
@@ -777,6 +760,23 @@ export type CustomElements = {
    */
   "terra-chip": DefineComponent<TerraChipProps>;
 
+  /**
+   * Browse through the NASA CMR or Giovanni catalogs.
+   * ---
+   *
+   */
+  "terra-browse-variables": DefineComponent<TerraBrowseVariablesProps>;
+
+  /**
+   * A component for visualizing Hydrology Data Rods time series using the GES DISC Giovanni API
+   * ---
+   *
+   *
+   * ### **Events:**
+   *  - **terra-date-range-change** - Emitted whenever the date range of the date slider is updated
+   */
+  "terra-data-rods": DefineComponent<TerraDataRodsProps>;
+
   /**
    * Easily allow users to select, subset, and download NASA Earth science data collections with spatial, temporal, and variable filters.
    * ---
@@ -795,35 +795,35 @@ export type CustomElements = {
   "terra-data-subsetter-history": DefineComponent<TerraDataSubsetterHistoryProps>;
 
   /**
-   * A date picker component that supports single date selection or date range selection.
+   * Short summary of the component's intended use.
    * ---
    *
    *
    * ### **Slots:**
    *  - _default_ - The default slot.
+   * - **example** - An example slot.
+   *
+   * ### **CSS Properties:**
+   *  - **--example** - An example CSS custom property. _(default: undefined)_
    *
    * ### **CSS Parts:**
    *  - **base** - The component's base wrapper.
-   * - **input** - The date input element.
    */
-  "terra-date-picker": DefineComponent<TerraDatePickerProps>;
+  "terra-date-range-slider": DefineComponent<TerraDateRangeSliderProps>;
 
   /**
-   * Short summary of the component's intended use.
+   * A date picker component that supports single date selection or date range selection.
    * ---
    *
    *
    * ### **Slots:**
    *  - _default_ - The default slot.
-   * - **example** - An example slot.
-   *
-   * ### **CSS Properties:**
-   *  - **--example** - An example CSS custom property. _(default: undefined)_
    *
    * ### **CSS Parts:**
    *  - **base** - The component's base wrapper.
+   * - **input** - The date input element.
    */
-  "terra-date-range-slider": DefineComponent<TerraDateRangeSliderProps>;
+  "terra-date-picker": DefineComponent<TerraDatePickerProps>;
 
   /**
    * Used to create both modal and non-modal dialog boxes.
@@ -924,6 +924,24 @@ export type CustomElements = {
    */
   "terra-spatial-picker": DefineComponent<TerraSpatialPickerProps>;
 
+  /**
+   *
+   * ---
+   *
+   */
+  "terra-time-average-map": DefineComponent<TerraTimeAverageMapProps>;
+
+  /**
+   * A component for visualizing time series data using the GES DISC Giovanni API.
+   * ---
+   *
+   *
+   * ### **Events:**
+   *  - **terra-date-range-change** - Emitted whenever the date range is modified
+   * - **terra-time-series-data-change** - Emitted whenever time series data has been fetched from Giovanni
+   */
+  "terra-time-series": DefineComponent<TerraTimeSeriesProps>;
+
   /**
    * Fuzzy-search for dataset variables in combobox with list autocomplete.
    * ---
@@ -949,17 +967,6 @@ export type CustomElements = {
    */
   "terra-variable-combobox": DefineComponent<TerraVariableComboboxProps>;
 
-  /**
-   * A component for visualizing time series data using the GES DISC Giovanni API.
-   * ---
-   *
-   *
-   * ### **Events:**
-   *  - **terra-date-range-change** - Emitted whenever the date range is modified
-   * - **terra-time-series-data-change** - Emitted whenever time series data has been fetched from Giovanni
-   */
-  "terra-time-series": DefineComponent<TerraTimeSeriesProps>;
-
   /**
    * Fuzzy-search for dataset keywords in combobox with list autocomplete.
    * ---
@@ -980,13 +987,6 @@ export type CustomElements = {
    * - **listbox** - A `ul` that holds the clickable options.
    */
   "terra-variable-keyword-search": DefineComponent<TerraVariableKeywordSearchProps>;
-
-  /**
-   *
-   * ---
-   *
-   */
-  "terra-time-average-map": DefineComponent<TerraTimeAverageMapProps>;
 };
 
 declare module "vue" {