fix: Hide new pageIndex logic behind flag (#103)

Author: gethinwebster

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);

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;

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 };