tsdf 8.0.0-beta.1 → 8.0.0-beta.3

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.
Files changed (57) hide show
  1. package/dist/main.cjs +1 -0
  2. package/dist/main.d.ts +269 -0
  3. package/dist/main.js +1 -0
  4. package/package.json +4 -1
  5. package/.eslintignore +0 -3
  6. package/.eslintrc.cjs +0 -119
  7. package/.gitattributes +0 -22
  8. package/.prettierrc +0 -6
  9. package/.vscode/settings.json +0 -3
  10. package/.vscode/tasks.json +0 -35
  11. package/fetch-orquestrator-scenarios.excalidraw +0 -10115
  12. package/scripts/check-if-is-sync.sh +0 -6
  13. package/src/collectionFetchOrquestrator.ts +0 -23
  14. package/src/collectionStore.ts +0 -608
  15. package/src/documentStore.ts +0 -272
  16. package/src/fetchOrquestrator.ts +0 -335
  17. package/src/listQueryStore.ts +0 -1190
  18. package/src/main.ts +0 -22
  19. package/src/storeShared.ts +0 -5
  20. package/src/useEnsureIsLoaded.ts +0 -50
  21. package/src/utils/filterAndMap.ts +0 -20
  22. package/src/utils/getCacheId.ts +0 -19
  23. package/src/utils/hooks.ts +0 -110
  24. package/src/utils/isObject.ts +0 -3
  25. package/src/utils/math.ts +0 -7
  26. package/src/utils/serializableClone.ts +0 -3
  27. package/src/utils/useLatestValue.ts +0 -16
  28. package/test/__snapshots__/listQueryStore.test.ts.snap +0 -146
  29. package/test/__snapshots__/listQueryStoreHooks.test.ts.snap +0 -9
  30. package/test/collectionStore.test.ts +0 -523
  31. package/test/collectionStoreHooks.test.tsx +0 -651
  32. package/test/documentStore.test.ts +0 -183
  33. package/test/documentStoreHooks.test.tsx +0 -857
  34. package/test/fetchOrquestrator.test.ts +0 -913
  35. package/test/listQueryStore.test.ts +0 -1158
  36. package/test/listQueryStoreHooks.test.tsx +0 -662
  37. package/test/listQueryStoreHooks2.test.tsx +0 -483
  38. package/test/listQueryStoreHooksMutations.test.tsx +0 -764
  39. package/test/mocks/fetchMock.ts +0 -296
  40. package/test/mocks/fetchOrquestratorEnv.ts +0 -370
  41. package/test/setup/setup.ts +0 -109
  42. package/test/testHelpers.test.ts +0 -88
  43. package/test/utils/RenderObjValues.tsx +0 -23
  44. package/test/utils/arrayUtils.ts +0 -13
  45. package/test/utils/createDefaultListQueryStore.ts +0 -275
  46. package/test/utils/createOrVariations.ts +0 -48
  47. package/test/utils/dedent.ts +0 -50
  48. package/test/utils/delayCall.ts +0 -25
  49. package/test/utils/math.ts +0 -3
  50. package/test/utils/objectUtils.ts +0 -18
  51. package/test/utils/range.ts +0 -19
  52. package/test/utils/sleep.ts +0 -3
  53. package/test/utils/storeUtils.ts +0 -460
  54. package/tsconfig.json +0 -24
  55. package/tsconfig.prod.json +0 -9
  56. package/tsup.config.ts +0 -12
  57. package/vitest.config.ts +0 -10
@@ -1,460 +0,0 @@
1
- /* eslint-disable @typescript-eslint/no-unsafe-argument */
2
- /* eslint-disable @typescript-eslint/no-unsafe-return */
3
- import { deepEqual, Store } from 't-state';
4
- import {
5
- newTSDFCollectionStore,
6
- TSDFCollectionStore,
7
- TSFDCollectionState,
8
- } from '../../src/collectionStore';
9
- import { newTSDFDocumentStore } from '../../src/documentStore';
10
- import { filterAndMap } from '../../src/utils/filterAndMap';
11
- import { isObject } from '../../src/utils/isObject';
12
- import { clampMin } from '../../src/utils/math';
13
- import { mockServerResource } from '../mocks/fetchMock';
14
- import { arrayWithPrevAndIndex } from './arrayUtils';
15
- import { pick } from './objectUtils';
16
-
17
- export type StoreError = {
18
- message: string;
19
- };
20
-
21
- export function normalizeError(exception: unknown): StoreError {
22
- if (exception instanceof Error) {
23
- return {
24
- message: exception.message,
25
- };
26
- }
27
-
28
- return {
29
- message: String(exception),
30
- };
31
- }
32
-
33
- export type DefaultDocStoreData = {
34
- hello: string;
35
- };
36
-
37
- export function createDefaultDocumentStore({
38
- initialServerData: serverHello = 'world',
39
- useLoadedSnapshot,
40
- emulateRTU,
41
- dynamicRTUThrottleMs,
42
- debug,
43
- }: {
44
- initialServerData?: string;
45
- useLoadedSnapshot?: boolean;
46
- debug?: never;
47
- emulateRTU?: boolean;
48
- dynamicRTUThrottleMs?: (duration: number) => number;
49
- } = {}) {
50
- const serverMock = mockServerResource<DefaultDocStoreData>({
51
- initialData: { hello: serverHello },
52
- logFetchs: debug,
53
- });
54
-
55
- const store = newTSDFDocumentStore({
56
- fetchFn: serverMock.fetchWitoutSelector,
57
- initialData: useLoadedSnapshot ? { hello: 'world' } : undefined,
58
- errorNormalizer: normalizeError,
59
- dynamicRealtimeThrottleMs: dynamicRTUThrottleMs,
60
- });
61
-
62
- const startTime = Date.now();
63
-
64
- function getElapsedTime() {
65
- return Date.now() - startTime;
66
- }
67
-
68
- if (debug as any) {
69
- store.store.subscribe(({ current }) => {
70
- // eslint-disable-next-line no-console
71
- console.log(serverMock.relativeTime(), current);
72
- });
73
- }
74
-
75
- if (emulateRTU) {
76
- serverMock.addOnUpdateServerData(({ prev, data }) => {
77
- if (!deepEqual(prev, data)) {
78
- store.invalidateData('realtimeUpdate');
79
- }
80
- });
81
- }
82
-
83
- return { serverMock, store, getElapsedTime };
84
- }
85
-
86
- type Todo = {
87
- title: string;
88
- completed: boolean;
89
- description?: string;
90
- };
91
-
92
- type ServerData = Record<string, Todo | null>;
93
-
94
- export type DefaultCollectionState = TSFDCollectionState<
95
- Todo,
96
- string,
97
- StoreError
98
- >;
99
-
100
- export type DefaultCollectionStore = TSDFCollectionStore<
101
- Todo,
102
- StoreError,
103
- string
104
- >;
105
-
106
- export function createDefaultCollectionStore<
107
- Payload extends { id: { id: string } } | string = string,
108
- >({
109
- initialServerData: serverInitialData = {
110
- '1': { title: 'todo', completed: false },
111
- },
112
- useLoadedSnapshot,
113
- randomTimeout,
114
- emulateRTU,
115
- dynamicRTUThrottleMs,
116
- debug,
117
- }: {
118
- initialServerData?: ServerData;
119
- useLoadedSnapshot?: boolean;
120
- dynamicRTUThrottleMs?: (duration: number) => number;
121
- emulateRTU?: boolean;
122
- /** default: 30-100 */
123
- randomTimeout?: true;
124
- debug?: never;
125
- } = {}) {
126
- const serverMock = mockServerResource<ServerData, Todo>({
127
- initialData: serverInitialData,
128
- randomTimeout,
129
- logFetchs: debug,
130
- fetchSelector(data, params) {
131
- let payload = params.startsWith('{"id":"')
132
- ? (JSON.parse(params) as { id: { id: string } })
133
- : params;
134
-
135
- if (isObject(payload)) {
136
- payload = payload.id.id;
137
- }
138
-
139
- const todo: any = data && data[params];
140
-
141
- if (!todo) {
142
- throw new Error('Not found');
143
- }
144
-
145
- return todo;
146
- },
147
- });
148
-
149
- const collectionStore = newTSDFCollectionStore<Todo, StoreError, Payload>({
150
- fetchFn: async (payload) => {
151
- return serverMock.fetch(
152
- typeof payload === 'object' ? JSON.stringify(payload) : String(payload),
153
- );
154
- },
155
- errorNormalizer: normalizeError,
156
- dynamicRealtimeThrottleMs: dynamicRTUThrottleMs,
157
- });
158
-
159
- if (useLoadedSnapshot) {
160
- const initialState: DefaultCollectionState = {};
161
-
162
- for (const [id, todo] of Object.entries(serverInitialData)) {
163
- initialState[id] = {
164
- data: todo,
165
- status: 'success',
166
- error: null,
167
- payload: id,
168
- refetchOnMount: false,
169
- wasLoaded: true,
170
- };
171
- }
172
-
173
- collectionStore.store.setState(initialState as any);
174
- }
175
-
176
- const startTime = Date.now();
177
-
178
- function getElapsedTime() {
179
- return Date.now() - startTime;
180
- }
181
-
182
- const renderResults: any[] = [];
183
-
184
- function onRender(renderResult: any) {
185
- renderResults.push(renderResult);
186
- }
187
-
188
- if (debug as any) {
189
- collectionStore.store.subscribe(({ current }) => {
190
- // eslint-disable-next-line no-console
191
- console.log(serverMock.relativeTime(), current);
192
- });
193
- }
194
-
195
- if (emulateRTU) {
196
- serverMock.addOnUpdateServerData(({ prev, data }) => {
197
- for (const tableId of Object.keys(data)) {
198
- if (!deepEqual(prev[tableId], data[tableId])) {
199
- collectionStore.invalidateItem(tableId as Payload, 'realtimeUpdate');
200
- }
201
- }
202
- });
203
- }
204
-
205
- return {
206
- serverMock,
207
- store: collectionStore,
208
- getElapsedTime,
209
- onRender,
210
- renderResults,
211
- shouldNotSkip(this: void, scheduleResult: any) {
212
- if (scheduleResult === 'skipped') {
213
- throw new Error('Should not skip');
214
- }
215
- },
216
- };
217
- }
218
-
219
- export function shouldNotSkip(scheduleResult: any) {
220
- if (scheduleResult === 'skipped') {
221
- throw new Error('Should not skip');
222
- }
223
- }
224
-
225
- export function createRenderStore() {
226
- let renders: Record<string, unknown>[] = [];
227
- let rendersTime: number[] = [];
228
- let startTime = Date.now();
229
- let onNextRender: () => void = () => {};
230
-
231
- function reset(keepLastRender = false) {
232
- renders = keepLastRender ? [renders.at(-1)!] : [];
233
- rendersTime = [];
234
- startTime = Date.now();
235
- }
236
-
237
- function add(render: Record<string, unknown>) {
238
- renders.push(render);
239
- rendersTime.push(Date.now() - startTime);
240
-
241
- onNextRender();
242
-
243
- if (renders.length > 100) {
244
- throw new Error('Too many renders');
245
- }
246
- }
247
-
248
- function renderCount() {
249
- return renders.filter((item) => !item._lastSnapshotMark).length;
250
- }
251
-
252
- async function waitNextRender(timeout = 50) {
253
- return new Promise<void>((resolve) => {
254
- const timeoutId = setTimeout(() => {
255
- throw new Error('Timeout');
256
- }, timeout);
257
-
258
- onNextRender = () => {
259
- clearTimeout(timeoutId);
260
- resolve();
261
- };
262
- });
263
- }
264
-
265
- function getSnapshot({
266
- arrays = { firstNItems: 1 },
267
- changesOnly = true,
268
- filterKeys,
269
- includeLastSnapshotEndMark = true,
270
- }: {
271
- arrays?: 'all' | 'firstAndLast' | 'lenght' | { firstNItems: number };
272
- changesOnly?: boolean;
273
- filterKeys?: string[];
274
- includeLastSnapshotEndMark?: boolean;
275
- } = {}) {
276
- let rendersToUse = renders;
277
-
278
- if (changesOnly || filterKeys) {
279
- rendersToUse = [];
280
-
281
- for (let { item, prev } of arrayWithPrevAndIndex(renders)) {
282
- if (filterKeys) {
283
- prev = prev && pick(prev, filterKeys);
284
- item = pick(item, filterKeys);
285
- }
286
-
287
- if (!deepEqual(prev, item)) {
288
- rendersToUse.push(item);
289
- }
290
- }
291
- }
292
-
293
- renders.push({ _lastSnapshotMark: true });
294
-
295
- return `\n${filterAndMap(rendersToUse, (render, ignore, i) => {
296
- if (render._lastSnapshotMark) {
297
- if (includeLastSnapshotEndMark && i !== rendersToUse.length - 1) {
298
- return '---';
299
- } else {
300
- return ignore;
301
- }
302
- }
303
-
304
- let line = '';
305
-
306
- for (const [key, _value] of Object.entries(render)) {
307
- let value = _value;
308
-
309
- if (Array.isArray(value)) {
310
- if (arrays === 'lenght') {
311
- value = `Array(${value.length})`;
312
- } else if (arrays === 'firstAndLast' && value.length > 2) {
313
- const intermediateSize = clampMin(value.length - 2, 0);
314
-
315
- value = [
316
- value[0],
317
- `...(${intermediateSize} between)`,
318
- value.at(-1),
319
- ];
320
- } else if (typeof arrays === 'object' && value.length > 2) {
321
- value = [
322
- ...value.slice(0, arrays.firstNItems),
323
- `...(${value.length - arrays.firstNItems} more)`,
324
- ];
325
- }
326
- }
327
-
328
- if (value === '') {
329
- value = `''`;
330
- }
331
-
332
- if (typeof value === 'object' && value !== null) {
333
- value = JSON.stringify(value).replace(/"/g, '').replace(/,/g, ', ');
334
- }
335
-
336
- line += `${key}: ${value} -- `;
337
- }
338
-
339
- line = line.slice(0, -4);
340
- return line;
341
- }).join('\n')}\n`;
342
- }
343
-
344
- return {
345
- add,
346
- reset,
347
- getSnapshot,
348
- waitNextRender,
349
- get changesSnapshot() {
350
- return getSnapshot({ changesOnly: true });
351
- },
352
- get snapshot() {
353
- return getSnapshot({ changesOnly: false });
354
- },
355
- renderCount,
356
- get rendersTime() {
357
- return rendersTime;
358
- },
359
- };
360
- }
361
-
362
- export function createValueStore<T>(initialValue: T) {
363
- const store = new Store({
364
- state: { value: initialValue },
365
- });
366
-
367
- return {
368
- store,
369
- useValue() {
370
- return store.useSelector((state) => state.value);
371
- },
372
- set(value: T) {
373
- store.setState({ value });
374
- },
375
- };
376
- }
377
-
378
- function formatArray(
379
- type: 'all' | { firstNItems: number } | 'length',
380
- array: any[],
381
- ): string {
382
- if (type === 'length') {
383
- return `Array(${array.length})`;
384
- }
385
-
386
- const normalizedItems: string[] = [];
387
-
388
- for (const item of array) {
389
- if (isObject(item)) {
390
- normalizedItems.push(`{${formatObject(item, type)}}`);
391
- } else {
392
- normalizedItems.push(String(item));
393
- }
394
-
395
- if (
396
- typeof type === 'object' &&
397
- normalizedItems.length >= type.firstNItems
398
- ) {
399
- normalizedItems.push(`...(${array.length - type.firstNItems} more)`);
400
- break;
401
- }
402
- }
403
-
404
- return `[${normalizedItems.join(', ')}]`;
405
- }
406
-
407
- function formatObject(obj: Record<string, any>, arrayType: any): string {
408
- return Object.keys(obj)
409
- .map((key) => {
410
- let value = obj[key];
411
-
412
- if (Array.isArray(value)) {
413
- value = formatArray(arrayType, value);
414
- }
415
-
416
- if (isObject(value)) {
417
- value = JSON.stringify(value)
418
- .replace(/"/g, '')
419
- .replace(/,/g, ', ')
420
- .replace(/:/g, ': ');
421
- }
422
-
423
- return `${key}: ${value}`;
424
- })
425
- .join(', ');
426
- }
427
-
428
- export function simplifyArraySnapshot(
429
- array: any[],
430
- arrayType: 'all' | { firstNItems: number } | 'length' = { firstNItems: 4 },
431
- ) {
432
- const result = array
433
- .map((item) => {
434
- if (isObject(item)) {
435
- return formatObject(item, arrayType);
436
- }
437
-
438
- if (Array.isArray(item)) {
439
- return formatArray(arrayType, item);
440
- }
441
-
442
- return String(item);
443
- })
444
- .join('\n');
445
-
446
- return `\n${result}\n`;
447
- }
448
-
449
- export function waitElapsedTime() {
450
- const startTime = Date.now();
451
-
452
- return (waitUntil: number) => {
453
- return new Promise<void>((resolve) => {
454
- const timeoutId = setTimeout(() => {
455
- clearTimeout(timeoutId);
456
- resolve();
457
- }, waitUntil - (Date.now() - startTime));
458
- });
459
- };
460
- }
package/tsconfig.json DELETED
@@ -1,24 +0,0 @@
1
- {
2
- "compileOnSave": false,
3
- "compilerOptions": {
4
- "target": "ESNext",
5
- "moduleResolution": "node",
6
- "module": "CommonJS",
7
- "jsx": "react-jsx",
8
- "skipLibCheck": true,
9
- "types": [
10
- "node"
11
- ],
12
- "noEmit": true,
13
- "esModuleInterop": true,
14
- "strictNullChecks": true,
15
- "noImplicitReturns": true,
16
- "noImplicitAny": true,
17
- "alwaysStrict": true,
18
- "strict": true,
19
- "noUncheckedIndexedAccess": true,
20
- "forceConsistentCasingInFileNames": true,
21
- "keyofStringsOnly": true,
22
- "strictPropertyInitialization": true
23
- }
24
- }
@@ -1,9 +0,0 @@
1
- {
2
- "extends": "./tsconfig.json",
3
- "compilerOptions": {
4
- "outDir": "./dist",
5
- "noEmit": false,
6
- "declaration": true
7
- },
8
- "include": ["src/*", "test/**/*"],
9
- }
package/tsup.config.ts DELETED
@@ -1,12 +0,0 @@
1
- import { defineConfig } from 'tsup';
2
- import glob from 'tiny-glob'
3
-
4
-
5
- export default defineConfig({
6
- entry: ['src/main.ts'],
7
- clean: true,
8
- format: ['cjs', 'esm'],
9
- esbuildOptions(options) {
10
- options.mangleProps = /[^_]_$/;
11
- },
12
- });
package/vitest.config.ts DELETED
@@ -1,10 +0,0 @@
1
- import { defineConfig } from 'vitest/config';
2
-
3
- export default defineConfig({
4
- test: {
5
- include: ['test/*.test.{ts,tsx}'],
6
- testTimeout: 5_000,
7
- setupFiles: 'test/setup/setup.ts',
8
- environment: 'happy-dom',
9
- },
10
- });