@nasa-terra/components 0.0.53 → 0.0.57

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

@@ -1,27 +1,36 @@
 import type { DefineComponent } from "vue";
 
-import type { TerraAlert } from "../../components/alert/alert.component.js";
-import type { TerraBrowseVariables } from "../../components/browse-variables/browse-variables.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 { TerraBrowseVariables } from "../../components/browse-variables/browse-variables.component.js";
 import type { TerraChip } from "../../components/chip/chip.component.js";
-import type { TerraCombobox } from "../../components/combobox/combobox.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 { TerraDatePicker } from "../../components/date-picker/date-picker.component.js";
+import type { TerraDataSubsetter } from "../../components/data-subsetter/data-subsetter.component.js";
+import type { TerraCombobox } from "../../components/combobox/combobox.component.js";
 import type { TerraDateRangeSlider } from "../../components/date-range-slider/date-range-slider.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";
 import type { TerraLogin } from "../../components/login/login.component.js";
+import type { TerraLoader } from "../../components/loader/loader.component.js";
 import type { TerraMap } from "../../components/map/map.component.js";
 import type { TerraPlot } from "../../components/plot/plot.component.js";
-import type { TerraSkeleton } from "../../components/skeleton/skeleton.component.js";
 import type { TerraSpatialPicker } from "../../components/spatial-picker/spatial-picker.component.js";
-import type { TerraTimeSeries } from "../../components/time-series/time-series.component.js";
+import type { TerraSkeleton } from "../../components/skeleton/skeleton.component.js";
 import type { TerraVariableCombobox } from "../../components/variable-combobox/variable-combobox.component.js";
+import type { TerraTimeSeries, CustomEvent } from "../../components/time-series/time-series.component.js";
 import type { TerraVariableKeywordSearch } from "../../components/variable-keyword-search/variable-keyword-search.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"];
+};
+
 type TerraAlertProps = {
   /** Indicates whether or not the alert is open. You can toggle this attribute to show and hide the alert, or you can
 use the `show()` and `hide()` methods and this attribute will reflect the alert's open state. */
@@ -51,29 +60,6 @@ Typically used to indicate the remaining time before a whole app refresh. */
   onTerraAfterHide?: (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"];
-  /**  */
-  searchQuery?: TerraBrowseVariables["searchQuery"];
-  /**  */
-  selectedFacets?: TerraBrowseVariables["selectedFacets"];
-  /**  */
-  selectedVariables?: TerraBrowseVariables["selectedVariables"];
-  /**  */
-  showVariablesBrowse?: TerraBrowseVariables["showVariablesBrowse"];
-};
-
-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"];
-};
-
 type TerraButtonProps = {
   /**  */
   title?: TerraButton["title"];
@@ -141,35 +127,23 @@ value of this attribute must be an id of a form in the same document or shadow r
   validationMessage?: TerraButton["validationMessage"];
 };
 
-type TerraChipProps = {
+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"];
   /**  */
-  size?: TerraChip["size"];
-};
-
-type TerraComboboxProps = {
-  /** Label the combobox with this. */
-  label?: TerraCombobox["label"];
-  /** name the combobox with this. */
-  name?: TerraCombobox["name"];
-  /** Set a placeholder for the combobox with this.
-Defaults to the label's value. */
-  placeholder?: TerraCombobox["placeholder"];
-  /** Hide the combobox's help text.
-When hidden, not rendered at all. */
-  "hide-help"?: TerraCombobox["hideHelp"];
-  /** Hide the combobox's label text.
-When hidden, still presents to screen readers. */
-  "hide-label"?: TerraCombobox["hideLabel"];
-  /** status of the content */
-  status?: TerraCombobox["status"];
-  /** content or data of the combobox. This could be of type string | GroupedListItem[] | ListItem[] | undefined */
-  content?: TerraCombobox["content"];
+  searchQuery?: TerraBrowseVariables["searchQuery"];
   /**  */
-  isExpanded?: TerraCombobox["isExpanded"];
+  selectedFacets?: TerraBrowseVariables["selectedFacets"];
   /**  */
-  query?: TerraCombobox["query"];
+  selectedVariables?: TerraBrowseVariables["selectedVariables"];
   /**  */
-  searchResults?: TerraCombobox["searchResults"];
+  showVariablesBrowse?: TerraBrowseVariables["showVariablesBrowse"];
+};
+
+type TerraChipProps = {
+  /**  */
+  size?: TerraChip["size"];
 };
 
 type TerraDataRodsProps = {
@@ -193,39 +167,8 @@ The property's value will be inserted after "Bearer" (the authentication scheme)
   "bearer-token"?: TerraDataRods["bearerToken"];
   /**  */
   catalogVariable?: TerraDataRods["catalogVariable"];
-};
-
-type TerraDataSubsetterProps = {
-  /**  */
-  "collection-entry-id"?: TerraDataSubsetter["collectionEntryId"];
-  /**  */
-  "show-collection-search"?: TerraDataSubsetter["showCollectionSearch"];
-  /**  */
-  "job-id"?: TerraDataSubsetter["jobId"];
-  /**  */
-  "bearer-token"?: TerraDataSubsetter["bearerToken"];
-  /**  */
-  collectionWithServices?: TerraDataSubsetter["collectionWithServices"];
-  /**  */
-  selectedVariables?: TerraDataSubsetter["selectedVariables"];
-  /**  */
-  expandedVariableGroups?: TerraDataSubsetter["expandedVariableGroups"];
-  /**  */
-  touchedFields?: TerraDataSubsetter["touchedFields"];
-  /**  */
-  spatialSelection?: TerraDataSubsetter["spatialSelection"];
-  /**  */
-  selectedDateRange?: TerraDataSubsetter["selectedDateRange"];
-  /**  */
-  selectedFormat?: TerraDataSubsetter["selectedFormat"];
-  /**  */
-  cancelingGetData?: TerraDataSubsetter["cancelingGetData"];
-  /**  */
-  selectedTab?: TerraDataSubsetter["selectedTab"];
-  /**  */
-  refineParameters?: TerraDataSubsetter["refineParameters"];
-  /**  */
-  showDownloadMenu?: TerraDataSubsetter["showDownloadMenu"];
+  /** Emitted whenever the date range of the date slider is updated */
+  onTerraDateRangeChange?: (e: CustomEvent<never>) => void;
 };
 
 type TerraDatePickerProps = {
@@ -273,6 +216,69 @@ type TerraDatePickerProps = {
   selectedDates?: TerraDatePicker["selectedDates"];
 };
 
+type TerraDataSubsetterProps = {
+  /**  */
+  "collection-entry-id"?: TerraDataSubsetter["collectionEntryId"];
+  /**  */
+  "show-collection-search"?: TerraDataSubsetter["showCollectionSearch"];
+  /**  */
+  "job-id"?: TerraDataSubsetter["jobId"];
+  /**  */
+  "bearer-token"?: TerraDataSubsetter["bearerToken"];
+  /**  */
+  collectionWithServices?: TerraDataSubsetter["collectionWithServices"];
+  /**  */
+  selectedVariables?: TerraDataSubsetter["selectedVariables"];
+  /**  */
+  expandedVariableGroups?: TerraDataSubsetter["expandedVariableGroups"];
+  /**  */
+  touchedFields?: TerraDataSubsetter["touchedFields"];
+  /**  */
+  spatialSelection?: TerraDataSubsetter["spatialSelection"];
+  /**  */
+  selectedDateRange?: TerraDataSubsetter["selectedDateRange"];
+  /**  */
+  selectedFormat?: TerraDataSubsetter["selectedFormat"];
+  /**  */
+  cancelingGetData?: TerraDataSubsetter["cancelingGetData"];
+  /**  */
+  selectedTab?: TerraDataSubsetter["selectedTab"];
+  /**  */
+  refineParameters?: TerraDataSubsetter["refineParameters"];
+  /**  */
+  showDownloadMenu?: TerraDataSubsetter["showDownloadMenu"];
+  /**  */
+  spatialPicker?: TerraDataSubsetter["spatialPicker"];
+  /** called when a subset job enters a final state (e.g. successful, failed, completed_with_errors) */
+  onTerraSubsetJobComplete?: (e: CustomEvent<never>) => void;
+};
+
+type TerraComboboxProps = {
+  /** Label the combobox with this. */
+  label?: TerraCombobox["label"];
+  /** name the combobox with this. */
+  name?: TerraCombobox["name"];
+  /** Set a placeholder for the combobox with this.
+Defaults to the label's value. */
+  placeholder?: TerraCombobox["placeholder"];
+  /** Hide the combobox's help text.
+When hidden, not rendered at all. */
+  "hide-help"?: TerraCombobox["hideHelp"];
+  /** Hide the combobox's label text.
+When hidden, still presents to screen readers. */
+  "hide-label"?: TerraCombobox["hideLabel"];
+  /** status of the content */
+  status?: TerraCombobox["status"];
+  /** content or data of the combobox. This could be of type string | GroupedListItem[] | ListItem[] | undefined */
+  content?: TerraCombobox["content"];
+  /**  */
+  isExpanded?: TerraCombobox["isExpanded"];
+  /**  */
+  query?: TerraCombobox["query"];
+  /**  */
+  searchResults?: TerraCombobox["searchResults"];
+};
+
 type TerraDateRangeSliderProps = {
   /**  */
   "time-scale"?: TerraDateRangeSlider["timeScale"];
@@ -332,6 +338,11 @@ ignored by assistive devices. */
   onTerraError?: (e: CustomEvent<never>) => void;
 };
 
+type TerraLoginProps = {
+  /** Emitted when a bearer token has been received from EDL. */
+  onTerraLogin?: (e: CustomEvent<never>) => void;
+};
+
 type TerraLoaderProps = {
   /** The loader's variant */
   variant?: TerraLoader["variant"];
@@ -343,11 +354,6 @@ type TerraLoaderProps = {
   _currentPercent?: TerraLoader["_currentPercent"];
 };
 
-type TerraLoginProps = {
-  /** Emitted when a bearer token has been received from EDL. */
-  onTerraLogin?: (e: CustomEvent<never>) => void;
-};
-
 type TerraMapProps = {
   /** Minimum zoom level of the map. */
   "min-zoom"?: TerraMap["minZoom"];
@@ -390,15 +396,6 @@ type TerraPlotProps = {
   base?: TerraPlot["base"];
 };
 
-type TerraSkeletonProps = {
-  /**  */
-  rows?: TerraSkeleton["rows"];
-  /**  */
-  effect?: TerraSkeleton["effect"];
-  /**  */
-  variableWidths?: TerraSkeleton["variableWidths"];
-};
-
 type TerraSpatialPickerProps = {
   /** Minimum zoom level of the map. */
   "min-zoom"?: TerraSpatialPicker["minZoom"];
@@ -436,41 +433,17 @@ the default is false, the map is positioned absolute under the input */
   mapValue?: TerraSpatialPicker["mapValue"];
   /**  */
   spatialInput?: TerraSpatialPicker["spatialInput"];
+  /**  */
+  map?: TerraSpatialPicker["map"];
 };
 
-type TerraTimeSeriesProps = {
-  /** a variable entry ID (ex: GPM_3IMERGHH_06_precipitationCal) */
-  "variable-entry-id"?: TerraTimeSeries["variableEntryId"];
-  /** a collection entry id (ex: GPM_3IMERGHH_06)
-only required if you don't include a variableEntryId */
-  collection?: TerraTimeSeries["collection"];
-  /** a variable short name to plot (ex: precipitationCal)
-only required if you don't include a variableEntryId */
-  variable?: TerraTimeSeries["variable"];
-  /** The start date for the time series plot. (ex: 2021-01-01) */
-  "start-date"?: TerraTimeSeries["startDate"];
-  /** The end date for the time series plot. (ex: 2021-01-01) */
-  "end-date"?: TerraTimeSeries["endDate"];
-  /** The point location in "lat,lon" format. */
-  location?: TerraTimeSeries["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"?: TerraTimeSeries["bearerToken"];
-  /**  */
-  plot?: TerraTimeSeries["plot"];
+type TerraSkeletonProps = {
   /**  */
-  menu?: TerraTimeSeries["menu"];
+  rows?: TerraSkeleton["rows"];
   /**  */
-  catalogVariable?: TerraTimeSeries["catalogVariable"];
-  /** if true, we'll show a warning to the user about them requesting a large number of data points */
-  showDataPointWarning?: TerraTimeSeries["showDataPointWarning"];
-  /** stores the estimated */
-  estimatedDataPoints?: TerraTimeSeries["estimatedDataPoints"];
+  effect?: TerraSkeleton["effect"];
   /**  */
-  activeMenuItem?: TerraTimeSeries["activeMenuItem"];
-  /** Emitted whenever time series data has been fetched from Giovanni */
-  onTerraTimeSeriesDataChange?: (e: CustomEvent<never>) => void;
+  variableWidths?: TerraSkeleton["variableWidths"];
 };
 
 type TerraVariableComboboxProps = {
@@ -508,6 +481,43 @@ The property's value will be inserted after "Bearer" (the authentication scheme)
   onTerraComboboxChange?: (e: CustomEvent<never>) => void;
 };
 
+type TerraTimeSeriesProps = {
+  /** a variable entry ID (ex: GPM_3IMERGHH_06_precipitationCal) */
+  "variable-entry-id"?: TerraTimeSeries["variableEntryId"];
+  /** a collection entry id (ex: GPM_3IMERGHH_06)
+only required if you don't include a variableEntryId */
+  collection?: TerraTimeSeries["collection"];
+  /** a variable short name to plot (ex: precipitationCal)
+only required if you don't include a variableEntryId */
+  variable?: TerraTimeSeries["variable"];
+  /** The start date for the time series plot. (ex: 2021-01-01) */
+  "start-date"?: TerraTimeSeries["startDate"];
+  /** The end date for the time series plot. (ex: 2021-01-01) */
+  "end-date"?: TerraTimeSeries["endDate"];
+  /** The point location in "lat,lon" format. */
+  location?: TerraTimeSeries["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"?: TerraTimeSeries["bearerToken"];
+  /**  */
+  plot?: TerraTimeSeries["plot"];
+  /**  */
+  menu?: TerraTimeSeries["menu"];
+  /**  */
+  catalogVariable?: TerraTimeSeries["catalogVariable"];
+  /** if true, we'll show a warning to the user about them requesting a large number of data points */
+  showDataPointWarning?: TerraTimeSeries["showDataPointWarning"];
+  /** stores the estimated */
+  estimatedDataPoints?: TerraTimeSeries["estimatedDataPoints"];
+  /**  */
+  activeMenuItem?: TerraTimeSeries["activeMenuItem"];
+  /** Emitted whenever the date range is modified */
+  onTerraDateRangeChange?: (e: CustomEvent<CustomEvent>) => void;
+  /** Emitted whenever time series data has been fetched from Giovanni */
+  onTerraTimeSeriesDataChange?: (e: CustomEvent<never>) => void;
+};
+
 type TerraVariableKeywordSearchProps = {
   /** Label the combobox with this. */
   label?: TerraVariableKeywordSearch["label"];
@@ -534,6 +544,17 @@ When hidden, still presents to screen readers. */
 };
 
 export type CustomElements = {
+  /**
+   * A collapsible content panel for showing and hiding content.
+   * ---
+   *
+   *
+   * ### **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.
    * ---
@@ -562,24 +583,6 @@ export type CustomElements = {
    */
   "terra-alert": DefineComponent<TerraAlertProps>;
 
-  /**
-   * Browse through the NASA CMR or Giovanni catalogs.
-   * ---
-   *
-   */
-  "terra-browse-variables": DefineComponent<TerraBrowseVariablesProps>;
-
-  /**
-   * A collapsible content panel for showing and hiding content.
-   * ---
-   *
-   *
-   * ### **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.
    * ---
@@ -609,6 +612,13 @@ export type CustomElements = {
    */
   "terra-button": DefineComponent<TerraButtonProps>;
 
+  /**
+   * Browse through the NASA CMR or Giovanni catalogs.
+   * ---
+   *
+   */
+  "terra-browse-variables": DefineComponent<TerraBrowseVariablesProps>;
+
   /**
    * Used for contacts and tags
    * ---
@@ -620,35 +630,37 @@ export type CustomElements = {
   "terra-chip": DefineComponent<TerraChipProps>;
 
   /**
-   * Fuzzy-search for combobox with list autocomplete.
+   * A component for visualizing Hydrology Data Rods time series using the GES DISC Giovanni API
    * ---
    *
    *
-   * ### **CSS Properties:**
-   *  - **--host-height** - The height of the host element. _(default: undefined)_
-   * - **--help-height** - The height of the search help element. _(default: undefined)_
-   * - **--label-height** - The height of the input's label element. _(default: undefined)_
-   *
-   * ### **CSS Parts:**
-   *  - **base** - A `search` element, the component's base.
-   * - **combobox** - An `input` element used for searching.
-   * - **button** - A `button` used for toggling the listbox's visibility.
-   * - **listbox** - A `ul` that holds the clickable options.
+   * ### **Events:**
+   *  - **terra-date-range-change** - Emitted whenever the date range of the date slider is updated
    */
-  "terra-combobox": DefineComponent<TerraComboboxProps>;
+  "terra-data-rods": DefineComponent<TerraDataRodsProps>;
 
   /**
-   * A component for visualizing Hydrology Data Rods time series using the GES DISC Giovanni API
+   * A date picker component that supports single date selection or date range selection.
    * ---
    *
+   *
+   * ### **Slots:**
+   *  - _default_ - The default slot.
+   *
+   * ### **CSS Parts:**
+   *  - **base** - The component's base wrapper.
+   * - **input** - The date input element.
    */
-  "terra-data-rods": DefineComponent<TerraDataRodsProps>;
+  "terra-date-picker": DefineComponent<TerraDatePickerProps>;
 
   /**
    * Short summary of the component's intended use.
    * ---
    *
    *
+   * ### **Events:**
+   *  - **terra-subset-job-complete** - called when a subset job enters a final state (e.g. successful, failed, completed_with_errors)
+   *
    * ### **Slots:**
    *  - _default_ - The default slot.
    * - **example** - An example slot.
@@ -662,18 +674,22 @@ export type CustomElements = {
   "terra-data-subsetter": DefineComponent<TerraDataSubsetterProps>;
 
   /**
-   * A date picker component that supports single date selection or date range selection.
+   * Fuzzy-search for combobox with list autocomplete.
    * ---
    *
    *
-   * ### **Slots:**
-   *  - _default_ - The default slot.
+   * ### **CSS Properties:**
+   *  - **--host-height** - The height of the host element. _(default: undefined)_
+   * - **--help-height** - The height of the search help element. _(default: undefined)_
+   * - **--label-height** - The height of the input's label element. _(default: undefined)_
    *
    * ### **CSS Parts:**
-   *  - **base** - The component's base wrapper.
-   * - **input** - The date input element.
+   *  - **base** - A `search` element, the component's base.
+   * - **combobox** - An `input` element used for searching.
+   * - **button** - A `button` used for toggling the listbox's visibility.
+   * - **listbox** - A `ul` that holds the clickable options.
    */
-  "terra-date-picker": DefineComponent<TerraDatePickerProps>;
+  "terra-combobox": DefineComponent<TerraComboboxProps>;
 
   /**
    * Short summary of the component's intended use.
@@ -720,6 +736,16 @@ export type CustomElements = {
    */
   "terra-icon": DefineComponent<TerraIconProps>;
 
+  /**
+   * A form that logs in to Earthdata Login (EDL) and returns a bearer token.
+   * ---
+   *
+   *
+   * ### **Events:**
+   *  - **terra-login** - Emitted when a bearer token has been received from EDL.
+   */
+  "terra-login": DefineComponent<TerraLoginProps>;
+
   /**
    * Loaders are used to indicate there is content that is loading.
    * ---
@@ -733,16 +759,6 @@ export type CustomElements = {
    */
   "terra-loader": DefineComponent<TerraLoaderProps>;
 
-  /**
-   * A form that logs in to Earthdata Login (EDL) and returns a bearer token.
-   * ---
-   *
-   *
-   * ### **Events:**
-   *  - **terra-login** - Emitted when a bearer token has been received from EDL.
-   */
-  "terra-login": DefineComponent<TerraLoginProps>;
-
   /**
    * A map component for visualizing and selecting coordinates.
    * ---
@@ -760,13 +776,6 @@ export type CustomElements = {
    */
   "terra-plot": DefineComponent<TerraPlotProps>;
 
-  /**
-   * Skeletons are loading indicators to represent where content will eventually be drawn.
-   * ---
-   *
-   */
-  "terra-skeleton": DefineComponent<TerraSkeletonProps>;
-
   /**
    * A component that allows input of coordinates and rendering of map.
    * ---
@@ -775,14 +784,11 @@ export type CustomElements = {
   "terra-spatial-picker": DefineComponent<TerraSpatialPickerProps>;
 
   /**
-   * A component for visualizing time series data using the GES DISC Giovanni API.
+   * Skeletons are loading indicators to represent where content will eventually be drawn.
    * ---
    *
-   *
-   * ### **Events:**
-   *  - **terra-time-series-data-change** - Emitted whenever time series data has been fetched from Giovanni
    */
-  "terra-time-series": DefineComponent<TerraTimeSeriesProps>;
+  "terra-skeleton": DefineComponent<TerraSkeletonProps>;
 
   /**
    * Fuzzy-search for dataset variables in combobox with list autocomplete.
@@ -809,6 +815,17 @@ 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.
    * ---