From 3ffe9cddc0a5aca7fb971e5809f36e86db3b5cfc Mon Sep 17 00:00:00 2001
From: Eric Liu <ericyl.us@gmail.com>
Date: Sat, 4 Jun 2022 13:25:53 -0700
Subject: [PATCH] breaking(types): type arrays as read-only

Closes #1259
---
 src/Checkbox/Checkbox.svelte                      |  2 +-
 src/ComboBox/ComboBox.svelte                      |  2 +-
 src/ContextMenu/ContextMenu.svelte                |  2 +-
 src/ContextMenu/ContextMenuGroup.svelte           |  2 +-
 src/DataTable/DataTable.svelte                    | 12 ++++++------
 src/DataTable/DataTableSkeleton.svelte            |  2 +-
 src/Dropdown/Dropdown.svelte                      |  2 +-
 src/FileUploader/FileUploader.svelte              | 10 +++++-----
 src/FileUploader/FileUploaderButton.svelte        |  6 +++---
 src/FileUploader/FileUploaderDropContainer.svelte | 14 +++++++-------
 src/MultiSelect/MultiSelect.svelte                |  4 ++--
 src/Pagination/Pagination.svelte                  |  2 +-
 src/TreeView/TreeView.svelte                      |  4 ++--
 src/UIShell/HeaderSearch.svelte                   |  2 +-
 14 files changed, 33 insertions(+), 33 deletions(-)

diff --git a/src/Checkbox/Checkbox.svelte b/src/Checkbox/Checkbox.svelte
index 1c7a2789..a98efe29 100644
--- a/src/Checkbox/Checkbox.svelte
+++ b/src/Checkbox/Checkbox.svelte
@@ -14,7 +14,7 @@
 
   /**
    * Specify the bound group
-   * @type {any[]}
+   * @type {ReadonlyArray<any>}
    */
   export let group = undefined;
 
diff --git a/src/ComboBox/ComboBox.svelte b/src/ComboBox/ComboBox.svelte
index b1100b25..76e59a44 100644
--- a/src/ComboBox/ComboBox.svelte
+++ b/src/ComboBox/ComboBox.svelte
@@ -8,7 +8,7 @@
 
   /**
    * Set the combobox items
-   * @type {ComboBoxItem[]}
+   * @type {ReadonlyArray<ComboBoxItem>}
    */
   export let items = [];
 
diff --git a/src/ContextMenu/ContextMenu.svelte b/src/ContextMenu/ContextMenu.svelte
index c1490844..68adc47a 100644
--- a/src/ContextMenu/ContextMenu.svelte
+++ b/src/ContextMenu/ContextMenu.svelte
@@ -6,7 +6,7 @@
   /**
    * Specify an element or list of elements to trigger the context menu.
    * If no element is specified, the context menu applies to the entire window
-   * @type {null | HTMLElement | HTMLElement[]}
+   * @type {null | ReadonlyArray<null | HTMLElement>}
    */
   export let target = null;
 
diff --git a/src/ContextMenu/ContextMenuGroup.svelte b/src/ContextMenu/ContextMenuGroup.svelte
index 2ae256c7..c38d683a 100644
--- a/src/ContextMenu/ContextMenuGroup.svelte
+++ b/src/ContextMenu/ContextMenuGroup.svelte
@@ -1,5 +1,5 @@
 <script>
-  /** @type {string[]} */
+  /** @type {ReadonlyArray<string>} */
   export let selectedIds = [];
 
   /** Specify the label text */
diff --git a/src/DataTable/DataTable.svelte b/src/DataTable/DataTable.svelte
index 7e2ba502..f9289e9b 100644
--- a/src/DataTable/DataTable.svelte
+++ b/src/DataTable/DataTable.svelte
@@ -24,14 +24,14 @@
 
   /**
    * Specify the data table headers
-   * @type {DataTableHeader[]}
+   * @type {ReadonlyArray<DataTableHeader>}
    */
   export let headers = [];
 
   /**
    * Specify the rows the data table should render
    * keys defined in `headers` are used for the row ids
-   * @type {DataTableRow[]}
+   * @type {ReadonlyArray<DataTableRow>}
    */
   export let rows = [];
 
@@ -66,13 +66,13 @@
 
   /**
    * Specify the row ids to be expanded
-   * @type {DataTableRowId[]}
+   * @type {ReadonlyArray<DataTableRowId>}
    */
   export let expandedRowIds = [];
 
   /**
    * Specify the ids for rows that should not be expandable
-   * @type {DataTableRowId[]}
+   * @type {ReadonlyArray<DataTableRowId>}
    */
   export let nonExpandableRowIds = [];
 
@@ -90,13 +90,13 @@
 
   /**
    * Specify the row ids to be selected
-   * @type {DataTableRowId[]}
+   * @type {ReadonlyArray<DataTableRowId>}
    */
   export let selectedRowIds = [];
 
   /**
    * Specify the ids of rows that should not be selectable
-   * @type {DataTableRowId[]}
+   * @type {ReadonlyArray<DataTableRowId>}
    */
   export let nonSelectableRowIds = [];
 
diff --git a/src/DataTable/DataTableSkeleton.svelte b/src/DataTable/DataTableSkeleton.svelte
index 84c553bb..2628d9ed 100644
--- a/src/DataTable/DataTableSkeleton.svelte
+++ b/src/DataTable/DataTableSkeleton.svelte
@@ -25,7 +25,7 @@
   /**
    * Set the column headers
    * Supersedes `columns` if value is a non-empty array
-   * @type {string[] | Partial<DataTableHeader>[]}
+   * @type {ReadonlyArray<string | Partial<DataTableHeader>>}
    */
   export let headers = [];
 
diff --git a/src/Dropdown/Dropdown.svelte b/src/Dropdown/Dropdown.svelte
index e78ceb62..936841f2 100644
--- a/src/Dropdown/Dropdown.svelte
+++ b/src/Dropdown/Dropdown.svelte
@@ -9,7 +9,7 @@
 
   /**
    * Set the dropdown items
-   * @type {DropdownItem[]}
+   * @type {ReadonlyArray<DropdownItem>}
    */
   export let items = [];
 
diff --git a/src/FileUploader/FileUploader.svelte b/src/FileUploader/FileUploader.svelte
index b661ab75..4597937e 100644
--- a/src/FileUploader/FileUploader.svelte
+++ b/src/FileUploader/FileUploader.svelte
@@ -1,8 +1,8 @@
 <script>
   /**
-   * @event {File[]} add
-   * @event {File[]} remove
-   * @event {File[]} change
+   * @event {ReadonlyArray<File>} add
+   * @event {ReadonlyArray<File>} remove
+   * @event {ReadonlyArray<File>} change
    */
 
   /**
@@ -16,13 +16,13 @@
 
   /**
    * Specify the accepted file types
-   * @type {string[]}
+   * @type {ReadonlyArray<string>}
    */
   export let accept = [];
 
   /**
    * Obtain a reference to the uploaded files
-   * @type {File[]}
+   * @type {ReadonlyArray<File>}
    */
   export let files = [];
 
diff --git a/src/FileUploader/FileUploaderButton.svelte b/src/FileUploader/FileUploaderButton.svelte
index 1e8b8366..16864fb3 100644
--- a/src/FileUploader/FileUploaderButton.svelte
+++ b/src/FileUploader/FileUploaderButton.svelte
@@ -1,17 +1,17 @@
 <script>
   /**
-   * @event {File[]} change
+   * @event {ReadonlyArray<File>} change
    */
 
   /**
    * Specify the accepted file types
-   * @type {string[]}
+   * @type {ReadonlyArray<string>}
    */
   export let accept = [];
 
   /**
    * Obtain a reference to the uploaded files
-   * @type {File[]}
+   * @type {ReadonlyArray<File>}
    */
   export let files = [];
 
diff --git a/src/FileUploader/FileUploaderDropContainer.svelte b/src/FileUploader/FileUploaderDropContainer.svelte
index 0b82c811..20213bef 100644
--- a/src/FileUploader/FileUploaderDropContainer.svelte
+++ b/src/FileUploader/FileUploaderDropContainer.svelte
@@ -1,18 +1,18 @@
 <script>
   /**
-   * @event {File[]} add
-   * @event {File[]} change
+   * @event {ReadonlyArray<File>} add
+   * @event {ReadonlyArray<File>} change
    */
 
   /**
    * Specify the accepted file types
-   * @type {string[]}
+   * @type {ReadonlyArray<string>}
    */
   export let accept = [];
 
   /**
    * Obtain a reference to the uploaded files
-   * @type {File[]}
+   * @type {ReadonlyArray<File>}
    */
   export let files = [];
 
@@ -20,9 +20,9 @@
   export let multiple = false;
 
   /**
-   * Override the default behavior of validating uploaded files
-   * The default behavior does not validate files
-   * @type {(files: File[]) => File[]}
+   * Override the default behavior of validating uploaded files.
+   * By default, files are not validated
+   * @type {(files: ReadonlyArray<File>) => ReadonlyArray<File>}
    */
   export let validateFiles = (files) => files;
 
diff --git a/src/MultiSelect/MultiSelect.svelte b/src/MultiSelect/MultiSelect.svelte
index 0177aa98..ca6c06a6 100644
--- a/src/MultiSelect/MultiSelect.svelte
+++ b/src/MultiSelect/MultiSelect.svelte
@@ -11,7 +11,7 @@
 
   /**
    * Set the multiselect items
-   * @type {MultiSelectItem[]}
+   * @type {ReadonlyArray<MultiSelectItem>}
    */
   export let items = [];
 
@@ -29,7 +29,7 @@
 
   /**
    * Set the selected ids
-   * @type {MultiSelectItemId[]}
+   * @type {ReadonlyArray<MultiSelectItemId>}
    */
   export let selectedIds = [];
 
diff --git a/src/Pagination/Pagination.svelte b/src/Pagination/Pagination.svelte
index 5738ae1c..948c9270 100644
--- a/src/Pagination/Pagination.svelte
+++ b/src/Pagination/Pagination.svelte
@@ -47,7 +47,7 @@
 
   /**
    * Specify the available page sizes
-   * @type {number[]}
+   * @type {ReadonlyArray<number>}
    */
   export let pageSizes = [10];
 
diff --git a/src/TreeView/TreeView.svelte b/src/TreeView/TreeView.svelte
index 3ca0c7fb..d9c1e668 100644
--- a/src/TreeView/TreeView.svelte
+++ b/src/TreeView/TreeView.svelte
@@ -22,13 +22,13 @@
 
   /**
    * Set the node ids to be selected
-   * @type {TreeNodeId[]}
+   * @type {ReadonlyArray<TreeNodeId>}
    */
   export let selectedIds = [];
 
   /**
    * Set the node ids to be expanded
-   * @type {TreeNodeId[]}
+   * @type {ReadonlyArray<TreeNodeId>}
    */
   export let expandedIds = [];
 
diff --git a/src/UIShell/HeaderSearch.svelte b/src/UIShell/HeaderSearch.svelte
index a806fe5a..7d101f99 100644
--- a/src/UIShell/HeaderSearch.svelte
+++ b/src/UIShell/HeaderSearch.svelte
@@ -19,7 +19,7 @@
 
   /**
    * Render a list of search results
-   * @type {HeaderSearchResult[]}
+   * @type {ReadonlyArray<HeaderSearchResult>}
    */
   export let results = [];