paginate.test.ts

packages/ninety-client/test/paginate.test.ts

1. import { describe, expect, it } from 'vitest'
2. import {
3. collect,
4. fromArray,
5. fromEnvelope,
6. fromTeamKeyed,
7. iterateAll,
8. type Page,
9. } from '../src/paginate.js'
10. import { NinetySchemaError } from '../src/errors.js'
12. const ctx = { endpoint: 'POST /test' }
14. describe('fromEnvelope: Issues, KPIs', () => {
15. it('reads items and totalCount', () => {
16. const p = fromEnvelope<number>({ items: [1, 2, 3], totalCount: 10 }, { page: 0, pageSize: 3 }, ctx)
17. expect(p.items).toEqual([1, 2, 3])
18. expect(p.total).toBe(10)
19. expect(p.hasMore).toBe(true)
20. })
22. it('reports hasMore false on the last page', () => {
23. const p = fromEnvelope<number>({ items: [9, 10], totalCount: 10 }, { page: 4, pageSize: 2 }, ctx)
24. expect(p.hasMore).toBe(false)
25. })
27. it('rejects a bare array', () => {
28. expect(() => fromEnvelope([1, 2], { page: 0, pageSize: 2 }, ctx)).toThrow(NinetySchemaError)
29. })
30. })
32. describe('fromArray: To-Dos, Teams', () => {
33. it('wraps a bare array with no total', () => {
34. const p = fromArray<number>([1, 2], { page: 0, pageSize: 5 }, ctx)
35. expect(p.items).toEqual([1, 2])
36. expect(p.total).toBeNull()
37. expect(p.hasMore).toBe(false)
38. })
40. it('infers hasMore from a full page', () => {
41. const p = fromArray<number>([1, 2, 3], { page: 0, pageSize: 3 }, ctx)
42. expect(p.hasMore).toBe(true)
43. })
45. it('rejects an envelope', () => {
46. expect(() => fromArray({ items: [] }, { page: 0, pageSize: 5 }, ctx)).toThrow(NinetySchemaError)
47. })
48. })
50. describe('fromTeamKeyed: Rocks', () => {
51. it('flattens and stamps teamId', () => {
52. const raw = { teamA: [{ title: 'x' }], teamB: [{ title: 'y' }, { title: 'z' }] }
53. const p = fromTeamKeyed<{ title: string }>(raw, { page: 0, pageSize: 50 }, ctx)
54. expect(p.items).toHaveLength(3)
55. expect(p.items.map((i) => i.teamId)).toEqual(['teamA', 'teamB', 'teamB'])
56. expect(p.items[0]?.title).toBe('x')
57. })
59. it('rejects an array', () => {
60. expect(() => fromTeamKeyed([], { page: 0, pageSize: 5 }, ctx)).toThrow(NinetySchemaError)
61. })
62. })
64. describe('iterateAll', () => {
65. const pageOf = (items: number[], page: number, pageSize: number, hasMore: boolean): Page<number> => ({
66. items,
67. total: null,
68. pageIndex: page,
69. pageSize,
70. hasMore,
71. })
73. it('walks every page and stops when hasMore is false', async () => {
74. const pages = [
75. pageOf([1, 2], 0, 2, true),
76. pageOf([3, 4], 1, 2, true),
77. pageOf([5], 2, 2, false),
78. ]
79. const seen: number[] = []
80. const all = await collect(
81. iterateAll<number>(async (req) => {
82. seen.push(req.page)
83. return pages[req.page]!
84. }, { page: 0, pageSize: 2 }),
85. )
86. expect(all).toEqual([1, 2, 3, 4, 5])
87. expect(seen).toEqual([0, 1, 2])
88. })
90. it('stops on an empty page even if hasMore lies', async () => {
91. const all = await collect(
92. iterateAll<number>(async (req) => pageOf([], req.page, 2, true), { page: 0, pageSize: 2 }),
93. )
94. expect(all).toEqual([])
95. })
97. it('throws at the safety cap rather than looping forever', async () => {
98. await expect(
99. collect(
100. iterateAll<number>(async (req) => pageOf([1], req.page, 1, true), { page: 0, pageSize: 1 }, { maxPages: 3 }),
101. ),
102. ).rejects.toThrow(/safety cap/)
103. })
104. })