@solid2-aria/stately 0.0.0-stage → 0.0.1

package/dist/data/create-async-list.js

@@ -0,0 +1,276 @@
+/*
+ * Copyright 2020 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+/*
+ * Derived from Adobe React Spectrum: packages/react-stately/src/data/useAsyncList.ts.
+ * Modified for Solid Aria: adapted reactive state, getters, imports, and APIs for Solid 2.
+ * Licensed under Apache-2.0. See LICENSES/Apache-2.0.txt and NOTICE.txt at the repository root.
+ */
+import { getItemKey } from "../utils/get-item-key.js";
+import { createListActions } from "./create-list-data.js";
+import { createMemo, createSignal, merge, onSettled, untrack } from "solid-js";
+// src/data/create-async-list.ts
+function reducer(data, action) {
+	switch (data.state) {
+		case "idle":
+		case "error": return reduceSettledState(data, action);
+		case "loading":
+		case "sorting":
+		case "filtering": return reduceLoadingState(data, action);
+		case "loadingMore": return reduceLoadingMoreState(data, action);
+		default: throw new Error(`Invalid state "${String(data.state)}"`);
+	}
+}
+function reduceSettledState(data, action) {
+	switch (action.type) {
+		case "loading":
+		case "loadingMore":
+		case "sorting":
+		case "filtering": return {
+			...data,
+			abortController: action.abortController,
+			filterText: action.filterText ?? data.filterText,
+			items: action.type === "loading" ? [] : data.items,
+			sortDescriptor: action.sortDescriptor ?? data.sortDescriptor,
+			state: action.type
+		};
+		case "update": return {
+			...data,
+			...action.updater?.(data)
+		};
+		case "success":
+		case "error": return data;
+		default: throw new Error(`Invalid action "${String(action.type)}" in state "${data.state}"`);
+	}
+}
+function reduceLoadingState(data, action) {
+	switch (action.type) {
+		case "success": {
+			if (action.abortController !== data.abortController) return data;
+			const selectedKeys = action.selectedKeys ?? data.selectedKeys;
+			return {
+				...data,
+				abortController: void 0,
+				cursor: action.cursor,
+				filterText: action.filterText ?? data.filterText,
+				items: [...action.items ?? []],
+				selectedKeys: selectedKeys === "all" ? "all" : new Set(selectedKeys),
+				sortDescriptor: action.sortDescriptor ?? data.sortDescriptor,
+				state: "idle"
+			};
+		}
+		case "error":
+			if (action.abortController !== data.abortController) return data;
+			return {
+				...data,
+				abortController: void 0,
+				error: action.error,
+				state: "error"
+			};
+		case "loading":
+		case "loadingMore":
+		case "sorting":
+		case "filtering":
+			data.abortController?.abort("aborting current load and starting new one");
+			return {
+				...data,
+				abortController: action.abortController,
+				filterText: action.filterText ?? data.filterText,
+				items: action.type === "loading" ? [] : data.items,
+				state: action.type
+			};
+		case "update": return {
+			...data,
+			...action.updater?.(data)
+		};
+		default: throw new Error(`Invalid action "${String(action.type)}" in state "${data.state}"`);
+	}
+}
+function reduceLoadingMoreState(data, action) {
+	switch (action.type) {
+		case "success": {
+			const selectedKeys = data.selectedKeys === "all" || action.selectedKeys === "all" ? "all" : /* @__PURE__ */ new Set([...data.selectedKeys, ...action.selectedKeys ?? []]);
+			return {
+				...data,
+				abortController: void 0,
+				cursor: action.cursor,
+				items: [...data.items, ...action.items ?? []],
+				selectedKeys: selectedKeys === "all" ? "all" : new Set(selectedKeys),
+				sortDescriptor: action.sortDescriptor ?? data.sortDescriptor,
+				state: "idle"
+			};
+		}
+		case "error":
+			if (action.abortController !== data.abortController) return data;
+			return {
+				...data,
+				error: action.error,
+				state: "error"
+			};
+		case "loading":
+		case "sorting":
+		case "filtering":
+			data.abortController?.abort();
+			return {
+				...data,
+				abortController: action.abortController,
+				filterText: action.filterText ?? data.filterText,
+				items: action.type === "loading" ? [] : data.items,
+				state: action.type
+			};
+		case "loadingMore":
+			action.abortController?.abort();
+			return data;
+		case "update": return {
+			...data,
+			...action.updater?.(data)
+		};
+		default: throw new Error(`Invalid action "${String(action.type)}" in state "${data.state}"`);
+	}
+}
+/**
+* Manages state for an immutable async loaded list data structure, and provides convenience methods
+* to update the data over time. Manages loading and error states, pagination, and sorting.
+*/
+function createAsyncList(options) {
+	const load = createMemo(() => options.load);
+	const sort = createMemo(() => options.sort);
+	const initialSelectedKeys = createMemo(() => options.initialSelectedKeys);
+	const initialSortDescriptor = createMemo(() => options.initialSortDescriptor);
+	const getKey = createMemo(() => options.getKey ?? getItemKey);
+	const initialFilterText = createMemo(() => options.initialFilterText ?? "");
+	const [data, setData] = createSignal({
+		error: void 0,
+		filterText: initialFilterText(),
+		items: [],
+		selectedKeys: initialSelectedKeys() === "all" ? "all" : new Set(initialSelectedKeys()),
+		sortDescriptor: initialSortDescriptor(),
+		state: "idle"
+	}, { ownedWrite: true });
+	let pendingData = untrack(data);
+	const dispatch = (action) => {
+		pendingData = reducer(pendingData, action);
+		setData(pendingData);
+	};
+	const dispatchFetch = async (action, fn) => {
+		const currentData = pendingData;
+		const currentLoad = load();
+		const abortController = new AbortController();
+		try {
+			dispatch({
+				...action,
+				abortController
+			});
+			if (abortController.signal.aborted) return;
+			const previousFilterText = action.filterText ?? currentData.filterText;
+			const response = await fn({
+				cursor: action.type === "loadingMore" ? currentData.cursor : void 0,
+				filterText: previousFilterText,
+				items: [...currentData.items],
+				loadingState: currentData.state,
+				selectedKeys: currentData.selectedKeys,
+				signal: abortController.signal,
+				sortDescriptor: action.sortDescriptor ?? currentData.sortDescriptor
+			});
+			const filterText = response.filterText ?? previousFilterText;
+			dispatch({
+				type: "success",
+				...response,
+				abortController
+			});
+			if (filterText && filterText !== previousFilterText && !abortController.signal.aborted) dispatchFetch({
+				filterText,
+				type: "filtering"
+			}, currentLoad);
+		} catch (error) {
+			if (abortController.signal.aborted) return;
+			dispatch({
+				abortController,
+				error: error instanceof Error ? error : new Error(String(error)),
+				type: "error"
+			});
+		}
+	};
+	onSettled(() => {
+		dispatchFetch({ type: "loading" }, load());
+		return () => pendingData.abortController?.abort();
+	});
+	return merge({
+		get error() {
+			return data().error;
+		},
+		get filterText() {
+			return data().filterText;
+		},
+		getItem(key) {
+			return data().items.find((item) => {
+				return getKey()(item) === key;
+			});
+		},
+		get isLoading() {
+			return data().state === "loading" || data().state === "loadingMore" || data().state === "sorting" || data().state === "filtering";
+		},
+		get items() {
+			return data().items;
+		},
+		loadMore() {
+			const currentData = pendingData;
+			const currentLoad = load();
+			if (currentData.state === "loading" || currentData.state === "loadingMore" || currentData.state === "filtering" || currentData.cursor === null || currentData.cursor === void 0) return;
+			dispatchFetch({ type: "loadingMore" }, currentLoad);
+		},
+		get loadingState() {
+			return data().state;
+		},
+		reload() {
+			const currentLoad = load();
+			dispatchFetch({ type: "loading" }, currentLoad);
+		},
+		get selectedKeys() {
+			return data().selectedKeys;
+		},
+		sort(sortDescriptor) {
+			const currentSort = sort();
+			const currentLoad = load();
+			dispatchFetch({
+				sortDescriptor,
+				type: "sorting"
+			}, async (loadOptions) => currentSort ? await currentSort({
+				...loadOptions,
+				sortDescriptor
+			}) : await currentLoad(loadOptions));
+		},
+		get sortDescriptor() {
+			return data().sortDescriptor;
+		}
+	}, createListActions(merge(options, {
+		get cursor() {
+			return pendingData.cursor;
+		},
+		get getKey() {
+			return getKey();
+		}
+	}), (fn) => {
+		dispatch({
+			type: "update",
+			updater: fn
+		});
+	}), { setFilterText(filterText) {
+		const currentLoad = load();
+		dispatchFetch({
+			filterText,
+			type: "filtering"
+		}, currentLoad);
+	} });
+}
+export { createAsyncList };
+
+//# sourceMappingURL=create-async-list.js.map

package/dist/data/create-async-list.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-async-list.js","names":[],"sources":["../../src/data/create-async-list.ts"],"sourcesContent":["/*\n * Copyright 2020 Adobe. All rights reserved.\n * This file is licensed to you under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License. You may obtain a copy\n * of the License at http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software distributed under\n * the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\n * OF ANY KIND, either express or implied. See the License for the specific language\n * governing permissions and limitations under the License.\n */\n/*\n * Derived from Adobe React Spectrum: packages/react-stately/src/data/useAsyncList.ts.\n * Modified for Solid Aria: adapted reactive state, getters, imports, and APIs for Solid 2.\n * Licensed under Apache-2.0. See LICENSES/Apache-2.0.txt and NOTICE.txt at the repository root.\n */\n\nimport type {\n  Key,\n  LoadingState,\n  Selection,\n  SortDescriptor,\n} from \"@solid2-aria/types-shared\";\nimport { createMemo, createSignal, untrack, merge, onSettled } from \"solid-js\";\n\nimport { getItemKey } from \"../utils/get-item-key\";\nimport { createListActions } from \"./create-list-data\";\nimport type { ListData, ListState } from \"./create-list-data\";\n\nexport interface AsyncListOptions<T, C> {\n  /** The keys for the initially selected items. */\n  initialSelectedKeys?: Iterable<Key>;\n  /** The initial sort descriptor. */\n  initialSortDescriptor?: SortDescriptor;\n  /** The initial filter text. */\n  initialFilterText?: string;\n  /** A function that returns a unique key for an item object. */\n  getKey?: (item: T) => Key;\n  /** A function that loads the data for the items in the list. */\n  load: AsyncListLoadFunction<T, C>;\n  /**\n   * An optional function that performs sorting. If not provided,\n   * then `sortDescriptor` is passed to the `load` function.\n   */\n  sort?: AsyncListLoadFunction<\n    T,\n    C,\n    AsyncListLoadOptions<T, C> & {\n      sortDescriptor: SortDescriptor;\n    }\n  >;\n}\n\nexport type AsyncListLoadFunction<\n  T,\n  C,\n  S extends AsyncListLoadOptions<T, C> = AsyncListLoadOptions<T, C>,\n> = (\n  state: S\n) => AsyncListStateUpdate<T, C> | Promise<AsyncListStateUpdate<T, C>>;\n\nexport interface AsyncListLoadOptions<T, C> {\n  /** The items currently in the list. */\n  items: T[];\n  /** The keys of the currently selected items in the list. */\n  selectedKeys: Selection;\n  /** The current sort descriptor for the list. */\n  sortDescriptor?: SortDescriptor;\n  /** An abort signal used to notify the load function that the request has been aborted. */\n  signal: AbortSignal;\n  /** The pagination cursor returned from the last page load. */\n  cursor?: C;\n  /** The current filter text used to perform server side filtering. */\n  filterText?: string;\n  /** The current loading state of the list. */\n  loadingState?: LoadingState;\n}\n\nexport interface AsyncListStateUpdate<T, C> {\n  /** The new items to append to the list. */\n  items: Iterable<T>;\n  /** The keys to add to the selection. */\n  selectedKeys?: Iterable<Key>;\n  /** The sort descriptor to set. */\n  sortDescriptor?: SortDescriptor;\n  /** The pagination cursor to be used for the next page load. */\n  cursor?: C;\n  /** The updated filter text for the list. */\n  filterText?: string;\n}\n\ninterface AsyncListState<T, C> extends ListState<T> {\n  state: LoadingState;\n  items: T[];\n  // disabledKeys?: Iterable<Key>,\n  selectedKeys: Selection;\n  // selectedKey?: Key,\n  // expandedKeys?: Iterable<Key>,\n  sortDescriptor?: SortDescriptor;\n  error?: Error;\n  abortController?: AbortController;\n  cursor?: C;\n}\n\ntype ActionType =\n  | \"success\"\n  | \"error\"\n  | \"loading\"\n  | \"loadingMore\"\n  | \"sorting\"\n  | \"update\"\n  | \"filtering\";\n\ninterface Action<T, C> {\n  type: ActionType;\n  items?: Iterable<T>;\n  selectedKeys?: Iterable<Key>;\n  sortDescriptor?: SortDescriptor;\n  error?: Error;\n  abortController?: AbortController;\n  updater?: (state: ListState<T>) => ListState<T>;\n  cursor?: C;\n  filterText?: string;\n}\n\nexport interface AsyncListData<T> extends ListData<T> {\n  /** Whether data is currently being loaded. */\n  isLoading: boolean;\n  /** If loading data failed, then this contains the error that occurred. */\n  error?: Error;\n  // disabledKeys?: Set<Key>,\n  // selectedKey?: Key,\n  // expandedKeys?: Set<Key>,\n  /** The current sort descriptor for the list. */\n  sortDescriptor?: SortDescriptor;\n  /** Reloads the data in the list. */\n  reload: () => void;\n  /** Loads the next page of data in the list. */\n  loadMore: () => void;\n  /** Triggers sorting for the list. */\n  sort: (descriptor: SortDescriptor) => void;\n  /** The current loading state for the list. */\n  loadingState: LoadingState;\n}\n\nfunction reducer<T, C>(\n  data: AsyncListState<T, C>,\n  action: Action<T, C>\n): AsyncListState<T, C> {\n  switch (data.state) {\n    case \"idle\":\n    case \"error\": {\n      return reduceSettledState(data, action);\n    }\n\n    case \"loading\":\n    case \"sorting\":\n    case \"filtering\": {\n      return reduceLoadingState(data, action);\n    }\n\n    case \"loadingMore\": {\n      return reduceLoadingMoreState(data, action);\n    }\n\n    default: {\n      throw new Error(`Invalid state \"${String(data.state)}\"`);\n    }\n  }\n}\n\nfunction reduceSettledState<T, C>(\n  data: AsyncListState<T, C>,\n  action: Action<T, C>\n): AsyncListState<T, C> {\n  switch (action.type) {\n    case \"loading\":\n    case \"loadingMore\":\n    case \"sorting\":\n    case \"filtering\": {\n      return {\n        ...data,\n        abortController: action.abortController,\n        filterText: action.filterText ?? data.filterText,\n        items: action.type === \"loading\" ? [] : data.items,\n        sortDescriptor: action.sortDescriptor ?? data.sortDescriptor,\n        state: action.type,\n      };\n    }\n\n    case \"update\": {\n      return {\n        ...data,\n        ...action.updater?.(data),\n      };\n    }\n\n    case \"success\":\n    case \"error\": {\n      return data;\n    }\n\n    default: {\n      throw new Error(\n        `Invalid action \"${String(action.type)}\" in state \"${data.state}\"`\n      );\n    }\n  }\n}\n\nfunction reduceLoadingState<T, C>(\n  data: AsyncListState<T, C>,\n  action: Action<T, C>\n): AsyncListState<T, C> {\n  switch (action.type) {\n    case \"success\": {\n      // Ignore if there is a newer abortcontroller in state.\n      // This means that multiple requests were going at once.\n      // We want to take only the latest result.\n      if (action.abortController !== data.abortController) {\n        return data;\n      }\n\n      const selectedKeys = action.selectedKeys ?? data.selectedKeys;\n\n      return {\n        ...data,\n        abortController: undefined,\n        cursor: action.cursor,\n        filterText: action.filterText ?? data.filterText,\n        items: [...(action.items ?? [])],\n        selectedKeys: selectedKeys === \"all\" ? \"all\" : new Set(selectedKeys),\n        sortDescriptor: action.sortDescriptor ?? data.sortDescriptor,\n        state: \"idle\",\n      };\n    }\n\n    case \"error\": {\n      if (action.abortController !== data.abortController) {\n        return data;\n      }\n\n      return {\n        ...data,\n        abortController: undefined,\n        error: action.error,\n        state: \"error\",\n      };\n    }\n\n    case \"loading\":\n    case \"loadingMore\":\n    case \"sorting\":\n    case \"filtering\": {\n      // We're already loading, and another load was triggered at the same time.\n      // We need to abort the previous load and start a new one.\n      data.abortController?.abort(\"aborting current load and starting new one\");\n\n      return {\n        ...data,\n        abortController: action.abortController,\n        filterText: action.filterText ?? data.filterText,\n        items: action.type === \"loading\" ? [] : data.items,\n        state: action.type,\n      };\n    }\n\n    case \"update\": {\n      // We're already loading, and an update happened at the same time (e.g. selectedKey changed).\n      // Update data but don't abort previous load.\n      return {\n        ...data,\n        ...action.updater?.(data),\n      };\n    }\n\n    default: {\n      throw new Error(\n        `Invalid action \"${String(action.type)}\" in state \"${data.state}\"`\n      );\n    }\n  }\n}\n\nfunction reduceLoadingMoreState<T, C>(\n  data: AsyncListState<T, C>,\n  action: Action<T, C>\n): AsyncListState<T, C> {\n  switch (action.type) {\n    case \"success\": {\n      const selectedKeys =\n        data.selectedKeys === \"all\" || action.selectedKeys === \"all\"\n          ? \"all\"\n          : new Set([...data.selectedKeys, ...(action.selectedKeys ?? [])]);\n\n      // Append the new items\n      return {\n        ...data,\n        abortController: undefined,\n        cursor: action.cursor,\n        items: [...data.items, ...(action.items ?? [])],\n        selectedKeys: selectedKeys === \"all\" ? \"all\" : new Set(selectedKeys),\n        sortDescriptor: action.sortDescriptor ?? data.sortDescriptor,\n        state: \"idle\",\n      };\n    }\n\n    case \"error\": {\n      if (action.abortController !== data.abortController) {\n        return data;\n      }\n\n      return {\n        ...data,\n        error: action.error,\n        state: \"error\",\n      };\n    }\n\n    case \"loading\":\n    case \"sorting\":\n    case \"filtering\": {\n      // We're already loading more, and another load was triggered at the same time.\n      // We need to abort the previous load more and start a new one.\n      data.abortController?.abort();\n\n      return {\n        ...data,\n        abortController: action.abortController,\n        filterText: action.filterText ?? data.filterText,\n        items: action.type === \"loading\" ? [] : data.items,\n        state: action.type,\n      };\n    }\n\n    case \"loadingMore\": {\n      // If already loading more and another loading more is triggered, abort the new load more since\n      // it is a duplicate request since the cursor hasn't been updated.\n      // Do not overwrite the data.abortController\n      action.abortController?.abort();\n\n      return data;\n    }\n\n    case \"update\": {\n      // We're already loading, and an update happened at the same time (e.g. selectedKey changed).\n      // Update data but don't abort previous load.\n      return {\n        ...data,\n        ...action.updater?.(data),\n      };\n    }\n\n    default: {\n      throw new Error(\n        `Invalid action \"${String(action.type)}\" in state \"${data.state}\"`\n      );\n    }\n  }\n}\n\n/**\n * Manages state for an immutable async loaded list data structure, and provides convenience methods\n * to update the data over time. Manages loading and error states, pagination, and sorting.\n */\nexport function createAsyncList<T, C = string>(\n  options: AsyncListOptions<T, C>\n): AsyncListData<T> {\n  const load = createMemo(() => options.load);\n  const sort = createMemo(() => options.sort);\n  const initialSelectedKeys = createMemo(() => options.initialSelectedKeys);\n  const initialSortDescriptor = createMemo(() => options.initialSortDescriptor);\n  const getKey = createMemo(() => options.getKey ?? getItemKey);\n  const initialFilterText = createMemo(() => options.initialFilterText ?? \"\");\n\n  const [data, setData] = createSignal<AsyncListState<T, C>>(\n    {\n      error: undefined,\n      filterText: initialFilterText(),\n      items: [],\n      selectedKeys:\n        initialSelectedKeys() === \"all\"\n          ? \"all\"\n          : new Set(initialSelectedKeys()),\n      sortDescriptor: initialSortDescriptor(),\n      state: \"idle\",\n    },\n    { ownedWrite: true }\n  );\n\n  let pendingData = untrack(data);\n\n  const dispatch = (action: Action<T, C>) => {\n    pendingData = reducer(pendingData, action);\n    setData(pendingData);\n  };\n\n  const dispatchFetch = async (\n    action: Action<T, C>,\n    fn: AsyncListLoadFunction<T, C>\n  ) => {\n    const currentData = pendingData;\n    const currentLoad = load();\n    const abortController = new AbortController();\n\n    try {\n      dispatch({ ...action, abortController });\n\n      if (abortController.signal.aborted) {\n        return;\n      }\n\n      const previousFilterText = action.filterText ?? currentData.filterText;\n\n      const response = await fn({\n        cursor: action.type === \"loadingMore\" ? currentData.cursor : undefined,\n        filterText: previousFilterText,\n        items: [...currentData.items],\n        loadingState: currentData.state,\n        selectedKeys: currentData.selectedKeys,\n        signal: abortController.signal,\n        sortDescriptor: action.sortDescriptor ?? currentData.sortDescriptor,\n      });\n\n      const filterText = response.filterText ?? previousFilterText;\n      dispatch({ type: \"success\", ...response, abortController });\n\n      // Fetch a new filtered list if filterText is updated via `load` response func rather than list.setFilterText\n      // Only do this if not aborted (e.g. user triggers another filter action before load completes)\n      if (\n        filterText &&\n        filterText !== previousFilterText &&\n        !abortController.signal.aborted\n      ) {\n        void dispatchFetch({ filterText, type: \"filtering\" }, currentLoad);\n      }\n    } catch (error) {\n      if (abortController.signal.aborted) {\n        return;\n      }\n\n      dispatch({\n        abortController,\n        error: error instanceof Error ? error : new Error(String(error)),\n        type: \"error\",\n      });\n    }\n  };\n\n  onSettled(() => {\n    void dispatchFetch({ type: \"loading\" }, load());\n\n    return () => pendingData.abortController?.abort();\n  });\n\n  return merge(\n    {\n      get error() {\n        return data().error;\n      },\n      get filterText() {\n        return data().filterText;\n      },\n      getItem(key: Key) {\n        const currentData = data();\n\n        return currentData.items.find((item) => {\n          const currentGetKey = getKey();\n\n          return currentGetKey(item) === key;\n        });\n      },\n      get isLoading() {\n        return (\n          data().state === \"loading\" ||\n          data().state === \"loadingMore\" ||\n          data().state === \"sorting\" ||\n          data().state === \"filtering\"\n        );\n      },\n      get items() {\n        return data().items;\n      },\n      loadMore() {\n        const currentData = pendingData;\n        const currentLoad = load();\n\n        // Ignore if already loading more or if performing server side filtering.\n        if (\n          currentData.state === \"loading\" ||\n          currentData.state === \"loadingMore\" ||\n          currentData.state === \"filtering\" ||\n          currentData.cursor === null ||\n          currentData.cursor === undefined\n        ) {\n          return;\n        }\n\n        void dispatchFetch({ type: \"loadingMore\" }, currentLoad);\n      },\n      get loadingState() {\n        return data().state;\n      },\n      reload() {\n        const currentLoad = load();\n        void dispatchFetch({ type: \"loading\" }, currentLoad);\n      },\n      get selectedKeys() {\n        return data().selectedKeys;\n      },\n      sort(sortDescriptor: SortDescriptor) {\n        const currentSort = sort();\n        const currentLoad = load();\n        void dispatchFetch(\n          { sortDescriptor, type: \"sorting\" },\n          async (loadOptions) =>\n            currentSort\n              ? await currentSort({ ...loadOptions, sortDescriptor })\n              : await currentLoad(loadOptions)\n        );\n      },\n      get sortDescriptor() {\n        return data().sortDescriptor;\n      },\n    } satisfies Partial<AsyncListData<T>>,\n    createListActions(\n      merge(options, {\n        get cursor() {\n          return pendingData.cursor;\n        },\n        get getKey() {\n          return getKey();\n        },\n      }),\n      (fn) => {\n        dispatch({ type: \"update\", updater: fn });\n      }\n    ),\n    {\n      setFilterText(filterText: string) {\n        const currentLoad = load();\n        void dispatchFetch({ filterText, type: \"filtering\" }, currentLoad);\n      },\n    } satisfies Partial<AsyncListData<T>>\n  );\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAiJA,SAAS,QACP,MACA,QACsB;CACtB,QAAQ,KAAK,OAAb;EACE,KAAK;EACL,KAAK,SACH,OAAO,mBAAmB,MAAM,MAAM;EAGxC,KAAK;EACL,KAAK;EACL,KAAK,aACH,OAAO,mBAAmB,MAAM,MAAM;EAGxC,KAAK,eACH,OAAO,uBAAuB,MAAM,MAAM;EAG5C,SACE,MAAM,IAAI,MAAM,kBAAkB,OAAO,KAAK,KAAK,EAAE,EAAE;CAE3D;AACF;AAEA,SAAS,mBACP,MACA,QACsB;CACtB,QAAQ,OAAO,MAAf;EACE,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK,aACH,OAAO;GACL,GAAG;GACH,iBAAiB,OAAO;GACxB,YAAY,OAAO,cAAc,KAAK;GACtC,OAAO,OAAO,SAAS,YAAY,CAAC,IAAI,KAAK;GAC7C,gBAAgB,OAAO,kBAAkB,KAAK;GAC9C,OAAO,OAAO;EAChB;EAGF,KAAK,UACH,OAAO;GACL,GAAG;GACH,GAAG,OAAO,UAAU,IAAI;EAC1B;EAGF,KAAK;EACL,KAAK,SACH,OAAO;EAGT,SACE,MAAM,IAAI,MACR,mBAAmB,OAAO,OAAO,IAAI,EAAE,cAAc,KAAK,MAAM,EAClE;CAEJ;AACF;AAEA,SAAS,mBACP,MACA,QACsB;CACtB,QAAQ,OAAO,MAAf;EACE,KAAK,WAAW;GAId,IAAI,OAAO,oBAAoB,KAAK,iBAClC,OAAO;GAGT,MAAM,eAAe,OAAO,gBAAgB,KAAK;GAEjD,OAAO;IACL,GAAG;IACH,iBAAiB,KAAA;IACjB,QAAQ,OAAO;IACf,YAAY,OAAO,cAAc,KAAK;IACtC,OAAO,CAAC,GAAI,OAAO,SAAS,CAAC,CAAE;IAC/B,cAAc,iBAAiB,QAAQ,QAAQ,IAAI,IAAI,YAAY;IACnE,gBAAgB,OAAO,kBAAkB,KAAK;IAC9C,OAAO;GACT;EACF;EAEA,KAAK;GACH,IAAI,OAAO,oBAAoB,KAAK,iBAClC,OAAO;GAGT,OAAO;IACL,GAAG;IACH,iBAAiB,KAAA;IACjB,OAAO,OAAO;IACd,OAAO;GACT;EAGF,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK;GAGH,KAAK,iBAAiB,MAAM,4CAA4C;GAExE,OAAO;IACL,GAAG;IACH,iBAAiB,OAAO;IACxB,YAAY,OAAO,cAAc,KAAK;IACtC,OAAO,OAAO,SAAS,YAAY,CAAC,IAAI,KAAK;IAC7C,OAAO,OAAO;GAChB;EAGF,KAAK,UAGH,OAAO;GACL,GAAG;GACH,GAAG,OAAO,UAAU,IAAI;EAC1B;EAGF,SACE,MAAM,IAAI,MACR,mBAAmB,OAAO,OAAO,IAAI,EAAE,cAAc,KAAK,MAAM,EAClE;CAEJ;AACF;AAEA,SAAS,uBACP,MACA,QACsB;CACtB,QAAQ,OAAO,MAAf;EACE,KAAK,WAAW;GACd,MAAM,eACJ,KAAK,iBAAiB,SAAS,OAAO,iBAAiB,QACnD,wBACA,IAAI,IAAI,CAAC,GAAG,KAAK,cAAc,GAAI,OAAO,gBAAgB,CAAC,CAAE,CAAC;GAGpE,OAAO;IACL,GAAG;IACH,iBAAiB,KAAA;IACjB,QAAQ,OAAO;IACf,OAAO,CAAC,GAAG,KAAK,OAAO,GAAI,OAAO,SAAS,CAAC,CAAE;IAC9C,cAAc,iBAAiB,QAAQ,QAAQ,IAAI,IAAI,YAAY;IACnE,gBAAgB,OAAO,kBAAkB,KAAK;IAC9C,OAAO;GACT;EACF;EAEA,KAAK;GACH,IAAI,OAAO,oBAAoB,KAAK,iBAClC,OAAO;GAGT,OAAO;IACL,GAAG;IACH,OAAO,OAAO;IACd,OAAO;GACT;EAGF,KAAK;EACL,KAAK;EACL,KAAK;GAGH,KAAK,iBAAiB,MAAM;GAE5B,OAAO;IACL,GAAG;IACH,iBAAiB,OAAO;IACxB,YAAY,OAAO,cAAc,KAAK;IACtC,OAAO,OAAO,SAAS,YAAY,CAAC,IAAI,KAAK;IAC7C,OAAO,OAAO;GAChB;EAGF,KAAK;GAIH,OAAO,iBAAiB,MAAM;GAE9B,OAAO;EAGT,KAAK,UAGH,OAAO;GACL,GAAG;GACH,GAAG,OAAO,UAAU,IAAI;EAC1B;EAGF,SACE,MAAM,IAAI,MACR,mBAAmB,OAAO,OAAO,IAAI,EAAE,cAAc,KAAK,MAAM,EAClE;CAEJ;AACF;;;;;AAMA,SAAgB,gBACd,SACkB;CAClB,MAAM,OAAO,iBAAiB,QAAQ,IAAI;CAC1C,MAAM,OAAO,iBAAiB,QAAQ,IAAI;CAC1C,MAAM,sBAAsB,iBAAiB,QAAQ,mBAAmB;CACxE,MAAM,wBAAwB,iBAAiB,QAAQ,qBAAqB;CAC5E,MAAM,SAAS,iBAAiB,QAAQ,UAAU,UAAU;CAC5D,MAAM,oBAAoB,iBAAiB,QAAQ,qBAAqB,EAAE;CAE1E,MAAM,CAAC,MAAM,WAAW,aACtB;EACE,OAAO,KAAA;EACP,YAAY,kBAAkB;EAC9B,OAAO,CAAC;EACR,cACE,oBAAoB,MAAM,QACtB,QACA,IAAI,IAAI,oBAAoB,CAAC;EACnC,gBAAgB,sBAAsB;EACtC,OAAO;CACT,GACA,EAAE,YAAY,KAAK,CACrB;CAEA,IAAI,cAAc,QAAQ,IAAI;CAE9B,MAAM,YAAY,WAAyB;EACzC,cAAc,QAAQ,aAAa,MAAM;EACzC,QAAQ,WAAW;CACrB;CAEA,MAAM,gBAAgB,OACpB,QACA,OACG;EACH,MAAM,cAAc;EACpB,MAAM,cAAc,KAAK;EACzB,MAAM,kBAAkB,IAAI,gBAAgB;EAE5C,IAAI;GACF,SAAS;IAAE,GAAG;IAAQ;GAAgB,CAAC;GAEvC,IAAI,gBAAgB,OAAO,SACzB;GAGF,MAAM,qBAAqB,OAAO,cAAc,YAAY;GAE5D,MAAM,WAAW,MAAM,GAAG;IACxB,QAAQ,OAAO,SAAS,gBAAgB,YAAY,SAAS,KAAA;IAC7D,YAAY;IACZ,OAAO,CAAC,GAAG,YAAY,KAAK;IAC5B,cAAc,YAAY;IAC1B,cAAc,YAAY;IAC1B,QAAQ,gBAAgB;IACxB,gBAAgB,OAAO,kBAAkB,YAAY;GACvD,CAAC;GAED,MAAM,aAAa,SAAS,cAAc;GAC1C,SAAS;IAAE,MAAM;IAAW,GAAG;IAAU;GAAgB,CAAC;GAI1D,IACE,cACA,eAAe,sBACf,CAAC,gBAAgB,OAAO,SAExB,cAAmB;IAAE;IAAY,MAAM;GAAY,GAAG,WAAW;EAErE,SAAS,OAAO;GACd,IAAI,gBAAgB,OAAO,SACzB;GAGF,SAAS;IACP;IACA,OAAO,iBAAiB,QAAQ,QAAQ,IAAI,MAAM,OAAO,KAAK,CAAC;IAC/D,MAAM;GACR,CAAC;EACH;CACF;CAEA,gBAAgB;EACd,cAAmB,EAAE,MAAM,UAAU,GAAG,KAAK,CAAC;EAE9C,aAAa,YAAY,iBAAiB,MAAM;CAClD,CAAC;CAED,OAAO,MACL;EACE,IAAI,QAAQ;GACV,OAAO,KAAK,CAAC,CAAC;EAChB;EACA,IAAI,aAAa;GACf,OAAO,KAAK,CAAC,CAAC;EAChB;EACA,QAAQ,KAAU;GAGhB,OAFoB,KAEH,CAAC,CAAC,MAAM,MAAM,SAAS;IAGtC,OAFsB,OAEH,CAAC,CAAC,IAAI,MAAM;GACjC,CAAC;EACH;EACA,IAAI,YAAY;GACd,OACE,KAAK,CAAC,CAAC,UAAU,aACjB,KAAK,CAAC,CAAC,UAAU,iBACjB,KAAK,CAAC,CAAC,UAAU,aACjB,KAAK,CAAC,CAAC,UAAU;EAErB;EACA,IAAI,QAAQ;GACV,OAAO,KAAK,CAAC,CAAC;EAChB;EACA,WAAW;GACT,MAAM,cAAc;GACpB,MAAM,cAAc,KAAK;GAGzB,IACE,YAAY,UAAU,aACtB,YAAY,UAAU,iBACtB,YAAY,UAAU,eACtB,YAAY,WAAW,QACvB,YAAY,WAAW,KAAA,GAEvB;GAGF,cAAmB,EAAE,MAAM,cAAc,GAAG,WAAW;EACzD;EACA,IAAI,eAAe;GACjB,OAAO,KAAK,CAAC,CAAC;EAChB;EACA,SAAS;GACP,MAAM,cAAc,KAAK;GACzB,cAAmB,EAAE,MAAM,UAAU,GAAG,WAAW;EACrD;EACA,IAAI,eAAe;GACjB,OAAO,KAAK,CAAC,CAAC;EAChB;EACA,KAAK,gBAAgC;GACnC,MAAM,cAAc,KAAK;GACzB,MAAM,cAAc,KAAK;GACzB,cACE;IAAE;IAAgB,MAAM;GAAU,GAClC,OAAO,gBACL,cACI,MAAM,YAAY;IAAE,GAAG;IAAa;GAAe,CAAC,IACpD,MAAM,YAAY,WAAW,CACrC;EACF;EACA,IAAI,iBAAiB;GACnB,OAAO,KAAK,CAAC,CAAC;EAChB;CACF,GACA,kBACE,MAAM,SAAS;EACb,IAAI,SAAS;GACX,OAAO,YAAY;EACrB;EACA,IAAI,SAAS;GACX,OAAO,OAAO;EAChB;CACF,CAAC,IACA,OAAO;EACN,SAAS;GAAE,MAAM;GAAU,SAAS;EAAG,CAAC;CAC1C,CACF,GACA,EACE,cAAc,YAAoB;EAChC,MAAM,cAAc,KAAK;EACzB,cAAmB;GAAE;GAAY,MAAM;EAAY,GAAG,WAAW;CACnE,EACF,CACF;AACF"}

package/dist/data/create-list-data.d.ts

@@ -0,0 +1,140 @@
+/*
+ * Copyright 2020 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+/*
+ * Derived from Adobe React Spectrum: packages/react-stately/src/data/useListData.ts.
+ * Modified for Solid Aria: adapted reactive state, getters, imports, and APIs for Solid 2.
+ * Licensed under Apache-2.0. See LICENSES/Apache-2.0.txt and NOTICE.txt at the repository root.
+ */
+import { Key, Selection } from "@solid2-aria/types-shared";
+export interface ListOptions<T> {
+  /** Initial items in the list. */
+  initialItems?: T[];
+  /** The keys for the initially selected items. */
+  initialSelectedKeys?: "all" | Iterable<Key>;
+  /** The initial text to filter the list by. */
+  initialFilterText?: string;
+  /** A function that returns a unique key for an item object. */
+  getKey?: (item: T) => Key;
+  /** A function that returns whether a item matches the current filter text. */
+  filter?: (item: T, filterText: string) => boolean;
+}
+export interface ListData<T> {
+  /** The items in the list. */
+  items: T[];
+  /** The keys of the currently selected items in the list. */
+  selectedKeys: Selection;
+  /** Sets the selected keys. */
+  setSelectedKeys: (keys: Selection) => void;
+  /** Adds the given keys to the current selected keys. */
+  addKeysToSelection: (keys: Selection) => void;
+  /** Removes the given keys from the current selected keys. */
+  removeKeysFromSelection: (keys: Selection) => void;
+  /** The current filter text. */
+  filterText: string;
+  /** Sets the filter text. */
+  setFilterText: (filterText: string) => void;
+  /**
+   * Gets an item from the list by key.
+   *
+   * @param key - The key of the item to retrieve.
+   */
+  getItem: (key: Key) => T | undefined;
+  /**
+   * Inserts items into the list at the given index.
+   *
+   * @param index - The index to insert into.
+   * @param values - The values to insert.
+   */
+  insert: (index: number, ...values: T[]) => void;
+  /**
+   * Inserts items into the list before the item at the given key.
+   *
+   * @param key - The key of the item to insert before.
+   * @param values - The values to insert.
+   */
+  insertBefore: (key: Key, ...values: T[]) => void;
+  /**
+   * Inserts items into the list after the item at the given key.
+   *
+   * @param key - The key of the item to insert after.
+   * @param values - The values to insert.
+   */
+  insertAfter: (key: Key, ...values: T[]) => void;
+  /**
+   * Appends items to the list.
+   *
+   * @param values - The values to insert.
+   */
+  append: (...values: T[]) => void;
+  /**
+   * Prepends items to the list.
+   *
+   * @param value - The value to insert.
+   */
+  prepend: (...values: T[]) => void;
+  /**
+   * Removes items from the list by their keys.
+   *
+   * @param keys - The keys of the item to remove.
+   */
+  remove: (...keys: Key[]) => void;
+  /**
+   * Removes all items from the list that are currently
+   * in the set of selected items.
+   */
+  removeSelectedItems: () => void;
+  /**
+   * Moves an item within the list.
+   *
+   * @param key - The key of the item to move.
+   * @param toIndex - The index to move the item to.
+   */
+  move: (key: Key, toIndex: number) => void;
+  /**
+   * Moves one or more items before a given key.
+   *
+   * @param key - The key of the item to move the items before.
+   * @param keys - The keys of the items to move.
+   */
+  moveBefore: (key: Key, keys: Iterable<Key>) => void;
+  /**
+   * Moves one or more items after a given key.
+   *
+   * @param key - The key of the item to move the items after.
+   * @param keys - The keys of the items to move.
+   */
+  moveAfter: (key: Key, keys: Iterable<Key>) => void;
+  /**
+   * Updates an item in the list.
+   *
+   * @param key - The key of the item to update.
+   * @param newValue - The new value for the item, or a function that returns the new value based on
+   *   the previous value.
+   */
+  update: (key: Key, newValue: T | ((prev: T) => T)) => void;
+}
+export interface ListState<T> {
+  items: T[];
+  selectedKeys: Selection;
+  filterText: string;
+}
+interface CreateListOptions<T, C> extends ListOptions<T> {
+  cursor?: C;
+}
+/**
+ * Manages state for an immutable list data structure, and provides convenience methods to
+ * update the data over time.
+ */
+export declare function createListData<T>(options: ListOptions<T>): ListData<T>;
+export declare function createListActions<T, C>(opts: CreateListOptions<T, C>, dispatch: (updater: (state: ListState<T>) => ListState<T>) => void): Omit<ListData<T>, "items" | "selectedKeys" | "getItem" | "filterText">;
+export {};
+//# sourceMappingURL=create-list-data.d.ts.map