@promoboxx/use-filter 1.11.1 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/workflows/main.yml +38 -0
- package/.vscode/settings.json +3 -0
- package/CHANGELOG.md +185 -0
- package/Makefile +25 -0
- package/eslint.config.js +30 -0
- package/mise.toml +3 -0
- package/package.json +33 -43
- package/prettier.config.js +3 -0
- package/src/lib/buildDefaultFilterInfo.ts +36 -0
- package/src/lib/getOffsetFromPage.ts +5 -0
- package/src/lib/getPageFromOffset.ts +5 -0
- package/src/lib/shallowEqual.test.ts +71 -0
- package/src/lib/shallowEqual.ts +26 -0
- package/src/store/index.ts +30 -0
- package/src/store/localStorageStore.ts +36 -0
- package/src/store/memoryStore.ts +27 -0
- package/src/store/reduxHelpers/createActions.test.ts +32 -0
- package/src/store/reduxHelpers/createActions.ts +56 -0
- package/src/store/reduxHelpers/createReducer.test.ts +65 -0
- package/src/store/reduxHelpers/createReducer.ts +47 -0
- package/src/store/reduxStore.ts +78 -0
- package/src/store/urlParamStore.test.ts +131 -0
- package/src/store/urlParamStore.ts +85 -0
- package/src/useFilter.test.tsx +822 -0
- package/src/useFilter.ts +524 -0
- package/src/useSimpleFilter.test.tsx +676 -0
- package/src/useSimpleFilter.ts +397 -0
- package/src/vitest-env.d.ts +1 -0
- package/tsconfig.json +76 -0
- package/tsdown.config.ts +30 -0
- package/vite.config.ts +9 -0
- package/dist/lib/buildDefaultFilterInfo.d.ts +0 -3
- package/dist/lib/buildDefaultFilterInfo.js +0 -35
- package/dist/lib/getOffsetFromPage.d.ts +0 -2
- package/dist/lib/getOffsetFromPage.js +0 -6
- package/dist/lib/getPageFromOffset.d.ts +0 -2
- package/dist/lib/getPageFromOffset.js +0 -6
- package/dist/lib/shallowEqual.d.ts +0 -2
- package/dist/lib/shallowEqual.js +0 -23
- package/dist/store/index.d.ts +0 -10
- package/dist/store/index.js +0 -16
- package/dist/store/localStorageStore.d.ts +0 -3
- package/dist/store/localStorageStore.js +0 -31
- package/dist/store/memoryStore.d.ts +0 -3
- package/dist/store/memoryStore.js +0 -23
- package/dist/store/reduxHelpers/createActions.d.ts +0 -16
- package/dist/store/reduxHelpers/createActions.js +0 -27
- package/dist/store/reduxHelpers/createReducer.d.ts +0 -8
- package/dist/store/reduxHelpers/createReducer.js +0 -26
- package/dist/store/reduxStore.d.ts +0 -15
- package/dist/store/reduxStore.js +0 -67
- package/dist/store/urlParamStore.d.ts +0 -2
- package/dist/store/urlParamStore.js +0 -86
- package/dist/useFilter.d.ts +0 -103
- package/dist/useFilter.js +0 -254
- package/dist/useSimpleFilter.d.ts +0 -86
- package/dist/useSimpleFilter.js +0 -173
|
@@ -0,0 +1,397 @@
|
|
|
1
|
+
import { useCallback, useEffect, useRef, useState } from 'react'
|
|
2
|
+
|
|
3
|
+
import getOffsetFromPage from './lib/getOffsetFromPage'
|
|
4
|
+
import getPageFromOffset from './lib/getPageFromOffset'
|
|
5
|
+
import shallowEqual from './lib/shallowEqual'
|
|
6
|
+
import { getFilterStore } from './store'
|
|
7
|
+
import type { FilterStore } from './store'
|
|
8
|
+
import type { UseFilterUpdateReason } from './useFilter'
|
|
9
|
+
|
|
10
|
+
interface UseSimpleFilterOptions<TFilter> {
|
|
11
|
+
/**
|
|
12
|
+
* Default values for your filter. When calling `.reset` your filter will be
|
|
13
|
+
* set to this.
|
|
14
|
+
* Changing these values does not cause a call to happen.
|
|
15
|
+
*/
|
|
16
|
+
defaultFilterInfo?: Partial<SimpleFilterInfo<TFilter>>
|
|
17
|
+
/**
|
|
18
|
+
* In case you want to change the default debounce duration.
|
|
19
|
+
*/
|
|
20
|
+
debounceDuration?: number
|
|
21
|
+
onBeforeSaveFilter?: (
|
|
22
|
+
filterInfo: SimpleFilterInfo<TFilter>,
|
|
23
|
+
) => SimpleFilterInfo<TFilter>
|
|
24
|
+
|
|
25
|
+
store?: FilterStore
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
export interface SimpleFilterApi<TFilter> {
|
|
29
|
+
/**
|
|
30
|
+
* Really more "is debouncing", since simple mode doesn't know when your code
|
|
31
|
+
* is doing anything.
|
|
32
|
+
*/
|
|
33
|
+
isLoading: boolean
|
|
34
|
+
/**
|
|
35
|
+
* Access to the filter and its metadata.
|
|
36
|
+
*/
|
|
37
|
+
filterInfo: SimpleFilterInfo<TFilter>
|
|
38
|
+
/**
|
|
39
|
+
* Same as the regular `filterInfo`, but updates in a debounced fashion.
|
|
40
|
+
*/
|
|
41
|
+
debouncedFilterInfo: SimpleFilterInfo<TFilter>
|
|
42
|
+
/**
|
|
43
|
+
* Why the last update happened.
|
|
44
|
+
*/
|
|
45
|
+
updateReason: UseFilterUpdateReason
|
|
46
|
+
|
|
47
|
+
/**
|
|
48
|
+
* Update one or more values in your filter.
|
|
49
|
+
*/
|
|
50
|
+
updateFilter: (
|
|
51
|
+
filter: Partial<TFilter>,
|
|
52
|
+
shouldRunImmediately?: boolean,
|
|
53
|
+
) => void
|
|
54
|
+
|
|
55
|
+
/**
|
|
56
|
+
* Does the boring math for you based on your `pageSize` and `totalResults`.
|
|
57
|
+
*/
|
|
58
|
+
pagingInfo: (total: string | number | null | undefined) => {
|
|
59
|
+
totalResults: number
|
|
60
|
+
totalPages: number
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
/**
|
|
64
|
+
* Resets the filter back to `defaultFilterInfo`.
|
|
65
|
+
*/
|
|
66
|
+
resetFilter: (shouldRunImmediately?: boolean) => void
|
|
67
|
+
|
|
68
|
+
/**
|
|
69
|
+
* Changes the offset. Will update `page`.
|
|
70
|
+
*/
|
|
71
|
+
setOffset: (offset: number | string, shouldRunImmediately?: boolean) => void
|
|
72
|
+
|
|
73
|
+
/**
|
|
74
|
+
* Changes the page. Will update `offset`.
|
|
75
|
+
*/
|
|
76
|
+
setPage: (page: number | string, shouldRunImmediately?: boolean) => void
|
|
77
|
+
|
|
78
|
+
/**
|
|
79
|
+
* Changes the page size.
|
|
80
|
+
*/
|
|
81
|
+
setPageSize: (
|
|
82
|
+
pageSize: number | string,
|
|
83
|
+
shouldRunImmediately?: boolean,
|
|
84
|
+
) => void
|
|
85
|
+
|
|
86
|
+
/**
|
|
87
|
+
* Change the sort method.
|
|
88
|
+
*/
|
|
89
|
+
setSort: (sort: string, shouldRunImmediately?: boolean) => void
|
|
90
|
+
|
|
91
|
+
/**
|
|
92
|
+
* Changes the cursor.
|
|
93
|
+
*/
|
|
94
|
+
setCursor: (
|
|
95
|
+
cursor: string | null | undefined,
|
|
96
|
+
shouldRunImmediately?: boolean,
|
|
97
|
+
) => void
|
|
98
|
+
|
|
99
|
+
/**
|
|
100
|
+
* Forces a refresh of the filter.
|
|
101
|
+
*/
|
|
102
|
+
forceRefresh: (shouldRunImmediately?: boolean) => void
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
export interface SimpleFilterInfo<TFilter> {
|
|
106
|
+
filter: TFilter
|
|
107
|
+
sort?: string
|
|
108
|
+
offset: number
|
|
109
|
+
page: number
|
|
110
|
+
pageSize: number
|
|
111
|
+
lastRefreshAt: number
|
|
112
|
+
cursor?: string | null
|
|
113
|
+
shouldRunImmediately: boolean
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
function useSimpleFilter<TFilter extends Record<string, unknown>>(
|
|
117
|
+
namespace: string,
|
|
118
|
+
options: UseSimpleFilterOptions<TFilter>,
|
|
119
|
+
) {
|
|
120
|
+
// Having these types of refs helps get around rules of hooks, and they need
|
|
121
|
+
// to be updated each render.
|
|
122
|
+
const ctxRefValue = {
|
|
123
|
+
namespace,
|
|
124
|
+
debounceDuration: options.debounceDuration,
|
|
125
|
+
defaultFilterInfo: options.defaultFilterInfo,
|
|
126
|
+
onBeforeSaveFilter: options.onBeforeSaveFilter,
|
|
127
|
+
store: options.store,
|
|
128
|
+
}
|
|
129
|
+
const ctxRef = useRef(ctxRefValue)
|
|
130
|
+
useEffect(() => {
|
|
131
|
+
ctxRef.current = ctxRefValue
|
|
132
|
+
})
|
|
133
|
+
|
|
134
|
+
const [isLoading, setIsLoading] = useState(false)
|
|
135
|
+
const [filterInfo, setFilterInfoState] = useState(() => {
|
|
136
|
+
const fromStore = getFilterStore(ctxRef.current.store).getFilter<TFilter>(
|
|
137
|
+
namespace,
|
|
138
|
+
)
|
|
139
|
+
|
|
140
|
+
// If the filter is already in the store, we have to make sure it ...
|
|
141
|
+
// - has both the filter and filterInfo
|
|
142
|
+
// - has all the fields the user passed to the hook
|
|
143
|
+
if (fromStore) {
|
|
144
|
+
const filterInfo = buildDefaultFilterInfo({
|
|
145
|
+
...fromStore,
|
|
146
|
+
shouldRunImmediately: true,
|
|
147
|
+
filter: {
|
|
148
|
+
...options.defaultFilterInfo?.filter,
|
|
149
|
+
...fromStore.filter,
|
|
150
|
+
},
|
|
151
|
+
})
|
|
152
|
+
|
|
153
|
+
return filterInfo
|
|
154
|
+
} else {
|
|
155
|
+
return buildDefaultFilterInfo({
|
|
156
|
+
...options.defaultFilterInfo,
|
|
157
|
+
shouldRunImmediately: true,
|
|
158
|
+
})
|
|
159
|
+
}
|
|
160
|
+
})
|
|
161
|
+
const [debouncedFilterInfo, setDebouncedFilterInfo] = useState(filterInfo)
|
|
162
|
+
|
|
163
|
+
// Not sure this is needed in simple mode?
|
|
164
|
+
const lastRefreshAtRef = useRef(-1)
|
|
165
|
+
|
|
166
|
+
const updateReasonRef = useRef<UseFilterUpdateReason>('initial')
|
|
167
|
+
|
|
168
|
+
useEffect(() => {
|
|
169
|
+
setIsLoading(true)
|
|
170
|
+
|
|
171
|
+
// If the lastRefreshAt hasn't changed, don't do anything.
|
|
172
|
+
if (lastRefreshAtRef.current === filterInfo.lastRefreshAt) {
|
|
173
|
+
setIsLoading(false)
|
|
174
|
+
return
|
|
175
|
+
}
|
|
176
|
+
|
|
177
|
+
let timeout: ReturnType<typeof setTimeout> | undefined = undefined
|
|
178
|
+
|
|
179
|
+
function makeRequest() {
|
|
180
|
+
lastRefreshAtRef.current = filterInfo.lastRefreshAt
|
|
181
|
+
getFilterStore(ctxRef.current.store).saveFilter(
|
|
182
|
+
ctxRef.current.namespace,
|
|
183
|
+
(ctxRef.current.onBeforeSaveFilter
|
|
184
|
+
? ctxRef.current.onBeforeSaveFilter(filterInfo)
|
|
185
|
+
: filterInfo) as any,
|
|
186
|
+
)
|
|
187
|
+
setDebouncedFilterInfo(filterInfo)
|
|
188
|
+
setIsLoading(false)
|
|
189
|
+
}
|
|
190
|
+
|
|
191
|
+
if (filterInfo.shouldRunImmediately) {
|
|
192
|
+
makeRequest()
|
|
193
|
+
} else {
|
|
194
|
+
timeout = setTimeout(makeRequest, ctxRef.current.debounceDuration ?? 500)
|
|
195
|
+
}
|
|
196
|
+
|
|
197
|
+
return () => {
|
|
198
|
+
if (timeout) {
|
|
199
|
+
clearTimeout(timeout)
|
|
200
|
+
}
|
|
201
|
+
}
|
|
202
|
+
}, [filterInfo])
|
|
203
|
+
|
|
204
|
+
const previousTotalRef = useRef(0)
|
|
205
|
+
|
|
206
|
+
const api: SimpleFilterApi<TFilter> = {
|
|
207
|
+
isLoading,
|
|
208
|
+
filterInfo,
|
|
209
|
+
debouncedFilterInfo,
|
|
210
|
+
updateReason: updateReasonRef.current,
|
|
211
|
+
|
|
212
|
+
updateFilter: useCallback(
|
|
213
|
+
(filter: Partial<TFilter>, shouldRunImmediately = false) => {
|
|
214
|
+
updateReasonRef.current = 'filter'
|
|
215
|
+
|
|
216
|
+
setFilterInfoState((previous) => {
|
|
217
|
+
const nextFilter = {
|
|
218
|
+
...previous.filter,
|
|
219
|
+
...filter,
|
|
220
|
+
}
|
|
221
|
+
|
|
222
|
+
if (shallowEqual(previous.filter, nextFilter)) {
|
|
223
|
+
return previous
|
|
224
|
+
}
|
|
225
|
+
|
|
226
|
+
return {
|
|
227
|
+
...previous,
|
|
228
|
+
shouldRunImmediately,
|
|
229
|
+
offset: 0,
|
|
230
|
+
page: 1,
|
|
231
|
+
totalResults: 1,
|
|
232
|
+
totalPages: 1,
|
|
233
|
+
filter: nextFilter,
|
|
234
|
+
cursor: undefined,
|
|
235
|
+
lastRefreshAt: new Date().getTime(),
|
|
236
|
+
}
|
|
237
|
+
})
|
|
238
|
+
},
|
|
239
|
+
[],
|
|
240
|
+
),
|
|
241
|
+
|
|
242
|
+
pagingInfo: useCallback(
|
|
243
|
+
(total: string | number | null | undefined) => {
|
|
244
|
+
const normalized = Number(
|
|
245
|
+
// Because we accept `null` as an argument, we can't do something as
|
|
246
|
+
// simple as `total ?? ...`
|
|
247
|
+
total == null ? previousTotalRef.current : total,
|
|
248
|
+
)
|
|
249
|
+
previousTotalRef.current = normalized
|
|
250
|
+
|
|
251
|
+
return {
|
|
252
|
+
totalResults: normalized,
|
|
253
|
+
totalPages: Math.ceil(normalized / filterInfo.pageSize),
|
|
254
|
+
}
|
|
255
|
+
},
|
|
256
|
+
[filterInfo.pageSize],
|
|
257
|
+
),
|
|
258
|
+
|
|
259
|
+
resetFilter: useCallback((shouldRunImmediately: boolean = false) => {
|
|
260
|
+
updateReasonRef.current = 'filter'
|
|
261
|
+
|
|
262
|
+
setFilterInfoState({
|
|
263
|
+
...buildDefaultFilterInfo(ctxRef.current.defaultFilterInfo),
|
|
264
|
+
shouldRunImmediately,
|
|
265
|
+
})
|
|
266
|
+
}, []),
|
|
267
|
+
|
|
268
|
+
setOffset: useCallback(
|
|
269
|
+
(offset: number | string, shouldRunImmediately: boolean = false) => {
|
|
270
|
+
updateReasonRef.current = 'pagination'
|
|
271
|
+
|
|
272
|
+
const offsetNumber = Number(offset)
|
|
273
|
+
|
|
274
|
+
setFilterInfoState((previous) => ({
|
|
275
|
+
...previous,
|
|
276
|
+
offset: offsetNumber,
|
|
277
|
+
page: getPageFromOffset(offsetNumber, previous.pageSize),
|
|
278
|
+
lastRefreshAt: new Date().getTime(),
|
|
279
|
+
shouldRunImmediately,
|
|
280
|
+
}))
|
|
281
|
+
},
|
|
282
|
+
[],
|
|
283
|
+
),
|
|
284
|
+
|
|
285
|
+
setPage: useCallback(
|
|
286
|
+
(page: number | string, shouldRunImmediately: boolean = false) => {
|
|
287
|
+
updateReasonRef.current = 'pagination'
|
|
288
|
+
|
|
289
|
+
const pageNumber = Number(page)
|
|
290
|
+
|
|
291
|
+
setFilterInfoState((previous) => ({
|
|
292
|
+
...previous,
|
|
293
|
+
offset: getOffsetFromPage(pageNumber, previous.pageSize),
|
|
294
|
+
page: pageNumber,
|
|
295
|
+
lastRefreshAt: new Date().getTime(),
|
|
296
|
+
shouldRunImmediately,
|
|
297
|
+
}))
|
|
298
|
+
},
|
|
299
|
+
[],
|
|
300
|
+
),
|
|
301
|
+
|
|
302
|
+
setPageSize: useCallback(
|
|
303
|
+
(pageSize: number | string, shouldRunImmediately: boolean = false) => {
|
|
304
|
+
updateReasonRef.current = 'pagination'
|
|
305
|
+
|
|
306
|
+
setFilterInfoState((previous) => {
|
|
307
|
+
const pageSizeNumber = Number(pageSize)
|
|
308
|
+
const page = getPageFromOffset(previous.offset, pageSizeNumber)
|
|
309
|
+
const offset = getOffsetFromPage(page, pageSizeNumber)
|
|
310
|
+
|
|
311
|
+
return {
|
|
312
|
+
...previous,
|
|
313
|
+
pageSize: pageSizeNumber,
|
|
314
|
+
offset,
|
|
315
|
+
page,
|
|
316
|
+
lastRefreshAt: new Date().getTime(),
|
|
317
|
+
shouldRunImmediately,
|
|
318
|
+
}
|
|
319
|
+
})
|
|
320
|
+
},
|
|
321
|
+
[],
|
|
322
|
+
),
|
|
323
|
+
|
|
324
|
+
setSort: useCallback(
|
|
325
|
+
(sort: string, shouldRunImmediately: boolean = false) => {
|
|
326
|
+
updateReasonRef.current = 'filter'
|
|
327
|
+
|
|
328
|
+
setFilterInfoState((previous) => ({
|
|
329
|
+
...previous,
|
|
330
|
+
sort,
|
|
331
|
+
lastRefreshAt: new Date().getTime(),
|
|
332
|
+
shouldRunImmediately,
|
|
333
|
+
}))
|
|
334
|
+
},
|
|
335
|
+
[],
|
|
336
|
+
),
|
|
337
|
+
|
|
338
|
+
setCursor: useCallback(
|
|
339
|
+
(
|
|
340
|
+
cursor: string | null | undefined,
|
|
341
|
+
shouldRunImmediately: boolean = false,
|
|
342
|
+
) => {
|
|
343
|
+
updateReasonRef.current = 'pagination'
|
|
344
|
+
|
|
345
|
+
setFilterInfoState((previous) => ({
|
|
346
|
+
...previous,
|
|
347
|
+
cursor,
|
|
348
|
+
lastRefreshAt: new Date().getTime(),
|
|
349
|
+
shouldRunImmediately,
|
|
350
|
+
}))
|
|
351
|
+
},
|
|
352
|
+
[],
|
|
353
|
+
),
|
|
354
|
+
|
|
355
|
+
forceRefresh: useCallback((shouldRunImmediately: boolean = false) => {
|
|
356
|
+
updateReasonRef.current = 'filter'
|
|
357
|
+
|
|
358
|
+
setFilterInfoState((previous) => ({
|
|
359
|
+
...previous,
|
|
360
|
+
lastRefreshAt: new Date().getTime(),
|
|
361
|
+
shouldRunImmediately,
|
|
362
|
+
}))
|
|
363
|
+
}, []),
|
|
364
|
+
}
|
|
365
|
+
|
|
366
|
+
return api
|
|
367
|
+
}
|
|
368
|
+
|
|
369
|
+
function buildDefaultFilterInfo<T>(
|
|
370
|
+
filterInfo: Partial<SimpleFilterInfo<T>> = {},
|
|
371
|
+
): SimpleFilterInfo<T> {
|
|
372
|
+
const merged: SimpleFilterInfo<T> = {
|
|
373
|
+
// Cast here to work around "'T' could be instantiated with an arbitrary
|
|
374
|
+
// type which could be unrelated to '{}'"
|
|
375
|
+
filter: {} as T,
|
|
376
|
+
|
|
377
|
+
sort: undefined,
|
|
378
|
+
pageSize: 20,
|
|
379
|
+
lastRefreshAt: new Date().getTime(),
|
|
380
|
+
offset: 0,
|
|
381
|
+
page: 1,
|
|
382
|
+
shouldRunImmediately: false,
|
|
383
|
+
...filterInfo,
|
|
384
|
+
}
|
|
385
|
+
|
|
386
|
+
// If there's a page but no offset, set the offset.
|
|
387
|
+
if (filterInfo.page != null && filterInfo.offset == null) {
|
|
388
|
+
merged.offset = getOffsetFromPage(filterInfo.page, merged.pageSize)
|
|
389
|
+
// If there's an offset but no page, set the page.
|
|
390
|
+
} else if (filterInfo.page == null && filterInfo.offset != null) {
|
|
391
|
+
merged.page = getPageFromOffset(filterInfo.offset, merged.pageSize)
|
|
392
|
+
}
|
|
393
|
+
|
|
394
|
+
return merged
|
|
395
|
+
}
|
|
396
|
+
|
|
397
|
+
export default useSimpleFilter
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
/// <reference types="vitest/globals" />
|
package/tsconfig.json
ADDED
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
{
|
|
2
|
+
"compilerOptions": {
|
|
3
|
+
/* Visit https://aka.ms/tsconfig.json to read more about this file */
|
|
4
|
+
|
|
5
|
+
/* Basic Options */
|
|
6
|
+
// "incremental": true, /* Enable incremental compilation */
|
|
7
|
+
"target": "es2021" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', 'ES2021', or 'ESNEXT'. */,
|
|
8
|
+
"module": "esnext" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */,
|
|
9
|
+
// "lib": [
|
|
10
|
+
// "DOM",
|
|
11
|
+
// "es2018"
|
|
12
|
+
// ] /* Specify library files to be included in the compilation. */,
|
|
13
|
+
// "allowJs": true, /* Allow javascript files to be compiled. */
|
|
14
|
+
// "checkJs": true, /* Report errors in .js files. */
|
|
15
|
+
"jsx": "react-jsx" /* Specify JSX code generation: 'preserve', 'react-native', 'react', 'react-jsx' or 'react-jsxdev'. */,
|
|
16
|
+
"declaration": true /* Generates corresponding '.d.ts' file. */,
|
|
17
|
+
// "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
|
|
18
|
+
// "sourceMap": true, /* Generates corresponding '.map' file. */
|
|
19
|
+
// "outFile": "./", /* Concatenate and emit output to single file. */
|
|
20
|
+
"outDir": "./dist" /* Redirect output structure to the directory. */,
|
|
21
|
+
// "rootDir": "./src" /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */,
|
|
22
|
+
// "composite": true, /* Enable project compilation */
|
|
23
|
+
// "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */
|
|
24
|
+
// "removeComments": true, /* Do not emit comments to output. */
|
|
25
|
+
// "noEmit": true, /* Do not emit outputs. */
|
|
26
|
+
// "importHelpers": true, /* Import emit helpers from 'tslib'. */
|
|
27
|
+
// "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
|
|
28
|
+
// "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
|
|
29
|
+
|
|
30
|
+
/* Strict Type-Checking Options */
|
|
31
|
+
"strict": true /* Enable all strict type-checking options. */,
|
|
32
|
+
// "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */
|
|
33
|
+
// "strictNullChecks": true, /* Enable strict null checks. */
|
|
34
|
+
// "strictFunctionTypes": true, /* Enable strict checking of function types. */
|
|
35
|
+
// "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
|
|
36
|
+
// "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */
|
|
37
|
+
// "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */
|
|
38
|
+
// "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */
|
|
39
|
+
|
|
40
|
+
/* Additional Checks */
|
|
41
|
+
// "noUnusedLocals": true, /* Report errors on unused locals. */
|
|
42
|
+
// "noUnusedParameters": true, /* Report errors on unused parameters. */
|
|
43
|
+
// "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
|
|
44
|
+
// "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */
|
|
45
|
+
// "noUncheckedIndexedAccess": true, /* Include 'undefined' in index signature results */
|
|
46
|
+
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an 'override' modifier. */
|
|
47
|
+
// "noPropertyAccessFromIndexSignature": true, /* Require undeclared properties from index signatures to use element accesses. */
|
|
48
|
+
|
|
49
|
+
/* Module Resolution Options */
|
|
50
|
+
"moduleResolution": "bundler" /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */,
|
|
51
|
+
// "baseUrl": "./", /* Base directory to resolve non-absolute module names. */
|
|
52
|
+
// "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
|
|
53
|
+
// "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */
|
|
54
|
+
// "typeRoots": [], /* List of folders to include type definitions from. */
|
|
55
|
+
// "types": [], /* Type declaration files to be included in compilation. */
|
|
56
|
+
// "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
|
|
57
|
+
"esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */,
|
|
58
|
+
// "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */
|
|
59
|
+
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
|
|
60
|
+
|
|
61
|
+
/* Source Map Options */
|
|
62
|
+
// "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */
|
|
63
|
+
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
|
|
64
|
+
// "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */
|
|
65
|
+
// "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
|
|
66
|
+
|
|
67
|
+
/* Experimental Options */
|
|
68
|
+
// "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
|
|
69
|
+
// "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */
|
|
70
|
+
|
|
71
|
+
/* Advanced Options */
|
|
72
|
+
"skipLibCheck": true /* Skip type checking of declaration files. */,
|
|
73
|
+
"forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */
|
|
74
|
+
},
|
|
75
|
+
"include": ["src/", "vite.config.ts", "tsdown.config.ts"]
|
|
76
|
+
}
|
package/tsdown.config.ts
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { defineConfig } from 'tsdown'
|
|
2
|
+
import type { UserConfig } from 'tsdown'
|
|
3
|
+
|
|
4
|
+
const shared: UserConfig = {
|
|
5
|
+
entry: [
|
|
6
|
+
'./src/**/*.{ts,tsx}',
|
|
7
|
+
'!./src/**/*.test.{ts,tsx}',
|
|
8
|
+
'!./src/vitest-env.d.ts',
|
|
9
|
+
],
|
|
10
|
+
root: 'src',
|
|
11
|
+
unbundle: true,
|
|
12
|
+
hash: false,
|
|
13
|
+
minify: false,
|
|
14
|
+
treeshake: false,
|
|
15
|
+
dts: true,
|
|
16
|
+
clean: false,
|
|
17
|
+
deps: {
|
|
18
|
+
skipNodeModulesBundle: true,
|
|
19
|
+
},
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
export default defineConfig([
|
|
23
|
+
{ ...shared, format: 'esm', outDir: 'dist/esm' },
|
|
24
|
+
{
|
|
25
|
+
...shared,
|
|
26
|
+
format: 'cjs',
|
|
27
|
+
outDir: 'dist/cjs',
|
|
28
|
+
outExtensions: () => ({ js: '.js', dts: '.d.ts' }),
|
|
29
|
+
},
|
|
30
|
+
])
|
package/vite.config.ts
ADDED
|
@@ -1,35 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
var __assign = (this && this.__assign) || function () {
|
|
3
|
-
__assign = Object.assign || function(t) {
|
|
4
|
-
for (var s, i = 1, n = arguments.length; i < n; i++) {
|
|
5
|
-
s = arguments[i];
|
|
6
|
-
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
|
|
7
|
-
t[p] = s[p];
|
|
8
|
-
}
|
|
9
|
-
return t;
|
|
10
|
-
};
|
|
11
|
-
return __assign.apply(this, arguments);
|
|
12
|
-
};
|
|
13
|
-
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
14
|
-
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
15
|
-
};
|
|
16
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
-
var getOffsetFromPage_1 = __importDefault(require("./getOffsetFromPage"));
|
|
18
|
-
var getPageFromOffset_1 = __importDefault(require("./getPageFromOffset"));
|
|
19
|
-
function buildDefaultFilterInfo(filterInfo) {
|
|
20
|
-
if (filterInfo === void 0) { filterInfo = {}; }
|
|
21
|
-
var merged = __assign({
|
|
22
|
-
// Cast here to work around "'T' could be instantiated with an arbitrary
|
|
23
|
-
// type which could be unrelated to '{}'"
|
|
24
|
-
filter: {}, sort: undefined, pageSize: 20, lastRefreshAt: new Date().getTime(), totalResults: 1, totalPages: 1, offset: 0, page: 1, shouldRunImmediately: false }, filterInfo);
|
|
25
|
-
// If there's a page but no offset, set the offset.
|
|
26
|
-
if (filterInfo.page != null && filterInfo.offset == null) {
|
|
27
|
-
merged.offset = getOffsetFromPage_1.default(filterInfo.page, merged.pageSize);
|
|
28
|
-
// If there's an offset but no page, set the page.
|
|
29
|
-
}
|
|
30
|
-
else if (filterInfo.page == null && filterInfo.offset != null) {
|
|
31
|
-
merged.page = getPageFromOffset_1.default(filterInfo.offset, merged.pageSize);
|
|
32
|
-
}
|
|
33
|
-
return merged;
|
|
34
|
-
}
|
|
35
|
-
exports.default = buildDefaultFilterInfo;
|
package/dist/lib/shallowEqual.js
DELETED
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
var shallowEqual = function (objA, objB) {
|
|
4
|
-
if (Object.is(objA, objB)) {
|
|
5
|
-
return true;
|
|
6
|
-
}
|
|
7
|
-
if (typeof objA !== 'object' || !objA || typeof objB !== 'object' || !objB) {
|
|
8
|
-
return false;
|
|
9
|
-
}
|
|
10
|
-
var keysA = Object.keys(objA);
|
|
11
|
-
var keysB = Object.keys(objB);
|
|
12
|
-
if (keysA.length !== keysB.length) {
|
|
13
|
-
return false;
|
|
14
|
-
}
|
|
15
|
-
for (var _i = 0, keysA_1 = keysA; _i < keysA_1.length; _i++) {
|
|
16
|
-
var key = keysA_1[_i];
|
|
17
|
-
if (!Object.is(objA[key], objB[key])) {
|
|
18
|
-
return false;
|
|
19
|
-
}
|
|
20
|
-
}
|
|
21
|
-
return true;
|
|
22
|
-
};
|
|
23
|
-
exports.default = shallowEqual;
|
package/dist/store/index.d.ts
DELETED
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
import { FilterInfo } from '../useFilter';
|
|
2
|
-
export interface FilterStore {
|
|
3
|
-
getFilter<TFilter = any>(namespace: string): FilterInfo<TFilter> | null | undefined;
|
|
4
|
-
saveFilter<TFilter = any>(namespace: string, filter: FilterInfo<TFilter>): void;
|
|
5
|
-
getData<TResult = any>(namespace: string): TResult | null | undefined;
|
|
6
|
-
saveData<TResult = any>(namespace: string, data: TResult): void;
|
|
7
|
-
clear(): void;
|
|
8
|
-
}
|
|
9
|
-
export declare function setFilterStore(newStore: FilterStore): void;
|
|
10
|
-
export declare function getFilterStore(optionalStore?: FilterStore): FilterStore;
|
package/dist/store/index.js
DELETED
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.getFilterStore = exports.setFilterStore = void 0;
|
|
4
|
-
var globalStore;
|
|
5
|
-
function setFilterStore(newStore) {
|
|
6
|
-
globalStore = newStore;
|
|
7
|
-
}
|
|
8
|
-
exports.setFilterStore = setFilterStore;
|
|
9
|
-
function getFilterStore(optionalStore) {
|
|
10
|
-
var resolvedStore = optionalStore || globalStore;
|
|
11
|
-
if (!resolvedStore) {
|
|
12
|
-
throw new Error('A store must be set with setFilterStore');
|
|
13
|
-
}
|
|
14
|
-
return resolvedStore;
|
|
15
|
-
}
|
|
16
|
-
exports.getFilterStore = getFilterStore;
|
|
@@ -1,31 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
var prefix = 'useFilter';
|
|
4
|
-
var localStorageStore = {
|
|
5
|
-
getFilter: function (namespace) {
|
|
6
|
-
var item = localStorage.getItem(prefix + "/" + namespace + "/filter");
|
|
7
|
-
if (item) {
|
|
8
|
-
return JSON.parse(item);
|
|
9
|
-
}
|
|
10
|
-
},
|
|
11
|
-
saveFilter: function (namespace, filter) {
|
|
12
|
-
localStorage.setItem(prefix + "/" + namespace + "/filter", JSON.stringify(filter));
|
|
13
|
-
},
|
|
14
|
-
getData: function (namespace) {
|
|
15
|
-
var item = localStorage.getItem(prefix + "/" + namespace + "/data");
|
|
16
|
-
if (item) {
|
|
17
|
-
return JSON.parse(item);
|
|
18
|
-
}
|
|
19
|
-
},
|
|
20
|
-
saveData: function (namespace, data) {
|
|
21
|
-
localStorage.setItem(prefix + "/" + namespace + "/data", JSON.stringify(data));
|
|
22
|
-
},
|
|
23
|
-
clear: function () {
|
|
24
|
-
for (var key in localStorage) {
|
|
25
|
-
if (key.startsWith(prefix)) {
|
|
26
|
-
localStorage.removeItem(key);
|
|
27
|
-
}
|
|
28
|
-
}
|
|
29
|
-
},
|
|
30
|
-
};
|
|
31
|
-
exports.default = localStorageStore;
|