tsdf 17.0.4 → 17.0.5
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/dist/async-storage.d.ts +1 -1
- package/dist/async-storage.js +1 -1
- package/dist/{asyncStorageAdapter-CMohMeKm.d.ts → asyncStorageAdapter-DgsuE-T8.d.ts} +1 -1
- package/dist/{asyncStorageAdapter-BuGjbXYA.js → asyncStorageAdapter-URS9eulL.js} +165 -25
- package/dist/{asyncStorageAdapters-ClUvxNQA.js → asyncStorageAdapters-Bxrrj_Mt.js} +2 -2
- package/dist/indexed-db-storage.d.ts +1 -1
- package/dist/indexed-db-storage.js +1 -1
- package/dist/{indexedDbPersistentStorage-BSlgLveB.js → indexedDbPersistentStorage-BameJ4st.js} +11 -1
- package/dist/main.d.ts +34 -30
- package/dist/main.js +856 -257
- package/dist/opfs-storage.d.ts +1 -1
- package/dist/opfs-storage.js +1 -1
- package/dist/{opfsPersistentStorage-Ci0JcCo5.d.ts → opfsPersistentStorage-BngS1m0X.d.ts} +1 -1
- package/dist/{opfsPersistentStorage-D_k77Srq.js → opfsPersistentStorage-JsSCNBTr.js} +1 -1
- package/dist/{types-D0ttVGmj.d.ts → types-BlyGC_PO.d.ts} +3 -3
- package/package.json +1 -1
- package/dist/src/async-storage.d.ts +0 -1
- package/dist/src/cacheLimits/lruCacheRuntime.d.ts +0 -9
- package/dist/src/cacheLimits/scheduleIdleThrottled.d.ts +0 -1
- package/dist/src/cacheLimits/useRegisterActiveKeys.d.ts +0 -1
- package/dist/src/collectionStore/collectionCacheLimits.d.ts +0 -1
- package/dist/src/collectionStore/collectionStore.d.ts +0 -385
- package/dist/src/collectionStore/executeBatchFetch.d.ts +0 -6
- package/dist/src/collectionStore/useItem.d.ts +0 -15
- package/dist/src/collectionStore/useMultipleItems.d.ts +0 -35
- package/dist/src/debug.d.ts +0 -30
- package/dist/src/documentStore.d.ts +0 -290
- package/dist/src/hooks/useListItem.d.ts +0 -22
- package/dist/src/hooks/useListItemIsDeleted.d.ts +0 -13
- package/dist/src/hooks/useListItemIsLoading.d.ts +0 -16
- package/dist/src/indexed-db-storage.d.ts +0 -1
- package/dist/src/internal/offlineTestInstrumentation.d.ts +0 -12
- package/dist/src/internal/testTimelineTypes.d.ts +0 -1
- package/dist/src/invalidationUtils.d.ts +0 -8
- package/dist/src/isOffScreenContext.d.ts +0 -16
- package/dist/src/listQueryStore/createFetchApi.d.ts +0 -1
- package/dist/src/listQueryStore/createMutationApi.d.ts +0 -1
- package/dist/src/listQueryStore/executeItemBatchFetch.d.ts +0 -20
- package/dist/src/listQueryStore/executeQueryFetch.d.ts +0 -7
- package/dist/src/listQueryStore/itemFieldUtils.d.ts +0 -77
- package/dist/src/listQueryStore/listQueryCacheLimits.d.ts +0 -1
- package/dist/src/listQueryStore/listQueryStore.d.ts +0 -538
- package/dist/src/listQueryStore/types.d.ts +0 -347
- package/dist/src/listQueryStore/useFindItem.d.ts +0 -7
- package/dist/src/listQueryStore/useItem.d.ts +0 -29
- package/dist/src/listQueryStore/useListQuery.d.ts +0 -29
- package/dist/src/listQueryStore/useMultipleItems.d.ts +0 -44
- package/dist/src/listQueryStore/useMultipleListQueries.d.ts +0 -46
- package/dist/src/listQueryStore/usePendingOfflineItems.d.ts +0 -19
- package/dist/src/main.d.ts +0 -23
- package/dist/src/opfs-storage.d.ts +0 -1
- package/dist/src/persistentStorage/asyncStorageAdapter.d.ts +0 -95
- package/dist/src/persistentStorage/asyncStorageAdapters.d.ts +0 -2
- package/dist/src/persistentStorage/asyncStorageShared.d.ts +0 -23
- package/dist/src/persistentStorage/collectionStorePersistence.d.ts +0 -26
- package/dist/src/persistentStorage/compactListQueryLocalStorageEntry.d.ts +0 -11
- package/dist/src/persistentStorage/compactLocalStorageEntry.d.ts +0 -8
- package/dist/src/persistentStorage/documentEntryKey.d.ts +0 -1
- package/dist/src/persistentStorage/documentStorePersistence.d.ts +0 -17
- package/dist/src/persistentStorage/indexedDbAsyncStorageAdapter.d.ts +0 -165
- package/dist/src/persistentStorage/indexedDbPersistentStorage.d.ts +0 -6
- package/dist/src/persistentStorage/listQueryStorePersistence.d.ts +0 -37
- package/dist/src/persistentStorage/localStorageMetadata.d.ts +0 -126
- package/dist/src/persistentStorage/navigatorLocks.d.ts +0 -3
- package/dist/src/persistentStorage/offline/entityMetadata.d.ts +0 -12
- package/dist/src/persistentStorage/offline/fetchRuntime.d.ts +0 -35
- package/dist/src/persistentStorage/offline/mutationRuntime.d.ts +0 -31
- package/dist/src/persistentStorage/offline/offlineResolution.typeGuards.d.ts +0 -1
- package/dist/src/persistentStorage/offline/overlayStoreLifecycle.d.ts +0 -13
- package/dist/src/persistentStorage/offline/sessionCoordinator.d.ts +0 -94
- package/dist/src/persistentStorage/offline/sessionProtectionRegistry.d.ts +0 -11
- package/dist/src/persistentStorage/offline/storeController.d.ts +0 -86
- package/dist/src/persistentStorage/offline/types.d.ts +0 -1255
- package/dist/src/persistentStorage/offlineUploadRegistry.d.ts +0 -11
- package/dist/src/persistentStorage/offlineUploadTypes.d.ts +0 -97
- package/dist/src/persistentStorage/offlineUploadsShared.d.ts +0 -4
- package/dist/src/persistentStorage/opfsAsyncStorageAdapter.d.ts +0 -24
- package/dist/src/persistentStorage/opfsFileNaming.d.ts +0 -23
- package/dist/src/persistentStorage/opfsHelpers.d.ts +0 -3
- package/dist/src/persistentStorage/opfsOfflineUploadAdapter.d.ts +0 -2
- package/dist/src/persistentStorage/opfsPersistentStorage.d.ts +0 -2
- package/dist/src/persistentStorage/parsePersistedData.d.ts +0 -45
- package/dist/src/persistentStorage/persistenceUtils.d.ts +0 -52
- package/dist/src/persistentStorage/persistentStorageDefaults.d.ts +0 -4
- package/dist/src/persistentStorage/persistentStorageManager.d.ts +0 -197
- package/dist/src/persistentStorage/quotaDebug.d.ts +0 -16
- package/dist/src/persistentStorage/scheduleIdleCleanup.d.ts +0 -28
- package/dist/src/persistentStorage/storageAdapter.d.ts +0 -41
- package/dist/src/persistentStorage/storageEntryPrefixes.d.ts +0 -16
- package/dist/src/persistentStorage/types.d.ts +0 -412
- package/dist/src/persistentStorage/validateWithSchema.d.ts +0 -12
- package/dist/src/requestScheduler.d.ts +0 -81
- package/dist/src/storeManager.d.ts +0 -160
- package/dist/src/utils/automaticFetchPolicy.d.ts +0 -29
- package/dist/src/utils/browserTabsPriority.d.ts +0 -43
- package/dist/src/utils/browserTabsSync.d.ts +0 -33
- package/dist/src/utils/optimisticMutationTracker.d.ts +0 -20
- package/dist/src/utils/optimisticRollback.d.ts +0 -11
- package/dist/src/utils/payloadDebounce.d.ts +0 -5
- package/dist/src/utils/performMutation.d.ts +0 -19
- package/dist/src/utils/reusePrevIfEqual.d.ts +0 -1
- package/dist/src/utils/storeFocusLifecycle.d.ts +0 -1
- package/dist/src/utils/storeShared.d.ts +0 -126
- package/dist/src/utils/useEnsureIsLoaded.d.ts +0 -6
- package/dist/src/utils/useRequireFreshData.d.ts +0 -6
- package/dist/tests/basic-functionality/collection-store.test.d.ts +0 -1
- package/dist/tests/basic-functionality/document-store.test.d.ts +0 -1
- package/dist/tests/basic-functionality/list-query-state-manipulation.test.d.ts +0 -1
- package/dist/tests/basic-functionality/list-query-store.test.d.ts +0 -1
- package/dist/tests/browser-tabs/browser-tabs-background-rtu-batch.test.d.ts +0 -1
- package/dist/tests/browser-tabs/browser-tabs-background-rtu.test.d.ts +0 -1
- package/dist/tests/browser-tabs/browser-tabs-background-scheduling.test.d.ts +0 -1
- package/dist/tests/browser-tabs/browser-tabs-list-query-pagination.test.d.ts +0 -1
- package/dist/tests/browser-tabs/browser-tabs-non-cancelable-fetches.test.d.ts +0 -1
- package/dist/tests/browser-tabs/browser-tabs-optimistic-sync.test.d.ts +0 -1
- package/dist/tests/browser-tabs/browser-tabs-partial-resources.test.d.ts +0 -1
- package/dist/tests/browser-tabs/browser-tabs-priority.test.d.ts +0 -1
- package/dist/tests/browser-tabs/browser-tabs-snapshot-consistency.test.d.ts +0 -1
- package/dist/tests/browser-tabs/browser-tabs-state-methods.test.d.ts +0 -1
- package/dist/tests/browser-tabs/browser-tabs-sync-coordinator.test.d.ts +0 -1
- package/dist/tests/browser-tabs/browser-tabs-test-helpers.d.ts +0 -69
- package/dist/tests/browser-tabs/focus-coordinator.test.d.ts +0 -1
- package/dist/tests/hooks/collection-hooks-2.test.d.ts +0 -1
- package/dist/tests/hooks/collection-hooks.test.d.ts +0 -1
- package/dist/tests/hooks/collection-useListItem.test.d.ts +0 -1
- package/dist/tests/hooks/debounce-payload-hooks.test.d.ts +0 -1
- package/dist/tests/hooks/disable-refetches.test.d.ts +0 -1
- package/dist/tests/hooks/document-hooks-2.test.d.ts +0 -1
- package/dist/tests/hooks/document-hooks.test.d.ts +0 -1
- package/dist/tests/hooks/document-useListItem.test.d.ts +0 -1
- package/dist/tests/hooks/fetch-error-recovery.test.d.ts +0 -1
- package/dist/tests/hooks/hook-memoization.test.d.ts +0 -1
- package/dist/tests/hooks/list-query-hooks-2.test.d.ts +0 -1
- package/dist/tests/hooks/list-query-hooks-3.test.d.ts +0 -1
- package/dist/tests/hooks/list-query-hooks-mutations.test.d.ts +0 -1
- package/dist/tests/hooks/list-query-hooks.test.d.ts +0 -1
- package/dist/tests/hooks/list-query-pending-offline-items.test.d.ts +0 -1
- package/dist/tests/hooks/off-screen-context.test.d.ts +0 -1
- package/dist/tests/list-query-features/list-query-derived-queries.test.d.ts +0 -1
- package/dist/tests/list-query-features/list-query-offset-pagination.test.d.ts +0 -1
- package/dist/tests/list-query-features/list-query-optimistic-filters.test.d.ts +0 -1
- package/dist/tests/list-query-features/list-query-partial-resources-2.test.d.ts +0 -1
- package/dist/tests/list-query-features/list-query-partial-resources-3.test.d.ts +0 -1
- package/dist/tests/list-query-features/list-query-partial-resources-regressions.test.d.ts +0 -1
- package/dist/tests/list-query-features/list-query-partial-resources-show-partial-status.test.d.ts +0 -1
- package/dist/tests/list-query-features/list-query-partial-resources.test.d.ts +0 -1
- package/dist/tests/list-query-features/list-query-size-coalescing-partial-resources.test.d.ts +0 -1
- package/dist/tests/mocks/browserTabsTestUtils.d.ts +0 -17
- package/dist/tests/mocks/collectionStoreTestEnv.d.ts +0 -265
- package/dist/tests/mocks/documentStoreTestEnv.d.ts +0 -140
- package/dist/tests/mocks/duplicateStoreGuard.test.d.ts +0 -1
- package/dist/tests/mocks/listQueryStoreTestEnv.d.ts +0 -295
- package/dist/tests/mocks/mockBrowserOpfs.d.ts +0 -70
- package/dist/tests/mocks/mockBrowserOpfs.test.d.ts +0 -1
- package/dist/tests/mocks/mockLocalStorageStore.d.ts +0 -61
- package/dist/tests/mocks/seedScenarioPersistentStorage.d.ts +0 -51
- package/dist/tests/mocks/serverMock.d.ts +0 -56
- package/dist/tests/mocks/serverTableMock.d.ts +0 -174
- package/dist/tests/mocks/testEnvUtils.d.ts +0 -120
- package/dist/tests/mocks/testScenarioPersistentStorage.test.d.ts +0 -1
- package/dist/tests/offline/offline-fetching-scenarios.test.d.ts +0 -1
- package/dist/tests/offline/offline-mixed-adapter-storage.test.d.ts +0 -1
- package/dist/tests/offline/offline-mutation-fallback.test.d.ts +0 -1
- package/dist/tests/offline/offline-network-recovery.test.d.ts +0 -1
- package/dist/tests/offline/offline-outage.test.d.ts +0 -1
- package/dist/tests/offline/offline-overlays.test.d.ts +0 -1
- package/dist/tests/offline/offline-query-replay.test.d.ts +0 -1
- package/dist/tests/offline/offline-reads.test.d.ts +0 -1
- package/dist/tests/offline/offline-replay-conflicts.test.d.ts +0 -1
- package/dist/tests/offline/offline-replay-queueing.test.d.ts +0 -1
- package/dist/tests/offline/offline-resolution-dependencies.test.d.ts +0 -1
- package/dist/tests/offline/offline-runtime-controls.test.d.ts +0 -1
- package/dist/tests/offline/offline-session-and-global-state.test.d.ts +0 -1
- package/dist/tests/offline/offline-storage.test.d.ts +0 -1
- package/dist/tests/offline/offline-uploads.test.d.ts +0 -1
- package/dist/tests/offline/offlineReplayTestShared.d.ts +0 -292
- package/dist/tests/offline/offlineTestShared.d.ts +0 -156
- package/dist/tests/perform-mutation/mutation-error-rollback.test.d.ts +0 -1
- package/dist/tests/perform-mutation/perform-mutation-block-window-close.test.d.ts +0 -1
- package/dist/tests/perform-mutation/perform-mutation-debounce.test.d.ts +0 -1
- package/dist/tests/perform-mutation/store-events.test.d.ts +0 -1
- package/dist/tests/persistent-storage/async-storage-efficiency/collection.test.d.ts +0 -1
- package/dist/tests/persistent-storage/async-storage-efficiency/document.test.d.ts +0 -1
- package/dist/tests/persistent-storage/async-storage-efficiency/list-query.test.d.ts +0 -1
- package/dist/tests/persistent-storage/async-storage-efficiency/maintenance.test.d.ts +0 -1
- package/dist/tests/persistent-storage/async-storage-efficiency/shared.d.ts +0 -804
- package/dist/tests/persistent-storage/async-storage-shared.test.d.ts +0 -1
- package/dist/tests/persistent-storage/collection-store-persistence.converted.opfs.test.d.ts +0 -1
- package/dist/tests/persistent-storage/collection-store-persistence.converted.test.d.ts +0 -1
- package/dist/tests/persistent-storage/collection-store-persistence.opfs.test.d.ts +0 -1
- package/dist/tests/persistent-storage/collection-store-persistence.test.d.ts +0 -1
- package/dist/tests/persistent-storage/document-store-persistence.converted.opfs.test.d.ts +0 -1
- package/dist/tests/persistent-storage/document-store-persistence.converted.test.d.ts +0 -1
- package/dist/tests/persistent-storage/document-store-persistence.opfs.test.d.ts +0 -1
- package/dist/tests/persistent-storage/document-store-persistence.test.d.ts +0 -1
- package/dist/tests/persistent-storage/expiration-scan.test.d.ts +0 -1
- package/dist/tests/persistent-storage/indexeddb-async-storage-efficiency/collection.test.d.ts +0 -1
- package/dist/tests/persistent-storage/indexeddb-async-storage-efficiency/document.test.d.ts +0 -1
- package/dist/tests/persistent-storage/indexeddb-async-storage-efficiency/list-query.test.d.ts +0 -1
- package/dist/tests/persistent-storage/indexeddb-async-storage-efficiency/maintenance.test.d.ts +0 -1
- package/dist/tests/persistent-storage/indexeddb-async-storage-efficiency/shared.d.ts +0 -780
- package/dist/tests/persistent-storage/indexeddb-storage-adapter.test.d.ts +0 -1
- package/dist/tests/persistent-storage/list-query-store-persistence.converted.opfs.test.d.ts +0 -1
- package/dist/tests/persistent-storage/list-query-store-persistence.converted.test.d.ts +0 -1
- package/dist/tests/persistent-storage/list-query-store-persistence.opfs.test.d.ts +0 -1
- package/dist/tests/persistent-storage/list-query-store-persistence.test.d.ts +0 -1
- package/dist/tests/persistent-storage/persistence-with-tabs-sync.test.d.ts +0 -1
- package/dist/tests/persistent-storage/persistentStorageByteBudgetTestUtils.d.ts +0 -18
- package/dist/tests/persistent-storage/quota-exceeded-recovery-no-locks.test.d.ts +0 -1
- package/dist/tests/persistent-storage/quota-exceeded-recovery.test.d.ts +0 -1
- package/dist/tests/persistent-storage/quotaRecoveryTestUtils.d.ts +0 -228
- package/dist/tests/persistent-storage/storage-adapter.test.d.ts +0 -1
- package/dist/tests/persistent-storage/sync-storage-efficiency/collection.test.d.ts +0 -1
- package/dist/tests/persistent-storage/sync-storage-efficiency/document.test.d.ts +0 -1
- package/dist/tests/persistent-storage/sync-storage-efficiency/list-query.test.d.ts +0 -1
- package/dist/tests/persistent-storage/sync-storage-efficiency/maintenance.test.d.ts +0 -1
- package/dist/tests/persistent-storage/sync-storage-efficiency/shared.d.ts +0 -784
- package/dist/tests/playwright/browser-tabs.spec.d.ts +0 -1
- package/dist/tests/playwright/persistent-storage.spec.d.ts +0 -1
- package/dist/tests/request-schedulling/batch-medium-priority.test.d.ts +0 -1
- package/dist/tests/request-schedulling/batch-realtime-updates.test.d.ts +0 -1
- package/dist/tests/request-schedulling/collection-batch-coalescing.test.d.ts +0 -1
- package/dist/tests/request-schedulling/collection-batch-key-grouping.test.d.ts +0 -1
- package/dist/tests/request-schedulling/collection-fetch-orchestration.test.d.ts +0 -1
- package/dist/tests/request-schedulling/document-await-fetch.test.d.ts +0 -1
- package/dist/tests/request-schedulling/document-base-coalescing.test.d.ts +0 -1
- package/dist/tests/request-schedulling/document-fetch-orchestration.test.d.ts +0 -1
- package/dist/tests/request-schedulling/document-medium-priority-fetch.test.d.ts +0 -1
- package/dist/tests/request-schedulling/document-realtime-updates.test.d.ts +0 -1
- package/dist/tests/request-schedulling/list-query-item-batch-coalescing.test.d.ts +0 -1
- package/dist/tests/request-schedulling/list-query-item-batch-key-grouping.test.d.ts +0 -1
- package/dist/tests/request-schedulling/list-query-size-coalescing.test.d.ts +0 -1
- package/dist/tests/request-schedulling/medium-vs-realtime.test.d.ts +0 -1
- package/dist/tests/request-schedulling/request-scheduler-cross-tab-sync.test.d.ts +0 -1
- package/dist/tests/request-schedulling/window-focus.test.d.ts +0 -1
- package/dist/tests/store-manager.test.d.ts +0 -1
- package/dist/tests/user-facing-api/collection-offline-usage.test.d.ts +0 -1
- package/dist/tests/user-facing-api/document-offline-usage.test.d.ts +0 -1
- package/dist/tests/user-facing-api/list-query-offline-usage.test.d.ts +0 -1
- package/dist/tests/user-facing-api/result-returning-callbacks.test.d.ts +0 -1
- package/dist/tests/utils/genericTestUtils.d.ts +0 -6
- package/dist/tests/utils/indexedDbPersistentStorageOptimizationTestUtils.d.ts +0 -79
- package/dist/tests/utils/indexedDbPersistentStorageTestStore.d.ts +0 -181
- package/dist/tests/utils/listQueryHooksTestUtils.d.ts +0 -8
- package/dist/tests/utils/networkMock.d.ts +0 -11
- package/dist/tests/utils/opfsPersistentStorageTestStore.d.ts +0 -220
- package/dist/tests/utils/persistentStorageOptimizationTestUtils.d.ts +0 -54
- package/dist/tests/utils/persistentStorageOptimizationTestUtils.test.d.ts +0 -1
- package/dist/tests/utils/persistentStorageTestStore.d.ts +0 -66
- package/dist/tests/utils/resetSessionForTests.d.ts +0 -3
- package/dist/tests/utils/withSuppressedActError.d.ts +0 -4
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
import type { OfflineUploadAdapter } from './offlineUploadTypes';
|
|
2
|
-
export declare function registerOfflineUploadAdapterForSession(sessionKey: string, adapter: OfflineUploadAdapter): void;
|
|
3
|
-
export declare function clearRegisteredOfflineUploadStorage(sessionKey: string): Promise<void>;
|
|
4
|
-
/**
|
|
5
|
-
* Test-only primitive for resetting the session-to-upload-adapter registry.
|
|
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 __resetOfflineUploadRegistryForTests(): void;
|
|
@@ -1,97 +0,0 @@
|
|
|
1
|
-
import type { ValidPayload } from '../utils/storeShared';
|
|
2
|
-
/** Lifecycle state for a session-scoped offline upload. */
|
|
3
|
-
export type OfflineUploadState = 'pending' | 'uploading' | 'uploaded' | 'failed';
|
|
4
|
-
/** Source that created a staged offline upload. */
|
|
5
|
-
export type OfflineUploadSource = 'manual' | 'mutation';
|
|
6
|
-
/** Progress snapshot reported while uploading a staged file. */
|
|
7
|
-
export type OfflineUploadProgress = {
|
|
8
|
-
/** Normalized progress from `0` to `1`. */
|
|
9
|
-
progress: number;
|
|
10
|
-
/** Loaded byte count, when available from the transport. */
|
|
11
|
-
loadedBytes?: number;
|
|
12
|
-
/** Total byte count, when available from the transport. */
|
|
13
|
-
totalBytes?: number;
|
|
14
|
-
};
|
|
15
|
-
/** Public metadata for a file staged for offline mutation replay. */
|
|
16
|
-
export type OfflineUpload<TResolvedRef extends ValidPayload = ValidPayload> = {
|
|
17
|
-
/** Stable upload id used by offline operation inputs. */
|
|
18
|
-
id: string;
|
|
19
|
-
/** Session key that owns this upload. */
|
|
20
|
-
sessionKey: string;
|
|
21
|
-
/** Source that created this upload. */
|
|
22
|
-
source: OfflineUploadSource;
|
|
23
|
-
/** Current upload lifecycle state. */
|
|
24
|
-
state: OfflineUploadState;
|
|
25
|
-
/** Original file name. */
|
|
26
|
-
fileName: string;
|
|
27
|
-
/** MIME type recorded for the staged file. */
|
|
28
|
-
mimeType: string;
|
|
29
|
-
/** File size in bytes. */
|
|
30
|
-
sizeBytes: number;
|
|
31
|
-
/** Epoch timestamp when the upload was staged. */
|
|
32
|
-
createdAt: number;
|
|
33
|
-
/** Epoch timestamp for the latest upload metadata change. */
|
|
34
|
-
updatedAt: number;
|
|
35
|
-
/** Final server-side reference after upload completes. */
|
|
36
|
-
resolvedRef?: TResolvedRef;
|
|
37
|
-
/** Latest upload progress snapshot. */
|
|
38
|
-
progress?: OfflineUploadProgress;
|
|
39
|
-
/** Last upload failure message, when any. */
|
|
40
|
-
lastError?: {
|
|
41
|
-
message: string;
|
|
42
|
-
};
|
|
43
|
-
};
|
|
44
|
-
/** Persisted offline upload record including the staged file object. */
|
|
45
|
-
export type OfflineStoredUploadRecord<TResolvedRef extends ValidPayload = ValidPayload> = OfflineUpload<TResolvedRef> & {
|
|
46
|
-
/** Staged file blob restored from the upload adapter. */
|
|
47
|
-
file: File;
|
|
48
|
-
/** Last online session start time seen before the upload was stored. */
|
|
49
|
-
lastOnlineSessionStartedAt?: number;
|
|
50
|
-
/** File last-modified timestamp. */
|
|
51
|
-
lastModified: number;
|
|
52
|
-
};
|
|
53
|
-
/** Storage backend contract for session-scoped offline upload files. */
|
|
54
|
-
export type OfflineUploadAdapter = {
|
|
55
|
-
/** Saves or replaces one staged upload record. */
|
|
56
|
-
save<TResolvedRef extends ValidPayload>(sessionKey: string, id: string, record: OfflineStoredUploadRecord<TResolvedRef>): Promise<void>;
|
|
57
|
-
/** Loads one staged upload record by id. */
|
|
58
|
-
load<TResolvedRef extends ValidPayload>(sessionKey: string, id: string): Promise<OfflineStoredUploadRecord<TResolvedRef> | null>;
|
|
59
|
-
/** Lists all staged upload records for a session. */
|
|
60
|
-
list<TResolvedRef extends ValidPayload>(sessionKey: string): Promise<OfflineStoredUploadRecord<TResolvedRef>[]>;
|
|
61
|
-
/** Removes one staged upload record. */
|
|
62
|
-
remove(sessionKey: string, id: string): Promise<void>;
|
|
63
|
-
/** Removes all staged upload records for a session. */
|
|
64
|
-
clearSession(sessionKey: string): Promise<void>;
|
|
65
|
-
/** Test-only reset hook used by TSDF internals. */
|
|
66
|
-
resetForTests?(): void;
|
|
67
|
-
};
|
|
68
|
-
/** Context passed to the configured offline upload transport. */
|
|
69
|
-
export type OfflineUploadTransportContext = {
|
|
70
|
-
/** Stable upload id being transported. */
|
|
71
|
-
id: string;
|
|
72
|
-
/** Session key that owns this upload. */
|
|
73
|
-
sessionKey: string;
|
|
74
|
-
/** File to upload. */
|
|
75
|
-
file: File;
|
|
76
|
-
/** Reports upload progress back to TSDF. */
|
|
77
|
-
onProgress: (progress: OfflineUploadProgress) => void;
|
|
78
|
-
};
|
|
79
|
-
/** Upload handling config for an offline session. */
|
|
80
|
-
export type OfflineSessionUploadsConfig<TResolvedRef extends ValidPayload = ValidPayload> = {
|
|
81
|
-
/** Adapter used to persist staged files until replay can upload them. */
|
|
82
|
-
adapter: OfflineUploadAdapter;
|
|
83
|
-
/** Upload transport that returns the final server-side file reference. */
|
|
84
|
-
upload: (ctx: OfflineUploadTransportContext) => Promise<TResolvedRef>;
|
|
85
|
-
/** Maximum number of concurrent upload transports. */
|
|
86
|
-
concurrency?: number;
|
|
87
|
-
};
|
|
88
|
-
/** Files attached to an offline-capable mutation call, keyed by upload id. */
|
|
89
|
-
export type OfflineMutationUploadsInput = Record<string, Blob | File>;
|
|
90
|
-
export type OfflineAttachedUploadIds = Record<string, string>;
|
|
91
|
-
/** Resolved upload files and references available while an offline operation replays. */
|
|
92
|
-
export type OfflineOperationUploadsContext<TResolvedRef extends ValidPayload = ValidPayload> = {
|
|
93
|
-
/** Locally staged files by upload id. */
|
|
94
|
-
filesById: Record<string, File>;
|
|
95
|
-
/** Final uploaded refs by upload id. */
|
|
96
|
-
resolvedRefsById: Record<string, TResolvedRef>;
|
|
97
|
-
};
|
|
@@ -1,4 +0,0 @@
|
|
|
1
|
-
import type { ValidPayload } from '../utils/storeShared';
|
|
2
|
-
import type { OfflineStoredUploadRecord, OfflineUpload, OfflineUploadProgress, OfflineUploadSource, OfflineUploadState } from './offlineUploadTypes';
|
|
3
|
-
export declare function stripStoredUploadFile<TResolvedRef extends ValidPayload = ValidPayload>(record: OfflineStoredUploadRecord<TResolvedRef>): OfflineUpload<TResolvedRef>;
|
|
4
|
-
export declare function createStoredUploadRecord<TResolvedRef extends ValidPayload = ValidPayload>(id: string, sessionKey: string, fileInput: Blob | File, source: OfflineUploadSource, state?: OfflineUploadState, createdAtInput?: number, progress?: OfflineUploadProgress, resolvedRef?: TResolvedRef, lastError?: OfflineStoredUploadRecord<TResolvedRef>['lastError'], lastOnlineSessionStartedAt?: number): OfflineStoredUploadRecord<TResolvedRef>;
|
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
import { type TSDFDebugLogger } from '../debug';
|
|
2
|
-
import type { AsyncStorageDiscoveredScope, AsyncStorageDriver, AsyncStorageDriverSetEntry, AsyncStorageNamespaceScope } from './types';
|
|
3
|
-
export declare class OpfsAsyncStorageDriver implements AsyncStorageDriver {
|
|
4
|
-
#private;
|
|
5
|
-
debugLogger?: TSDFDebugLogger;
|
|
6
|
-
get(scope: AsyncStorageNamespaceScope, key: string): Promise<unknown>;
|
|
7
|
-
set(scope: AsyncStorageNamespaceScope, key: string, value: unknown): Promise<void>;
|
|
8
|
-
remove(scope: AsyncStorageNamespaceScope, key: string): Promise<void>;
|
|
9
|
-
getMany(scope: AsyncStorageNamespaceScope, keys: string[]): Promise<unknown[]>;
|
|
10
|
-
setMany(scope: AsyncStorageNamespaceScope, entries: AsyncStorageDriverSetEntry[]): Promise<void>;
|
|
11
|
-
removeMany(scope: AsyncStorageNamespaceScope, keys: string[]): Promise<void>;
|
|
12
|
-
listKeys(scope: AsyncStorageNamespaceScope): Promise<string[]>;
|
|
13
|
-
clear(scope: AsyncStorageNamespaceScope): Promise<void>;
|
|
14
|
-
listScopes(sessionKey?: string): Promise<AsyncStorageNamespaceScope[]>;
|
|
15
|
-
listScopesWithKnownRecordKeys(sessionKey?: string): Promise<AsyncStorageDiscoveredScope[]>;
|
|
16
|
-
withIsolatedCleanupDriver<T>(callback: (driver: AsyncStorageDriver) => Promise<T>): Promise<T>;
|
|
17
|
-
cleanupRemoveKnownRecords(scope: AsyncStorageNamespaceScope, keys: string[]): Promise<string[]>;
|
|
18
|
-
cleanupRemoveKnownStoreDir(scope: AsyncStorageNamespaceScope, keys: string[]): Promise<boolean>;
|
|
19
|
-
cleanupRemoveKnownSessionDir(sessionKey: string): Promise<boolean>;
|
|
20
|
-
cleanupFinalizeRemovedRecords(scope: AsyncStorageNamespaceScope, removedKeys: string[]): void;
|
|
21
|
-
cleanupFinalizeRemovedStoreDir(scope: AsyncStorageNamespaceScope, removedKeys: string[]): void;
|
|
22
|
-
cleanupFinalizeRemovedSessionDir(sessionKey: string): void;
|
|
23
|
-
__resetForTests(): void;
|
|
24
|
-
}
|
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
import type { AsyncStorageNamespaceScope } from './types';
|
|
2
|
-
export declare const OPFS_ROOT_DIR = "tsdf";
|
|
3
|
-
export declare function encodePathSegment(value: string): string;
|
|
4
|
-
export declare function decodePathSegment(value: string): string;
|
|
5
|
-
export declare function joinPath(...segments: string[]): string;
|
|
6
|
-
type OpfsRecordKind = 'payload' | 'raw';
|
|
7
|
-
export declare function parseRecordKindAlias(value: string): OpfsRecordKind | null;
|
|
8
|
-
export declare function parseRecordKey(key: string): {
|
|
9
|
-
recordKind: 'payload';
|
|
10
|
-
userKey: string;
|
|
11
|
-
} | {
|
|
12
|
-
rawKey: string;
|
|
13
|
-
recordKind: 'raw';
|
|
14
|
-
};
|
|
15
|
-
export declare function buildFileName(scope: AsyncStorageNamespaceScope, key: string): string;
|
|
16
|
-
export declare function resolveHashedPayloadRecordKeyFromValue(scope: AsyncStorageNamespaceScope, value: unknown): string | null;
|
|
17
|
-
type ParsedOpfsFileName = {
|
|
18
|
-
isHashedPayload: boolean;
|
|
19
|
-
key: string | null;
|
|
20
|
-
kind: AsyncStorageNamespaceScope['kind'];
|
|
21
|
-
};
|
|
22
|
-
export declare function parseFileNameInfo(fileName: string): ParsedOpfsFileName | null;
|
|
23
|
-
export {};
|
|
@@ -1,3 +0,0 @@
|
|
|
1
|
-
export declare function getNavigatorStorageDirectory(): Promise<FileSystemDirectoryHandle>;
|
|
2
|
-
export declare function getDirectoryHandleIfExists(parent: FileSystemDirectoryHandle, name: string): Promise<FileSystemDirectoryHandle | null>;
|
|
3
|
-
export declare function getFileHandleIfExists(parent: FileSystemDirectoryHandle, name: string): Promise<FileSystemFileHandle | null>;
|
|
@@ -1,45 +0,0 @@
|
|
|
1
|
-
import type { ItemLoadedFields } from '../listQueryStore/types';
|
|
2
|
-
import type { ValidPayload } from '../utils/storeShared';
|
|
3
|
-
import type { ConvertedPersistentStorageDataSchema, PersistentStorageDataSchema, PersistentStorageSchema } from './types';
|
|
4
|
-
export type NormalizedPersistentStorageDataSchema<TFinal, TStorage = unknown> = {
|
|
5
|
-
mode: 'direct';
|
|
6
|
-
storeSchema: PersistentStorageSchema<TFinal>;
|
|
7
|
-
} | ({
|
|
8
|
-
mode: 'converted';
|
|
9
|
-
} & ConvertedPersistentStorageDataSchema<TFinal, TStorage>);
|
|
10
|
-
export declare function normalizePersistentStorageDataSchema<TFinal, TStorage = unknown>(schema: PersistentStorageDataSchema<TFinal, TStorage>): NormalizedPersistentStorageDataSchema<TFinal, TStorage>;
|
|
11
|
-
export declare function parsePersistedStoreData<TFinal, TStorage = unknown>(value: unknown, schema: NormalizedPersistentStorageDataSchema<TFinal, TStorage>): TFinal | null;
|
|
12
|
-
type PersistedStoreDataValue<TFinal, TStorage = unknown> = TFinal | TStorage;
|
|
13
|
-
export declare function convertStoreDataForPersistence<TFinal, TStorage = unknown>(value: TFinal, schema: NormalizedPersistentStorageDataSchema<TFinal, TStorage>): {
|
|
14
|
-
ok: true;
|
|
15
|
-
value: TFinal | TStorage;
|
|
16
|
-
} | {
|
|
17
|
-
ok: false;
|
|
18
|
-
error: unknown;
|
|
19
|
-
};
|
|
20
|
-
type ParsedPersistedDocumentData<TData = unknown> = {
|
|
21
|
-
data: TData;
|
|
22
|
-
};
|
|
23
|
-
export declare function parsePersistedDocumentData(value: unknown): ParsedPersistedDocumentData | null;
|
|
24
|
-
export declare function parsePersistedDocumentData<TFinal, TStorage = unknown>(value: unknown, dataSchema: NormalizedPersistentStorageDataSchema<TFinal, TStorage>): ParsedPersistedDocumentData<PersistedStoreDataValue<TFinal, TStorage>> | null;
|
|
25
|
-
export type ParsedPersistedCollectionItemData<ItemPayload extends ValidPayload, TData = unknown> = {
|
|
26
|
-
data: TData;
|
|
27
|
-
payload: ItemPayload;
|
|
28
|
-
};
|
|
29
|
-
export declare function parsePersistedCollectionItemData<ItemPayload extends ValidPayload>(value: unknown, payloadSchema: PersistentStorageSchema<ItemPayload>): ParsedPersistedCollectionItemData<ItemPayload> | null;
|
|
30
|
-
export declare function parsePersistedCollectionItemData<ItemPayload extends ValidPayload, TFinal, TStorage = unknown>(value: unknown, payloadSchema: PersistentStorageSchema<ItemPayload>, dataSchema: NormalizedPersistentStorageDataSchema<TFinal, TStorage>): ParsedPersistedCollectionItemData<ItemPayload, PersistedStoreDataValue<TFinal, TStorage>> | null;
|
|
31
|
-
export type ParsedTypedPersistedListQueryItemData<ItemPayload extends ValidPayload, TData> = {
|
|
32
|
-
data: TData;
|
|
33
|
-
payload: ItemPayload;
|
|
34
|
-
loadedFields?: ItemLoadedFields;
|
|
35
|
-
};
|
|
36
|
-
export type ParsedPersistedListQueryItemData<ItemPayload extends ValidPayload> = ParsedTypedPersistedListQueryItemData<ItemPayload, unknown>;
|
|
37
|
-
export declare function parsePersistedListQueryItemData<ItemPayload extends ValidPayload>(value: unknown, payloadSchema: PersistentStorageSchema<ItemPayload>): ParsedPersistedListQueryItemData<ItemPayload> | null;
|
|
38
|
-
export declare function parsePersistedListQueryItemData<ItemPayload extends ValidPayload, TFinal, TStorage = unknown>(value: unknown, payloadSchema: PersistentStorageSchema<ItemPayload>, dataSchema: NormalizedPersistentStorageDataSchema<TFinal, TStorage>): ParsedTypedPersistedListQueryItemData<ItemPayload, PersistedStoreDataValue<TFinal, TStorage>> | null;
|
|
39
|
-
export type ParsedPersistedListQueryData<QueryPayload extends ValidPayload> = {
|
|
40
|
-
payload: QueryPayload;
|
|
41
|
-
items: string[];
|
|
42
|
-
hasMore: boolean;
|
|
43
|
-
};
|
|
44
|
-
export declare function parsePersistedListQueryData<QueryPayload extends ValidPayload>(value: unknown, payloadSchema: PersistentStorageSchema<QueryPayload>): ParsedPersistedListQueryData<QueryPayload> | null;
|
|
45
|
-
export {};
|
|
@@ -1,52 +0,0 @@
|
|
|
1
|
-
import type { ValidPayload } from '../utils/storeShared';
|
|
2
|
-
import type { IdleCleanupContext } from './scheduleIdleCleanup';
|
|
3
|
-
import type { AsyncStorageNamespaceCommitConditionalRemove } from './types';
|
|
4
|
-
/**
|
|
5
|
-
* Creates a key set that auto-clears entries after a microtask.
|
|
6
|
-
* Used to deduplicate sync storage reads within the same event loop tick.
|
|
7
|
-
*/
|
|
8
|
-
export declare function createTimedKeySet(): {
|
|
9
|
-
has: (key: string) => boolean;
|
|
10
|
-
remember: (key: string) => void;
|
|
11
|
-
clear: (key: string) => void;
|
|
12
|
-
clearAll: () => void;
|
|
13
|
-
};
|
|
14
|
-
export declare function createShouldIgnoreItemPredicate<ItemPayload extends ValidPayload>(ignoreItems: ItemPayload[] | ((payload: ItemPayload) => boolean) | undefined, resolveItemKey: (payload: ItemPayload) => string): (payload: ItemPayload) => boolean;
|
|
15
|
-
export declare function getSerializedStringSize(value: string): number;
|
|
16
|
-
/**
|
|
17
|
-
* Detects browser storage quota errors thrown by `localStorage.setItem` and
|
|
18
|
-
* IndexedDB writes, covering the standard `QuotaExceededError` name plus the
|
|
19
|
-
* legacy Firefox name.
|
|
20
|
-
*/
|
|
21
|
-
export declare function isQuotaExceededError(error: unknown): boolean;
|
|
22
|
-
export declare function serializeJsonForStorage(value: unknown): {
|
|
23
|
-
rawValue: string;
|
|
24
|
-
sizeBytes: number;
|
|
25
|
-
};
|
|
26
|
-
type AsyncMaintenanceMetadataEntry = {
|
|
27
|
-
customMetadata: Record<string, unknown>;
|
|
28
|
-
key: string;
|
|
29
|
-
lastAccessAt: number;
|
|
30
|
-
sizeBytes?: number;
|
|
31
|
-
version: number;
|
|
32
|
-
};
|
|
33
|
-
/**
|
|
34
|
-
* Removes planned async maintenance entries in bounded batches. Each batch is
|
|
35
|
-
* a conditional remove, so entries other code or tabs changed since planning
|
|
36
|
-
* are kept as stale in the same write instead of being deleted through an
|
|
37
|
-
* outdated plan. The plan itself is never restarted, so every deadline makes
|
|
38
|
-
* progress. `shouldContinue` is checked around every batch so a plan never
|
|
39
|
-
* outlives the session it was built for; `onRemoved` only runs while it holds.
|
|
40
|
-
*/
|
|
41
|
-
export declare function removeAsyncMaintenanceEntriesIfUnchanged<T extends AsyncMaintenanceMetadataEntry>(plannedEntries: T[], isOfflineProtected: (customMetadata: T['customMetadata']) => boolean, removeIfUnchanged: (entries: AsyncStorageNamespaceCommitConditionalRemove[]) => Promise<ReadonlySet<string> | null>, onRemoved: (keys: string[]) => void, batchSize: number, shouldContinue: () => boolean, idleContext: IdleCleanupContext): Promise<{
|
|
42
|
-
completed: boolean;
|
|
43
|
-
hasStaleEntries: boolean;
|
|
44
|
-
}>;
|
|
45
|
-
export type ByteBudgetResult = {
|
|
46
|
-
keptKeys: Set<string>;
|
|
47
|
-
unprotectedBytes: number;
|
|
48
|
-
};
|
|
49
|
-
export declare function keepEntriesWithinByteBudget<T>(entries: T[], getKey: (entry: T) => string, getLastAccessAt: (entry: T) => number, getSizeBytes: (entry: T) => number, isPinned: (entry: T) => boolean, isProtected: (entry: T) => boolean, maxBytes: number): ByteBudgetResult;
|
|
50
|
-
/** Deadline-aware variant used by background storage maintenance. */
|
|
51
|
-
export declare function keepEntriesWithinByteBudgetDuringIdle<T>(entries: T[], getKey: (entry: T) => string, getLastAccessAt: (entry: T) => number, getSizeBytes: (entry: T) => number, isPinned: (entry: T) => boolean, isProtected: (entry: T) => boolean, maxBytes: number, idleContext: IdleCleanupContext): Promise<ByteBudgetResult | null>;
|
|
52
|
-
export {};
|
|
@@ -1,4 +0,0 @@
|
|
|
1
|
-
import type { AsyncStorageNamespaceKind, StorageAdapter } from './types';
|
|
2
|
-
type DefaultMaxBytesProfile = 'localSync' | 'async';
|
|
3
|
-
export declare function getDefaultMaxBytesForScope(adapter: StorageAdapter | DefaultMaxBytesProfile, scopeKind: Extract<AsyncStorageNamespaceKind, 'collection.item' | 'listQuery.item' | 'listQuery.query'>): number;
|
|
4
|
-
export {};
|
|
@@ -1,197 +0,0 @@
|
|
|
1
|
-
import { type TSDFDebugLogger, type TSDFPersistentStorageDebugOperation } from '../debug';
|
|
2
|
-
import { type CompactLocalStorageEntryValue } from './compactLocalStorageEntry';
|
|
3
|
-
import type { OfflineNetworkModeConfig } from './offline/types';
|
|
4
|
-
import { type IdleCleanupContext } from './scheduleIdleCleanup';
|
|
5
|
-
import { localPersistentStorage, type LocalStorageMetadataOptions } from './storageAdapter';
|
|
6
|
-
import type { AsyncStorageAdapter, AsyncStorageMetadataOrder, AsyncStorageNamespaceCommitConditionalRemove, AsyncStorageNamespaceKind, AsyncStorageNamespaceScope, AsyncStorageNamespaceStaticPolicy, AsyncStorageTouchMode, PersistentStorageBaseConfig, StorageAdapter, StorageCacheEntry } from './types';
|
|
7
|
-
export declare const SYNC_STORAGE_TOUCH_THROTTLE_MS = 60000;
|
|
8
|
-
type PersistentStorageRuntimeConfig = Omit<PersistentStorageBaseConfig<never>, 'schema'> & {
|
|
9
|
-
debugLogger?: TSDFDebugLogger;
|
|
10
|
-
logger?: TSDFDebugLogger;
|
|
11
|
-
};
|
|
12
|
-
export type PersistentStorageDebugContext = {
|
|
13
|
-
adapterKind: 'async' | 'local-sync';
|
|
14
|
-
debugLogger?: TSDFDebugLogger;
|
|
15
|
-
entryPrefix?: string;
|
|
16
|
-
key?: string;
|
|
17
|
-
namespaceKind?: AsyncStorageNamespaceKind;
|
|
18
|
-
storeName: string;
|
|
19
|
-
};
|
|
20
|
-
export declare function createPersistentStorageDebugContext(adapter: StorageAdapter, storeName: string, debugLogger?: TSDFDebugLogger, entryPrefix?: string, key?: string, namespaceKind?: AsyncStorageNamespaceKind): PersistentStorageDebugContext;
|
|
21
|
-
export declare function getLocalStorageAdapter(adapter: StorageAdapter): typeof localPersistentStorage | null;
|
|
22
|
-
export declare function assertValidPersistentStoreName(storeName: string): void;
|
|
23
|
-
/**
|
|
24
|
-
* Schedules managed localStorage maintenance during idle time.
|
|
25
|
-
*
|
|
26
|
-
* When multiple callers enqueue maintenance before the idle callback runs,
|
|
27
|
-
* forced manifest keys are coalesced and a global sweep request wins over
|
|
28
|
-
* targeted maintenance because it already covers the full cleanup pass.
|
|
29
|
-
*/
|
|
30
|
-
export declare function scheduleLocalStorageMaintenance(forceManifestKeys?: Iterable<string>): void;
|
|
31
|
-
export declare function recordLocalStorageTouch(key: string, timestamp: number): void;
|
|
32
|
-
export declare function touchLocalStorageKeyWithThrottle(key: string, touch: () => boolean | Promise<boolean>): Promise<void>;
|
|
33
|
-
export declare function getLocalStorageMaxAgeMs(): number;
|
|
34
|
-
export declare function isOfflineNetworkModeActiveSync(networkConfig: OfflineNetworkModeConfig | undefined): boolean;
|
|
35
|
-
export declare function mergeLocalStorageOfflineProtection(sessionKey: string, storageKey: string, currentOfflineProtected: boolean): boolean;
|
|
36
|
-
export declare function scheduleLocalStorageRemoval(key: string, options: LocalStorageMetadataOptions | undefined): void;
|
|
37
|
-
type LocalStorageValueCodec<T> = {
|
|
38
|
-
serialize(data: T): CompactLocalStorageEntryValue;
|
|
39
|
-
deserialize(data: CompactLocalStorageEntryValue): T | null;
|
|
40
|
-
};
|
|
41
|
-
type AsyncStorageValueCodec<T, TSerialized = unknown, TMetadata extends Record<string, unknown> = Record<string, unknown>> = {
|
|
42
|
-
serialize(data: T): TSerialized;
|
|
43
|
-
deserialize(data: TSerialized, metadata?: TMetadata): T | null;
|
|
44
|
-
};
|
|
45
|
-
export type PersistentStorageHandle<T> = {
|
|
46
|
-
/** Loads persisted data, validating version and schema. Returns null if not found or invalid. */
|
|
47
|
-
load(options?: {
|
|
48
|
-
touch?: AsyncStorageTouchMode;
|
|
49
|
-
}): Promise<T | null>;
|
|
50
|
-
/** Schedules a debounced save. getData is called at save time to capture latest state. */
|
|
51
|
-
scheduleSave(getData: () => T): void;
|
|
52
|
-
/** Immediately saves data, canceling any pending debounce. */
|
|
53
|
-
saveNow(data: T): Promise<void>;
|
|
54
|
-
/** Removes the persisted entry and cancels any pending debounce. */
|
|
55
|
-
clear(): Promise<void>;
|
|
56
|
-
/** Cancels any pending debounce timer without saving. */
|
|
57
|
-
dispose(): void;
|
|
58
|
-
};
|
|
59
|
-
/**
|
|
60
|
-
* Creates a handle for reading/writing a single persisted storage entry.
|
|
61
|
-
*
|
|
62
|
-
* @param config - Storage configuration including the injected adapter, schema, and version.
|
|
63
|
-
* @param itemValidator - Optional per-item validator for compound data structures.
|
|
64
|
-
* Called after the overall cache entry is loaded. Use this to validate individual
|
|
65
|
-
* items within collections/queries.
|
|
66
|
-
*/
|
|
67
|
-
export declare function createPersistentStorageHandle<T>(config: PersistentStorageRuntimeConfig, { asyncValueCodec, getManifestMeta, asyncNamespace, valueCodec }?: {
|
|
68
|
-
asyncValueCodec?: AsyncStorageValueCodec<T>;
|
|
69
|
-
getManifestMeta?: (data: T) => Record<string, unknown> | undefined;
|
|
70
|
-
asyncNamespace?: {
|
|
71
|
-
storeName?: string;
|
|
72
|
-
kind?: AsyncStorageNamespaceKind;
|
|
73
|
-
entryKey?: string;
|
|
74
|
-
};
|
|
75
|
-
valueCodec?: AsyncStorageValueCodec<T>;
|
|
76
|
-
}): PersistentStorageHandle<T>;
|
|
77
|
-
type PersistentStorageNamespaceMetadata<TMetadata extends Record<string, unknown>> = {
|
|
78
|
-
customMetadata: TMetadata;
|
|
79
|
-
key: string;
|
|
80
|
-
lastAccessAt: number;
|
|
81
|
-
sizeBytes?: number;
|
|
82
|
-
writtenAt: number;
|
|
83
|
-
version: number;
|
|
84
|
-
};
|
|
85
|
-
type PersistentStorageNamespaceCommitArgs<T, TMetadata extends Record<string, unknown> = Record<string, never>> = {
|
|
86
|
-
removes?: string[];
|
|
87
|
-
staticPolicy?: AsyncStorageNamespaceStaticPolicy | null;
|
|
88
|
-
touches?: Array<{
|
|
89
|
-
key: string;
|
|
90
|
-
lastAccessAt?: number;
|
|
91
|
-
}>;
|
|
92
|
-
upserts?: Array<{
|
|
93
|
-
data: T;
|
|
94
|
-
key: string;
|
|
95
|
-
metadata?: TMetadata;
|
|
96
|
-
}>;
|
|
97
|
-
};
|
|
98
|
-
type LocalStorageMaintenanceRemovalResult = {
|
|
99
|
-
completed: boolean;
|
|
100
|
-
removedKeys: Set<string>;
|
|
101
|
-
staleKeys: Set<string>;
|
|
102
|
-
};
|
|
103
|
-
type PersistentStorageNamespaceHandle<T, TMetadata extends Record<string, unknown> = Record<string, never>> = {
|
|
104
|
-
/** The async adapter backing this handle, or `null` for `local-sync`. */
|
|
105
|
-
getAsyncAdapter(): AsyncStorageAdapter | null;
|
|
106
|
-
commit(args: PersistentStorageNamespaceCommitArgs<T, TMetadata>): Promise<void>;
|
|
107
|
-
/**
|
|
108
|
-
* Async adapters only: removes entries whose metadata still matches through
|
|
109
|
-
* `removeEntries` and resolves with the keys kept because they changed, or
|
|
110
|
-
* `null` when nothing could be verified (no active session or a storage
|
|
111
|
-
* error). The remover is passed in so shared persistence code doesn't pull
|
|
112
|
-
* the async adapter implementation into sync-only bundles.
|
|
113
|
-
*/
|
|
114
|
-
removeEntriesIfUnchanged(entries: AsyncStorageNamespaceCommitConditionalRemove[], removeEntries: (adapter: AsyncStorageAdapter, scope: AsyncStorageNamespaceScope, entries: AsyncStorageNamespaceCommitConditionalRemove[]) => Promise<ReadonlySet<string>>): Promise<ReadonlySet<string> | null>;
|
|
115
|
-
readEntry(entryKey: string, options?: {
|
|
116
|
-
touch?: AsyncStorageTouchMode;
|
|
117
|
-
}): Promise<StorageCacheEntry<T> | null>;
|
|
118
|
-
load(entryKey: string, options?: {
|
|
119
|
-
touch?: AsyncStorageTouchMode;
|
|
120
|
-
}): Promise<T | null>;
|
|
121
|
-
loadMany(entryKeys: string[], options?: {
|
|
122
|
-
touch?: AsyncStorageTouchMode;
|
|
123
|
-
}): Promise<Array<T | null>>;
|
|
124
|
-
save(entryKey: string, data: T): Promise<void>;
|
|
125
|
-
replaceAll(entries: Array<{
|
|
126
|
-
data: T;
|
|
127
|
-
key: string;
|
|
128
|
-
}>): Promise<void>;
|
|
129
|
-
remove(entryKey: string): Promise<void>;
|
|
130
|
-
listKeys(): Promise<string[]>;
|
|
131
|
-
listMetadata(args?: {
|
|
132
|
-
order?: AsyncStorageMetadataOrder;
|
|
133
|
-
}): Promise<PersistentStorageNamespaceMetadata<TMetadata>[]>;
|
|
134
|
-
listMetadataByFilter(args: {
|
|
135
|
-
equals: unknown;
|
|
136
|
-
key: string;
|
|
137
|
-
order?: AsyncStorageMetadataOrder;
|
|
138
|
-
}): Promise<PersistentStorageNamespaceMetadata<TMetadata>[]>;
|
|
139
|
-
removeLocalEntriesIfUnchanged(entries: Array<{
|
|
140
|
-
key: string;
|
|
141
|
-
lastAccessAt: number;
|
|
142
|
-
offlineProtected: boolean;
|
|
143
|
-
}>, context: IdleCleanupContext, shouldContinue?: () => boolean): Promise<LocalStorageMaintenanceRemovalResult>;
|
|
144
|
-
clear(): Promise<void>;
|
|
145
|
-
dispose(): void;
|
|
146
|
-
};
|
|
147
|
-
export declare function listAllPersistentStorageNamespaceMetadata<T, TMetadata extends Record<string, unknown> = Record<string, never>>(namespace: PersistentStorageNamespaceHandle<T, TMetadata>, args?: {
|
|
148
|
-
order?: AsyncStorageMetadataOrder;
|
|
149
|
-
}): Promise<PersistentStorageNamespaceMetadata<TMetadata>[]>;
|
|
150
|
-
export declare function listPersistentStorageNamespaceMetadataByFilter<T, TMetadata extends Record<string, unknown> = Record<string, never>>(namespace: PersistentStorageNamespaceHandle<T, TMetadata>, args: {
|
|
151
|
-
equals: unknown;
|
|
152
|
-
key: string;
|
|
153
|
-
order?: AsyncStorageMetadataOrder;
|
|
154
|
-
}): Promise<PersistentStorageNamespaceMetadata<TMetadata>[]>;
|
|
155
|
-
export declare function createPersistentStorageNamespaceHandle<T, TMetadata extends Record<string, unknown> = Record<string, never>>(config: PersistentStorageRuntimeConfig & {
|
|
156
|
-
entryPrefix: string;
|
|
157
|
-
}, { asyncValueCodec, getManifestMeta, valueCodec }?: {
|
|
158
|
-
asyncValueCodec?: AsyncStorageValueCodec<T, unknown, TMetadata>;
|
|
159
|
-
getManifestMeta?: (data: T, entryKey: string) => TMetadata | undefined;
|
|
160
|
-
valueCodec?: AsyncStorageValueCodec<T, unknown, TMetadata>;
|
|
161
|
-
}): PersistentStorageNamespaceHandle<T, TMetadata>;
|
|
162
|
-
export declare function readStorageEntryFromLocalStorageSync<T = unknown>(key: string, version: number | undefined, options: LocalStorageMetadataOptions & {
|
|
163
|
-
allowExpiredRead?: boolean;
|
|
164
|
-
debug?: {
|
|
165
|
-
context: PersistentStorageDebugContext;
|
|
166
|
-
details?: Readonly<Record<string, unknown>>;
|
|
167
|
-
operation: TSDFPersistentStorageDebugOperation;
|
|
168
|
-
};
|
|
169
|
-
}, valueCodec?: LocalStorageValueCodec<T>): StorageCacheEntry<T> | null;
|
|
170
|
-
/**
|
|
171
|
-
* Gets the storage key for a given session and store name.
|
|
172
|
-
* Exported for use by store persistence integrations.
|
|
173
|
-
*/
|
|
174
|
-
export declare function getStorageKeyForStore(sessionKey: string, storeName: string): string;
|
|
175
|
-
export declare function getStoragePrefixForStoreNamespace(sessionKey: string, storeName: string, entryPrefix: string): string;
|
|
176
|
-
export declare function createProtectedStorageKey(sessionKey: string, storeName: string, kind: string, key: string, backend?: 'async' | 'localStorage'): string;
|
|
177
|
-
export declare function readManifestPayloadMeta(meta: unknown): unknown;
|
|
178
|
-
/** Clears all persistent storage entries for a given session key and adapter. */
|
|
179
|
-
export declare function clearSessionStorage(sessionKey: string, adapter: StorageAdapter): Promise<void>;
|
|
180
|
-
/** Clears all persistent storage entries for a given session key across built-in adapters. */
|
|
181
|
-
export declare function clearAllSessionStorage(sessionKey: string): Promise<void>;
|
|
182
|
-
/**
|
|
183
|
-
* Refreshes the timestamp of a localStorage cache entry to track last access time.
|
|
184
|
-
* Used by store persistence setup functions after successful sync reads.
|
|
185
|
-
*/
|
|
186
|
-
export declare function refreshLocalStorageTimestamp(key: string, options: LocalStorageMetadataOptions): void;
|
|
187
|
-
/**
|
|
188
|
-
* Resets persistent-storage maintenance and expiration-tracking state.
|
|
189
|
-
*
|
|
190
|
-
* Exported for test cleanup, but restart-style tests should prefer
|
|
191
|
-
* `resetSessionForTests()` from `tests/utils/resetSessionForTests.ts` so this
|
|
192
|
-
* low-level reset stays coordinated with the other session/runtime resets.
|
|
193
|
-
*/
|
|
194
|
-
export declare function resetExpirationScanTracking(): void;
|
|
195
|
-
export declare function readProtectedStorageKeys(adapter: StorageAdapter, sessionKey: string, debugLogger?: TSDFDebugLogger): Promise<Set<string>>;
|
|
196
|
-
export declare function scheduleAsyncStorageMaintenance(maintenanceKey: string, callback: (context: IdleCleanupContext) => Promise<void>): void;
|
|
197
|
-
export {};
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
import { type TSDFDebugLogger } from '../debug';
|
|
2
|
-
import type { AsyncStorageNamespaceKind } from './types';
|
|
3
|
-
export type QuotaCleanupPhase = 'startup-cleanup' | 'maintenance' | 'flush';
|
|
4
|
-
export declare function logPersistentStorageQuotaCleanup(args: {
|
|
5
|
-
adapter: 'async' | 'local-sync';
|
|
6
|
-
logger: TSDFDebugLogger;
|
|
7
|
-
evictedEntries: number;
|
|
8
|
-
keptEntries: number;
|
|
9
|
-
maxBytes: number;
|
|
10
|
-
namespaceKind: AsyncStorageNamespaceKind;
|
|
11
|
-
phase: QuotaCleanupPhase;
|
|
12
|
-
quota: 'maxBytes' | 'maxItemBytes' | 'maxQueryBytes';
|
|
13
|
-
storeName: string;
|
|
14
|
-
totalEntries: number;
|
|
15
|
-
unprotectedBytes: number;
|
|
16
|
-
}): void;
|
|
@@ -1,28 +0,0 @@
|
|
|
1
|
-
export type IdleCleanupDeadline = {
|
|
2
|
-
readonly didTimeout: boolean;
|
|
3
|
-
timeRemaining(): number;
|
|
4
|
-
};
|
|
5
|
-
/**
|
|
6
|
-
* Schedules a fire-and-forget cleanup callback during idle time.
|
|
7
|
-
* Uses `requestIdleCallback` when available, falling back to a timer-backed
|
|
8
|
-
* synthetic 12 ms deadline.
|
|
9
|
-
*/
|
|
10
|
-
export declare function scheduleIdleCleanup(callback: (deadline: IdleCleanupDeadline) => void): () => void;
|
|
11
|
-
export type IdleCleanupContext = {
|
|
12
|
-
cancel(): void;
|
|
13
|
-
getContinuationCount(): number;
|
|
14
|
-
isCanceled(): boolean;
|
|
15
|
-
shouldYield(): boolean;
|
|
16
|
-
yieldIfNeeded(): Promise<boolean>;
|
|
17
|
-
};
|
|
18
|
-
/**
|
|
19
|
-
* Tracks the current idle deadline and schedules cancellable continuations
|
|
20
|
-
* when a maintenance pass exhausts it.
|
|
21
|
-
*/
|
|
22
|
-
export declare function createIdleCleanupContext(initialDeadline: IdleCleanupDeadline): IdleCleanupContext;
|
|
23
|
-
export declare const INITIAL_MAINTENANCE_CLEANUP_DELAY_MS = 10000;
|
|
24
|
-
/**
|
|
25
|
-
* Gives startup maintenance a short grace period before using the regular
|
|
26
|
-
* idle cleanup scheduling.
|
|
27
|
-
*/
|
|
28
|
-
export declare function scheduleInitialMaintenanceCleanup(callback: () => void): () => void;
|
|
@@ -1,41 +0,0 @@
|
|
|
1
|
-
import { readManagedLocalStorageManifestEntriesByPrefix, readManagedLocalStorageNamespaceEntryByPayload, readManagedLocalStorageSingleEntryByPayload, upsertManagedLocalStorageNamespaceEntry, upsertManagedLocalStorageSingleEntry, type ManagedLocalStorageNamespaceRemovalCandidate, type ManagedLocalStorageNamespaceRemovalResult } from './localStorageMetadata';
|
|
2
|
-
import { type IdleCleanupContext } from './scheduleIdleCleanup';
|
|
3
|
-
export type LocalStorageMetadataOptions = {
|
|
4
|
-
metadata: 'single';
|
|
5
|
-
} | {
|
|
6
|
-
metadata: 'namespace';
|
|
7
|
-
namespacePrefix: string;
|
|
8
|
-
};
|
|
9
|
-
type LocalPersistentStorage = {
|
|
10
|
-
kind: 'local-sync';
|
|
11
|
-
runLocked<T>(callback: () => T | Promise<T>): Promise<T>;
|
|
12
|
-
runMaintenanceLocked<T>(context: IdleCleanupContext, callback: () => T | Promise<T>): Promise<T>;
|
|
13
|
-
readRaw(key: string): string | null;
|
|
14
|
-
write<T>(key: string, value: T): {
|
|
15
|
-
rawValue: string;
|
|
16
|
-
sizeBytes: number;
|
|
17
|
-
};
|
|
18
|
-
remove(key: string, options?: LocalStorageMetadataOptions): void;
|
|
19
|
-
removeByPrefix(prefix: string): void;
|
|
20
|
-
listKeys(prefix: string): string[];
|
|
21
|
-
listRawKeys(prefix: string): string[];
|
|
22
|
-
getManifestKeyForSingle(storageKey: string): string;
|
|
23
|
-
getManifestKeyForPrefix(storagePrefix: string): string;
|
|
24
|
-
readSingleEntryMetadataByPayload(payloadKey: string): ReturnType<typeof readManagedLocalStorageSingleEntryByPayload>;
|
|
25
|
-
readNamespaceEntryMetadataByPayload(payloadKey: string, namespacePrefix: string): ReturnType<typeof readManagedLocalStorageNamespaceEntryByPayload>;
|
|
26
|
-
listManifestEntries(prefix: string): ReturnType<typeof readManagedLocalStorageManifestEntriesByPrefix>;
|
|
27
|
-
upsertSingleEntry(args: Parameters<typeof upsertManagedLocalStorageSingleEntry>[0]): string;
|
|
28
|
-
upsertNamespaceEntry(args: Parameters<typeof upsertManagedLocalStorageNamespaceEntry>[0]): string;
|
|
29
|
-
touchSingleEntry(payloadKey: string): boolean;
|
|
30
|
-
touchNamespaceEntry(payloadKey: string, namespacePrefix: string): boolean;
|
|
31
|
-
removeNamespaceEntriesIfUnchanged(storagePrefix: string, candidates: ManagedLocalStorageNamespaceRemovalCandidate[], candidateIndex: number, shouldYield: () => boolean): ManagedLocalStorageNamespaceRemovalResult;
|
|
32
|
-
clearManifest(manifestKey: string): void;
|
|
33
|
-
clearSession(sessionKey: string): void;
|
|
34
|
-
registerMaintenanceCallback(manifestKey: string, callback: (context?: IdleCleanupContext) => Promise<void>): void;
|
|
35
|
-
unregisterMaintenanceCallback(manifestKey: string): void;
|
|
36
|
-
runMaintenance(forceManifestKeys: Iterable<string> | undefined, context: IdleCleanupContext): Promise<void>;
|
|
37
|
-
readProtectedStorageKeys(sessionKey: string): Set<string>;
|
|
38
|
-
syncSessionProtectedKeys(sessionKey: string, protectedKeys: Iterable<string>): void;
|
|
39
|
-
};
|
|
40
|
-
export declare const localPersistentStorage: LocalPersistentStorage;
|
|
41
|
-
export { opfsPersistentStorage } from './opfsPersistentStorage';
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
export declare const COLLECTION_STORAGE_ENTRY_PREFIX = "ci";
|
|
2
|
-
export declare const LIST_QUERY_ITEM_STORAGE_ENTRY_PREFIX = "li";
|
|
3
|
-
export declare const LIST_QUERY_QUERY_STORAGE_ENTRY_PREFIX = "lq";
|
|
4
|
-
export declare const OFFLINE_QUEUE_STORAGE_ENTRY_PREFIX = "oq";
|
|
5
|
-
export declare const OFFLINE_CONFLICT_STORAGE_ENTRY_PREFIX = "oc";
|
|
6
|
-
export declare const OFFLINE_ENTITY_STORAGE_ENTRY_PREFIX = "oe";
|
|
7
|
-
/**
|
|
8
|
-
* Store-name root reserved for offline coordination data. Every payload key
|
|
9
|
-
* of the form `tsdf.<sessionKey>._o_.<name>` belongs to the offline runtime
|
|
10
|
-
* and is never evicted by quota recovery or expired by generic cleanup.
|
|
11
|
-
*/
|
|
12
|
-
export declare const OFFLINE_ROOT_STORE_NAME = "_o_";
|
|
13
|
-
/** Store name of the per-session offline mode status entry. */
|
|
14
|
-
export declare const OFFLINE_SESSION_STATUS_STORE_NAME = "_o_.s";
|
|
15
|
-
/** Builds the `localStorage` key holding a session's offline mode status. */
|
|
16
|
-
export declare function getOfflineSessionStatusStorageKey(sessionKey: string): string;
|