tsdf 17.0.4 → 17.0.6

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 (251) hide show
  1. package/dist/async-storage.d.ts +1 -1
  2. package/dist/async-storage.js +1 -1
  3. package/dist/{asyncStorageAdapter-CMohMeKm.d.ts → asyncStorageAdapter-DgsuE-T8.d.ts} +1 -1
  4. package/dist/{asyncStorageAdapter-BuGjbXYA.js → asyncStorageAdapter-URS9eulL.js} +165 -25
  5. package/dist/{asyncStorageAdapters-ClUvxNQA.js → asyncStorageAdapters-Bxrrj_Mt.js} +2 -2
  6. package/dist/indexed-db-storage.d.ts +1 -1
  7. package/dist/indexed-db-storage.js +1 -1
  8. package/dist/{indexedDbPersistentStorage-BSlgLveB.js → indexedDbPersistentStorage-BameJ4st.js} +11 -1
  9. package/dist/main.d.ts +34 -30
  10. package/dist/main.js +856 -257
  11. package/dist/opfs-storage.d.ts +1 -1
  12. package/dist/opfs-storage.js +1 -1
  13. package/dist/{opfsPersistentStorage-Ci0JcCo5.d.ts → opfsPersistentStorage-BngS1m0X.d.ts} +1 -1
  14. package/dist/{opfsPersistentStorage-D_k77Srq.js → opfsPersistentStorage-JsSCNBTr.js} +1 -1
  15. package/dist/{types-D0ttVGmj.d.ts → types-BlyGC_PO.d.ts} +3 -3
  16. package/package.json +5 -5
  17. package/dist/src/async-storage.d.ts +0 -1
  18. package/dist/src/cacheLimits/lruCacheRuntime.d.ts +0 -9
  19. package/dist/src/cacheLimits/scheduleIdleThrottled.d.ts +0 -1
  20. package/dist/src/cacheLimits/useRegisterActiveKeys.d.ts +0 -1
  21. package/dist/src/collectionStore/collectionCacheLimits.d.ts +0 -1
  22. package/dist/src/collectionStore/collectionStore.d.ts +0 -385
  23. package/dist/src/collectionStore/executeBatchFetch.d.ts +0 -6
  24. package/dist/src/collectionStore/useItem.d.ts +0 -15
  25. package/dist/src/collectionStore/useMultipleItems.d.ts +0 -35
  26. package/dist/src/debug.d.ts +0 -30
  27. package/dist/src/documentStore.d.ts +0 -290
  28. package/dist/src/hooks/useListItem.d.ts +0 -22
  29. package/dist/src/hooks/useListItemIsDeleted.d.ts +0 -13
  30. package/dist/src/hooks/useListItemIsLoading.d.ts +0 -16
  31. package/dist/src/indexed-db-storage.d.ts +0 -1
  32. package/dist/src/internal/offlineTestInstrumentation.d.ts +0 -12
  33. package/dist/src/internal/testTimelineTypes.d.ts +0 -1
  34. package/dist/src/invalidationUtils.d.ts +0 -8
  35. package/dist/src/isOffScreenContext.d.ts +0 -16
  36. package/dist/src/listQueryStore/createFetchApi.d.ts +0 -1
  37. package/dist/src/listQueryStore/createMutationApi.d.ts +0 -1
  38. package/dist/src/listQueryStore/executeItemBatchFetch.d.ts +0 -20
  39. package/dist/src/listQueryStore/executeQueryFetch.d.ts +0 -7
  40. package/dist/src/listQueryStore/itemFieldUtils.d.ts +0 -77
  41. package/dist/src/listQueryStore/listQueryCacheLimits.d.ts +0 -1
  42. package/dist/src/listQueryStore/listQueryStore.d.ts +0 -538
  43. package/dist/src/listQueryStore/types.d.ts +0 -347
  44. package/dist/src/listQueryStore/useFindItem.d.ts +0 -7
  45. package/dist/src/listQueryStore/useItem.d.ts +0 -29
  46. package/dist/src/listQueryStore/useListQuery.d.ts +0 -29
  47. package/dist/src/listQueryStore/useMultipleItems.d.ts +0 -44
  48. package/dist/src/listQueryStore/useMultipleListQueries.d.ts +0 -46
  49. package/dist/src/listQueryStore/usePendingOfflineItems.d.ts +0 -19
  50. package/dist/src/main.d.ts +0 -23
  51. package/dist/src/opfs-storage.d.ts +0 -1
  52. package/dist/src/persistentStorage/asyncStorageAdapter.d.ts +0 -95
  53. package/dist/src/persistentStorage/asyncStorageAdapters.d.ts +0 -2
  54. package/dist/src/persistentStorage/asyncStorageShared.d.ts +0 -23
  55. package/dist/src/persistentStorage/collectionStorePersistence.d.ts +0 -26
  56. package/dist/src/persistentStorage/compactListQueryLocalStorageEntry.d.ts +0 -11
  57. package/dist/src/persistentStorage/compactLocalStorageEntry.d.ts +0 -8
  58. package/dist/src/persistentStorage/documentEntryKey.d.ts +0 -1
  59. package/dist/src/persistentStorage/documentStorePersistence.d.ts +0 -17
  60. package/dist/src/persistentStorage/indexedDbAsyncStorageAdapter.d.ts +0 -165
  61. package/dist/src/persistentStorage/indexedDbPersistentStorage.d.ts +0 -6
  62. package/dist/src/persistentStorage/listQueryStorePersistence.d.ts +0 -37
  63. package/dist/src/persistentStorage/localStorageMetadata.d.ts +0 -126
  64. package/dist/src/persistentStorage/navigatorLocks.d.ts +0 -3
  65. package/dist/src/persistentStorage/offline/entityMetadata.d.ts +0 -12
  66. package/dist/src/persistentStorage/offline/fetchRuntime.d.ts +0 -35
  67. package/dist/src/persistentStorage/offline/mutationRuntime.d.ts +0 -31
  68. package/dist/src/persistentStorage/offline/offlineResolution.typeGuards.d.ts +0 -1
  69. package/dist/src/persistentStorage/offline/overlayStoreLifecycle.d.ts +0 -13
  70. package/dist/src/persistentStorage/offline/sessionCoordinator.d.ts +0 -94
  71. package/dist/src/persistentStorage/offline/sessionProtectionRegistry.d.ts +0 -11
  72. package/dist/src/persistentStorage/offline/storeController.d.ts +0 -86
  73. package/dist/src/persistentStorage/offline/types.d.ts +0 -1255
  74. package/dist/src/persistentStorage/offlineUploadRegistry.d.ts +0 -11
  75. package/dist/src/persistentStorage/offlineUploadTypes.d.ts +0 -97
  76. package/dist/src/persistentStorage/offlineUploadsShared.d.ts +0 -4
  77. package/dist/src/persistentStorage/opfsAsyncStorageAdapter.d.ts +0 -24
  78. package/dist/src/persistentStorage/opfsFileNaming.d.ts +0 -23
  79. package/dist/src/persistentStorage/opfsHelpers.d.ts +0 -3
  80. package/dist/src/persistentStorage/opfsOfflineUploadAdapter.d.ts +0 -2
  81. package/dist/src/persistentStorage/opfsPersistentStorage.d.ts +0 -2
  82. package/dist/src/persistentStorage/parsePersistedData.d.ts +0 -45
  83. package/dist/src/persistentStorage/persistenceUtils.d.ts +0 -52
  84. package/dist/src/persistentStorage/persistentStorageDefaults.d.ts +0 -4
  85. package/dist/src/persistentStorage/persistentStorageManager.d.ts +0 -197
  86. package/dist/src/persistentStorage/quotaDebug.d.ts +0 -16
  87. package/dist/src/persistentStorage/scheduleIdleCleanup.d.ts +0 -28
  88. package/dist/src/persistentStorage/storageAdapter.d.ts +0 -41
  89. package/dist/src/persistentStorage/storageEntryPrefixes.d.ts +0 -16
  90. package/dist/src/persistentStorage/types.d.ts +0 -412
  91. package/dist/src/persistentStorage/validateWithSchema.d.ts +0 -12
  92. package/dist/src/requestScheduler.d.ts +0 -81
  93. package/dist/src/storeManager.d.ts +0 -160
  94. package/dist/src/utils/automaticFetchPolicy.d.ts +0 -29
  95. package/dist/src/utils/browserTabsPriority.d.ts +0 -43
  96. package/dist/src/utils/browserTabsSync.d.ts +0 -33
  97. package/dist/src/utils/optimisticMutationTracker.d.ts +0 -20
  98. package/dist/src/utils/optimisticRollback.d.ts +0 -11
  99. package/dist/src/utils/payloadDebounce.d.ts +0 -5
  100. package/dist/src/utils/performMutation.d.ts +0 -19
  101. package/dist/src/utils/reusePrevIfEqual.d.ts +0 -1
  102. package/dist/src/utils/storeFocusLifecycle.d.ts +0 -1
  103. package/dist/src/utils/storeShared.d.ts +0 -126
  104. package/dist/src/utils/useEnsureIsLoaded.d.ts +0 -6
  105. package/dist/src/utils/useRequireFreshData.d.ts +0 -6
  106. package/dist/tests/basic-functionality/collection-store.test.d.ts +0 -1
  107. package/dist/tests/basic-functionality/document-store.test.d.ts +0 -1
  108. package/dist/tests/basic-functionality/list-query-state-manipulation.test.d.ts +0 -1
  109. package/dist/tests/basic-functionality/list-query-store.test.d.ts +0 -1
  110. package/dist/tests/browser-tabs/browser-tabs-background-rtu-batch.test.d.ts +0 -1
  111. package/dist/tests/browser-tabs/browser-tabs-background-rtu.test.d.ts +0 -1
  112. package/dist/tests/browser-tabs/browser-tabs-background-scheduling.test.d.ts +0 -1
  113. package/dist/tests/browser-tabs/browser-tabs-list-query-pagination.test.d.ts +0 -1
  114. package/dist/tests/browser-tabs/browser-tabs-non-cancelable-fetches.test.d.ts +0 -1
  115. package/dist/tests/browser-tabs/browser-tabs-optimistic-sync.test.d.ts +0 -1
  116. package/dist/tests/browser-tabs/browser-tabs-partial-resources.test.d.ts +0 -1
  117. package/dist/tests/browser-tabs/browser-tabs-priority.test.d.ts +0 -1
  118. package/dist/tests/browser-tabs/browser-tabs-snapshot-consistency.test.d.ts +0 -1
  119. package/dist/tests/browser-tabs/browser-tabs-state-methods.test.d.ts +0 -1
  120. package/dist/tests/browser-tabs/browser-tabs-sync-coordinator.test.d.ts +0 -1
  121. package/dist/tests/browser-tabs/browser-tabs-test-helpers.d.ts +0 -69
  122. package/dist/tests/browser-tabs/focus-coordinator.test.d.ts +0 -1
  123. package/dist/tests/hooks/collection-hooks-2.test.d.ts +0 -1
  124. package/dist/tests/hooks/collection-hooks.test.d.ts +0 -1
  125. package/dist/tests/hooks/collection-useListItem.test.d.ts +0 -1
  126. package/dist/tests/hooks/debounce-payload-hooks.test.d.ts +0 -1
  127. package/dist/tests/hooks/disable-refetches.test.d.ts +0 -1
  128. package/dist/tests/hooks/document-hooks-2.test.d.ts +0 -1
  129. package/dist/tests/hooks/document-hooks.test.d.ts +0 -1
  130. package/dist/tests/hooks/document-useListItem.test.d.ts +0 -1
  131. package/dist/tests/hooks/fetch-error-recovery.test.d.ts +0 -1
  132. package/dist/tests/hooks/hook-memoization.test.d.ts +0 -1
  133. package/dist/tests/hooks/list-query-hooks-2.test.d.ts +0 -1
  134. package/dist/tests/hooks/list-query-hooks-3.test.d.ts +0 -1
  135. package/dist/tests/hooks/list-query-hooks-mutations.test.d.ts +0 -1
  136. package/dist/tests/hooks/list-query-hooks.test.d.ts +0 -1
  137. package/dist/tests/hooks/list-query-pending-offline-items.test.d.ts +0 -1
  138. package/dist/tests/hooks/off-screen-context.test.d.ts +0 -1
  139. package/dist/tests/list-query-features/list-query-derived-queries.test.d.ts +0 -1
  140. package/dist/tests/list-query-features/list-query-offset-pagination.test.d.ts +0 -1
  141. package/dist/tests/list-query-features/list-query-optimistic-filters.test.d.ts +0 -1
  142. package/dist/tests/list-query-features/list-query-partial-resources-2.test.d.ts +0 -1
  143. package/dist/tests/list-query-features/list-query-partial-resources-3.test.d.ts +0 -1
  144. package/dist/tests/list-query-features/list-query-partial-resources-regressions.test.d.ts +0 -1
  145. package/dist/tests/list-query-features/list-query-partial-resources-show-partial-status.test.d.ts +0 -1
  146. package/dist/tests/list-query-features/list-query-partial-resources.test.d.ts +0 -1
  147. package/dist/tests/list-query-features/list-query-size-coalescing-partial-resources.test.d.ts +0 -1
  148. package/dist/tests/mocks/browserTabsTestUtils.d.ts +0 -17
  149. package/dist/tests/mocks/collectionStoreTestEnv.d.ts +0 -265
  150. package/dist/tests/mocks/documentStoreTestEnv.d.ts +0 -140
  151. package/dist/tests/mocks/duplicateStoreGuard.test.d.ts +0 -1
  152. package/dist/tests/mocks/listQueryStoreTestEnv.d.ts +0 -295
  153. package/dist/tests/mocks/mockBrowserOpfs.d.ts +0 -70
  154. package/dist/tests/mocks/mockBrowserOpfs.test.d.ts +0 -1
  155. package/dist/tests/mocks/mockLocalStorageStore.d.ts +0 -61
  156. package/dist/tests/mocks/seedScenarioPersistentStorage.d.ts +0 -51
  157. package/dist/tests/mocks/serverMock.d.ts +0 -56
  158. package/dist/tests/mocks/serverTableMock.d.ts +0 -174
  159. package/dist/tests/mocks/testEnvUtils.d.ts +0 -120
  160. package/dist/tests/mocks/testScenarioPersistentStorage.test.d.ts +0 -1
  161. package/dist/tests/offline/offline-fetching-scenarios.test.d.ts +0 -1
  162. package/dist/tests/offline/offline-mixed-adapter-storage.test.d.ts +0 -1
  163. package/dist/tests/offline/offline-mutation-fallback.test.d.ts +0 -1
  164. package/dist/tests/offline/offline-network-recovery.test.d.ts +0 -1
  165. package/dist/tests/offline/offline-outage.test.d.ts +0 -1
  166. package/dist/tests/offline/offline-overlays.test.d.ts +0 -1
  167. package/dist/tests/offline/offline-query-replay.test.d.ts +0 -1
  168. package/dist/tests/offline/offline-reads.test.d.ts +0 -1
  169. package/dist/tests/offline/offline-replay-conflicts.test.d.ts +0 -1
  170. package/dist/tests/offline/offline-replay-queueing.test.d.ts +0 -1
  171. package/dist/tests/offline/offline-resolution-dependencies.test.d.ts +0 -1
  172. package/dist/tests/offline/offline-runtime-controls.test.d.ts +0 -1
  173. package/dist/tests/offline/offline-session-and-global-state.test.d.ts +0 -1
  174. package/dist/tests/offline/offline-storage.test.d.ts +0 -1
  175. package/dist/tests/offline/offline-uploads.test.d.ts +0 -1
  176. package/dist/tests/offline/offlineReplayTestShared.d.ts +0 -292
  177. package/dist/tests/offline/offlineTestShared.d.ts +0 -156
  178. package/dist/tests/perform-mutation/mutation-error-rollback.test.d.ts +0 -1
  179. package/dist/tests/perform-mutation/perform-mutation-block-window-close.test.d.ts +0 -1
  180. package/dist/tests/perform-mutation/perform-mutation-debounce.test.d.ts +0 -1
  181. package/dist/tests/perform-mutation/store-events.test.d.ts +0 -1
  182. package/dist/tests/persistent-storage/async-storage-efficiency/collection.test.d.ts +0 -1
  183. package/dist/tests/persistent-storage/async-storage-efficiency/document.test.d.ts +0 -1
  184. package/dist/tests/persistent-storage/async-storage-efficiency/list-query.test.d.ts +0 -1
  185. package/dist/tests/persistent-storage/async-storage-efficiency/maintenance.test.d.ts +0 -1
  186. package/dist/tests/persistent-storage/async-storage-efficiency/shared.d.ts +0 -804
  187. package/dist/tests/persistent-storage/async-storage-shared.test.d.ts +0 -1
  188. package/dist/tests/persistent-storage/collection-store-persistence.converted.opfs.test.d.ts +0 -1
  189. package/dist/tests/persistent-storage/collection-store-persistence.converted.test.d.ts +0 -1
  190. package/dist/tests/persistent-storage/collection-store-persistence.opfs.test.d.ts +0 -1
  191. package/dist/tests/persistent-storage/collection-store-persistence.test.d.ts +0 -1
  192. package/dist/tests/persistent-storage/document-store-persistence.converted.opfs.test.d.ts +0 -1
  193. package/dist/tests/persistent-storage/document-store-persistence.converted.test.d.ts +0 -1
  194. package/dist/tests/persistent-storage/document-store-persistence.opfs.test.d.ts +0 -1
  195. package/dist/tests/persistent-storage/document-store-persistence.test.d.ts +0 -1
  196. package/dist/tests/persistent-storage/expiration-scan.test.d.ts +0 -1
  197. package/dist/tests/persistent-storage/indexeddb-async-storage-efficiency/collection.test.d.ts +0 -1
  198. package/dist/tests/persistent-storage/indexeddb-async-storage-efficiency/document.test.d.ts +0 -1
  199. package/dist/tests/persistent-storage/indexeddb-async-storage-efficiency/list-query.test.d.ts +0 -1
  200. package/dist/tests/persistent-storage/indexeddb-async-storage-efficiency/maintenance.test.d.ts +0 -1
  201. package/dist/tests/persistent-storage/indexeddb-async-storage-efficiency/shared.d.ts +0 -780
  202. package/dist/tests/persistent-storage/indexeddb-storage-adapter.test.d.ts +0 -1
  203. package/dist/tests/persistent-storage/list-query-store-persistence.converted.opfs.test.d.ts +0 -1
  204. package/dist/tests/persistent-storage/list-query-store-persistence.converted.test.d.ts +0 -1
  205. package/dist/tests/persistent-storage/list-query-store-persistence.opfs.test.d.ts +0 -1
  206. package/dist/tests/persistent-storage/list-query-store-persistence.test.d.ts +0 -1
  207. package/dist/tests/persistent-storage/persistence-with-tabs-sync.test.d.ts +0 -1
  208. package/dist/tests/persistent-storage/persistentStorageByteBudgetTestUtils.d.ts +0 -18
  209. package/dist/tests/persistent-storage/quota-exceeded-recovery-no-locks.test.d.ts +0 -1
  210. package/dist/tests/persistent-storage/quota-exceeded-recovery.test.d.ts +0 -1
  211. package/dist/tests/persistent-storage/quotaRecoveryTestUtils.d.ts +0 -228
  212. package/dist/tests/persistent-storage/storage-adapter.test.d.ts +0 -1
  213. package/dist/tests/persistent-storage/sync-storage-efficiency/collection.test.d.ts +0 -1
  214. package/dist/tests/persistent-storage/sync-storage-efficiency/document.test.d.ts +0 -1
  215. package/dist/tests/persistent-storage/sync-storage-efficiency/list-query.test.d.ts +0 -1
  216. package/dist/tests/persistent-storage/sync-storage-efficiency/maintenance.test.d.ts +0 -1
  217. package/dist/tests/persistent-storage/sync-storage-efficiency/shared.d.ts +0 -784
  218. package/dist/tests/playwright/browser-tabs.spec.d.ts +0 -1
  219. package/dist/tests/playwright/persistent-storage.spec.d.ts +0 -1
  220. package/dist/tests/request-schedulling/batch-medium-priority.test.d.ts +0 -1
  221. package/dist/tests/request-schedulling/batch-realtime-updates.test.d.ts +0 -1
  222. package/dist/tests/request-schedulling/collection-batch-coalescing.test.d.ts +0 -1
  223. package/dist/tests/request-schedulling/collection-batch-key-grouping.test.d.ts +0 -1
  224. package/dist/tests/request-schedulling/collection-fetch-orchestration.test.d.ts +0 -1
  225. package/dist/tests/request-schedulling/document-await-fetch.test.d.ts +0 -1
  226. package/dist/tests/request-schedulling/document-base-coalescing.test.d.ts +0 -1
  227. package/dist/tests/request-schedulling/document-fetch-orchestration.test.d.ts +0 -1
  228. package/dist/tests/request-schedulling/document-medium-priority-fetch.test.d.ts +0 -1
  229. package/dist/tests/request-schedulling/document-realtime-updates.test.d.ts +0 -1
  230. package/dist/tests/request-schedulling/list-query-item-batch-coalescing.test.d.ts +0 -1
  231. package/dist/tests/request-schedulling/list-query-item-batch-key-grouping.test.d.ts +0 -1
  232. package/dist/tests/request-schedulling/list-query-size-coalescing.test.d.ts +0 -1
  233. package/dist/tests/request-schedulling/medium-vs-realtime.test.d.ts +0 -1
  234. package/dist/tests/request-schedulling/request-scheduler-cross-tab-sync.test.d.ts +0 -1
  235. package/dist/tests/request-schedulling/window-focus.test.d.ts +0 -1
  236. package/dist/tests/store-manager.test.d.ts +0 -1
  237. package/dist/tests/user-facing-api/collection-offline-usage.test.d.ts +0 -1
  238. package/dist/tests/user-facing-api/document-offline-usage.test.d.ts +0 -1
  239. package/dist/tests/user-facing-api/list-query-offline-usage.test.d.ts +0 -1
  240. package/dist/tests/user-facing-api/result-returning-callbacks.test.d.ts +0 -1
  241. package/dist/tests/utils/genericTestUtils.d.ts +0 -6
  242. package/dist/tests/utils/indexedDbPersistentStorageOptimizationTestUtils.d.ts +0 -79
  243. package/dist/tests/utils/indexedDbPersistentStorageTestStore.d.ts +0 -181
  244. package/dist/tests/utils/listQueryHooksTestUtils.d.ts +0 -8
  245. package/dist/tests/utils/networkMock.d.ts +0 -11
  246. package/dist/tests/utils/opfsPersistentStorageTestStore.d.ts +0 -220
  247. package/dist/tests/utils/persistentStorageOptimizationTestUtils.d.ts +0 -54
  248. package/dist/tests/utils/persistentStorageOptimizationTestUtils.test.d.ts +0 -1
  249. package/dist/tests/utils/persistentStorageTestStore.d.ts +0 -66
  250. package/dist/tests/utils/resetSessionForTests.d.ts +0 -3
  251. package/dist/tests/utils/withSuppressedActError.d.ts +0 -4
@@ -1,94 +0,0 @@
1
- import { type TSDFDebugLogger } from '../../debug';
2
- import type { ValidPayload } from '../../utils/storeShared';
3
- import type { OfflineSessionUploadsConfig } from '../offlineUploadTypes';
4
- import type { StorageAdapter } from '../types';
5
- import type { GlobalOfflineEntity, InternalGlobalOfflineEntity, GlobalOfflineStatus, OfflineResolutionRecord, OfflineSession, OfflineSessionConfig } from './types';
6
- type SessionCoordinatorOptions = {
7
- sessionKey: string;
8
- appVersion?: string;
9
- adapter?: StorageAdapter;
10
- onPersistentStorageError?: (error: unknown) => void;
11
- debugLogger?: TSDFDebugLogger;
12
- config?: OfflineSessionConfig;
13
- uploads?: OfflineSessionUploadsConfig;
14
- bootstrapStatusFromLocalStorage?: boolean;
15
- };
16
- export declare function createDefaultStatus(sessionKey: string): GlobalOfflineStatus;
17
- /**
18
- * Returns a session-scoped offline coordinator, creating it if needed.
19
- * Existing coordinators are reconfigured when adapter/configuration changes.
20
- */
21
- export declare function getOrCreateSessionOfflineCoordinator(sessionKey: string, options?: Omit<SessionCoordinatorOptions, 'sessionKey'>): SessionOfflineCoordinator;
22
- /**
23
- * Returns the latest offline status for a session. If the session has not been
24
- * initialized yet, this returns a default "online" status with empty recovery data.
25
- */
26
- export declare function getGlobalOfflineStatus(sessionKey: string): GlobalOfflineStatus;
27
- /**
28
- * Returns the latest list of offline entities for a session.
29
- * Useful to render pending sync state badges or pending-item indicators.
30
- */
31
- export declare function getGlobalOfflineEntities(sessionKey: string): GlobalOfflineEntity[];
32
- /**
33
- * Returns the latest list of offline conflict/retry resolutions for a session.
34
- * Useful to render conflict-resolution trays or retry-required queues.
35
- */
36
- export declare function getGlobalOfflineResolutions(sessionKey: string): OfflineResolutionRecord[];
37
- /**
38
- * Test-only primitive for resetting just the offline session coordinator
39
- * registry.
40
- *
41
- * Prefer calling `resetSessionForTests()` from
42
- * `tests/utils/resetSessionForTests.ts` so restart-style tests reset the full
43
- * session/runtime boundary instead of invoking this low-level reset directly.
44
- */
45
- export declare function __resetSessionOfflineCoordinatorRegistryForTests(): void;
46
- export declare function getOfflineSessionUploadsConfig<TUploadRef extends ValidPayload>(session: OfflineSession<TUploadRef>): OfflineSessionUploadsConfig<TUploadRef> | undefined;
47
- export declare function getOfflineSessionAppVersion(session: OfflineSession): string | undefined;
48
- export declare function createOfflineSession<TUploadRef extends ValidPayload = ValidPayload>(args: {
49
- config: OfflineSessionConfig<TUploadRef>;
50
- getSessionKey?: () => string | false;
51
- appVersion?: string;
52
- debugLogger?: TSDFDebugLogger;
53
- }): OfflineSession<TUploadRef>;
54
- /**
55
- * React hook that subscribes to the offline status stream for a session.
56
- */
57
- export declare function useGlobalOfflineStatus(sessionKey: string): GlobalOfflineStatus;
58
- /**
59
- * React hook that subscribes to the offline entities stream for a session.
60
- */
61
- export declare function useGlobalOfflineEntities(sessionKey: string): readonly GlobalOfflineEntity[];
62
- /**
63
- * React hook returning global offline conflict/retry resolutions for a session.
64
- */
65
- export declare function useGlobalOfflineResolutions(sessionKey: string): readonly OfflineResolutionRecord[];
66
- /**
67
- * React hook returning offline entities for a specific store in a session.
68
- */
69
- export declare function useOfflineStoreEntitiesWithPayload(args: {
70
- sessionKey: string | false;
71
- inactiveScope: string;
72
- storeName?: string;
73
- }): readonly InternalGlobalOfflineEntity[];
74
- export declare function useOfflineStoreEntities(args: {
75
- sessionKey: string | false;
76
- inactiveScope: string;
77
- storeName?: string;
78
- }): readonly GlobalOfflineEntity[];
79
- /**
80
- * React hook returning offline status for a session or inactive scope.
81
- */
82
- export declare function useOfflineStoreStatus(args: {
83
- sessionKey: string | false;
84
- inactiveScope: string;
85
- }): GlobalOfflineStatus;
86
- /**
87
- * React hook returning offline conflict/retry resolutions for a specific store in a session.
88
- */
89
- export declare function useOfflineStoreResolutions(args: {
90
- sessionKey: string | false;
91
- inactiveScope: string;
92
- storeName?: string;
93
- }): readonly OfflineResolutionRecord[];
94
- export {};
@@ -1,11 +0,0 @@
1
- export declare function setSessionProtectedKeysSnapshot(sessionKey: string, protectedKeys: Iterable<string>): void;
2
- export declare function getSessionProtectedKeysSnapshot(sessionKey: string): Set<string> | null;
3
- export declare function clearSessionProtectedKeysSnapshot(sessionKey: string): void;
4
- /**
5
- * Test-only primitive for resetting cached protected-key snapshots.
6
- *
7
- * Prefer calling `resetSessionForTests()` from
8
- * `tests/utils/resetSessionForTests.ts` so restart-style tests reset the full
9
- * session/runtime boundary instead of invoking this low-level reset directly.
10
- */
11
- export declare function __resetSessionProtectedKeysSnapshotForTests(): void;
@@ -1,86 +0,0 @@
1
- import { __LEGIT_ANY__ } from '@ls-stack/utils/saferTyping';
2
- import type { TSDFDebugLogger } from '../../debug';
3
- import type { ValidPayload } from '../../utils/storeShared';
4
- import type { OfflineMutationUploadsInput } from '../offlineUploadTypes';
5
- import type { StorageAdapter } from '../types';
6
- import type { PreparedOfflineMutation } from './mutationRuntime';
7
- import { type AnyOfflineOperationDefinition, type GlobalOfflineEntity, type OfflineMutationInput, type OfflineOperationSchemaShape, type OfflineResolutionActionForOperation, type OfflineResolutionRecordForStore, type OfflineEntityRef, type OfflineSession, type OfflineStoreType, type ParsedOfflineResolutionConflictResultForOperation } from './types';
8
- type OfflineStoreAdapter = {
9
- getEntityRefs?: (args: {
10
- operationName: string;
11
- input: unknown;
12
- }) => unknown[];
13
- normalizeEntityRefs?: (entityRefs: unknown[]) => OfflineEntityRef[];
14
- getProtectedCacheKeys: (entityRefs: OfflineEntityRef[]) => string[];
15
- applyPendingEntity?: (args: {
16
- operationName: string;
17
- input: unknown;
18
- tempId: ValidPayload;
19
- pendingEntity: unknown;
20
- }) => void;
21
- rollbackPendingEntity?: (args: {
22
- operationName: string;
23
- input: unknown;
24
- tempId: ValidPayload;
25
- pendingEntity: unknown;
26
- }) => void;
27
- reconcileTempEntity?: (args: {
28
- operationName: string;
29
- input: unknown;
30
- tempId: ValidPayload;
31
- result: unknown;
32
- reconciliation: {
33
- finalPayload: ValidPayload;
34
- finalData?: unknown;
35
- };
36
- }) => void;
37
- captureQueuedMutationOverlays?: (args: {
38
- sessionKey: string;
39
- entityRefs: OfflineEntityRef[];
40
- }) => void;
41
- rebindQueuedMutationOverlays?: (args: {
42
- sessionKey: string;
43
- itemKeyRewrites: {
44
- previousItemKey: string;
45
- nextItemKey: string;
46
- }[];
47
- }) => void;
48
- syncEntityOverlays?: (args: {
49
- sessionKey: string;
50
- entities: GlobalOfflineEntity[];
51
- }) => void;
52
- };
53
- export declare class OfflineSessionUnavailableError extends Error {
54
- readonly code = 460;
55
- readonly id: "offline-session-unavailable";
56
- constructor();
57
- }
58
- export type OfflineStoreController<TOperations extends Record<string, OfflineOperationSchemaShape>> = {
59
- dispose: () => void;
60
- hydrateIfNeeded: () => Promise<void>;
61
- canQueueMutation: () => boolean;
62
- prepareForMutation: <TName extends keyof TOperations & string>(args: {
63
- offline: OfflineMutationInput<TOperations, TName>;
64
- upload?: OfflineMutationUploadsInput;
65
- }) => Promise<PreparedOfflineMutation>;
66
- queueMutation: <TName extends keyof TOperations & string>(args: {
67
- offline: OfflineMutationInput<TOperations, TName>;
68
- upload?: OfflineMutationUploadsInput;
69
- }) => Promise<void>;
70
- getOfflineEntities: () => GlobalOfflineEntity[];
71
- getOfflineResolutions: () => OfflineResolutionRecordForStore<TOperations>[];
72
- parseOfflineResolutionConflict: <TName extends keyof TOperations & string>(resolution: OfflineResolutionRecordForStore<TOperations, TName>) => ParsedOfflineResolutionConflictResultForOperation<TOperations, TName>;
73
- resolveOfflineResolution: <TName extends keyof TOperations & string>(resolutionId: string, operationName: TName, resolution: OfflineResolutionActionForOperation<TOperations, TName>) => Promise<void>;
74
- prepareForFetch: () => Promise<void>;
75
- getSessionStatus: () => {
76
- isOfflineMode: boolean;
77
- } | null;
78
- shouldTreatFetchAsOffline: () => boolean;
79
- handleFetchSuccess: () => Promise<void>;
80
- evaluateOfflineFetchError: (error: unknown, operationName?: string) => Promise<void>;
81
- ensureReplayScheduled: () => Promise<void>;
82
- };
83
- type OfflineStoreControllerBootstrap = Pick<OfflineStoreController<Record<string, OfflineOperationSchemaShape>>, 'hydrateIfNeeded' | 'ensureReplayScheduled'>;
84
- export declare function initializeOfflineStoreController(controller: OfflineStoreControllerBootstrap | null | undefined): void;
85
- export declare function createOfflineStoreController<TOperations extends Record<string, AnyOfflineOperationDefinition<__LEGIT_ANY__>>>(storeName: string, storeType: OfflineStoreType, getSessionKey: () => string | false, onPersistentStorageError: ((error: unknown) => void) | undefined, debugLogger: TSDFDebugLogger | undefined, adapter: StorageAdapter, storeAdapter: OfflineStoreAdapter, offlineSession: OfflineSession, operations: TOperations): OfflineStoreController<TOperations>;
86
- export {};