refactor(pagination): make pagination optional & provide unpaginated rows

Author: ChronicStone

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@chronicstone/array-query",
   "type": "module",
-  "version": "0.0.0",
+  "version": "0.1.0",
   "description": "A simple and lightweight array query library",
   "author": "Cyprien THAO <cthao.pro@gmail.com>",
   "license": "MIT",

src/query.ts

@@ -1,10 +1,10 @@
-import type { FilterMatchMode, GenericObject, MatchModeProcessorMap, QueryParams } from './types'
+import type { FilterMatchMode, GenericObject, MatchModeProcessorMap, QueryParams, QueryResult } from './types'
 import { MatchModeProcessor, getObjectProperty, validateBetweenPayload } from './utils'
 
-export function query<T extends GenericObject>(
+export function query<T extends GenericObject, P extends QueryParams>(
   data: T[],
-  params: QueryParams,
-) {
+  params: P,
+): QueryResult<T, P> {
   let result: T[] = [...data]
 
   if (params.search?.value) {
@@ -152,16 +152,24 @@ export function query<T extends GenericObject>(
     })
   }
 
-  const totalRows = result.length
-  const totalPages = Math.ceil(totalRows / params.limit)
-  const start = (params.page - 1) * params.limit
-  const end = start + params.limit
-  result = result.slice(start, end)
+  if (typeof params.limit === 'undefined') {
+    return { rows: result } as QueryResult<T, P>
+  }
+
+  else {
+    const unpaginatedRows = [...result]
+    const totalRows = result.length
+    const totalPages = Math.ceil(totalRows / params.limit)
+    const start = params.offset ?? 0
+    const end = start + params.limit
+    result = result.slice(start, end)
 
-  return {
-    totalRows,
-    totalPages,
-    rows: result,
+    return {
+      totalRows,
+      totalPages,
+      rows: result,
+      unpaginatedRows,
+    } as QueryResult<T, P>
   }
 }
 

src/types.ts

@@ -70,15 +70,16 @@ export type QueryFilter = {
 } & MatchModeCore
 
 export interface QueryParams {
-  page: number
-  limit: number
   sort?: { key: string, dir?: 'asc' | 'desc' }
   search?: {
     value: string
     keys: string[]
   }
   filter?: QueryFilter[]
+  limit?: number
+  offset?: number
 }
+export type QueryResult<T extends GenericObject, P extends QueryParams> = P extends { limit: number } ? { totalRows: number, totalPages: number, rows: T[], unpaginatedRows: T[] } : { totalRows: number, totalPages: number, rows: T[] }
 
 export interface MatchModeProcessorMap {
   equals: ({ value, filter }: { value: any, filter: any }) => boolean

test/index.test.ts

@@ -8,7 +8,6 @@ describe('should filter users', () => {
   it('should filter active users', () => {
     const { totalPages, totalRows } = query(users, {
       limit: 10,
-      page: 1,
       sort: {
         key: 'createdAt',
         dir: 'desc',