Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,14 @@
"name": "@aboutbits/react-pagination",
"version": "2.0.1",
"description": "Pagination hooks for React",
"type": "module",
"types": "./dist/types/index.d.ts",
"module": "./dist/esm/index.js",
"main": "./dist/cjs/index.js",
"exports": {
".": {
"types": "./dist/types/engine/index.d.ts",
"import": "./dist/esm/engine/index.js",
"require": "./dist/cjs/engine/index.js"
"types": "./dist/types/index.d.ts",
"import": "./dist/esm/index.js",
"require": "./dist/cjs/index.js"
},
"./next-router": {
"types": "./dist/types/routers/nextRouter.d.ts",
Expand Down
8 changes: 8 additions & 0 deletions src/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
export * from './engine'
export * from './utils'
export * from './routers/nextRouter'
export * from './routers/reactRouter'
export * from './routers/inMemory'
export * from './zod/routers/nextRouter'
export * from './zod/routers/reactRouter'
export * from './zod/routers/inMemory'
25 changes: 14 additions & 11 deletions src/routers/__test__/inMemory.test.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
import { act, renderHook } from '@testing-library/react'
import { z } from 'zod'
import { NonNullableRecord } from '../../utils'
import { useQuery, useQueryAndPagination } from '../../zod/routers/inMemory'
import { usePagination } from '../inMemory'
import {
useZodInMemoryQuery,
useZodInMemoryQueryAndPagination,
} from '../../zod/routers/inMemory'
import { useInMemoryPagination } from '../inMemory'

describe('InMemory', () => {
const searchSchema = z.object({
Expand All @@ -11,12 +14,12 @@ describe('InMemory', () => {

const useInMemoryQueryWithSearch = (
defaultQuery: NonNullableRecord<z.infer<typeof searchSchema>>,
) => useQuery(defaultQuery, searchSchema)
) => useZodInMemoryQuery(defaultQuery, searchSchema)

test('should set default page and size', () => {
const page = 0
const size = 15
const { result } = renderHook(() => usePagination({ page, size }))
const { result } = renderHook(() => useInMemoryPagination({ page, size }))

expect(result.current.page).toBe(page)
expect(result.current.size).toBe(size)
Expand All @@ -25,7 +28,7 @@ describe('InMemory', () => {
test('should change page', () => {
const page = 2

const { result } = renderHook(() => usePagination())
const { result } = renderHook(() => useInMemoryPagination())

act(() => {
result.current.setPage(page)
Expand Down Expand Up @@ -53,7 +56,7 @@ describe('InMemory', () => {
const page = 2

const { result } = renderHook(() =>
useQueryAndPagination({ search: '' }, searchSchema),
useZodInMemoryQueryAndPagination({ search: '' }, searchSchema),
)

act(() => {
Expand All @@ -77,7 +80,7 @@ describe('InMemory', () => {
test('change default parameters', () => {
const page = 1
const size = 10
const { result } = renderHook(() => usePagination({ page, size }))
const { result } = renderHook(() => useInMemoryPagination({ page, size }))

expect(result.current.page).toBe(page)
expect(result.current.size).toBe(size)
Expand All @@ -90,7 +93,7 @@ describe('InMemory', () => {
const page = 2

const { result } = renderHook(() =>
useQueryAndPagination({ search: defaultSearch }, searchSchema),
useZodInMemoryQueryAndPagination({ search: defaultSearch }, searchSchema),
)

act(() => {
Expand Down Expand Up @@ -125,7 +128,7 @@ describe('InMemory', () => {
const page = 2

const { result } = renderHook(() =>
useQueryAndPagination({ search: defaultSearch }, searchSchema),
useZodInMemoryQueryAndPagination({ search: defaultSearch }, searchSchema),
)

act(() => {
Expand Down Expand Up @@ -159,7 +162,7 @@ describe('InMemory', () => {
})

const { result } = renderHook(() =>
useQuery({ search: '', department: '' }, schema),
useZodInMemoryQuery({ search: '', department: '' }, schema),
)

act(() => {
Expand All @@ -178,7 +181,7 @@ describe('InMemory', () => {
const search = ''

const { result } = renderHook(() =>
useQuery({ search: 'Default search' }, searchSchema),
useZodInMemoryQuery({ search: 'Default search' }, searchSchema),
)

act(() => {
Expand Down
37 changes: 24 additions & 13 deletions src/routers/__test__/nextRouter.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,11 @@ import router from 'next/router'
import { z } from 'zod'
import { vi } from 'vitest'
import { NonNullableRecord } from '../../utils'
import { useQuery, useQueryAndPagination } from '../../zod/routers/nextRouter'
import { usePagination } from '../nextRouter'
import {
useZodNextRouterQuery,
useZodNextRouterQueryAndPagination,
} from '../../zod/routers/nextRouter'
import { useNextRouterPagination } from '../nextRouter'

// eslint-disable-next-line @typescript-eslint/no-unsafe-return
vi.mock('next/router', () => require('next-router-mock'))
Expand All @@ -20,12 +23,12 @@ describe('NextRouter', () => {

const useNextRouterQueryWithSearch = (
defaultQuery: NonNullableRecord<z.infer<typeof searchSchema>>,
) => useQuery(defaultQuery, searchSchema)
) => useZodNextRouterQuery(defaultQuery, searchSchema)

test('should set default page and size', () => {
const page = 0
const size = 15
const { result } = renderHook(() => usePagination({ page, size }))
const { result } = renderHook(() => useNextRouterPagination({ page, size }))

expect(result.current.page).toBe(page)
expect(result.current.size).toBe(size)
Expand All @@ -34,7 +37,7 @@ describe('NextRouter', () => {
test('should change page', () => {
const page = 2

const { result } = renderHook(() => usePagination())
const { result } = renderHook(() => useNextRouterPagination())

act(() => {
result.current.setPage(page)
Expand Down Expand Up @@ -64,7 +67,7 @@ describe('NextRouter', () => {
const page = 2

const { result } = renderHook(() =>
useQueryAndPagination({ search: '' }, searchSchema),
useZodNextRouterQueryAndPagination({ search: '' }, searchSchema),
)

act(() => {
Expand All @@ -91,7 +94,7 @@ describe('NextRouter', () => {
test('change default parameters', () => {
const page = 1
const size = 10
const { result } = renderHook(() => usePagination({ page, size }))
const { result } = renderHook(() => useNextRouterPagination({ page, size }))

expect(result.current.page).toBe(page)
expect(result.current.size).toBe(size)
Expand All @@ -104,7 +107,10 @@ describe('NextRouter', () => {
const page = 2

const { result } = renderHook(() =>
useQueryAndPagination({ search: defaultSearch }, searchSchema),
useZodNextRouterQueryAndPagination(
{ search: defaultSearch },
searchSchema,
),
)

act(() => {
Expand Down Expand Up @@ -146,7 +152,10 @@ describe('NextRouter', () => {
const page = 2

const { result } = renderHook(() =>
useQueryAndPagination({ search: defaultSearch }, searchSchema),
useZodNextRouterQueryAndPagination(
{ search: defaultSearch },
searchSchema,
),
)

act(() => {
Expand Down Expand Up @@ -194,7 +203,7 @@ describe('NextRouter', () => {
})

const { result } = renderHook(() =>
useQuery(
useZodNextRouterQuery(
{
search: '',
department: '',
Expand Down Expand Up @@ -226,7 +235,9 @@ describe('NextRouter', () => {
const greeting = 'hello'
router.query = { greeting }

const { result } = renderHook(() => useQuery({ search: '' }, searchSchema))
const { result } = renderHook(() =>
useZodNextRouterQuery({ search: '' }, searchSchema),
)

act(() => {
result.current.setQuery({ search: 'Max' })
Expand All @@ -242,7 +253,7 @@ describe('NextRouter', () => {
router.query = { search: 'Max' }

const { result } = renderHook(() =>
useQuery({ search: defaultSearch }, searchSchema),
useZodNextRouterQuery({ search: defaultSearch }, searchSchema),
)

act(() => {
Expand All @@ -257,7 +268,7 @@ describe('NextRouter', () => {
const search = ''

const { result } = renderHook(() =>
useQuery({ search: 'Default search' }, searchSchema),
useZodNextRouterQuery({ search: 'Default search' }, searchSchema),
)

act(() => {
Expand Down
35 changes: 22 additions & 13 deletions src/routers/__test__/reactRouter.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,11 @@ import { act, renderHook } from '@testing-library/react'
import { z } from 'zod'
import { BrowserRouter } from 'react-router-dom'
import { NonNullableRecord } from '../../utils'
import { useQuery, useQueryAndPagination } from '../../zod/routers/reactRouter'
import { usePagination } from '../reactRouter'
import {
useZodReactRouterQuery,
useZodReactRouterQueryAndPagination,
} from '../../zod/routers/reactRouter'
import { useReactRouterPagination } from '../reactRouter'

const renderHookWithContext = <Result, Props>(
render: (initialProps: Props) => Result,
Expand All @@ -25,13 +28,13 @@ describe('ReactRouter', () => {

const useReactRouterQueryWithSearch = (
defaultQuery: NonNullableRecord<z.infer<typeof searchSchema>>,
) => useQuery(defaultQuery, searchSchema)
) => useZodReactRouterQuery(defaultQuery, searchSchema)

test('should set default page and size', () => {
const page = 0
const size = 15
const { result } = renderHookWithContext(() =>
usePagination({ page, size }),
useReactRouterPagination({ page, size }),
)

expect(result.current.page).toBe(page)
Expand All @@ -41,7 +44,7 @@ describe('ReactRouter', () => {
test('should change page', () => {
const page = 2

const { result } = renderHookWithContext(() => usePagination())
const { result } = renderHookWithContext(() => useReactRouterPagination())

act(() => {
result.current.setPage(page)
Expand Down Expand Up @@ -71,7 +74,7 @@ describe('ReactRouter', () => {
const page = 2

const { result } = renderHookWithContext(() =>
useQueryAndPagination({ search: '' }, searchSchema),
useZodReactRouterQueryAndPagination({ search: '' }, searchSchema),
)

act(() => {
Expand All @@ -97,7 +100,7 @@ describe('ReactRouter', () => {
const page = 1
const size = 10
const { result } = renderHookWithContext(() =>
usePagination({ page, size }),
useReactRouterPagination({ page, size }),
)

expect(result.current.page).toBe(page)
Expand All @@ -111,7 +114,10 @@ describe('ReactRouter', () => {
const page = 2

const { result } = renderHookWithContext(() =>
useQueryAndPagination({ search: defaultSearch }, searchSchema),
useZodReactRouterQueryAndPagination(
{ search: defaultSearch },
searchSchema,
),
)

act(() => {
Expand Down Expand Up @@ -149,7 +155,10 @@ describe('ReactRouter', () => {
const page = 2

const { result } = renderHookWithContext(() =>
useQueryAndPagination({ search: defaultSearch }, searchSchema),
useZodReactRouterQueryAndPagination(
{ search: defaultSearch },
searchSchema,
),
)

act(() => {
Expand Down Expand Up @@ -186,7 +195,7 @@ describe('ReactRouter', () => {
})

const { result } = renderHookWithContext(() =>
useQuery({ search: '', department: '' }, schema),
useZodReactRouterQuery({ search: '', department: '' }, schema),
)

act(() => {
Expand All @@ -207,7 +216,7 @@ describe('ReactRouter', () => {
window.history.pushState({}, '', `/?greeting=${greeting}`)

const { result } = renderHookWithContext(() =>
useQuery({ search: '' }, searchSchema),
useZodReactRouterQuery({ search: '' }, searchSchema),
)

act(() => {
Expand All @@ -226,7 +235,7 @@ describe('ReactRouter', () => {
window.history.pushState({}, '', `/?search=Max`)

const { result } = renderHookWithContext(() =>
useQuery({ search: defaultSearch }, searchSchema),
useZodReactRouterQuery({ search: defaultSearch }, searchSchema),
)

act(() => {
Expand All @@ -241,7 +250,7 @@ describe('ReactRouter', () => {
const search = ''

const { result } = renderHookWithContext(() =>
useQuery({ search: 'Default search' }, searchSchema),
useZodReactRouterQuery({ search: 'Default search' }, searchSchema),
)

act(() => {
Expand Down
8 changes: 4 additions & 4 deletions src/routers/inMemory.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ const useInMemoryRouter = (): Router => {
}
}

export const useQuery = <T extends AbstractQuery>(
export const useInMemoryQuery = <T extends AbstractQuery>(
defaultQuery: T,
parseQuery: ParseQuery<T>,
options?: Partial<AbstractQueryOptions>,
Expand All @@ -38,7 +38,7 @@ export const useQuery = <T extends AbstractQuery>(
return useAbstractQuery(defaultQuery, parseQuery, router, options)
}

export const useQueryAndPagination = <T extends AbstractQuery>(
export const useInMemoryQueryAndPagination = <T extends AbstractQuery>(
defaultQuery: T,
parseQuery: ParseQuery<T>,
defaultPagination?: PaginationQuery,
Expand All @@ -54,11 +54,11 @@ export const useQueryAndPagination = <T extends AbstractQuery>(
)
}

export const usePagination = (
export const useInMemoryPagination = (
defaultPagination?: PaginationQuery,
options?: Partial<AbstractQueryOptions>,
) => {
const { page, size, setPage, setSize, setPagination, resetPagination } =
useQueryAndPagination({}, () => ({}), defaultPagination, options)
useInMemoryQueryAndPagination({}, () => ({}), defaultPagination, options)
return { page, size, setPage, setSize, setPagination, resetPagination }
}
Loading