@nasa-terra/components 0.0.59 → 0.0.60

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

@@ -1,14 +1,14 @@
 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 { TerraBrowseVariables } from "../../components/browse-variables/browse-variables.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 { TerraDataRods } from "../../components/data-rods/data-rods.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";
@@ -18,11 +18,23 @@ 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 { 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 { TerraVariableCombobox } from "../../components/variable-combobox/variable-combobox.component.js";
+import type { TerraSkeleton } from "../../components/skeleton/skeleton.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"];
+
+  /** 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
 use the `show()` and `hide()` methods and this attribute will reflect the alert's open state. */
@@ -52,18 +64,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 TerraBrowseVariablesProps = {
   /** Allows the user to switch the catalog between different providers
 TODO: add support for CMR catalog and make it the default */
@@ -176,6 +176,31 @@ When hidden, still presents to screen readers. */
   searchResults?: TerraCombobox["searchResults"];
 };
 
+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"];
+  /** Emitted whenever the date range of the date slider is updated */
+  onTerraDateRangeChange?: (e: CustomEvent<never>) => void;
+};
+
 type TerraDataSubsetterProps = {
   /**  */
   "collection-entry-id"?: TerraDataSubsetter["collectionEntryId"];
@@ -247,31 +272,6 @@ this prop allows you to override that behavior and always show the history panel
   _authController?: TerraDataSubsetterHistory["_authController"];
 };
 
-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"];
-  /** Emitted whenever the date range of the date slider is updated */
-  onTerraDateRangeChange?: (e: CustomEvent<never>) => void;
-};
-
 type TerraDatePickerProps = {
   /**  */
   id?: TerraDatePicker["id"];
@@ -478,15 +478,6 @@ the default is false, the map is positioned absolute under the input */
   map?: TerraSpatialPicker["map"];
 };
 
-type TerraSkeletonProps = {
-  /**  */
-  rows?: TerraSkeleton["rows"];
-  /**  */
-  effect?: TerraSkeleton["effect"];
-  /**  */
-  variableWidths?: TerraSkeleton["variableWidths"];
-};
-
 type TerraTimeSeriesProps = {
   /** a variable entry ID (ex: GPM_3IMERGHH_06_precipitationCal) */
   "variable-entry-id"?: TerraTimeSeries["variableEntryId"];
@@ -562,6 +553,15 @@ The property's value will be inserted after "Bearer" (the authentication scheme)
   onTerraComboboxChange?: (e: CustomEvent<never>) => void;
 };
 
+type TerraSkeletonProps = {
+  /**  */
+  rows?: TerraSkeleton["rows"];
+  /**  */
+  effect?: TerraSkeleton["effect"];
+  /**  */
+  variableWidths?: TerraSkeleton["variableWidths"];
+};
+
 type TerraVariableKeywordSearchProps = {
   /** Label the combobox with this. */
   label?: TerraVariableKeywordSearch["label"];
@@ -588,6 +588,20 @@ When hidden, still presents to screen readers. */
 };
 
 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.
    * ---
@@ -616,20 +630,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>;
-
   /**
    * Browse through the NASA CMR or Giovanni catalogs.
    * ---
@@ -695,31 +695,31 @@ export type CustomElements = {
   "terra-combobox": DefineComponent<TerraComboboxProps>;
 
   /**
-   * Easily allow users to select, subset, and download NASA Earth science data collections with spatial, temporal, and variable filters.
+   * A component for visualizing Hydrology Data Rods time series using the GES DISC Giovanni API
    * ---
    *
    *
    * ### **Events:**
-   *  - **terra-subset-job-complete** - called when a subset job enters a final state (e.g. successful, failed, completed_with_errors)
+   *  - **terra-date-range-change** - Emitted whenever the date range of the date slider is updated
    */
-  "terra-data-subsetter": DefineComponent<TerraDataSubsetterProps>;
+  "terra-data-rods": DefineComponent<TerraDataRodsProps>;
 
   /**
-   * 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 component for visualizing Hydrology Data Rods time series using the GES DISC Giovanni API
+   * 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-date-range-change** - Emitted whenever the date range of the date slider is updated
    */
-  "terra-data-rods": DefineComponent<TerraDataRodsProps>;
+  "terra-data-subsetter-history": DefineComponent<TerraDataSubsetterHistoryProps>;
 
   /**
    * A date picker component that supports single date selection or date range selection.
@@ -827,13 +827,6 @@ export type CustomElements = {
    */
   "terra-spatial-picker": DefineComponent<TerraSpatialPickerProps>;
 
-  /**
-   * Skeletons are loading indicators to represent where content will eventually be drawn.
-   * ---
-   *
-   */
-  "terra-skeleton": DefineComponent<TerraSkeletonProps>;
-
   /**
    * A component for visualizing time series data using the GES DISC Giovanni API.
    * ---
@@ -870,6 +863,13 @@ export type CustomElements = {
    */
   "terra-variable-combobox": DefineComponent<TerraVariableComboboxProps>;
 
+  /**
+   * Skeletons are loading indicators to represent where content will eventually be drawn.
+   * ---
+   *
+   */
+  "terra-skeleton": DefineComponent<TerraSkeletonProps>;
+
   /**
    * Fuzzy-search for dataset keywords in combobox with list autocomplete.
    * ---

package/dist/vscode.html-custom-data.json

@@ -2,6 +2,29 @@
   "$schema": "https://raw.githubusercontent.com/microsoft/vscode-html-languageservice/main/docs/customData.schema.json",
   "version": 1.1,
   "tags": [
+    {
+      "name": "terra-accordion",
+      "description": "A collapsible content panel for showing and hiding content.\n---\n\n\n### **Events:**\n - **terra-accordion-toggle** - emitted when the accordion opens or closes\n\n### **Slots:**\n - _default_ - The default slot for accordion content.\n- **summary** - The summary/header for the accordion (optional, overrides summary property)",
+      "attributes": [
+        {
+          "name": "summary",
+          "description": "The summary/header for the accordion. Use the property for simple text, or the slot for custom content.",
+          "values": []
+        },
+        {
+          "name": "open",
+          "description": "Whether the accordion is open or not. This property is reflected as an attribute and can be controlled programmatically or by user interaction.",
+          "values": []
+        },
+        { "name": "showArrow", "values": [] }
+      ],
+      "references": [
+        {
+          "name": "Documentation",
+          "url": "https://disc.gsfc.nasa.gov/components/accordion"
+        }
+      ]
+    },
     {
       "name": "terra-alert",
       "description": "Alerts are used to display important messages inline or as toast notifications.\n---\n\n\n### **Events:**\n - **terra-show** - Emitted when the alert opens.\n- **terra-after-show** - Emitted after the alert opens and all animations are complete.\n- **terra-hide** - Emitted when the alert closes.\n- **terra-after-hide** - Emitted after the alert closes and all animations are complete.\n\n### **Methods:**\n - **show()** - Shows the alert.\n- **hide()** - Hides the alert\n- **toast()** - Displays the alert as a toast notification. This will move the alert out of its position in the DOM and, when\ndismissed, it will be removed from the DOM completely. By storing a reference to the alert, you can reuse it by\ncalling this method again. The returned promise will resolve after the alert is hidden.\n\n### **Slots:**\n - _default_ - The alert's main content.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **icon** - The container that wraps the optional icon.\n- **message** - The container that wraps the alert's main content.",
@@ -46,29 +69,6 @@
         }
       ]
     },
-    {
-      "name": "terra-accordion",
-      "description": "A collapsible content panel for showing and hiding content.\n---\n\n\n### **Events:**\n - **terra-accordion-toggle** - emitted when the accordion opens or closes\n\n### **Slots:**\n - _default_ - The default slot for accordion content.\n- **summary** - The summary/header for the accordion (optional, overrides summary property)",
-      "attributes": [
-        {
-          "name": "summary",
-          "description": "The summary/header for the accordion. Use the property for simple text, or the slot for custom content.",
-          "values": []
-        },
-        {
-          "name": "open",
-          "description": "Whether the accordion is open or not. This property is reflected as an attribute and can be controlled programmatically or by user interaction.",
-          "values": []
-        },
-        { "name": "showArrow", "values": [] }
-      ],
-      "references": [
-        {
-          "name": "Documentation",
-          "url": "https://disc.gsfc.nasa.gov/components/accordion"
-        }
-      ]
-    },
     {
       "name": "terra-browse-variables",
       "description": "Browse through the NASA CMR or Giovanni catalogs.\n---\n",
@@ -318,41 +318,6 @@
         }
       ]
     },
-    {
-      "name": "terra-data-subsetter",
-      "description": "Easily allow users to select, subset, and download NASA Earth science data collections with spatial, temporal, and variable filters.\n---\n\n\n### **Events:**\n - **terra-subset-job-complete** - called when a subset job enters a final state (e.g. successful, failed, completed_with_errors)",
-      "attributes": [
-        { "name": "collection-entry-id", "values": [] },
-        { "name": "show-collection-search", "values": [] },
-        { "name": "job-id", "values": [] },
-        { "name": "bearer-token", "values": [] }
-      ],
-      "references": [
-        {
-          "name": "Documentation",
-          "url": "https://disc.gsfc.nasa.gov/components/data-subsetter"
-        }
-      ]
-    },
-    {
-      "name": "terra-data-subsetter-history",
-      "description": "Shows a floating panel with a user's recent data subset requests and their status, with quick access to results and re-submission.\n---\n",
-      "attributes": [
-        { "name": "label", "values": [] },
-        { "name": "bearer-token", "values": [] },
-        {
-          "name": "always-show",
-          "description": "if a user has never done a subset request, by default they don't see the history panel at all\nthis prop allows you to override that behavior and always show the history panel",
-          "values": []
-        }
-      ],
-      "references": [
-        {
-          "name": "Documentation",
-          "url": "https://disc.gsfc.nasa.gov/components/data-subsetter-history"
-        }
-      ]
-    },
     {
       "name": "terra-data-rods",
       "description": "A component for visualizing Hydrology Data Rods time series using the GES DISC Giovanni API\n---\n\n\n### **Events:**\n - **terra-date-range-change** - Emitted whenever the date range of the date slider is updated",
@@ -400,6 +365,41 @@
         }
       ]
     },
+    {
+      "name": "terra-data-subsetter",
+      "description": "Easily allow users to select, subset, and download NASA Earth science data collections with spatial, temporal, and variable filters.\n---\n\n\n### **Events:**\n - **terra-subset-job-complete** - called when a subset job enters a final state (e.g. successful, failed, completed_with_errors)",
+      "attributes": [
+        { "name": "collection-entry-id", "values": [] },
+        { "name": "show-collection-search", "values": [] },
+        { "name": "job-id", "values": [] },
+        { "name": "bearer-token", "values": [] }
+      ],
+      "references": [
+        {
+          "name": "Documentation",
+          "url": "https://disc.gsfc.nasa.gov/components/data-subsetter"
+        }
+      ]
+    },
+    {
+      "name": "terra-data-subsetter-history",
+      "description": "Shows a floating panel with a user's recent data subset requests and their status, with quick access to results and re-submission.\n---\n",
+      "attributes": [
+        { "name": "label", "values": [] },
+        { "name": "bearer-token", "values": [] },
+        {
+          "name": "always-show",
+          "description": "if a user has never done a subset request, by default they don't see the history panel at all\nthis prop allows you to override that behavior and always show the history panel",
+          "values": []
+        }
+      ],
+      "references": [
+        {
+          "name": "Documentation",
+          "url": "https://disc.gsfc.nasa.gov/components/data-subsetter-history"
+        }
+      ]
+    },
     {
       "name": "terra-date-picker",
       "description": "A date picker component that supports single date selection or date range selection.\n---\n\n\n### **Slots:**\n - _default_ - The default slot.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **input** - The date input element.",
@@ -714,28 +714,6 @@
         }
       ]
     },
-    {
-      "name": "terra-skeleton",
-      "description": "Skeletons are loading indicators to represent where content will eventually be drawn.\n---\n",
-      "attributes": [
-        { "name": "rows", "values": [] },
-        {
-          "name": "effect",
-          "values": [
-            { "name": "pulse" },
-            { "name": "sheen" },
-            { "name": "none" }
-          ]
-        },
-        { "name": "variableWidths", "values": [] }
-      ],
-      "references": [
-        {
-          "name": "Documentation",
-          "url": "https://disc.gsfc.nasa.gov/components/skeleton"
-        }
-      ]
-    },
     {
       "name": "terra-time-series",
       "description": "A component for visualizing time series data using the GES DISC Giovanni API.\n---\n\n\n### **Events:**\n - **terra-date-range-change** - Emitted whenever the date range is modified\n- **terra-time-series-data-change** - Emitted whenever time series data has been fetched from Giovanni",
@@ -830,6 +808,28 @@
         }
       ]
     },
+    {
+      "name": "terra-skeleton",
+      "description": "Skeletons are loading indicators to represent where content will eventually be drawn.\n---\n",
+      "attributes": [
+        { "name": "rows", "values": [] },
+        {
+          "name": "effect",
+          "values": [
+            { "name": "pulse" },
+            { "name": "sheen" },
+            { "name": "none" }
+          ]
+        },
+        { "name": "variableWidths", "values": [] }
+      ],
+      "references": [
+        {
+          "name": "Documentation",
+          "url": "https://disc.gsfc.nasa.gov/components/skeleton"
+        }
+      ]
+    },
     {
       "name": "terra-variable-keyword-search",
       "description": "Fuzzy-search for dataset keywords in combobox with list autocomplete.\n---\n\n\n### **Events:**\n - **terra-variable-keyword-search-change** - Emitted when an option is selected.\n- **terra-search** - Emitted when the component is triggering a search (like a form triggering submit).\n\n### **CSS Properties:**\n - **--host-height** - The height of the host element. _(default: undefined)_\n- **--label-height** - The height of the input's label element. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - A `search` element, the component's base.\n- **combobox** - An `input` element used for searching.\n- **button** - A `button` used for toggling the listbox's visibility.\n- **listbox** - A `ul` that holds the clickable options.",