Merge branch 'main' into main

Author: cansuaa

Diff for: src/__tests__/operations/paginate.test.ts

@@ -93,7 +93,7 @@ test('displays an out of range page', () => {
     items: processed,
     pagesCount,
     actualPageIndex,
-  } = processItems(items, { currentPageIndex: 3 }, { pagination: {} });
+  } = processItems(items, { currentPageIndex: 3 }, { pagination: { allowPageOutOfRange: true } });
   expect(actualPageIndex).toEqual(3);
   expect(pagesCount).toEqual(2);
   expect(processed).toHaveLength(0);

Diff for: src/interfaces.ts

@@ -44,7 +44,7 @@ export interface UseCollectionOptions<T> {
     freeTextFiltering?: PropertyFilterFreeTextFiltering;
   };
   sorting?: { defaultState?: SortingState<T> };
-  pagination?: { defaultPage?: number; pageSize?: number };
+  pagination?: { defaultPage?: number; pageSize?: number; allowPageOutOfRange?: boolean };
   selection?: {
     defaultSelectedItems?: ReadonlyArray<T>;
     keepSelection?: boolean;

Diff for: src/operations/pagination.ts

@@ -16,7 +16,7 @@ export function createPageProps<T>(
   const pageSize = pagination.pageSize ?? DEFAULT_PAGE_SIZE;
   const pagesCount = Math.ceil(items.length / pageSize);
   let pageIndex = currentPageIndex ?? 1;
-  if (pageIndex < 1 || Number.isNaN(pageIndex)) {
+  if (pageIndex < 1 || (pageIndex > pagesCount && !pagination.allowPageOutOfRange) || Number.isNaN(pageIndex)) {
     pageIndex = 1;
   }
   return { pageSize, pagesCount, pageIndex };

Diff for: src/types.ts

@@ -5,5 +5,10 @@
  * subset of node.js types, safe to use in browser and bundlers
  * we do not use `lib.dom` types because they are not available in SSR environment
  */
-declare const process: { env: { NODE_ENV?: string } };
-declare const console: { warn: (...args: Array<any>) => void };
+declare global {
+  const process: { env: { NODE_ENV?: string } };
+  const console: { warn: (...args: Array<any>) => void };
+}
+
+// dummy export to make typescript treat this file as ES module
+export {};

Diff for: src/utils.ts

@@ -84,22 +84,22 @@ export function createActions<T>({
   return {
     setFiltering(filteringText) {
       dispatch({ type: 'filtering', filteringText });
-      collectionRef.current && collectionRef.current.scrollToTop();
+      collectionRef.current?.scrollToTop();
     },
     setSorting(state: SortingState<T>) {
       dispatch({ type: 'sorting', sortingState: state });
-      collectionRef.current && collectionRef.current.scrollToTop();
+      collectionRef.current?.scrollToTop();
     },
     setCurrentPage(pageIndex: number) {
       dispatch({ type: 'pagination', pageIndex });
-      collectionRef.current && collectionRef.current.scrollToTop();
+      collectionRef.current?.scrollToTop();
     },
     setSelectedItems(selectedItems: Array<T>) {
       dispatch({ type: 'selection', selectedItems });
     },
     setPropertyFiltering(query: PropertyFilterQuery) {
       dispatch({ type: 'property-filtering', query });
-      collectionRef.current && collectionRef.current.scrollToTop();
+      collectionRef.current?.scrollToTop();
     },
     setExpandedItems(expandedItems: ReadonlyArray<T>) {
       dispatch({ type: 'expansion', expandedItems });