@nasa-terra/components 0.0.68 → 0.0.70

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

@@ -1,29 +1,41 @@
 import type { DefineComponent } from "vue";
 
+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 { TerraAccordion } from "../../components/accordion/accordion.component.js";
+import type { TerraButton } from "../../components/button/button.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 { TerraDataSubsetterHistory } from "../../components/data-subsetter-history/data-subsetter-history.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 { 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 { TerraMap } from "../../components/map/map.component.js";
 import type { TerraPlot } from "../../components/plot/plot.component.js";
+import type { TerraMap } from "../../components/map/map.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 { 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 { TerraTimeAverageMap } from "../../components/time-average-map/time-average-map.component.js";
 import type { TerraVariableKeywordSearch } from "../../components/variable-keyword-search/variable-keyword-search.component.js";
+import type { TerraVariableCombobox } from "../../components/variable-combobox/variable-combobox.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,6 +66,22 @@ 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"];
+  /**  */
+  "selected-variable-entry-ids"?: TerraBrowseVariables["selectedVariableEntryIds"];
+  /**  */
+  searchQuery?: TerraBrowseVariables["searchQuery"];
+  /**  */
+  selectedFacets?: TerraBrowseVariables["selectedFacets"];
+  /**  */
+  selectedVariables?: TerraBrowseVariables["selectedVariables"];
+  /**  */
+  showVariablesBrowse?: TerraBrowseVariables["showVariablesBrowse"];
+};
+
 type TerraButtonProps = {
   /**  */
   title?: TerraButton["title"];
@@ -121,34 +149,6 @@ value of this attribute must be an id of a form in the same document or shadow r
   validationMessage?: TerraButton["validationMessage"];
 };
 
-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 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 TerraChipProps = {
   /**  */
   size?: TerraChip["size"];
@@ -205,6 +205,26 @@ The property's value will be inserted after "Bearer" (the authentication scheme)
   onTerraDateRangeChange?: (e: CustomEvent<never>) => void;
 };
 
+type TerraDataSubsetterHistoryProps = {
+  /**  */
+  label?: TerraDataSubsetterHistory["label"];
+  /**  */
+  "bearer-token"?: TerraDataSubsetterHistory["bearerToken"];
+  /** if a user has never done a subset request, by default they don't see the history panel at all
+this prop allows you to override that behavior and always show the history panel */
+  "always-show"?: TerraDataSubsetterHistory["alwaysShow"];
+  /**  */
+  collapsed?: TerraDataSubsetterHistory["collapsed"];
+  /**  */
+  selectedJob?: TerraDataSubsetterHistory["selectedJob"];
+  /**  */
+  hideCancelled?: TerraDataSubsetterHistory["hideCancelled"];
+  /**  */
+  dialog?: TerraDataSubsetterHistory["dialog"];
+  /**  */
+  _authController?: TerraDataSubsetterHistory["_authController"];
+};
+
 type TerraDataSubsetterProps = {
   /**  */
   "collection-entry-id"?: TerraDataSubsetter["collectionEntryId"];
@@ -256,26 +276,6 @@ type TerraDataSubsetterProps = {
   onTerraSubsetJobComplete?: (e: CustomEvent<never>) => void;
 };
 
-type TerraDataSubsetterHistoryProps = {
-  /**  */
-  label?: TerraDataSubsetterHistory["label"];
-  /**  */
-  "bearer-token"?: TerraDataSubsetterHistory["bearerToken"];
-  /** if a user has never done a subset request, by default they don't see the history panel at all
-this prop allows you to override that behavior and always show the history panel */
-  "always-show"?: TerraDataSubsetterHistory["alwaysShow"];
-  /**  */
-  collapsed?: TerraDataSubsetterHistory["collapsed"];
-  /**  */
-  selectedJob?: TerraDataSubsetterHistory["selectedJob"];
-  /**  */
-  hideCancelled?: TerraDataSubsetterHistory["hideCancelled"];
-  /**  */
-  dialog?: TerraDataSubsetterHistory["dialog"];
-  /**  */
-  _authController?: TerraDataSubsetterHistory["_authController"];
-};
-
 type TerraDatePickerProps = {
   /**  */
   id?: TerraDatePicker["id"];
@@ -399,6 +399,19 @@ type TerraLoginProps = {
   onTerraLogin?: (e: CustomEvent<never>) => void;
 };
 
+type TerraPlotProps = {
+  /**  */
+  plotTitle?: TerraPlot["plotTitle"];
+  /**  */
+  layout?: TerraPlot["layout"];
+  /**  */
+  config?: TerraPlot["config"];
+  /**  */
+  data?: TerraPlot["data"];
+  /**  */
+  base?: TerraPlot["base"];
+};
+
 type TerraMapProps = {
   /** Minimum zoom level of the map. */
   "min-zoom"?: TerraMap["minZoom"];
@@ -428,19 +441,6 @@ type TerraMapProps = {
   _mapController?: TerraMap["_mapController"];
 };
 
-type TerraPlotProps = {
-  /**  */
-  plotTitle?: TerraPlot["plotTitle"];
-  /**  */
-  layout?: TerraPlot["layout"];
-  /**  */
-  config?: TerraPlot["config"];
-  /**  */
-  data?: TerraPlot["data"];
-  /**  */
-  base?: TerraPlot["base"];
-};
-
 type TerraPlotToolbarProps = {
   /**  */
   catalogVariable?: TerraPlotToolbar["catalogVariable"];
@@ -518,6 +518,44 @@ the default is false, the map is positioned absolute under the input */
   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.
+Or the bounding box in "west,south,east,north" 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"];
+  /**  */
+  plotToolbar?: TerraTimeSeries["plotToolbar"];
+  /**  */
+  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"];
+  /**  */
+  _authController?: TerraTimeSeries["_authController"];
+  /** 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 TerraTimeAverageMapProps = {
   /** a collection entry id (ex: GPM_3IMERGHH_06) */
   collection?: TerraTimeAverageMap["collection"];
@@ -552,42 +590,29 @@ The property's value will be inserted after "Bearer" (the authentication scheme)
   _fetchVariableTask?: TerraTimeAverageMap["_fetchVariableTask"];
 };
 
-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.
-Or the bounding box in "west,south,east,north" 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"];
+type TerraVariableKeywordSearchProps = {
+  /** Label the combobox with this. */
+  label?: TerraVariableKeywordSearch["label"];
+  /** Set a placeholder for the combobox with this.
+Defaults to the label's value. */
+  placeholder?: TerraVariableKeywordSearch["placeholder"];
+  /** Hide the combobox's label text.
+When hidden, still presents to screen readers. */
+  "hide-label"?: TerraVariableKeywordSearch["hideLabel"];
+  /** type can be `Boolean`, `String`, `Number`, `Object`, or `Array` */
+  searchConfig?: TerraVariableKeywordSearch["searchConfig"];
   /**  */
-  plot?: TerraTimeSeries["plot"];
+  value?: TerraVariableKeywordSearch["value"];
   /**  */
-  plotToolbar?: TerraTimeSeries["plotToolbar"];
+  isExpanded?: TerraVariableKeywordSearch["isExpanded"];
   /**  */
-  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"];
+  query?: TerraVariableKeywordSearch["query"];
   /**  */
-  _authController?: TerraTimeSeries["_authController"];
-  /** 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;
+  searchResults?: TerraVariableKeywordSearch["searchResults"];
+  /** Emitted when an option is selected. */
+  onTerraVariableKeywordSearchChange?: (e: CustomEvent<never>) => void;
+  /** Emitted when the component is triggering a search (like a form triggering submit). */
+  onTerraSearch?: (e: CustomEvent<never>) => void;
 };
 
 type TerraVariableComboboxProps = {
@@ -625,32 +650,21 @@ The property's value will be inserted after "Bearer" (the authentication scheme)
   onTerraComboboxChange?: (e: CustomEvent<never>) => void;
 };
 
-type TerraVariableKeywordSearchProps = {
-  /** Label the combobox with this. */
-  label?: TerraVariableKeywordSearch["label"];
-  /** Set a placeholder for the combobox with this.
-Defaults to the label's value. */
-  placeholder?: TerraVariableKeywordSearch["placeholder"];
-  /** Hide the combobox's label text.
-When hidden, still presents to screen readers. */
-  "hide-label"?: TerraVariableKeywordSearch["hideLabel"];
-  /** type can be `Boolean`, `String`, `Number`, `Object`, or `Array` */
-  searchConfig?: TerraVariableKeywordSearch["searchConfig"];
-  /**  */
-  value?: TerraVariableKeywordSearch["value"];
-  /**  */
-  isExpanded?: TerraVariableKeywordSearch["isExpanded"];
-  /**  */
-  query?: TerraVariableKeywordSearch["query"];
-  /**  */
-  searchResults?: TerraVariableKeywordSearch["searchResults"];
-  /** Emitted when an option is selected. */
-  onTerraVariableKeywordSearchChange?: (e: CustomEvent<never>) => void;
-  /** Emitted when the component is triggering a search (like a form triggering submit). */
-  onTerraSearch?: (e: CustomEvent<never>) => void;
-};
-
 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.
    * ---
@@ -679,6 +693,13 @@ export type CustomElements = {
    */
   "terra-alert": DefineComponent<TerraAlertProps>;
 
+  /**
+   * Browse through the NASA CMR or Giovanni catalogs.
+   * ---
+   *
+   */
+  "terra-browse-variables": DefineComponent<TerraBrowseVariablesProps>;
+
   /**
    * Buttons represent actions that are available to the user.
    * ---
@@ -708,27 +729,6 @@ export type CustomElements = {
    */
   "terra-button": DefineComponent<TerraButtonProps>;
 
-  /**
-   * Browse through the NASA CMR or Giovanni catalogs.
-   * ---
-   *
-   */
-  "terra-browse-variables": DefineComponent<TerraBrowseVariablesProps>;
-
-  /**
-   * 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>;
-
   /**
    * Used for contacts and tags
    * ---
@@ -768,21 +768,21 @@ export type CustomElements = {
   "terra-data-rods": DefineComponent<TerraDataRodsProps>;
 
   /**
-   * Easily allow users to select, subset, and download NASA Earth science data collections with spatial, temporal, and variable filters.
+   * Shows a floating panel with a user's recent data subset requests and their status, with quick access to results and re-submission.
    * ---
    *
-   *
-   * ### **Events:**
-   *  - **terra-subset-job-complete** - called when a subset job enters a final state (e.g. successful, failed, completed_with_errors)
    */
-  "terra-data-subsetter": DefineComponent<TerraDataSubsetterProps>;
+  "terra-data-subsetter-history": DefineComponent<TerraDataSubsetterHistoryProps>;
 
   /**
-   * Shows a floating panel with a user's recent data subset requests and their status, with quick access to results and re-submission.
+   * Easily allow users to select, subset, and download NASA Earth science data collections with spatial, temporal, and variable filters.
    * ---
    *
+   *
+   * ### **Events:**
+   *  - **terra-subset-job-complete** - called when a subset job enters a final state (e.g. successful, failed, completed_with_errors)
    */
-  "terra-data-subsetter-history": DefineComponent<TerraDataSubsetterHistoryProps>;
+  "terra-data-subsetter": DefineComponent<TerraDataSubsetterProps>;
 
   /**
    * A date picker component that supports single date selection or date range selection.
@@ -866,13 +866,6 @@ export type CustomElements = {
    */
   "terra-login": DefineComponent<TerraLoginProps>;
 
-  /**
-   * A map component for visualizing and selecting coordinates.
-   * ---
-   *
-   */
-  "terra-map": DefineComponent<TerraMapProps>;
-
   /**
    * A web component for interactive graphs using Plotly.js.
    * ---
@@ -883,6 +876,13 @@ export type CustomElements = {
    */
   "terra-plot": DefineComponent<TerraPlotProps>;
 
+  /**
+   * A map component for visualizing and selecting coordinates.
+   * ---
+   *
+   */
+  "terra-map": DefineComponent<TerraMapProps>;
+
   /**
    * Short summary of the component's intended use.
    * ---
@@ -914,13 +914,6 @@ 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.
    * ---
@@ -933,20 +926,23 @@ export type CustomElements = {
   "terra-time-series": DefineComponent<TerraTimeSeriesProps>;
 
   /**
-   * Fuzzy-search for dataset variables in combobox with list autocomplete.
+   *
    * ---
    *
+   */
+  "terra-time-average-map": DefineComponent<TerraTimeAverageMapProps>;
+
+  /**
+   * Fuzzy-search for dataset keywords in combobox with list autocomplete.
+   * ---
    *
-   * ### **Events:**
-   *  - **terra-combobox-change** - Emitted when an option is selected.
    *
-   * ### **Methods:**
-   *  - **valueChanged(oldValue: _string_, newValue: _string_)** - This component's value is read by other components.
-   * Internally, the variable metdata has slight differences that require adapting.
+   * ### **Events:**
+   *  - **terra-variable-keyword-search-change** - Emitted when an option is selected.
+   * - **terra-search** - Emitted when the component is triggering a search (like a form triggering submit).
    *
    * ### **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:**
@@ -955,19 +951,23 @@ export type CustomElements = {
    * - **button** - A `button` used for toggling the listbox's visibility.
    * - **listbox** - A `ul` that holds the clickable options.
    */
-  "terra-variable-combobox": DefineComponent<TerraVariableComboboxProps>;
+  "terra-variable-keyword-search": DefineComponent<TerraVariableKeywordSearchProps>;
 
   /**
-   * Fuzzy-search for dataset keywords in combobox with list autocomplete.
+   * Fuzzy-search for dataset variables in combobox with list autocomplete.
    * ---
    *
    *
    * ### **Events:**
-   *  - **terra-variable-keyword-search-change** - Emitted when an option is selected.
-   * - **terra-search** - Emitted when the component is triggering a search (like a form triggering submit).
+   *  - **terra-combobox-change** - Emitted when an option is selected.
+   *
+   * ### **Methods:**
+   *  - **valueChanged(oldValue: _string_, newValue: _string_)** - This component's value is read by other components.
+   * Internally, the variable metdata has slight differences that require adapting.
    *
    * ### **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:**
@@ -976,7 +976,7 @@ export type CustomElements = {
    * - **button** - A `button` used for toggling the listbox's visibility.
    * - **listbox** - A `ul` that holds the clickable options.
    */
-  "terra-variable-keyword-search": DefineComponent<TerraVariableKeywordSearchProps>;
+  "terra-variable-combobox": DefineComponent<TerraVariableComboboxProps>;
 };
 
 declare module "vue" {