tsdf 17.0.2 → 17.0.4

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 (247) hide show
  1. package/dist/async-storage.d.ts +1 -1
  2. package/dist/{asyncStorageAdapter-DuAUANgu.d.ts → asyncStorageAdapter-CMohMeKm.d.ts} +1 -1
  3. package/dist/indexed-db-storage.d.ts +1 -1
  4. package/dist/main.d.ts +28 -32
  5. package/dist/main.js +46 -46
  6. package/dist/opfs-storage.d.ts +1 -1
  7. package/dist/{opfsPersistentStorage-BB0qqnRz.d.ts → opfsPersistentStorage-Ci0JcCo5.d.ts} +1 -1
  8. package/dist/src/async-storage.d.ts +1 -0
  9. package/dist/src/cacheLimits/lruCacheRuntime.d.ts +9 -0
  10. package/dist/src/cacheLimits/scheduleIdleThrottled.d.ts +1 -0
  11. package/dist/src/cacheLimits/useRegisterActiveKeys.d.ts +1 -0
  12. package/dist/src/collectionStore/collectionCacheLimits.d.ts +1 -0
  13. package/dist/src/collectionStore/collectionStore.d.ts +385 -0
  14. package/dist/src/collectionStore/executeBatchFetch.d.ts +6 -0
  15. package/dist/src/collectionStore/useItem.d.ts +15 -0
  16. package/dist/src/collectionStore/useMultipleItems.d.ts +35 -0
  17. package/dist/src/debug.d.ts +30 -0
  18. package/dist/src/documentStore.d.ts +290 -0
  19. package/dist/src/hooks/useListItem.d.ts +22 -0
  20. package/dist/src/hooks/useListItemIsDeleted.d.ts +13 -0
  21. package/dist/src/hooks/useListItemIsLoading.d.ts +16 -0
  22. package/dist/src/indexed-db-storage.d.ts +1 -0
  23. package/dist/src/internal/offlineTestInstrumentation.d.ts +12 -0
  24. package/dist/src/internal/testTimelineTypes.d.ts +1 -0
  25. package/dist/src/invalidationUtils.d.ts +8 -0
  26. package/dist/src/isOffScreenContext.d.ts +16 -0
  27. package/dist/src/listQueryStore/createFetchApi.d.ts +1 -0
  28. package/dist/src/listQueryStore/createMutationApi.d.ts +1 -0
  29. package/dist/src/listQueryStore/executeItemBatchFetch.d.ts +20 -0
  30. package/dist/src/listQueryStore/executeQueryFetch.d.ts +7 -0
  31. package/dist/src/listQueryStore/itemFieldUtils.d.ts +77 -0
  32. package/dist/src/listQueryStore/listQueryCacheLimits.d.ts +1 -0
  33. package/dist/src/listQueryStore/listQueryStore.d.ts +538 -0
  34. package/dist/src/listQueryStore/types.d.ts +347 -0
  35. package/dist/src/listQueryStore/useFindItem.d.ts +7 -0
  36. package/dist/src/listQueryStore/useItem.d.ts +29 -0
  37. package/dist/src/listQueryStore/useListQuery.d.ts +29 -0
  38. package/dist/src/listQueryStore/useMultipleItems.d.ts +44 -0
  39. package/dist/src/listQueryStore/useMultipleListQueries.d.ts +46 -0
  40. package/dist/src/listQueryStore/usePendingOfflineItems.d.ts +19 -0
  41. package/dist/src/main.d.ts +23 -0
  42. package/dist/src/opfs-storage.d.ts +1 -0
  43. package/dist/src/persistentStorage/asyncStorageAdapter.d.ts +95 -0
  44. package/dist/src/persistentStorage/asyncStorageAdapters.d.ts +2 -0
  45. package/dist/src/persistentStorage/asyncStorageShared.d.ts +23 -0
  46. package/dist/src/persistentStorage/collectionStorePersistence.d.ts +26 -0
  47. package/dist/src/persistentStorage/compactListQueryLocalStorageEntry.d.ts +11 -0
  48. package/dist/src/persistentStorage/compactLocalStorageEntry.d.ts +8 -0
  49. package/dist/src/persistentStorage/documentEntryKey.d.ts +1 -0
  50. package/dist/src/persistentStorage/documentStorePersistence.d.ts +17 -0
  51. package/dist/src/persistentStorage/indexedDbAsyncStorageAdapter.d.ts +165 -0
  52. package/dist/src/persistentStorage/indexedDbPersistentStorage.d.ts +6 -0
  53. package/dist/src/persistentStorage/listQueryStorePersistence.d.ts +37 -0
  54. package/dist/src/persistentStorage/localStorageMetadata.d.ts +126 -0
  55. package/dist/src/persistentStorage/navigatorLocks.d.ts +3 -0
  56. package/dist/src/persistentStorage/offline/entityMetadata.d.ts +12 -0
  57. package/dist/src/persistentStorage/offline/fetchRuntime.d.ts +35 -0
  58. package/dist/src/persistentStorage/offline/mutationRuntime.d.ts +31 -0
  59. package/dist/src/persistentStorage/offline/offlineResolution.typeGuards.d.ts +1 -0
  60. package/dist/src/persistentStorage/offline/overlayStoreLifecycle.d.ts +13 -0
  61. package/dist/src/persistentStorage/offline/sessionCoordinator.d.ts +94 -0
  62. package/dist/src/persistentStorage/offline/sessionProtectionRegistry.d.ts +11 -0
  63. package/dist/src/persistentStorage/offline/storeController.d.ts +86 -0
  64. package/dist/src/persistentStorage/offline/types.d.ts +1255 -0
  65. package/dist/src/persistentStorage/offlineUploadRegistry.d.ts +11 -0
  66. package/dist/src/persistentStorage/offlineUploadTypes.d.ts +97 -0
  67. package/dist/src/persistentStorage/offlineUploadsShared.d.ts +4 -0
  68. package/dist/src/persistentStorage/opfsAsyncStorageAdapter.d.ts +24 -0
  69. package/dist/src/persistentStorage/opfsFileNaming.d.ts +23 -0
  70. package/dist/src/persistentStorage/opfsHelpers.d.ts +3 -0
  71. package/dist/src/persistentStorage/opfsOfflineUploadAdapter.d.ts +2 -0
  72. package/dist/src/persistentStorage/opfsPersistentStorage.d.ts +2 -0
  73. package/dist/src/persistentStorage/parsePersistedData.d.ts +45 -0
  74. package/dist/src/persistentStorage/persistenceUtils.d.ts +52 -0
  75. package/dist/src/persistentStorage/persistentStorageDefaults.d.ts +4 -0
  76. package/dist/src/persistentStorage/persistentStorageManager.d.ts +197 -0
  77. package/dist/src/persistentStorage/quotaDebug.d.ts +16 -0
  78. package/dist/src/persistentStorage/scheduleIdleCleanup.d.ts +28 -0
  79. package/dist/src/persistentStorage/storageAdapter.d.ts +41 -0
  80. package/dist/src/persistentStorage/storageEntryPrefixes.d.ts +16 -0
  81. package/dist/src/persistentStorage/types.d.ts +412 -0
  82. package/dist/src/persistentStorage/validateWithSchema.d.ts +12 -0
  83. package/dist/src/requestScheduler.d.ts +81 -0
  84. package/dist/src/storeManager.d.ts +160 -0
  85. package/dist/src/utils/automaticFetchPolicy.d.ts +29 -0
  86. package/dist/src/utils/browserTabsPriority.d.ts +43 -0
  87. package/dist/src/utils/browserTabsSync.d.ts +33 -0
  88. package/dist/src/utils/optimisticMutationTracker.d.ts +20 -0
  89. package/dist/src/utils/optimisticRollback.d.ts +11 -0
  90. package/dist/src/utils/payloadDebounce.d.ts +5 -0
  91. package/dist/src/utils/performMutation.d.ts +19 -0
  92. package/dist/src/utils/reusePrevIfEqual.d.ts +1 -0
  93. package/dist/src/utils/storeFocusLifecycle.d.ts +1 -0
  94. package/dist/src/utils/storeShared.d.ts +126 -0
  95. package/dist/src/utils/useEnsureIsLoaded.d.ts +6 -0
  96. package/dist/src/utils/useRequireFreshData.d.ts +6 -0
  97. package/dist/tests/basic-functionality/collection-store.test.d.ts +1 -0
  98. package/dist/tests/basic-functionality/document-store.test.d.ts +1 -0
  99. package/dist/tests/basic-functionality/list-query-state-manipulation.test.d.ts +1 -0
  100. package/dist/tests/basic-functionality/list-query-store.test.d.ts +1 -0
  101. package/dist/tests/browser-tabs/browser-tabs-background-rtu-batch.test.d.ts +1 -0
  102. package/dist/tests/browser-tabs/browser-tabs-background-rtu.test.d.ts +1 -0
  103. package/dist/tests/browser-tabs/browser-tabs-background-scheduling.test.d.ts +1 -0
  104. package/dist/tests/browser-tabs/browser-tabs-list-query-pagination.test.d.ts +1 -0
  105. package/dist/tests/browser-tabs/browser-tabs-non-cancelable-fetches.test.d.ts +1 -0
  106. package/dist/tests/browser-tabs/browser-tabs-optimistic-sync.test.d.ts +1 -0
  107. package/dist/tests/browser-tabs/browser-tabs-partial-resources.test.d.ts +1 -0
  108. package/dist/tests/browser-tabs/browser-tabs-priority.test.d.ts +1 -0
  109. package/dist/tests/browser-tabs/browser-tabs-snapshot-consistency.test.d.ts +1 -0
  110. package/dist/tests/browser-tabs/browser-tabs-state-methods.test.d.ts +1 -0
  111. package/dist/tests/browser-tabs/browser-tabs-sync-coordinator.test.d.ts +1 -0
  112. package/dist/tests/browser-tabs/browser-tabs-test-helpers.d.ts +69 -0
  113. package/dist/tests/browser-tabs/focus-coordinator.test.d.ts +1 -0
  114. package/dist/tests/hooks/collection-hooks-2.test.d.ts +1 -0
  115. package/dist/tests/hooks/collection-hooks.test.d.ts +1 -0
  116. package/dist/tests/hooks/collection-useListItem.test.d.ts +1 -0
  117. package/dist/tests/hooks/debounce-payload-hooks.test.d.ts +1 -0
  118. package/dist/tests/hooks/disable-refetches.test.d.ts +1 -0
  119. package/dist/tests/hooks/document-hooks-2.test.d.ts +1 -0
  120. package/dist/tests/hooks/document-hooks.test.d.ts +1 -0
  121. package/dist/tests/hooks/document-useListItem.test.d.ts +1 -0
  122. package/dist/tests/hooks/fetch-error-recovery.test.d.ts +1 -0
  123. package/dist/tests/hooks/hook-memoization.test.d.ts +1 -0
  124. package/dist/tests/hooks/list-query-hooks-2.test.d.ts +1 -0
  125. package/dist/tests/hooks/list-query-hooks-3.test.d.ts +1 -0
  126. package/dist/tests/hooks/list-query-hooks-mutations.test.d.ts +1 -0
  127. package/dist/tests/hooks/list-query-hooks.test.d.ts +1 -0
  128. package/dist/tests/hooks/list-query-pending-offline-items.test.d.ts +1 -0
  129. package/dist/tests/hooks/off-screen-context.test.d.ts +1 -0
  130. package/dist/tests/list-query-features/list-query-derived-queries.test.d.ts +1 -0
  131. package/dist/tests/list-query-features/list-query-offset-pagination.test.d.ts +1 -0
  132. package/dist/tests/list-query-features/list-query-optimistic-filters.test.d.ts +1 -0
  133. package/dist/tests/list-query-features/list-query-partial-resources-2.test.d.ts +1 -0
  134. package/dist/tests/list-query-features/list-query-partial-resources-3.test.d.ts +1 -0
  135. package/dist/tests/list-query-features/list-query-partial-resources-regressions.test.d.ts +1 -0
  136. package/dist/tests/list-query-features/list-query-partial-resources-show-partial-status.test.d.ts +1 -0
  137. package/dist/tests/list-query-features/list-query-partial-resources.test.d.ts +1 -0
  138. package/dist/tests/list-query-features/list-query-size-coalescing-partial-resources.test.d.ts +1 -0
  139. package/dist/tests/mocks/browserTabsTestUtils.d.ts +17 -0
  140. package/dist/tests/mocks/collectionStoreTestEnv.d.ts +265 -0
  141. package/dist/tests/mocks/documentStoreTestEnv.d.ts +140 -0
  142. package/dist/tests/mocks/duplicateStoreGuard.test.d.ts +1 -0
  143. package/dist/tests/mocks/listQueryStoreTestEnv.d.ts +295 -0
  144. package/dist/tests/mocks/mockBrowserOpfs.d.ts +70 -0
  145. package/dist/tests/mocks/mockBrowserOpfs.test.d.ts +1 -0
  146. package/dist/tests/mocks/mockLocalStorageStore.d.ts +61 -0
  147. package/dist/tests/mocks/seedScenarioPersistentStorage.d.ts +51 -0
  148. package/dist/tests/mocks/serverMock.d.ts +56 -0
  149. package/dist/tests/mocks/serverTableMock.d.ts +174 -0
  150. package/dist/tests/mocks/testEnvUtils.d.ts +120 -0
  151. package/dist/tests/mocks/testScenarioPersistentStorage.test.d.ts +1 -0
  152. package/dist/tests/offline/offline-fetching-scenarios.test.d.ts +1 -0
  153. package/dist/tests/offline/offline-mixed-adapter-storage.test.d.ts +1 -0
  154. package/dist/tests/offline/offline-mutation-fallback.test.d.ts +1 -0
  155. package/dist/tests/offline/offline-network-recovery.test.d.ts +1 -0
  156. package/dist/tests/offline/offline-outage.test.d.ts +1 -0
  157. package/dist/tests/offline/offline-overlays.test.d.ts +1 -0
  158. package/dist/tests/offline/offline-query-replay.test.d.ts +1 -0
  159. package/dist/tests/offline/offline-reads.test.d.ts +1 -0
  160. package/dist/tests/offline/offline-replay-conflicts.test.d.ts +1 -0
  161. package/dist/tests/offline/offline-replay-queueing.test.d.ts +1 -0
  162. package/dist/tests/offline/offline-resolution-dependencies.test.d.ts +1 -0
  163. package/dist/tests/offline/offline-runtime-controls.test.d.ts +1 -0
  164. package/dist/tests/offline/offline-session-and-global-state.test.d.ts +1 -0
  165. package/dist/tests/offline/offline-storage.test.d.ts +1 -0
  166. package/dist/tests/offline/offline-uploads.test.d.ts +1 -0
  167. package/dist/tests/offline/offlineReplayTestShared.d.ts +292 -0
  168. package/dist/tests/offline/offlineTestShared.d.ts +156 -0
  169. package/dist/tests/perform-mutation/mutation-error-rollback.test.d.ts +1 -0
  170. package/dist/tests/perform-mutation/perform-mutation-block-window-close.test.d.ts +1 -0
  171. package/dist/tests/perform-mutation/perform-mutation-debounce.test.d.ts +1 -0
  172. package/dist/tests/perform-mutation/store-events.test.d.ts +1 -0
  173. package/dist/tests/persistent-storage/async-storage-efficiency/collection.test.d.ts +1 -0
  174. package/dist/tests/persistent-storage/async-storage-efficiency/document.test.d.ts +1 -0
  175. package/dist/tests/persistent-storage/async-storage-efficiency/list-query.test.d.ts +1 -0
  176. package/dist/tests/persistent-storage/async-storage-efficiency/maintenance.test.d.ts +1 -0
  177. package/dist/tests/persistent-storage/async-storage-efficiency/shared.d.ts +804 -0
  178. package/dist/tests/persistent-storage/async-storage-shared.test.d.ts +1 -0
  179. package/dist/tests/persistent-storage/collection-store-persistence.converted.opfs.test.d.ts +1 -0
  180. package/dist/tests/persistent-storage/collection-store-persistence.converted.test.d.ts +1 -0
  181. package/dist/tests/persistent-storage/collection-store-persistence.opfs.test.d.ts +1 -0
  182. package/dist/tests/persistent-storage/collection-store-persistence.test.d.ts +1 -0
  183. package/dist/tests/persistent-storage/document-store-persistence.converted.opfs.test.d.ts +1 -0
  184. package/dist/tests/persistent-storage/document-store-persistence.converted.test.d.ts +1 -0
  185. package/dist/tests/persistent-storage/document-store-persistence.opfs.test.d.ts +1 -0
  186. package/dist/tests/persistent-storage/document-store-persistence.test.d.ts +1 -0
  187. package/dist/tests/persistent-storage/expiration-scan.test.d.ts +1 -0
  188. package/dist/tests/persistent-storage/indexeddb-async-storage-efficiency/collection.test.d.ts +1 -0
  189. package/dist/tests/persistent-storage/indexeddb-async-storage-efficiency/document.test.d.ts +1 -0
  190. package/dist/tests/persistent-storage/indexeddb-async-storage-efficiency/list-query.test.d.ts +1 -0
  191. package/dist/tests/persistent-storage/indexeddb-async-storage-efficiency/maintenance.test.d.ts +1 -0
  192. package/dist/tests/persistent-storage/indexeddb-async-storage-efficiency/shared.d.ts +780 -0
  193. package/dist/tests/persistent-storage/indexeddb-storage-adapter.test.d.ts +1 -0
  194. package/dist/tests/persistent-storage/list-query-store-persistence.converted.opfs.test.d.ts +1 -0
  195. package/dist/tests/persistent-storage/list-query-store-persistence.converted.test.d.ts +1 -0
  196. package/dist/tests/persistent-storage/list-query-store-persistence.opfs.test.d.ts +1 -0
  197. package/dist/tests/persistent-storage/list-query-store-persistence.test.d.ts +1 -0
  198. package/dist/tests/persistent-storage/persistence-with-tabs-sync.test.d.ts +1 -0
  199. package/dist/tests/persistent-storage/persistentStorageByteBudgetTestUtils.d.ts +18 -0
  200. package/dist/tests/persistent-storage/quota-exceeded-recovery-no-locks.test.d.ts +1 -0
  201. package/dist/tests/persistent-storage/quota-exceeded-recovery.test.d.ts +1 -0
  202. package/dist/tests/persistent-storage/quotaRecoveryTestUtils.d.ts +228 -0
  203. package/dist/tests/persistent-storage/storage-adapter.test.d.ts +1 -0
  204. package/dist/tests/persistent-storage/sync-storage-efficiency/collection.test.d.ts +1 -0
  205. package/dist/tests/persistent-storage/sync-storage-efficiency/document.test.d.ts +1 -0
  206. package/dist/tests/persistent-storage/sync-storage-efficiency/list-query.test.d.ts +1 -0
  207. package/dist/tests/persistent-storage/sync-storage-efficiency/maintenance.test.d.ts +1 -0
  208. package/dist/tests/persistent-storage/sync-storage-efficiency/shared.d.ts +784 -0
  209. package/dist/tests/playwright/browser-tabs.spec.d.ts +1 -0
  210. package/dist/tests/playwright/persistent-storage.spec.d.ts +1 -0
  211. package/dist/tests/request-schedulling/batch-medium-priority.test.d.ts +1 -0
  212. package/dist/tests/request-schedulling/batch-realtime-updates.test.d.ts +1 -0
  213. package/dist/tests/request-schedulling/collection-batch-coalescing.test.d.ts +1 -0
  214. package/dist/tests/request-schedulling/collection-batch-key-grouping.test.d.ts +1 -0
  215. package/dist/tests/request-schedulling/collection-fetch-orchestration.test.d.ts +1 -0
  216. package/dist/tests/request-schedulling/document-await-fetch.test.d.ts +1 -0
  217. package/dist/tests/request-schedulling/document-base-coalescing.test.d.ts +1 -0
  218. package/dist/tests/request-schedulling/document-fetch-orchestration.test.d.ts +1 -0
  219. package/dist/tests/request-schedulling/document-medium-priority-fetch.test.d.ts +1 -0
  220. package/dist/tests/request-schedulling/document-realtime-updates.test.d.ts +1 -0
  221. package/dist/tests/request-schedulling/list-query-item-batch-coalescing.test.d.ts +1 -0
  222. package/dist/tests/request-schedulling/list-query-item-batch-key-grouping.test.d.ts +1 -0
  223. package/dist/tests/request-schedulling/list-query-size-coalescing.test.d.ts +1 -0
  224. package/dist/tests/request-schedulling/medium-vs-realtime.test.d.ts +1 -0
  225. package/dist/tests/request-schedulling/request-scheduler-cross-tab-sync.test.d.ts +1 -0
  226. package/dist/tests/request-schedulling/window-focus.test.d.ts +1 -0
  227. package/dist/tests/store-manager.test.d.ts +1 -0
  228. package/dist/tests/user-facing-api/collection-offline-usage.test.d.ts +1 -0
  229. package/dist/tests/user-facing-api/document-offline-usage.test.d.ts +1 -0
  230. package/dist/tests/user-facing-api/list-query-offline-usage.test.d.ts +1 -0
  231. package/dist/tests/user-facing-api/result-returning-callbacks.test.d.ts +1 -0
  232. package/dist/tests/utils/genericTestUtils.d.ts +6 -0
  233. package/dist/tests/utils/indexedDbPersistentStorageOptimizationTestUtils.d.ts +79 -0
  234. package/dist/tests/utils/indexedDbPersistentStorageTestStore.d.ts +181 -0
  235. package/dist/tests/utils/listQueryHooksTestUtils.d.ts +8 -0
  236. package/dist/tests/utils/networkMock.d.ts +11 -0
  237. package/dist/tests/utils/opfsPersistentStorageTestStore.d.ts +220 -0
  238. package/dist/tests/utils/persistentStorageOptimizationTestUtils.d.ts +54 -0
  239. package/dist/tests/utils/persistentStorageOptimizationTestUtils.test.d.ts +1 -0
  240. package/dist/tests/utils/persistentStorageTestStore.d.ts +66 -0
  241. package/dist/tests/utils/resetSessionForTests.d.ts +3 -0
  242. package/dist/tests/utils/withSuppressedActError.d.ts +4 -0
  243. package/dist/{types-aWgyZHLj.d.ts → types-D0ttVGmj.d.ts} +1 -1
  244. package/docs/browser-tabs-sync.md +2 -0
  245. package/docs/mutations.md +7 -3
  246. package/docs/persistent-storage.md +2 -0
  247. package/package.json +6 -3
@@ -0,0 +1 @@
1
+ import '@testing-library/react/dont-cleanup-after-each';
@@ -0,0 +1 @@
1
+ import '@testing-library/react/dont-cleanup-after-each';
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1 @@
1
+ import '@testing-library/react/dont-cleanup-after-each';
@@ -0,0 +1 @@
1
+ import '@testing-library/react/dont-cleanup-after-each';
@@ -0,0 +1 @@
1
+ import '@testing-library/react/dont-cleanup-after-each';
@@ -0,0 +1 @@
1
+ import '@testing-library/react/dont-cleanup-after-each';
@@ -0,0 +1 @@
1
+ import '@testing-library/react/dont-cleanup-after-each';
@@ -0,0 +1 @@
1
+ import '@testing-library/react/dont-cleanup-after-each';
@@ -0,0 +1,17 @@
1
+ import type { BrowserTabsTransportFactory } from '../../src/utils/browserTabsSync';
2
+ export declare function getNextStoreId(prefix?: string): string;
3
+ export declare function registerMockStoreInstance(args: {
4
+ storeId: string;
5
+ storeType: 'document' | 'collection' | 'listQuery';
6
+ testBrowserTabId: string;
7
+ }): () => void;
8
+ export type BrowserTabsTransportAuditEntry = {
9
+ channelName: string;
10
+ message: unknown;
11
+ };
12
+ export declare function createInMemoryBrowserTabsTransportFactory(): BrowserTabsTransportFactory;
13
+ export declare function createInspectableInMemoryBrowserTabsTransportFactory(): {
14
+ transportFactory: BrowserTabsTransportFactory;
15
+ getMessages(channelName?: string | undefined): BrowserTabsTransportAuditEntry[];
16
+ replayMessage(entry: BrowserTabsTransportAuditEntry): void;
17
+ };
@@ -0,0 +1,265 @@
1
+ import type { __LEGIT_ANY__ } from '@ls-stack/utils/saferTyping';
2
+ import { type CollectionStoreOptions } from '../../src/collectionStore/collectionStore';
3
+ import type { AnyOfflineOperationDefinition, CollectionOfflineEntityRef } from '../../src/persistentStorage/offline/types';
4
+ import type { CollectionPersistentStorageConfig, StorageAdapter } from '../../src/persistentStorage/types';
5
+ import type { FetchType } from '../../src/requestScheduler';
6
+ import { type StoreManager } from '../../src/storeManager';
7
+ import type { BrowserTabsPriorityTimings } from '../../src/utils/browserTabsPriority';
8
+ import type { BrowserTabsTransportFactory } from '../../src/utils/browserTabsSync';
9
+ import type { BlockWindowCloseHandler } from '../../src/utils/performMutation';
10
+ import { type ServerTableSharedState } from './serverTableMock';
11
+ type CollectionStoreTestScenario<D extends Record<string, unknown>> =
12
+ /** App just opened, no data fetched yet. */
13
+ 'idle'
14
+ /**
15
+ * App already opened before and data was fetched successfully.
16
+ * Using the default lowPriorityThrottleMs (200ms) it will still trigger a refetch on mount as initial system time is set to 10 seconds in the past.
17
+ */
18
+ | 'loaded'
19
+ /** Data was loaded previously but is now outdated (server has newer data). */
20
+ | {
21
+ loadedWithStaleData: Record<string, D>;
22
+ };
23
+ export type CollectionTestItem<D> = {
24
+ value: D;
25
+ };
26
+ type TestCollectionOfflineOperationsRegistry<D extends Record<string, unknown>> = Record<string, AnyOfflineOperationDefinition & {
27
+ getEntityRefs: (ctx: {
28
+ input: __LEGIT_ANY__;
29
+ }) => CollectionOfflineEntityRef<string>[];
30
+ }> & ([D] extends [never] ? never : unknown);
31
+ type TestCollectionOfflineOperationsConfig<D extends Record<string, unknown>> = TestCollectionOfflineOperationsRegistry<D> | null;
32
+ type TestCollectionPersistentStorageConfig<D extends Record<string, unknown>, StorageState, TOfflineOperations extends TestCollectionOfflineOperationsConfig<D>> = CollectionPersistentStorageConfig<CollectionTestItem<D>, string, StorageState, TOfflineOperations>;
33
+ type CollectionStoreTestEnvOptions<D extends Record<string, unknown>, TOfflineOperations extends TestCollectionOfflineOperationsConfig<D> = null, StorageState = unknown> = {
34
+ id?: string;
35
+ getSessionKey?: () => string | false;
36
+ storeManager?: StoreManager;
37
+ sharedServerTableState?: ServerTableSharedState<D>;
38
+ browserTabsTransportFactory?: BrowserTabsTransportFactory;
39
+ testBrowserTabId?: string;
40
+ browserTabsLeadershipTimings?: BrowserTabsPriorityTimings;
41
+ /** Binds this env to a focus coordinator. Provides per-tab `getWindowIsFocused` and `onWindowFocus`/`onWindowBlur` for scoped focus events. */
42
+ bindFocusController?: {
43
+ getWindowIsFocused: () => boolean;
44
+ onWindowFocus: (handler: () => void) => () => void;
45
+ onWindowBlur: (handler: () => void) => () => void;
46
+ };
47
+ dynamicRealtimeThrottleMs?: (params: {
48
+ lastFetchDuration: number;
49
+ windowIsNotFocused: boolean;
50
+ }) => number;
51
+ revalidateOnWindowFocus?: boolean | (() => boolean);
52
+ transportReconnectCooldownMs?: number;
53
+ baseCoalescingWindowMs?: number;
54
+ backgroundCoalescingDelayMs?: number;
55
+ lowPriorityThrottleMs?: number;
56
+ mediumPriorityDelayMs?: number;
57
+ /** Enable batch fetch mode - uses batchFetchFn instead of per-item fetchFn */
58
+ useBatchFetch?: boolean;
59
+ /** Max items per batch (only used when useBatchFetch is true) */
60
+ maxBatchSize?: number;
61
+ maxItems?: number;
62
+ /** Optional function to group batch fetches by key */
63
+ getItemsBatchKey?: (payload: string) => string | false;
64
+ onStateCleanup?: CollectionStoreOptions<CollectionTestItem<D>, string>['onStateCleanup'];
65
+ testScenario?: CollectionStoreTestScenario<D>;
66
+ usesRealTimeUpdates?: boolean;
67
+ blockWindowClose?: BlockWindowCloseHandler;
68
+ persistentStorage?: TestCollectionPersistentStorageConfig<D, StorageState, TOfflineOperations>;
69
+ storageAdapter?: StorageAdapter;
70
+ __DANGEROUS_IGNORE_INITIAL_TIME_CHECK__?: boolean;
71
+ };
72
+ export declare function createCollectionStoreTestEnv<D extends Record<string, unknown>, TOfflineOperations extends TestCollectionOfflineOperationsConfig<D> = null, StorageState = unknown>(serverInitialData: Record<string, D>, { id, getSessionKey: getSessionKeyOption, storeManager, sharedServerTableState, browserTabsTransportFactory, testBrowserTabId, browserTabsLeadershipTimings, bindFocusController, dynamicRealtimeThrottleMs, revalidateOnWindowFocus, transportReconnectCooldownMs, baseCoalescingWindowMs, backgroundCoalescingDelayMs, lowPriorityThrottleMs, mediumPriorityDelayMs, useBatchFetch, maxBatchSize, maxItems, getItemsBatchKey, onStateCleanup, testScenario, usesRealTimeUpdates, blockWindowClose, persistentStorage, storageAdapter, __DANGEROUS_IGNORE_INITIAL_TIME_CHECK__ }?: CollectionStoreTestEnvOptions<D, TOfflineOperations, StorageState>): {
73
+ apiStore: import("../../src/main").CollectionStore<CollectionTestItem<D>, string, TOfflineOperations>;
74
+ store: import("t-state").Store<import("../../src/main").TSFDCollectionState<CollectionTestItem<D>, string>>;
75
+ serverTable: {
76
+ fetch: (itemId: string, signal?: AbortSignal | undefined, options?: {
77
+ fields?: string[] | undefined;
78
+ } | undefined) => Promise<D>;
79
+ list: (options?: {
80
+ offset?: number | undefined;
81
+ limit?: number | undefined;
82
+ itemIds?: string[] | undefined;
83
+ filters?: import("./serverTableMock").FilterOperator[] | undefined;
84
+ tableId?: string | undefined;
85
+ fields?: string[] | undefined;
86
+ batchKey?: string | undefined;
87
+ } | undefined, signal?: AbortSignal | undefined) => Promise<{
88
+ items: {
89
+ itemId: string;
90
+ data: D;
91
+ }[];
92
+ hasMore: boolean;
93
+ }>;
94
+ listSync: (options?: {
95
+ offset?: number | undefined;
96
+ limit?: number | undefined;
97
+ itemIds?: string[] | undefined;
98
+ filters?: import("./serverTableMock").FilterOperator[] | undefined;
99
+ tableId?: string | undefined;
100
+ fields?: string[] | undefined;
101
+ batchKey?: string | undefined;
102
+ } | undefined) => {
103
+ items: {
104
+ itemId: string;
105
+ data: D;
106
+ }[];
107
+ hasMore: boolean;
108
+ };
109
+ get: (itemId: string) => D | undefined;
110
+ getAll: () => Record<string, D>;
111
+ getByPrefix: (prefix: string) => {
112
+ itemId: string;
113
+ data: D;
114
+ }[];
115
+ entries: () => [string, D][];
116
+ delayedSetItem(itemId: string, data: D, options?: {
117
+ durationMs?: number | undefined;
118
+ }): Promise<void>;
119
+ delayedUpdateItem(itemId: string, data: Partial<D>, options?: {
120
+ durationMs?: number | undefined;
121
+ }): Promise<void>;
122
+ delayedRemoveItem(itemId: string, options?: {
123
+ durationMs?: number | undefined;
124
+ }): Promise<void>;
125
+ setItem: (itemId: string, data: D, options?: {
126
+ triggerRTUEvent?: "for_all_items" | boolean | undefined;
127
+ prepend?: boolean | undefined;
128
+ } | undefined) => void;
129
+ removeItem: (itemId: string) => void;
130
+ updateItem: (itemId: string, data: Partial<D>) => void;
131
+ emulateClientMutation: (itemId: string, newData: D, options?: {
132
+ duration?: number | undefined;
133
+ setDataAt?: number | undefined;
134
+ triggerRTUEvent?: boolean | undefined;
135
+ addServerDataChangeAction?: boolean | undefined;
136
+ mutationId?: string | number | undefined;
137
+ }) => Promise<D>;
138
+ addItem: (itemId: string, data: D, options?: {
139
+ duration?: number | undefined;
140
+ setDataAt?: number | undefined;
141
+ triggerRTUEvent?: boolean | undefined;
142
+ addServerDataChangeAction?: boolean | undefined;
143
+ mutationId?: string | number | undefined;
144
+ }) => Promise<void>;
145
+ addItemWithAutoGeneratedKey: (tableId: string, createData: (id: number, itemId: string) => D, options?: {
146
+ duration?: number | undefined;
147
+ setDataAt?: number | undefined;
148
+ triggerRTUEvent?: boolean | undefined;
149
+ addServerDataChangeAction?: boolean | undefined;
150
+ mutationId?: string | number | undefined;
151
+ }) => Promise<{
152
+ id: number;
153
+ itemId: string;
154
+ data: D;
155
+ }>;
156
+ deleteItem: (itemId: string, options?: {
157
+ duration?: number | undefined;
158
+ setDataAt?: number | undefined;
159
+ triggerRTUEvent?: boolean | undefined;
160
+ addServerDataChangeAction?: boolean | undefined;
161
+ mutationId?: string | number | undefined;
162
+ }) => Promise<void>;
163
+ wsEvents: import("evtmitter").Emitter<{
164
+ data_changed: {
165
+ itemId: string;
166
+ data: D;
167
+ };
168
+ item_deleted: {
169
+ itemId: string;
170
+ };
171
+ item_added: {
172
+ itemId: string;
173
+ data: D;
174
+ };
175
+ list_changed: undefined;
176
+ }>;
177
+ getItemHistory: (itemId: string) => D[];
178
+ setFetchDurations(itemId: string, ...durations: number[]): void;
179
+ setNextFetchError(itemId: string, error: string | {
180
+ message: string;
181
+ path?: string | undefined;
182
+ method?: "DELETE" | "GET" | "PATCH" | "POST" | "PUT" | undefined;
183
+ code?: number | undefined;
184
+ }): void;
185
+ addListFetchStartDelay(delayMs: number): void;
186
+ setNextListFetchError(error: string | {
187
+ message: string;
188
+ path?: string | undefined;
189
+ method?: "DELETE" | "GET" | "PATCH" | "POST" | "PUT" | undefined;
190
+ code?: number | undefined;
191
+ }): void;
192
+ getNextFetchError(itemId: string): {
193
+ message: string;
194
+ path?: string | undefined;
195
+ method?: "DELETE" | "GET" | "PATCH" | "POST" | "PUT" | undefined;
196
+ code?: number | undefined;
197
+ } | undefined;
198
+ readonly numOfStartedFetches: number;
199
+ readonly numOfFinishedFetches: number;
200
+ fetchHistory: ({
201
+ type: "fetch";
202
+ itemId: string;
203
+ fields: string[] | undefined;
204
+ result: "aborted" | "error" | D;
205
+ startedAt: number;
206
+ duration: number;
207
+ } | {
208
+ type: "list";
209
+ itemIds: string[] | undefined;
210
+ offset: number;
211
+ limit: number | undefined;
212
+ fields: string[] | undefined;
213
+ filters: import("./serverTableMock").FilterOperator[] | undefined;
214
+ batchKey: string | undefined;
215
+ startedAt: number;
216
+ duration: number;
217
+ results: "aborted" | {
218
+ itemId: string;
219
+ data: "error" | D;
220
+ }[];
221
+ })[];
222
+ clearFetchHistory(): void;
223
+ getRequestHistory(fetchType?: "all" | "item" | "list", options?: {
224
+ includeTime?: boolean | undefined;
225
+ } | undefined): {
226
+ _type: "item" | "list" | undefined;
227
+ payload: unknown;
228
+ time?: string | undefined;
229
+ returned_items?: number | undefined;
230
+ }[];
231
+ };
232
+ readonly uiChanges: Record<string, unknown>[];
233
+ readonly actions: {
234
+ action: string;
235
+ time: number;
236
+ uiValue: unknown;
237
+ actionValue?: unknown;
238
+ id?: string | number | undefined;
239
+ itemId?: string | undefined;
240
+ itemUiValues?: Record<string, unknown> | undefined;
241
+ }[];
242
+ trackUIChanges: (value: Record<string, number | "error" | undefined>, itemId?: string | undefined) => void;
243
+ trackItemUI: (itemId: string, value: unknown) => unknown;
244
+ addTimelineComments: (reference: "afterLastAction" | "beforeNextAction" | {
245
+ action: string;
246
+ id?: string | number | undefined;
247
+ }, comments: (string | {
248
+ comment: string;
249
+ deltaMs?: number | undefined;
250
+ })[]) => void;
251
+ scheduleFetch: (fetchType: FetchType, itemId: string, options?: {
252
+ mediumPriorityDelayMs?: number | undefined;
253
+ } | undefined) => import("../../src/requestScheduler").ScheduleFetchResults;
254
+ performClientUpdateAction: (itemId: string, newValue: D, { withRevalidation, withOptimisticUpdate, duration, triggerRTU, addServerDataChangeAction, error, }?: {
255
+ withRevalidation?: boolean | undefined;
256
+ withOptimisticUpdate?: boolean | undefined;
257
+ duration?: number | undefined;
258
+ triggerRTU?: boolean | undefined;
259
+ addServerDataChangeAction?: boolean | undefined;
260
+ error?: string | undefined;
261
+ }) => Promise<import("t-result").Result<unknown, import("../../src/main").MutationSkipped | import("../../src/main").StoreMutationError>>;
262
+ readonly timelineString: string;
263
+ clearTimeline(): void;
264
+ };
265
+ export {};
@@ -0,0 +1,140 @@
1
+ import { type DocumentStoreOptions } from '../../src/documentStore';
2
+ import type { AnyOfflineOperationDefinition } from '../../src/persistentStorage/offline/types';
3
+ import type { DocumentPersistentStorageConfig, StorageAdapter } from '../../src/persistentStorage/types';
4
+ import type { FetchType } from '../../src/requestScheduler';
5
+ import { type StoreManager } from '../../src/storeManager';
6
+ import type { BrowserTabsPriorityTimings } from '../../src/utils/browserTabsPriority';
7
+ import type { BrowserTabsTransportFactory } from '../../src/utils/browserTabsSync';
8
+ import type { BlockWindowCloseHandler } from '../../src/utils/performMutation';
9
+ import { type FetchErrorConfig, type SharedServerMockState } from './serverMock';
10
+ export type DocumentStoreTestScenario<D> =
11
+ /** App just opened, no data fetched yet. */
12
+ 'idle'
13
+ /**
14
+ * App already opened before and data was fetched successfully.
15
+ * Using the default lowPriorityThrottleMs (200ms) it will still trigger a refetch on mount as initial system time is set to 10 seconds in the past.
16
+ */
17
+ | 'loaded'
18
+ /** Data was loaded previously but is now outdated (server has newer data). */
19
+ | {
20
+ loadedWithStaleData: D;
21
+ };
22
+ type TestDocumentOfflineOperationsRegistry<D> = Record<string, AnyOfflineOperationDefinition> & ([D] extends [never] ? never : unknown);
23
+ type TestDocumentOfflineOperationsConfig<D> = TestDocumentOfflineOperationsRegistry<D> | null;
24
+ type TestDocumentPersistentStorageConfig<D, StorageState, TOfflineOperations extends TestDocumentOfflineOperationsConfig<D>> = DocumentPersistentStorageConfig<{
25
+ value: D;
26
+ }, StorageState, TOfflineOperations>;
27
+ type DocumentStoreTestEnvOptions<D, TOfflineOperations extends TestDocumentOfflineOperationsConfig<D> = null, StorageState = unknown> = {
28
+ id?: string;
29
+ getSessionKey?: () => string | false;
30
+ storeManager?: StoreManager;
31
+ sharedServerState?: SharedServerMockState<D>;
32
+ browserTabsTransportFactory?: BrowserTabsTransportFactory;
33
+ testBrowserTabId?: string;
34
+ browserTabsLeadershipTimings?: BrowserTabsPriorityTimings;
35
+ /** Binds this env to a focus coordinator. Provides per-tab `getWindowIsFocused` and `onWindowFocus`/`onWindowBlur` for scoped focus events. */
36
+ bindFocusController?: {
37
+ getWindowIsFocused: () => boolean;
38
+ onWindowFocus: (handler: () => void) => () => void;
39
+ onWindowBlur: (handler: () => void) => () => void;
40
+ };
41
+ dynamicRealtimeThrottleMs?: (params: {
42
+ lastFetchDuration: number;
43
+ windowIsNotFocused: boolean;
44
+ }) => number;
45
+ revalidateOnWindowFocus?: boolean | (() => boolean);
46
+ onMutationError?: DocumentStoreOptions<{
47
+ value: D;
48
+ }, TOfflineOperations, StorageState>['onMutationError'];
49
+ transportReconnectCooldownMs?: number;
50
+ baseCoalescingWindowMs?: number;
51
+ backgroundCoalescingDelayMs?: number;
52
+ lowPriorityThrottleMs?: number;
53
+ mediumPriorityDelayMs?: number;
54
+ testScenario?: DocumentStoreTestScenario<D>;
55
+ usesRealTimeUpdates?: boolean;
56
+ blockWindowClose?: BlockWindowCloseHandler;
57
+ persistentStorage?: TestDocumentPersistentStorageConfig<D, StorageState, TOfflineOperations>;
58
+ storageAdapter?: StorageAdapter;
59
+ __DANGEROUS_IGNORE_INITIAL_TIME_CHECK__?: boolean;
60
+ };
61
+ export declare function createDocumentStoreTestEnv<D, TOfflineOperations extends TestDocumentOfflineOperationsConfig<D> = null, StorageState = unknown>(serverInitialData: D, { id, getSessionKey: getSessionKeyOption, storeManager, sharedServerState, browserTabsTransportFactory, testBrowserTabId, browserTabsLeadershipTimings, bindFocusController, dynamicRealtimeThrottleMs, revalidateOnWindowFocus, onMutationError, transportReconnectCooldownMs, baseCoalescingWindowMs, backgroundCoalescingDelayMs, lowPriorityThrottleMs, mediumPriorityDelayMs, testScenario, usesRealTimeUpdates, blockWindowClose, persistentStorage, storageAdapter, __DANGEROUS_IGNORE_INITIAL_TIME_CHECK__ }?: DocumentStoreTestEnvOptions<D, TOfflineOperations, StorageState>): {
62
+ apiStore: import("../../src/documentStore").DocumentStore<{
63
+ value: D;
64
+ }, TOfflineOperations>;
65
+ store: import("t-state").Store<import("../../src/documentStore").DocumentStoreState<{
66
+ value: D;
67
+ }>>;
68
+ readonly uiChanges: (string | number | undefined)[];
69
+ readonly actions: {
70
+ action: string;
71
+ time: number;
72
+ uiValue: unknown;
73
+ actionValue?: unknown;
74
+ id?: string | number | undefined;
75
+ itemId?: string | undefined;
76
+ itemUiValues?: Record<string, unknown> | undefined;
77
+ }[];
78
+ trackUIChanges: (value: string | number | undefined, itemId?: string | undefined) => void;
79
+ addTimelineComments: (reference: "afterLastAction" | "beforeNextAction" | {
80
+ action: string;
81
+ id?: string | number | undefined;
82
+ }, comments: (string | {
83
+ comment: string;
84
+ deltaMs?: number | undefined;
85
+ })[]) => void;
86
+ scheduleFetch: (fetchType: FetchType, options?: {
87
+ mediumPriorityDelayMs?: number | undefined;
88
+ } | undefined) => import("../../src/requestScheduler").ScheduleFetchResults;
89
+ /** default duration: 1200ms */
90
+ performClientUpdateAction: (newValue: D, { withRevalidation, withOptimisticUpdate, duration, triggerRTU, addServerDataChangeAction, error, updateStateWithMutationResult, }?: {
91
+ withRevalidation?: boolean | undefined;
92
+ withOptimisticUpdate?: boolean | undefined;
93
+ duration?: number | undefined;
94
+ triggerRTU?: boolean | undefined;
95
+ addServerDataChangeAction?: boolean | undefined;
96
+ error?: string | undefined;
97
+ updateStateWithMutationResult?: boolean | undefined;
98
+ }) => Promise<import("t-result").Result<unknown, import("../../src/main").MutationSkipped | import("../../src/main").StoreMutationError>>;
99
+ readonly timelineString: string;
100
+ clearTimeline(): void;
101
+ serverMock: {
102
+ mutateData: (newData: D, { duration, setDataAt, triggerRTUEvent, addServerDataChangeAction, mutationId, addMutationResolvedAction, }?: {
103
+ duration?: number | undefined;
104
+ setDataAt?: number | undefined;
105
+ triggerRTUEvent?: boolean | undefined;
106
+ addServerDataChangeAction?: boolean | undefined;
107
+ addMutationResolvedAction?: boolean | undefined;
108
+ mutationId?: string | number | undefined;
109
+ }) => Promise<void>;
110
+ wsEvents: import("evtmitter").Emitter<{
111
+ data_changed: undefined;
112
+ }>;
113
+ delayedSetData(value: D, options?: {
114
+ durationMs?: number | undefined;
115
+ }): Promise<void>;
116
+ setData(value: D): void;
117
+ readonly current: D;
118
+ history: D[];
119
+ fetch: (signal?: AbortSignal | undefined, duration?: number) => Promise<D>;
120
+ setFetchDurations(...durations: number[]): void;
121
+ setNextFetchError(error: string | FetchErrorConfig): void;
122
+ readonly numOfStartedFetches: number;
123
+ readonly numOfFinishedFetches: number;
124
+ fetchHistory: {
125
+ id: string;
126
+ startTime: number;
127
+ endTime: number;
128
+ duration: number;
129
+ result: "aborted" | "error" | "success";
130
+ data?: D | undefined;
131
+ error?: Error | undefined;
132
+ }[];
133
+ clearFetchHistory(): void;
134
+ };
135
+ errorInNextFetch(error?: string | FetchErrorConfig): void;
136
+ setNextFetchDurations(...durations: number[]): void;
137
+ emulateExternalRTU(value: D): void;
138
+ setServerData(value: D): void;
139
+ };
140
+ export {};
@@ -0,0 +1 @@
1
+ export {};