@nasa-terra/components 0.0.76 → 0.0.77

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 { 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 { TerraBrowseVariables } from "../../components/browse-variables/browse-variables.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 { TerraDataSubsetterHistory } from "../../components/data-subsetter-history/data-subsetter-history.component.js";
 import type { TerraDateRangeSlider } from "../../components/date-range-slider/date-range-slider.component.js";
-import type { TerraChip } from "../../components/chip/chip.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";
@@ -18,12 +18,12 @@ 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 { TerraPlotToolbar } from "../../components/plot-toolbar/plot-toolbar.component.js";
-import type { TerraSpatialPicker } from "../../components/spatial-picker/spatial-picker.component.js";
 import type { TerraSkeleton } from "../../components/skeleton/skeleton.component.js";
-import type { TerraTimeSeries, CustomEvent } from "../../components/time-series/time-series.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 { 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";
+import type { TerraTimeSeries, CustomEvent } from "../../components/time-series/time-series.component.js";
 
 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 +54,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 TerraAccordionProps = {
   /** The summary/header for the accordion. Use the property for simple text, or the slot for custom content. */
   summary?: TerraAccordion["summary"];
@@ -133,6 +149,11 @@ value of this attribute must be an id of a form in the same document or shadow r
   validationMessage?: TerraButton["validationMessage"];
 };
 
+type TerraChipProps = {
+  /**  */
+  size?: TerraChip["size"];
+};
+
 type TerraComboboxProps = {
   /** Label the combobox with this. */
   label?: TerraCombobox["label"];
@@ -186,22 +207,6 @@ The property's value will be inserted after "Bearer" (the authentication scheme)
   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 TerraDataSubsetterProps = {
   /**  */
   "collection-entry-id"?: TerraDataSubsetter["collectionEntryId"];
@@ -253,26 +258,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"];
@@ -318,6 +303,26 @@ type TerraDatePickerProps = {
   selectedDates?: TerraDatePicker["selectedDates"];
 };
 
+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 TerraDateRangeSliderProps = {
   /**  */
   "time-scale"?: TerraDateRangeSlider["timeScale"];
@@ -337,11 +342,6 @@ type TerraDateRangeSliderProps = {
   slider?: TerraDateRangeSlider["slider"];
 };
 
-type TerraChipProps = {
-  /**  */
-  size?: TerraChip["size"];
-};
-
 type TerraDialogProps = {
   /** the ID to be used for accessibility associations */
   id?: TerraDialog["id"];
@@ -470,6 +470,15 @@ type TerraPlotToolbarProps = {
   _authController?: TerraPlotToolbar["_authController"];
 };
 
+type TerraSkeletonProps = {
+  /**  */
+  rows?: TerraSkeleton["rows"];
+  /**  */
+  effect?: TerraSkeleton["effect"];
+  /**  */
+  variableWidths?: TerraSkeleton["variableWidths"];
+};
+
 type TerraSpatialPickerProps = {
   /** Minimum zoom level of the map. */
   "min-zoom"?: TerraSpatialPicker["minZoom"];
@@ -513,53 +522,32 @@ the default is false, the map is positioned absolute under the input */
   map?: TerraSpatialPicker["map"];
 };
 
-type TerraSkeletonProps = {
+type TerraTimeAverageMapProps = {
+  /** a collection entry id (ex: GPM_3IMERGHH_06) */
+  collection?: TerraTimeAverageMap["collection"];
   /**  */
-  rows?: TerraSkeleton["rows"];
+  variable?: TerraTimeAverageMap["variable"];
   /**  */
-  effect?: TerraSkeleton["effect"];
+  "start-date"?: TerraTimeAverageMap["startDate"];
   /**  */
-  variableWidths?: TerraSkeleton["variableWidths"];
-};
-
-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"];
+  "end-date"?: TerraTimeAverageMap["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"];
+  location?: TerraTimeAverageMap["location"];
   /**  */
-  plot?: TerraTimeSeries["plot"];
+  long_name?: TerraTimeAverageMap["long_name"];
   /**  */
-  plotToolbar?: TerraTimeSeries["plotToolbar"];
+  activeMenuItem?: TerraTimeAverageMap["activeMenuItem"];
   /**  */
-  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"];
+  catalogVariable?: TerraTimeAverageMap["catalogVariable"];
   /**  */
-  _authController?: TerraTimeSeries["_authController"];
+  colormaps?: TerraTimeAverageMap["colormaps"];
   /**  */
-  _fetchVariableTask?: TerraTimeSeries["_fetchVariableTask"];
-  /** 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;
+  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 TerraVariableComboboxProps = {
@@ -622,32 +610,44 @@ 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"];
+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?: TerraTimeAverageMap["location"];
-  /**  */
-  long_name?: TerraTimeAverageMap["long_name"];
+  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"];
   /**  */
-  activeMenuItem?: TerraTimeAverageMap["activeMenuItem"];
+  plot?: TerraTimeSeries["plot"];
   /**  */
-  catalogVariable?: TerraTimeAverageMap["catalogVariable"];
+  plotToolbar?: TerraTimeSeries["plotToolbar"];
   /**  */
-  colormaps?: TerraTimeAverageMap["colormaps"];
+  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"];
   /**  */
-  colorMapName?: TerraTimeAverageMap["colorMapName"];
+  _authController?: TerraTimeSeries["_authController"];
   /**  */
-  _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"];
+  _fetchVariableTask?: TerraTimeSeries["_fetchVariableTask"];
+  /** 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;
 };
 
 export type CustomElements = {
@@ -679,6 +679,13 @@ 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.
    * ---
@@ -722,6 +729,16 @@ export type CustomElements = {
    */
   "terra-button": DefineComponent<TerraButtonProps>;
 
+  /**
+   * Used for contacts and tags
+   * ---
+   *
+   *
+   * ### **Slots:**
+   *  - _default_ - The chip's label.
+   */
+  "terra-chip": DefineComponent<TerraChipProps>;
+
   /**
    * Fuzzy-search for combobox with list autocomplete.
    * ---
@@ -750,13 +767,6 @@ export type CustomElements = {
    */
   "terra-data-rods": DefineComponent<TerraDataRodsProps>;
 
-  /**
-   * Browse through the NASA CMR or Giovanni catalogs.
-   * ---
-   *
-   */
-  "terra-browse-variables": DefineComponent<TerraBrowseVariablesProps>;
-
   /**
    * Easily allow users to select, subset, and download NASA Earth science data collections with spatial, temporal, and variable filters.
    * ---
@@ -767,13 +777,6 @@ export type CustomElements = {
    */
   "terra-data-subsetter": DefineComponent<TerraDataSubsetterProps>;
 
-  /**
-   * Shows a floating panel with a user's recent data subset requests and their status, with quick access to results and re-submission.
-   * ---
-   *
-   */
-  "terra-data-subsetter-history": DefineComponent<TerraDataSubsetterHistoryProps>;
-
   /**
    * A date picker component that supports single date selection or date range selection.
    * ---
@@ -788,6 +791,13 @@ export type CustomElements = {
    */
   "terra-date-picker": DefineComponent<TerraDatePickerProps>;
 
+  /**
+   * Shows a floating panel with a user's recent data subset requests and their status, with quick access to results and re-submission.
+   * ---
+   *
+   */
+  "terra-data-subsetter-history": DefineComponent<TerraDataSubsetterHistoryProps>;
+
   /**
    * Short summary of the component's intended use.
    * ---
@@ -805,16 +815,6 @@ export type CustomElements = {
    */
   "terra-date-range-slider": DefineComponent<TerraDateRangeSliderProps>;
 
-  /**
-   * Used for contacts and tags
-   * ---
-   *
-   *
-   * ### **Slots:**
-   *  - _default_ - The chip's label.
-   */
-  "terra-chip": DefineComponent<TerraChipProps>;
-
   /**
    * Used to create both modal and non-modal dialog boxes.
    * ---
@@ -901,29 +901,25 @@ export type CustomElements = {
   "terra-plot-toolbar": DefineComponent<TerraPlotToolbarProps>;
 
   /**
-   * A component that allows input of coordinates and rendering of map.
+   * Skeletons are loading indicators to represent where content will eventually be drawn.
    * ---
    *
    */
-  "terra-spatial-picker": DefineComponent<TerraSpatialPickerProps>;
+  "terra-skeleton": DefineComponent<TerraSkeletonProps>;
 
   /**
-   * Skeletons are loading indicators to represent where content will eventually be drawn.
+   * A component that allows input of coordinates and rendering of map.
    * ---
    *
    */
-  "terra-skeleton": DefineComponent<TerraSkeletonProps>;
+  "terra-spatial-picker": DefineComponent<TerraSpatialPickerProps>;
 
   /**
-   * 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>;
+  "terra-time-average-map": DefineComponent<TerraTimeAverageMapProps>;
 
   /**
    * Fuzzy-search for dataset variables in combobox with list autocomplete.
@@ -972,11 +968,15 @@ export type CustomElements = {
   "terra-variable-keyword-search": DefineComponent<TerraVariableKeywordSearchProps>;
 
   /**
-   *
+   * 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-average-map": DefineComponent<TerraTimeAverageMapProps>;
+  "terra-time-series": DefineComponent<TerraTimeSeriesProps>;
 };
 
 declare module "vue" {