fix: handle out-of-bounds page parameter gracefully (#1103)

src/paginate.spec.ts

@@ -3135,6 +3135,37 @@ describe('paginate', () => {
         expect(page.meta.totalItems).toBe(42)
     })
 
+    it('should fix currentPage when page is out of bounds', async () => {
+        const config: PaginateConfig<ToyShopEntity> = {
+            sortableColumns: ['id'],
+            maxLimit: 10,
+        }
+        const query: PaginateQuery = {
+            path: '',
+            page: 200,
+        }
+
+        const result = await paginate<ToyShopEntity>(query, toyShopRepo, config)
+
+        expect(result.meta.currentPage).toBe(1)
+        expect(result.meta.totalPages).toEqual(result.meta.currentPage)
+    })
+
+    it('should fix links when page is out of bounds', async () => {
+        const config: PaginateConfig<ToyShopEntity> = {
+            sortableColumns: ['id'],
+            maxLimit: 10,
+        }
+        const query: PaginateQuery = {
+            path: '/toys',
+            page: 200,
+        }
+
+        const result = await paginate<ToyShopEntity>(query, toyShopRepo, config)
+
+        expect(result.links.current).toBe('/toys?page=1&limit=10&sortBy=id:ASC')
+    })
+
     describe('should return result based on date column filter', () => {
         it('with $not and $null operators', async () => {
             const config: PaginateConfig<CatEntity> = {
@@ -3606,6 +3637,8 @@ describe('paginate', () => {
                 })
 
                 expect(result.data).toStrictEqual(expectedResult)
+                expect(result.links.last).toBeUndefined()
+                expect(result.links.next).toBeUndefined()
                 expect(result.links.current).toBe('?page=1&limit=20&sortBy=home.countCat:ASC')
             })
         })

src/paginate.ts

@@ -222,12 +222,12 @@ export async function paginate<T extends ObjectLiteral>(
         query.limit === PaginationLimit.COUNTER_ONLY
             ? PaginationLimit.COUNTER_ONLY
             : isPaginated === true
-            ? maxLimit === PaginationLimit.NO_PAGINATION
-                ? query.limit ?? defaultLimit
-                : query.limit === PaginationLimit.NO_PAGINATION
-                ? defaultLimit
-                : Math.min(query.limit ?? defaultLimit, maxLimit)
-            : defaultLimit
+              ? maxLimit === PaginationLimit.NO_PAGINATION
+                  ? (query.limit ?? defaultLimit)
+                  : query.limit === PaginationLimit.NO_PAGINATION
+                    ? defaultLimit
+                    : Math.min(query.limit ?? defaultLimit, maxLimit)
+              : defaultLimit
 
     const generateNullCursor = (): string => {
         return 'A' + '0'.repeat(15) // null values ​​should be looked up last, so use the smallest prefix
@@ -979,13 +979,14 @@ export async function paginate<T extends ObjectLiteral>(
     const itemsPerPage = limit === PaginationLimit.COUNTER_ONLY ? totalItems : isPaginated ? limit : items.length
     const totalItemsForMeta = limit === PaginationLimit.COUNTER_ONLY || isPaginated ? totalItems : items.length
     const totalPages = isPaginated ? Math.ceil(totalItems / limit) : 1
+    const currentPage = Math.max(1, Math.min(page, totalPages))
 
     const results: Paginated<T> = {
         data: items,
         meta: {
             itemsPerPage: config.paginationType === PaginationType.CURSOR ? items.length : itemsPerPage,
             totalItems: config.paginationType === PaginationType.CURSOR ? undefined : totalItemsForMeta,
-            currentPage: config.paginationType === PaginationType.CURSOR ? undefined : page,
+            currentPage: config.paginationType === PaginationType.CURSOR ? undefined : currentPage,
             totalPages: config.paginationType === PaginationType.CURSOR ? undefined : totalPages,
             sortBy,
             search: query.search,
@@ -1010,7 +1011,7 @@ export async function paginate<T extends ObjectLiteral>(
                     : {
                           first: page == 1 ? undefined : buildLink(1),
                           previous: page - 1 < 1 ? undefined : buildLink(page - 1),
-                          current: buildLink(page),
+                          current: buildLink(currentPage),
                           next: page + 1 > totalPages ? undefined : buildLink(page + 1),
                           last: page == totalPages || !totalItems ? undefined : buildLink(totalPages),
                       }