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.
- package/dist/async-storage.d.ts +1 -1
- package/dist/{asyncStorageAdapter-DuAUANgu.d.ts → asyncStorageAdapter-CMohMeKm.d.ts} +1 -1
- package/dist/indexed-db-storage.d.ts +1 -1
- package/dist/main.d.ts +28 -32
- package/dist/main.js +46 -46
- package/dist/opfs-storage.d.ts +1 -1
- package/dist/{opfsPersistentStorage-BB0qqnRz.d.ts → opfsPersistentStorage-Ci0JcCo5.d.ts} +1 -1
- package/dist/src/async-storage.d.ts +1 -0
- package/dist/src/cacheLimits/lruCacheRuntime.d.ts +9 -0
- package/dist/src/cacheLimits/scheduleIdleThrottled.d.ts +1 -0
- package/dist/src/cacheLimits/useRegisterActiveKeys.d.ts +1 -0
- package/dist/src/collectionStore/collectionCacheLimits.d.ts +1 -0
- package/dist/src/collectionStore/collectionStore.d.ts +385 -0
- package/dist/src/collectionStore/executeBatchFetch.d.ts +6 -0
- package/dist/src/collectionStore/useItem.d.ts +15 -0
- package/dist/src/collectionStore/useMultipleItems.d.ts +35 -0
- package/dist/src/debug.d.ts +30 -0
- package/dist/src/documentStore.d.ts +290 -0
- package/dist/src/hooks/useListItem.d.ts +22 -0
- package/dist/src/hooks/useListItemIsDeleted.d.ts +13 -0
- package/dist/src/hooks/useListItemIsLoading.d.ts +16 -0
- package/dist/src/indexed-db-storage.d.ts +1 -0
- package/dist/src/internal/offlineTestInstrumentation.d.ts +12 -0
- package/dist/src/internal/testTimelineTypes.d.ts +1 -0
- package/dist/src/invalidationUtils.d.ts +8 -0
- package/dist/src/isOffScreenContext.d.ts +16 -0
- package/dist/src/listQueryStore/createFetchApi.d.ts +1 -0
- package/dist/src/listQueryStore/createMutationApi.d.ts +1 -0
- package/dist/src/listQueryStore/executeItemBatchFetch.d.ts +20 -0
- package/dist/src/listQueryStore/executeQueryFetch.d.ts +7 -0
- package/dist/src/listQueryStore/itemFieldUtils.d.ts +77 -0
- package/dist/src/listQueryStore/listQueryCacheLimits.d.ts +1 -0
- package/dist/src/listQueryStore/listQueryStore.d.ts +538 -0
- package/dist/src/listQueryStore/types.d.ts +347 -0
- package/dist/src/listQueryStore/useFindItem.d.ts +7 -0
- package/dist/src/listQueryStore/useItem.d.ts +29 -0
- package/dist/src/listQueryStore/useListQuery.d.ts +29 -0
- package/dist/src/listQueryStore/useMultipleItems.d.ts +44 -0
- package/dist/src/listQueryStore/useMultipleListQueries.d.ts +46 -0
- package/dist/src/listQueryStore/usePendingOfflineItems.d.ts +19 -0
- package/dist/src/main.d.ts +23 -0
- package/dist/src/opfs-storage.d.ts +1 -0
- package/dist/src/persistentStorage/asyncStorageAdapter.d.ts +95 -0
- package/dist/src/persistentStorage/asyncStorageAdapters.d.ts +2 -0
- package/dist/src/persistentStorage/asyncStorageShared.d.ts +23 -0
- package/dist/src/persistentStorage/collectionStorePersistence.d.ts +26 -0
- package/dist/src/persistentStorage/compactListQueryLocalStorageEntry.d.ts +11 -0
- package/dist/src/persistentStorage/compactLocalStorageEntry.d.ts +8 -0
- package/dist/src/persistentStorage/documentEntryKey.d.ts +1 -0
- package/dist/src/persistentStorage/documentStorePersistence.d.ts +17 -0
- package/dist/src/persistentStorage/indexedDbAsyncStorageAdapter.d.ts +165 -0
- package/dist/src/persistentStorage/indexedDbPersistentStorage.d.ts +6 -0
- package/dist/src/persistentStorage/listQueryStorePersistence.d.ts +37 -0
- package/dist/src/persistentStorage/localStorageMetadata.d.ts +126 -0
- package/dist/src/persistentStorage/navigatorLocks.d.ts +3 -0
- package/dist/src/persistentStorage/offline/entityMetadata.d.ts +12 -0
- package/dist/src/persistentStorage/offline/fetchRuntime.d.ts +35 -0
- package/dist/src/persistentStorage/offline/mutationRuntime.d.ts +31 -0
- package/dist/src/persistentStorage/offline/offlineResolution.typeGuards.d.ts +1 -0
- package/dist/src/persistentStorage/offline/overlayStoreLifecycle.d.ts +13 -0
- package/dist/src/persistentStorage/offline/sessionCoordinator.d.ts +94 -0
- package/dist/src/persistentStorage/offline/sessionProtectionRegistry.d.ts +11 -0
- package/dist/src/persistentStorage/offline/storeController.d.ts +86 -0
- package/dist/src/persistentStorage/offline/types.d.ts +1255 -0
- package/dist/src/persistentStorage/offlineUploadRegistry.d.ts +11 -0
- package/dist/src/persistentStorage/offlineUploadTypes.d.ts +97 -0
- package/dist/src/persistentStorage/offlineUploadsShared.d.ts +4 -0
- package/dist/src/persistentStorage/opfsAsyncStorageAdapter.d.ts +24 -0
- package/dist/src/persistentStorage/opfsFileNaming.d.ts +23 -0
- package/dist/src/persistentStorage/opfsHelpers.d.ts +3 -0
- package/dist/src/persistentStorage/opfsOfflineUploadAdapter.d.ts +2 -0
- package/dist/src/persistentStorage/opfsPersistentStorage.d.ts +2 -0
- package/dist/src/persistentStorage/parsePersistedData.d.ts +45 -0
- package/dist/src/persistentStorage/persistenceUtils.d.ts +52 -0
- package/dist/src/persistentStorage/persistentStorageDefaults.d.ts +4 -0
- package/dist/src/persistentStorage/persistentStorageManager.d.ts +197 -0
- package/dist/src/persistentStorage/quotaDebug.d.ts +16 -0
- package/dist/src/persistentStorage/scheduleIdleCleanup.d.ts +28 -0
- package/dist/src/persistentStorage/storageAdapter.d.ts +41 -0
- package/dist/src/persistentStorage/storageEntryPrefixes.d.ts +16 -0
- package/dist/src/persistentStorage/types.d.ts +412 -0
- package/dist/src/persistentStorage/validateWithSchema.d.ts +12 -0
- package/dist/src/requestScheduler.d.ts +81 -0
- package/dist/src/storeManager.d.ts +160 -0
- package/dist/src/utils/automaticFetchPolicy.d.ts +29 -0
- package/dist/src/utils/browserTabsPriority.d.ts +43 -0
- package/dist/src/utils/browserTabsSync.d.ts +33 -0
- package/dist/src/utils/optimisticMutationTracker.d.ts +20 -0
- package/dist/src/utils/optimisticRollback.d.ts +11 -0
- package/dist/src/utils/payloadDebounce.d.ts +5 -0
- package/dist/src/utils/performMutation.d.ts +19 -0
- package/dist/src/utils/reusePrevIfEqual.d.ts +1 -0
- package/dist/src/utils/storeFocusLifecycle.d.ts +1 -0
- package/dist/src/utils/storeShared.d.ts +126 -0
- package/dist/src/utils/useEnsureIsLoaded.d.ts +6 -0
- package/dist/src/utils/useRequireFreshData.d.ts +6 -0
- package/dist/tests/basic-functionality/collection-store.test.d.ts +1 -0
- package/dist/tests/basic-functionality/document-store.test.d.ts +1 -0
- package/dist/tests/basic-functionality/list-query-state-manipulation.test.d.ts +1 -0
- package/dist/tests/basic-functionality/list-query-store.test.d.ts +1 -0
- package/dist/tests/browser-tabs/browser-tabs-background-rtu-batch.test.d.ts +1 -0
- package/dist/tests/browser-tabs/browser-tabs-background-rtu.test.d.ts +1 -0
- package/dist/tests/browser-tabs/browser-tabs-background-scheduling.test.d.ts +1 -0
- package/dist/tests/browser-tabs/browser-tabs-list-query-pagination.test.d.ts +1 -0
- package/dist/tests/browser-tabs/browser-tabs-non-cancelable-fetches.test.d.ts +1 -0
- package/dist/tests/browser-tabs/browser-tabs-optimistic-sync.test.d.ts +1 -0
- package/dist/tests/browser-tabs/browser-tabs-partial-resources.test.d.ts +1 -0
- package/dist/tests/browser-tabs/browser-tabs-priority.test.d.ts +1 -0
- package/dist/tests/browser-tabs/browser-tabs-snapshot-consistency.test.d.ts +1 -0
- package/dist/tests/browser-tabs/browser-tabs-state-methods.test.d.ts +1 -0
- package/dist/tests/browser-tabs/browser-tabs-sync-coordinator.test.d.ts +1 -0
- package/dist/tests/browser-tabs/browser-tabs-test-helpers.d.ts +69 -0
- package/dist/tests/browser-tabs/focus-coordinator.test.d.ts +1 -0
- package/dist/tests/hooks/collection-hooks-2.test.d.ts +1 -0
- package/dist/tests/hooks/collection-hooks.test.d.ts +1 -0
- package/dist/tests/hooks/collection-useListItem.test.d.ts +1 -0
- package/dist/tests/hooks/debounce-payload-hooks.test.d.ts +1 -0
- package/dist/tests/hooks/disable-refetches.test.d.ts +1 -0
- package/dist/tests/hooks/document-hooks-2.test.d.ts +1 -0
- package/dist/tests/hooks/document-hooks.test.d.ts +1 -0
- package/dist/tests/hooks/document-useListItem.test.d.ts +1 -0
- package/dist/tests/hooks/fetch-error-recovery.test.d.ts +1 -0
- package/dist/tests/hooks/hook-memoization.test.d.ts +1 -0
- package/dist/tests/hooks/list-query-hooks-2.test.d.ts +1 -0
- package/dist/tests/hooks/list-query-hooks-3.test.d.ts +1 -0
- package/dist/tests/hooks/list-query-hooks-mutations.test.d.ts +1 -0
- package/dist/tests/hooks/list-query-hooks.test.d.ts +1 -0
- package/dist/tests/hooks/list-query-pending-offline-items.test.d.ts +1 -0
- package/dist/tests/hooks/off-screen-context.test.d.ts +1 -0
- package/dist/tests/list-query-features/list-query-derived-queries.test.d.ts +1 -0
- package/dist/tests/list-query-features/list-query-offset-pagination.test.d.ts +1 -0
- package/dist/tests/list-query-features/list-query-optimistic-filters.test.d.ts +1 -0
- package/dist/tests/list-query-features/list-query-partial-resources-2.test.d.ts +1 -0
- package/dist/tests/list-query-features/list-query-partial-resources-3.test.d.ts +1 -0
- package/dist/tests/list-query-features/list-query-partial-resources-regressions.test.d.ts +1 -0
- package/dist/tests/list-query-features/list-query-partial-resources-show-partial-status.test.d.ts +1 -0
- package/dist/tests/list-query-features/list-query-partial-resources.test.d.ts +1 -0
- package/dist/tests/list-query-features/list-query-size-coalescing-partial-resources.test.d.ts +1 -0
- package/dist/tests/mocks/browserTabsTestUtils.d.ts +17 -0
- package/dist/tests/mocks/collectionStoreTestEnv.d.ts +265 -0
- package/dist/tests/mocks/documentStoreTestEnv.d.ts +140 -0
- package/dist/tests/mocks/duplicateStoreGuard.test.d.ts +1 -0
- package/dist/tests/mocks/listQueryStoreTestEnv.d.ts +295 -0
- package/dist/tests/mocks/mockBrowserOpfs.d.ts +70 -0
- package/dist/tests/mocks/mockBrowserOpfs.test.d.ts +1 -0
- package/dist/tests/mocks/mockLocalStorageStore.d.ts +61 -0
- package/dist/tests/mocks/seedScenarioPersistentStorage.d.ts +51 -0
- package/dist/tests/mocks/serverMock.d.ts +56 -0
- package/dist/tests/mocks/serverTableMock.d.ts +174 -0
- package/dist/tests/mocks/testEnvUtils.d.ts +120 -0
- package/dist/tests/mocks/testScenarioPersistentStorage.test.d.ts +1 -0
- package/dist/tests/offline/offline-fetching-scenarios.test.d.ts +1 -0
- package/dist/tests/offline/offline-mixed-adapter-storage.test.d.ts +1 -0
- package/dist/tests/offline/offline-mutation-fallback.test.d.ts +1 -0
- package/dist/tests/offline/offline-network-recovery.test.d.ts +1 -0
- package/dist/tests/offline/offline-outage.test.d.ts +1 -0
- package/dist/tests/offline/offline-overlays.test.d.ts +1 -0
- package/dist/tests/offline/offline-query-replay.test.d.ts +1 -0
- package/dist/tests/offline/offline-reads.test.d.ts +1 -0
- package/dist/tests/offline/offline-replay-conflicts.test.d.ts +1 -0
- package/dist/tests/offline/offline-replay-queueing.test.d.ts +1 -0
- package/dist/tests/offline/offline-resolution-dependencies.test.d.ts +1 -0
- package/dist/tests/offline/offline-runtime-controls.test.d.ts +1 -0
- package/dist/tests/offline/offline-session-and-global-state.test.d.ts +1 -0
- package/dist/tests/offline/offline-storage.test.d.ts +1 -0
- package/dist/tests/offline/offline-uploads.test.d.ts +1 -0
- package/dist/tests/offline/offlineReplayTestShared.d.ts +292 -0
- package/dist/tests/offline/offlineTestShared.d.ts +156 -0
- package/dist/tests/perform-mutation/mutation-error-rollback.test.d.ts +1 -0
- package/dist/tests/perform-mutation/perform-mutation-block-window-close.test.d.ts +1 -0
- package/dist/tests/perform-mutation/perform-mutation-debounce.test.d.ts +1 -0
- package/dist/tests/perform-mutation/store-events.test.d.ts +1 -0
- package/dist/tests/persistent-storage/async-storage-efficiency/collection.test.d.ts +1 -0
- package/dist/tests/persistent-storage/async-storage-efficiency/document.test.d.ts +1 -0
- package/dist/tests/persistent-storage/async-storage-efficiency/list-query.test.d.ts +1 -0
- package/dist/tests/persistent-storage/async-storage-efficiency/maintenance.test.d.ts +1 -0
- package/dist/tests/persistent-storage/async-storage-efficiency/shared.d.ts +804 -0
- package/dist/tests/persistent-storage/async-storage-shared.test.d.ts +1 -0
- package/dist/tests/persistent-storage/collection-store-persistence.converted.opfs.test.d.ts +1 -0
- package/dist/tests/persistent-storage/collection-store-persistence.converted.test.d.ts +1 -0
- package/dist/tests/persistent-storage/collection-store-persistence.opfs.test.d.ts +1 -0
- package/dist/tests/persistent-storage/collection-store-persistence.test.d.ts +1 -0
- package/dist/tests/persistent-storage/document-store-persistence.converted.opfs.test.d.ts +1 -0
- package/dist/tests/persistent-storage/document-store-persistence.converted.test.d.ts +1 -0
- package/dist/tests/persistent-storage/document-store-persistence.opfs.test.d.ts +1 -0
- package/dist/tests/persistent-storage/document-store-persistence.test.d.ts +1 -0
- package/dist/tests/persistent-storage/expiration-scan.test.d.ts +1 -0
- package/dist/tests/persistent-storage/indexeddb-async-storage-efficiency/collection.test.d.ts +1 -0
- package/dist/tests/persistent-storage/indexeddb-async-storage-efficiency/document.test.d.ts +1 -0
- package/dist/tests/persistent-storage/indexeddb-async-storage-efficiency/list-query.test.d.ts +1 -0
- package/dist/tests/persistent-storage/indexeddb-async-storage-efficiency/maintenance.test.d.ts +1 -0
- package/dist/tests/persistent-storage/indexeddb-async-storage-efficiency/shared.d.ts +780 -0
- package/dist/tests/persistent-storage/indexeddb-storage-adapter.test.d.ts +1 -0
- package/dist/tests/persistent-storage/list-query-store-persistence.converted.opfs.test.d.ts +1 -0
- package/dist/tests/persistent-storage/list-query-store-persistence.converted.test.d.ts +1 -0
- package/dist/tests/persistent-storage/list-query-store-persistence.opfs.test.d.ts +1 -0
- package/dist/tests/persistent-storage/list-query-store-persistence.test.d.ts +1 -0
- package/dist/tests/persistent-storage/persistence-with-tabs-sync.test.d.ts +1 -0
- package/dist/tests/persistent-storage/persistentStorageByteBudgetTestUtils.d.ts +18 -0
- package/dist/tests/persistent-storage/quota-exceeded-recovery-no-locks.test.d.ts +1 -0
- package/dist/tests/persistent-storage/quota-exceeded-recovery.test.d.ts +1 -0
- package/dist/tests/persistent-storage/quotaRecoveryTestUtils.d.ts +228 -0
- package/dist/tests/persistent-storage/storage-adapter.test.d.ts +1 -0
- package/dist/tests/persistent-storage/sync-storage-efficiency/collection.test.d.ts +1 -0
- package/dist/tests/persistent-storage/sync-storage-efficiency/document.test.d.ts +1 -0
- package/dist/tests/persistent-storage/sync-storage-efficiency/list-query.test.d.ts +1 -0
- package/dist/tests/persistent-storage/sync-storage-efficiency/maintenance.test.d.ts +1 -0
- package/dist/tests/persistent-storage/sync-storage-efficiency/shared.d.ts +784 -0
- package/dist/tests/playwright/browser-tabs.spec.d.ts +1 -0
- package/dist/tests/playwright/persistent-storage.spec.d.ts +1 -0
- package/dist/tests/request-schedulling/batch-medium-priority.test.d.ts +1 -0
- package/dist/tests/request-schedulling/batch-realtime-updates.test.d.ts +1 -0
- package/dist/tests/request-schedulling/collection-batch-coalescing.test.d.ts +1 -0
- package/dist/tests/request-schedulling/collection-batch-key-grouping.test.d.ts +1 -0
- package/dist/tests/request-schedulling/collection-fetch-orchestration.test.d.ts +1 -0
- package/dist/tests/request-schedulling/document-await-fetch.test.d.ts +1 -0
- package/dist/tests/request-schedulling/document-base-coalescing.test.d.ts +1 -0
- package/dist/tests/request-schedulling/document-fetch-orchestration.test.d.ts +1 -0
- package/dist/tests/request-schedulling/document-medium-priority-fetch.test.d.ts +1 -0
- package/dist/tests/request-schedulling/document-realtime-updates.test.d.ts +1 -0
- package/dist/tests/request-schedulling/list-query-item-batch-coalescing.test.d.ts +1 -0
- package/dist/tests/request-schedulling/list-query-item-batch-key-grouping.test.d.ts +1 -0
- package/dist/tests/request-schedulling/list-query-size-coalescing.test.d.ts +1 -0
- package/dist/tests/request-schedulling/medium-vs-realtime.test.d.ts +1 -0
- package/dist/tests/request-schedulling/request-scheduler-cross-tab-sync.test.d.ts +1 -0
- package/dist/tests/request-schedulling/window-focus.test.d.ts +1 -0
- package/dist/tests/store-manager.test.d.ts +1 -0
- package/dist/tests/user-facing-api/collection-offline-usage.test.d.ts +1 -0
- package/dist/tests/user-facing-api/document-offline-usage.test.d.ts +1 -0
- package/dist/tests/user-facing-api/list-query-offline-usage.test.d.ts +1 -0
- package/dist/tests/user-facing-api/result-returning-callbacks.test.d.ts +1 -0
- package/dist/tests/utils/genericTestUtils.d.ts +6 -0
- package/dist/tests/utils/indexedDbPersistentStorageOptimizationTestUtils.d.ts +79 -0
- package/dist/tests/utils/indexedDbPersistentStorageTestStore.d.ts +181 -0
- package/dist/tests/utils/listQueryHooksTestUtils.d.ts +8 -0
- package/dist/tests/utils/networkMock.d.ts +11 -0
- package/dist/tests/utils/opfsPersistentStorageTestStore.d.ts +220 -0
- package/dist/tests/utils/persistentStorageOptimizationTestUtils.d.ts +54 -0
- package/dist/tests/utils/persistentStorageOptimizationTestUtils.test.d.ts +1 -0
- package/dist/tests/utils/persistentStorageTestStore.d.ts +66 -0
- package/dist/tests/utils/resetSessionForTests.d.ts +3 -0
- package/dist/tests/utils/withSuppressedActError.d.ts +4 -0
- package/dist/{types-aWgyZHLj.d.ts → types-D0ttVGmj.d.ts} +1 -1
- package/docs/browser-tabs-sync.md +2 -0
- package/docs/mutations.md +7 -3
- package/docs/persistent-storage.md +2 -0
- package/package.json +6 -3
|
@@ -0,0 +1,784 @@
|
|
|
1
|
+
import type { OffsetPaginationConfig } from '../../../src/listQueryStore/types';
|
|
2
|
+
import { type ListQueryParams, type Row, type Tables } from '../../mocks/listQueryStoreTestEnv';
|
|
3
|
+
export declare function sumPersistedEntryBytes(...sizes: number[]): number;
|
|
4
|
+
export declare function getLocalCollectionEntrySizeBytes<T>(payload: string, data: T, version?: number): number;
|
|
5
|
+
export declare function getLocalListItemEntrySizeBytes<T>(payload: string, data: T, options?: {
|
|
6
|
+
loadedFields?: string[];
|
|
7
|
+
version?: number;
|
|
8
|
+
}): number;
|
|
9
|
+
export declare function getLocalListQueryEntrySizeBytes(payload: unknown, items: string[], options?: {
|
|
10
|
+
hasMore?: boolean;
|
|
11
|
+
lastAccessAt?: number;
|
|
12
|
+
version?: number;
|
|
13
|
+
}): number;
|
|
14
|
+
export declare const wrappedDocumentSchema: {
|
|
15
|
+
__rc_type: (t: {
|
|
16
|
+
value: {
|
|
17
|
+
name: string;
|
|
18
|
+
value: number;
|
|
19
|
+
};
|
|
20
|
+
}) => {
|
|
21
|
+
value: {
|
|
22
|
+
name: string;
|
|
23
|
+
value: number;
|
|
24
|
+
};
|
|
25
|
+
};
|
|
26
|
+
readonly withFallback: (fallback: {
|
|
27
|
+
value: {
|
|
28
|
+
name: string;
|
|
29
|
+
value: number;
|
|
30
|
+
};
|
|
31
|
+
} | ((invalidInput: unknown) => {
|
|
32
|
+
value: {
|
|
33
|
+
name: string;
|
|
34
|
+
value: number;
|
|
35
|
+
};
|
|
36
|
+
})) => import("runcheck").RcType<{
|
|
37
|
+
value: {
|
|
38
|
+
name: string;
|
|
39
|
+
value: number;
|
|
40
|
+
};
|
|
41
|
+
}>;
|
|
42
|
+
readonly where: (predicate: (input: {
|
|
43
|
+
value: {
|
|
44
|
+
name: string;
|
|
45
|
+
value: number;
|
|
46
|
+
};
|
|
47
|
+
}) => boolean | {
|
|
48
|
+
error: string;
|
|
49
|
+
}) => import("runcheck").RcType<{
|
|
50
|
+
value: {
|
|
51
|
+
name: string;
|
|
52
|
+
value: number;
|
|
53
|
+
};
|
|
54
|
+
}>;
|
|
55
|
+
readonly optional: () => import("runcheck").RcType<{
|
|
56
|
+
value: {
|
|
57
|
+
name: string;
|
|
58
|
+
value: number;
|
|
59
|
+
};
|
|
60
|
+
} | undefined>;
|
|
61
|
+
readonly optionalKey: () => import("runcheck").RcOptionalKeyType<{
|
|
62
|
+
value: {
|
|
63
|
+
name: string;
|
|
64
|
+
value: number;
|
|
65
|
+
};
|
|
66
|
+
} | undefined>;
|
|
67
|
+
readonly orNull: () => import("runcheck").RcType<{
|
|
68
|
+
value: {
|
|
69
|
+
name: string;
|
|
70
|
+
value: number;
|
|
71
|
+
};
|
|
72
|
+
} | null>;
|
|
73
|
+
readonly orNullish: () => import("runcheck").RcType<{
|
|
74
|
+
value: {
|
|
75
|
+
name: string;
|
|
76
|
+
value: number;
|
|
77
|
+
};
|
|
78
|
+
} | null | undefined>;
|
|
79
|
+
readonly withAutofix: (customAutofix: (input: unknown) => import("runcheck").AutoFixResult<{
|
|
80
|
+
value: {
|
|
81
|
+
name: string;
|
|
82
|
+
value: number;
|
|
83
|
+
};
|
|
84
|
+
}>) => import("runcheck").RcType<{
|
|
85
|
+
value: {
|
|
86
|
+
name: string;
|
|
87
|
+
value: number;
|
|
88
|
+
};
|
|
89
|
+
}>;
|
|
90
|
+
readonly default: <D extends {
|
|
91
|
+
value: {
|
|
92
|
+
name: string;
|
|
93
|
+
value: number;
|
|
94
|
+
};
|
|
95
|
+
}>(defaultValue: D | (() => D)) => import("runcheck").RcType<{
|
|
96
|
+
value: {
|
|
97
|
+
name: string;
|
|
98
|
+
value: number;
|
|
99
|
+
};
|
|
100
|
+
} | (D extends never[] ? never : D)>;
|
|
101
|
+
readonly nullishDefault: <D extends {
|
|
102
|
+
value: {
|
|
103
|
+
name: string;
|
|
104
|
+
value: number;
|
|
105
|
+
};
|
|
106
|
+
}>(defaultValue: D | (() => D)) => import("runcheck").RcType<{
|
|
107
|
+
value: {
|
|
108
|
+
name: string;
|
|
109
|
+
value: number;
|
|
110
|
+
};
|
|
111
|
+
} | (D extends never[] ? never : D)>;
|
|
112
|
+
readonly or: <O>(schema: import("runcheck").RcType<O>) => import("runcheck").RcType<O | {
|
|
113
|
+
value: {
|
|
114
|
+
name: string;
|
|
115
|
+
value: number;
|
|
116
|
+
};
|
|
117
|
+
}>;
|
|
118
|
+
readonly parse: (input: unknown, options?: {
|
|
119
|
+
noWarnings?: boolean | undefined;
|
|
120
|
+
} | undefined) => import("runcheck").RcParseResult<{
|
|
121
|
+
value: {
|
|
122
|
+
name: string;
|
|
123
|
+
value: number;
|
|
124
|
+
};
|
|
125
|
+
}>;
|
|
126
|
+
readonly parseJson: (jsonString: string, options?: {
|
|
127
|
+
noWarnings?: boolean | undefined;
|
|
128
|
+
} | undefined) => import("runcheck").RcParseResult<{
|
|
129
|
+
value: {
|
|
130
|
+
name: string;
|
|
131
|
+
value: number;
|
|
132
|
+
};
|
|
133
|
+
}>;
|
|
134
|
+
readonly _optional_key_?: false | undefined;
|
|
135
|
+
};
|
|
136
|
+
export declare const persistentStore: {
|
|
137
|
+
storage: {
|
|
138
|
+
writeRaw: (key: string, raw: string) => void;
|
|
139
|
+
writeValue: <T>(key: string, value: T) => void;
|
|
140
|
+
readEntry: <T>(key: string) => T | null;
|
|
141
|
+
remove: (key: string) => void;
|
|
142
|
+
listKeys: (prefix: string) => string[];
|
|
143
|
+
has: (key: string) => boolean;
|
|
144
|
+
getRaw: (key: string) => string | null;
|
|
145
|
+
getGlobalMaintenanceRaw: () => {
|
|
146
|
+
lastCleanupAt: number | null;
|
|
147
|
+
} | null;
|
|
148
|
+
storageKind?: "localStorage" | "memory" | undefined;
|
|
149
|
+
};
|
|
150
|
+
scope: (storeName: string, sessionKey: string) => import("../../utils/persistentStorageTestStore").PersistentTestStoreScope;
|
|
151
|
+
};
|
|
152
|
+
export declare function setupSyncStorageEfficiencyTestSuite(): void;
|
|
153
|
+
export declare function waitForScheduledCleanup(delayMs?: number): Promise<void>;
|
|
154
|
+
export declare function settleStartupBackgroundScan(): Promise<void>;
|
|
155
|
+
export declare function flushInvalidationPersistence(delayMs?: number): Promise<void>;
|
|
156
|
+
type HookRemountSettleMode = 'flushAllTimers' | 'none';
|
|
157
|
+
export declare function captureHookRemount<Result>(render: () => Result, options?: {
|
|
158
|
+
firstMountSettleMode?: HookRemountSettleMode;
|
|
159
|
+
remountSettleMode?: HookRemountSettleMode;
|
|
160
|
+
}): Promise<{
|
|
161
|
+
secondHook: import("@testing-library/react").RenderHookResult<Result, unknown>;
|
|
162
|
+
firstMountOperations: string;
|
|
163
|
+
remountOperations: string;
|
|
164
|
+
}>;
|
|
165
|
+
type DocumentState = {
|
|
166
|
+
name: string;
|
|
167
|
+
value: number;
|
|
168
|
+
};
|
|
169
|
+
export declare function setCachedDocumentData(storeName: string, sessionKey: string, data: DocumentState): string;
|
|
170
|
+
export declare function createDocumentEnv(options: {
|
|
171
|
+
storeName: string;
|
|
172
|
+
sessionKey?: string;
|
|
173
|
+
serverData?: DocumentState;
|
|
174
|
+
}): {
|
|
175
|
+
apiStore: import("../../../src/documentStore").DocumentStore<{
|
|
176
|
+
value: {
|
|
177
|
+
name: string;
|
|
178
|
+
value: number;
|
|
179
|
+
};
|
|
180
|
+
}, null>;
|
|
181
|
+
store: import("t-state").Store<import("../../../src/documentStore").DocumentStoreState<{
|
|
182
|
+
value: {
|
|
183
|
+
name: string;
|
|
184
|
+
value: number;
|
|
185
|
+
};
|
|
186
|
+
}>>;
|
|
187
|
+
readonly uiChanges: (string | number | undefined)[];
|
|
188
|
+
readonly actions: {
|
|
189
|
+
action: string;
|
|
190
|
+
time: number;
|
|
191
|
+
uiValue: unknown;
|
|
192
|
+
actionValue?: unknown;
|
|
193
|
+
id?: string | number | undefined;
|
|
194
|
+
itemId?: string | undefined;
|
|
195
|
+
itemUiValues?: Record<string, unknown> | undefined;
|
|
196
|
+
}[];
|
|
197
|
+
trackUIChanges: (value: string | number | undefined, itemId?: string | undefined) => void;
|
|
198
|
+
addTimelineComments: (reference: "afterLastAction" | "beforeNextAction" | {
|
|
199
|
+
action: string;
|
|
200
|
+
id?: string | number | undefined;
|
|
201
|
+
}, comments: (string | {
|
|
202
|
+
comment: string;
|
|
203
|
+
deltaMs?: number | undefined;
|
|
204
|
+
})[]) => void;
|
|
205
|
+
scheduleFetch: (fetchType: import("../../../src/requestScheduler").FetchType, options?: {
|
|
206
|
+
mediumPriorityDelayMs?: number | undefined;
|
|
207
|
+
} | undefined) => import("../../../src/requestScheduler").ScheduleFetchResults;
|
|
208
|
+
performClientUpdateAction: (newValue: {
|
|
209
|
+
name: string;
|
|
210
|
+
value: number;
|
|
211
|
+
}, { withRevalidation, withOptimisticUpdate, duration, triggerRTU, addServerDataChangeAction, error, updateStateWithMutationResult, }?: {
|
|
212
|
+
withRevalidation?: boolean | undefined;
|
|
213
|
+
withOptimisticUpdate?: boolean | undefined;
|
|
214
|
+
duration?: number | undefined;
|
|
215
|
+
triggerRTU?: boolean | undefined;
|
|
216
|
+
addServerDataChangeAction?: boolean | undefined;
|
|
217
|
+
error?: string | undefined;
|
|
218
|
+
updateStateWithMutationResult?: boolean | undefined;
|
|
219
|
+
}) => Promise<import("t-result").Result<unknown, import("../../../src/main").MutationSkipped | import("../../../src/main").StoreMutationError>>;
|
|
220
|
+
readonly timelineString: string;
|
|
221
|
+
clearTimeline(): void;
|
|
222
|
+
serverMock: {
|
|
223
|
+
mutateData: (newData: {
|
|
224
|
+
name: string;
|
|
225
|
+
value: number;
|
|
226
|
+
}, { duration, setDataAt, triggerRTUEvent, addServerDataChangeAction, mutationId, addMutationResolvedAction, }?: {
|
|
227
|
+
duration?: number | undefined;
|
|
228
|
+
setDataAt?: number | undefined;
|
|
229
|
+
triggerRTUEvent?: boolean | undefined;
|
|
230
|
+
addServerDataChangeAction?: boolean | undefined;
|
|
231
|
+
addMutationResolvedAction?: boolean | undefined;
|
|
232
|
+
mutationId?: string | number | undefined;
|
|
233
|
+
}) => Promise<void>;
|
|
234
|
+
wsEvents: import("evtmitter").Emitter<{
|
|
235
|
+
data_changed: undefined;
|
|
236
|
+
}>;
|
|
237
|
+
delayedSetData(value: {
|
|
238
|
+
name: string;
|
|
239
|
+
value: number;
|
|
240
|
+
}, options?: {
|
|
241
|
+
durationMs?: number | undefined;
|
|
242
|
+
}): Promise<void>;
|
|
243
|
+
setData(value: {
|
|
244
|
+
name: string;
|
|
245
|
+
value: number;
|
|
246
|
+
}): void;
|
|
247
|
+
readonly current: {
|
|
248
|
+
name: string;
|
|
249
|
+
value: number;
|
|
250
|
+
};
|
|
251
|
+
history: {
|
|
252
|
+
name: string;
|
|
253
|
+
value: number;
|
|
254
|
+
}[];
|
|
255
|
+
fetch: (signal?: AbortSignal | undefined, duration?: number) => Promise<{
|
|
256
|
+
name: string;
|
|
257
|
+
value: number;
|
|
258
|
+
}>;
|
|
259
|
+
setFetchDurations(...durations: number[]): void;
|
|
260
|
+
setNextFetchError(error: string | import("../../mocks/serverMock").FetchErrorConfig): void;
|
|
261
|
+
readonly numOfStartedFetches: number;
|
|
262
|
+
readonly numOfFinishedFetches: number;
|
|
263
|
+
fetchHistory: {
|
|
264
|
+
id: string;
|
|
265
|
+
startTime: number;
|
|
266
|
+
endTime: number;
|
|
267
|
+
duration: number;
|
|
268
|
+
result: "aborted" | "error" | "success";
|
|
269
|
+
data?: {
|
|
270
|
+
name: string;
|
|
271
|
+
value: number;
|
|
272
|
+
} | undefined;
|
|
273
|
+
error?: Error | undefined;
|
|
274
|
+
}[];
|
|
275
|
+
clearFetchHistory(): void;
|
|
276
|
+
};
|
|
277
|
+
errorInNextFetch(error?: string | import("../../mocks/serverMock").FetchErrorConfig): void;
|
|
278
|
+
setNextFetchDurations(...durations: number[]): void;
|
|
279
|
+
emulateExternalRTU(value: {
|
|
280
|
+
name: string;
|
|
281
|
+
value: number;
|
|
282
|
+
}): void;
|
|
283
|
+
setServerData(value: {
|
|
284
|
+
name: string;
|
|
285
|
+
value: number;
|
|
286
|
+
}): void;
|
|
287
|
+
};
|
|
288
|
+
type CollectionItemState = {
|
|
289
|
+
id: string;
|
|
290
|
+
name: string;
|
|
291
|
+
};
|
|
292
|
+
type PersistedCollectionItemState = {
|
|
293
|
+
value: CollectionItemState;
|
|
294
|
+
};
|
|
295
|
+
export declare function setCachedCollectionItem(storeName: string, sessionKey: string, payload: string, data: PersistedCollectionItemState): string;
|
|
296
|
+
export declare function listStoredCollectionItemPayloads(storeName: string, sessionKey: string): string[];
|
|
297
|
+
export declare function createCollectionEnv(options: {
|
|
298
|
+
storeName: string;
|
|
299
|
+
sessionKey?: string;
|
|
300
|
+
maxBytes?: number;
|
|
301
|
+
serverData?: Record<string, CollectionItemState>;
|
|
302
|
+
}): {
|
|
303
|
+
apiStore: import("../../../src/main").CollectionStore<import("../../mocks/collectionStoreTestEnv").CollectionTestItem<{
|
|
304
|
+
id: string;
|
|
305
|
+
name: string;
|
|
306
|
+
}>, string, null>;
|
|
307
|
+
store: import("t-state").Store<import("../../../src/main").TSFDCollectionState<import("../../mocks/collectionStoreTestEnv").CollectionTestItem<{
|
|
308
|
+
id: string;
|
|
309
|
+
name: string;
|
|
310
|
+
}>, string>>;
|
|
311
|
+
serverTable: {
|
|
312
|
+
fetch: (itemId: string, signal?: AbortSignal | undefined, options?: {
|
|
313
|
+
fields?: string[] | undefined;
|
|
314
|
+
} | undefined) => Promise<{
|
|
315
|
+
id: string;
|
|
316
|
+
name: string;
|
|
317
|
+
}>;
|
|
318
|
+
list: (options?: {
|
|
319
|
+
offset?: number | undefined;
|
|
320
|
+
limit?: number | undefined;
|
|
321
|
+
itemIds?: string[] | undefined;
|
|
322
|
+
filters?: import("../../mocks/serverTableMock").FilterOperator[] | undefined;
|
|
323
|
+
tableId?: string | undefined;
|
|
324
|
+
fields?: string[] | undefined;
|
|
325
|
+
batchKey?: string | undefined;
|
|
326
|
+
} | undefined, signal?: AbortSignal | undefined) => Promise<{
|
|
327
|
+
items: {
|
|
328
|
+
itemId: string;
|
|
329
|
+
data: {
|
|
330
|
+
id: string;
|
|
331
|
+
name: string;
|
|
332
|
+
};
|
|
333
|
+
}[];
|
|
334
|
+
hasMore: boolean;
|
|
335
|
+
}>;
|
|
336
|
+
listSync: (options?: {
|
|
337
|
+
offset?: number | undefined;
|
|
338
|
+
limit?: number | undefined;
|
|
339
|
+
itemIds?: string[] | undefined;
|
|
340
|
+
filters?: import("../../mocks/serverTableMock").FilterOperator[] | undefined;
|
|
341
|
+
tableId?: string | undefined;
|
|
342
|
+
fields?: string[] | undefined;
|
|
343
|
+
batchKey?: string | undefined;
|
|
344
|
+
} | undefined) => {
|
|
345
|
+
items: {
|
|
346
|
+
itemId: string;
|
|
347
|
+
data: {
|
|
348
|
+
id: string;
|
|
349
|
+
name: string;
|
|
350
|
+
};
|
|
351
|
+
}[];
|
|
352
|
+
hasMore: boolean;
|
|
353
|
+
};
|
|
354
|
+
get: (itemId: string) => {
|
|
355
|
+
id: string;
|
|
356
|
+
name: string;
|
|
357
|
+
} | undefined;
|
|
358
|
+
getAll: () => Record<string, {
|
|
359
|
+
id: string;
|
|
360
|
+
name: string;
|
|
361
|
+
}>;
|
|
362
|
+
getByPrefix: (prefix: string) => {
|
|
363
|
+
itemId: string;
|
|
364
|
+
data: {
|
|
365
|
+
id: string;
|
|
366
|
+
name: string;
|
|
367
|
+
};
|
|
368
|
+
}[];
|
|
369
|
+
entries: () => [string, {
|
|
370
|
+
id: string;
|
|
371
|
+
name: string;
|
|
372
|
+
}][];
|
|
373
|
+
delayedSetItem(itemId: string, data: {
|
|
374
|
+
id: string;
|
|
375
|
+
name: string;
|
|
376
|
+
}, options?: {
|
|
377
|
+
durationMs?: number | undefined;
|
|
378
|
+
}): Promise<void>;
|
|
379
|
+
delayedUpdateItem(itemId: string, data: Partial<{
|
|
380
|
+
id: string;
|
|
381
|
+
name: string;
|
|
382
|
+
}>, options?: {
|
|
383
|
+
durationMs?: number | undefined;
|
|
384
|
+
}): Promise<void>;
|
|
385
|
+
delayedRemoveItem(itemId: string, options?: {
|
|
386
|
+
durationMs?: number | undefined;
|
|
387
|
+
}): Promise<void>;
|
|
388
|
+
setItem: (itemId: string, data: {
|
|
389
|
+
id: string;
|
|
390
|
+
name: string;
|
|
391
|
+
}, options?: {
|
|
392
|
+
triggerRTUEvent?: "for_all_items" | boolean | undefined;
|
|
393
|
+
prepend?: boolean | undefined;
|
|
394
|
+
} | undefined) => void;
|
|
395
|
+
removeItem: (itemId: string) => void;
|
|
396
|
+
updateItem: (itemId: string, data: Partial<{
|
|
397
|
+
id: string;
|
|
398
|
+
name: string;
|
|
399
|
+
}>) => void;
|
|
400
|
+
emulateClientMutation: (itemId: string, newData: {
|
|
401
|
+
id: string;
|
|
402
|
+
name: string;
|
|
403
|
+
}, options?: {
|
|
404
|
+
duration?: number | undefined;
|
|
405
|
+
setDataAt?: number | undefined;
|
|
406
|
+
triggerRTUEvent?: boolean | undefined;
|
|
407
|
+
addServerDataChangeAction?: boolean | undefined;
|
|
408
|
+
mutationId?: string | number | undefined;
|
|
409
|
+
}) => Promise<{
|
|
410
|
+
id: string;
|
|
411
|
+
name: string;
|
|
412
|
+
}>;
|
|
413
|
+
addItem: (itemId: string, data: {
|
|
414
|
+
id: string;
|
|
415
|
+
name: string;
|
|
416
|
+
}, options?: {
|
|
417
|
+
duration?: number | undefined;
|
|
418
|
+
setDataAt?: number | undefined;
|
|
419
|
+
triggerRTUEvent?: boolean | undefined;
|
|
420
|
+
addServerDataChangeAction?: boolean | undefined;
|
|
421
|
+
mutationId?: string | number | undefined;
|
|
422
|
+
}) => Promise<void>;
|
|
423
|
+
addItemWithAutoGeneratedKey: (tableId: string, createData: (id: number, itemId: string) => {
|
|
424
|
+
id: string;
|
|
425
|
+
name: string;
|
|
426
|
+
}, options?: {
|
|
427
|
+
duration?: number | undefined;
|
|
428
|
+
setDataAt?: number | undefined;
|
|
429
|
+
triggerRTUEvent?: boolean | undefined;
|
|
430
|
+
addServerDataChangeAction?: boolean | undefined;
|
|
431
|
+
mutationId?: string | number | undefined;
|
|
432
|
+
}) => Promise<{
|
|
433
|
+
id: number;
|
|
434
|
+
itemId: string;
|
|
435
|
+
data: {
|
|
436
|
+
id: string;
|
|
437
|
+
name: string;
|
|
438
|
+
};
|
|
439
|
+
}>;
|
|
440
|
+
deleteItem: (itemId: string, options?: {
|
|
441
|
+
duration?: number | undefined;
|
|
442
|
+
setDataAt?: number | undefined;
|
|
443
|
+
triggerRTUEvent?: boolean | undefined;
|
|
444
|
+
addServerDataChangeAction?: boolean | undefined;
|
|
445
|
+
mutationId?: string | number | undefined;
|
|
446
|
+
}) => Promise<void>;
|
|
447
|
+
wsEvents: import("evtmitter").Emitter<{
|
|
448
|
+
data_changed: {
|
|
449
|
+
itemId: string;
|
|
450
|
+
data: {
|
|
451
|
+
id: string;
|
|
452
|
+
name: string;
|
|
453
|
+
};
|
|
454
|
+
};
|
|
455
|
+
item_deleted: {
|
|
456
|
+
itemId: string;
|
|
457
|
+
};
|
|
458
|
+
item_added: {
|
|
459
|
+
itemId: string;
|
|
460
|
+
data: {
|
|
461
|
+
id: string;
|
|
462
|
+
name: string;
|
|
463
|
+
};
|
|
464
|
+
};
|
|
465
|
+
list_changed: undefined;
|
|
466
|
+
}>;
|
|
467
|
+
getItemHistory: (itemId: string) => {
|
|
468
|
+
id: string;
|
|
469
|
+
name: string;
|
|
470
|
+
}[];
|
|
471
|
+
setFetchDurations(itemId: string, ...durations: number[]): void;
|
|
472
|
+
setNextFetchError(itemId: string, error: string | {
|
|
473
|
+
message: string;
|
|
474
|
+
path?: string | undefined;
|
|
475
|
+
method?: "DELETE" | "GET" | "PATCH" | "POST" | "PUT" | undefined;
|
|
476
|
+
code?: number | undefined;
|
|
477
|
+
}): void;
|
|
478
|
+
addListFetchStartDelay(delayMs: number): void;
|
|
479
|
+
setNextListFetchError(error: string | {
|
|
480
|
+
message: string;
|
|
481
|
+
path?: string | undefined;
|
|
482
|
+
method?: "DELETE" | "GET" | "PATCH" | "POST" | "PUT" | undefined;
|
|
483
|
+
code?: number | undefined;
|
|
484
|
+
}): void;
|
|
485
|
+
getNextFetchError(itemId: string): {
|
|
486
|
+
message: string;
|
|
487
|
+
path?: string | undefined;
|
|
488
|
+
method?: "DELETE" | "GET" | "PATCH" | "POST" | "PUT" | undefined;
|
|
489
|
+
code?: number | undefined;
|
|
490
|
+
} | undefined;
|
|
491
|
+
readonly numOfStartedFetches: number;
|
|
492
|
+
readonly numOfFinishedFetches: number;
|
|
493
|
+
fetchHistory: ({
|
|
494
|
+
type: "fetch";
|
|
495
|
+
itemId: string;
|
|
496
|
+
fields: string[] | undefined;
|
|
497
|
+
result: "aborted" | "error" | {
|
|
498
|
+
id: string;
|
|
499
|
+
name: string;
|
|
500
|
+
};
|
|
501
|
+
startedAt: number;
|
|
502
|
+
duration: number;
|
|
503
|
+
} | {
|
|
504
|
+
type: "list";
|
|
505
|
+
itemIds: string[] | undefined;
|
|
506
|
+
offset: number;
|
|
507
|
+
limit: number | undefined;
|
|
508
|
+
fields: string[] | undefined;
|
|
509
|
+
filters: import("../../mocks/serverTableMock").FilterOperator[] | undefined;
|
|
510
|
+
batchKey: string | undefined;
|
|
511
|
+
startedAt: number;
|
|
512
|
+
duration: number;
|
|
513
|
+
results: "aborted" | {
|
|
514
|
+
itemId: string;
|
|
515
|
+
data: "error" | {
|
|
516
|
+
id: string;
|
|
517
|
+
name: string;
|
|
518
|
+
};
|
|
519
|
+
}[];
|
|
520
|
+
})[];
|
|
521
|
+
clearFetchHistory(): void;
|
|
522
|
+
getRequestHistory(fetchType?: "all" | "item" | "list", options?: {
|
|
523
|
+
includeTime?: boolean | undefined;
|
|
524
|
+
} | undefined): {
|
|
525
|
+
_type: "item" | "list" | undefined;
|
|
526
|
+
payload: unknown;
|
|
527
|
+
time?: string | undefined;
|
|
528
|
+
returned_items?: number | undefined;
|
|
529
|
+
}[];
|
|
530
|
+
};
|
|
531
|
+
readonly uiChanges: Record<string, unknown>[];
|
|
532
|
+
readonly actions: {
|
|
533
|
+
action: string;
|
|
534
|
+
time: number;
|
|
535
|
+
uiValue: unknown;
|
|
536
|
+
actionValue?: unknown;
|
|
537
|
+
id?: string | number | undefined;
|
|
538
|
+
itemId?: string | undefined;
|
|
539
|
+
itemUiValues?: Record<string, unknown> | undefined;
|
|
540
|
+
}[];
|
|
541
|
+
trackUIChanges: (value: Record<string, number | "error" | undefined>, itemId?: string | undefined) => void;
|
|
542
|
+
trackItemUI: (itemId: string, value: unknown) => unknown;
|
|
543
|
+
addTimelineComments: (reference: "afterLastAction" | "beforeNextAction" | {
|
|
544
|
+
action: string;
|
|
545
|
+
id?: string | number | undefined;
|
|
546
|
+
}, comments: (string | {
|
|
547
|
+
comment: string;
|
|
548
|
+
deltaMs?: number | undefined;
|
|
549
|
+
})[]) => void;
|
|
550
|
+
scheduleFetch: (fetchType: import("../../../src/requestScheduler").FetchType, itemId: string, options?: {
|
|
551
|
+
mediumPriorityDelayMs?: number | undefined;
|
|
552
|
+
} | undefined) => import("../../../src/requestScheduler").ScheduleFetchResults;
|
|
553
|
+
performClientUpdateAction: (itemId: string, newValue: {
|
|
554
|
+
id: string;
|
|
555
|
+
name: string;
|
|
556
|
+
}, { withRevalidation, withOptimisticUpdate, duration, triggerRTU, addServerDataChangeAction, error, }?: {
|
|
557
|
+
withRevalidation?: boolean | undefined;
|
|
558
|
+
withOptimisticUpdate?: boolean | undefined;
|
|
559
|
+
duration?: number | undefined;
|
|
560
|
+
triggerRTU?: boolean | undefined;
|
|
561
|
+
addServerDataChangeAction?: boolean | undefined;
|
|
562
|
+
error?: string | undefined;
|
|
563
|
+
}) => Promise<import("t-result").Result<unknown, import("../../../src/main").MutationSkipped | import("../../../src/main").StoreMutationError>>;
|
|
564
|
+
readonly timelineString: string;
|
|
565
|
+
clearTimeline(): void;
|
|
566
|
+
};
|
|
567
|
+
export declare function rawItemPayload(tableId: string, id: number): string;
|
|
568
|
+
export declare function storeItemKey(tableId: string, id: number): string;
|
|
569
|
+
export declare function setCachedItem(storeName: string, sessionKey: string, tableId: string, id: number, data: Row): string;
|
|
570
|
+
export declare function setCachedQuery(storeName: string, sessionKey: string, params: ListQueryParams, items: string[], hasMore?: boolean): string;
|
|
571
|
+
export declare function listStoredKeys(prefix: string): string[];
|
|
572
|
+
export declare function createListQueryEnv(options: {
|
|
573
|
+
storeName: string;
|
|
574
|
+
sessionKey?: string;
|
|
575
|
+
getSessionKey?: () => string | false;
|
|
576
|
+
maxItemBytes?: number;
|
|
577
|
+
maxQueryBytes?: number;
|
|
578
|
+
maxQuerySize?: number;
|
|
579
|
+
serverData?: Tables<Row>;
|
|
580
|
+
offsetPagination?: OffsetPaginationConfig;
|
|
581
|
+
defaultQuerySize?: number;
|
|
582
|
+
}): {
|
|
583
|
+
apiStore: import("../../../src/main").ListQueryStore<Row, ListQueryParams, string, false, null>;
|
|
584
|
+
store: import("t-state").Store<import("../../../src/main").TSFDListQueryState<Row, ListQueryParams, string>>;
|
|
585
|
+
serverTable: Omit<{
|
|
586
|
+
fetch: (itemId: string, signal?: AbortSignal | undefined, options?: {
|
|
587
|
+
fields?: string[] | undefined;
|
|
588
|
+
} | undefined) => Promise<Row>;
|
|
589
|
+
list: (options?: {
|
|
590
|
+
offset?: number | undefined;
|
|
591
|
+
limit?: number | undefined;
|
|
592
|
+
itemIds?: string[] | undefined;
|
|
593
|
+
filters?: import("../../mocks/serverTableMock").FilterOperator[] | undefined;
|
|
594
|
+
tableId?: string | undefined;
|
|
595
|
+
fields?: string[] | undefined;
|
|
596
|
+
batchKey?: string | undefined;
|
|
597
|
+
} | undefined, signal?: AbortSignal | undefined) => Promise<{
|
|
598
|
+
items: {
|
|
599
|
+
itemId: string;
|
|
600
|
+
data: Row;
|
|
601
|
+
}[];
|
|
602
|
+
hasMore: boolean;
|
|
603
|
+
}>;
|
|
604
|
+
listSync: (options?: {
|
|
605
|
+
offset?: number | undefined;
|
|
606
|
+
limit?: number | undefined;
|
|
607
|
+
itemIds?: string[] | undefined;
|
|
608
|
+
filters?: import("../../mocks/serverTableMock").FilterOperator[] | undefined;
|
|
609
|
+
tableId?: string | undefined;
|
|
610
|
+
fields?: string[] | undefined;
|
|
611
|
+
batchKey?: string | undefined;
|
|
612
|
+
} | undefined) => {
|
|
613
|
+
items: {
|
|
614
|
+
itemId: string;
|
|
615
|
+
data: Row;
|
|
616
|
+
}[];
|
|
617
|
+
hasMore: boolean;
|
|
618
|
+
};
|
|
619
|
+
get: (itemId: string) => Row | undefined;
|
|
620
|
+
getAll: () => Record<string, Row>;
|
|
621
|
+
getByPrefix: (prefix: string) => {
|
|
622
|
+
itemId: string;
|
|
623
|
+
data: Row;
|
|
624
|
+
}[];
|
|
625
|
+
entries: () => [string, Row][];
|
|
626
|
+
delayedSetItem(itemId: string, data: Row, options?: {
|
|
627
|
+
durationMs?: number | undefined;
|
|
628
|
+
}): Promise<void>;
|
|
629
|
+
delayedUpdateItem(itemId: string, data: Partial<Row>, options?: {
|
|
630
|
+
durationMs?: number | undefined;
|
|
631
|
+
}): Promise<void>;
|
|
632
|
+
delayedRemoveItem(itemId: string, options?: {
|
|
633
|
+
durationMs?: number | undefined;
|
|
634
|
+
}): Promise<void>;
|
|
635
|
+
setItem: (itemId: string, data: Row, options?: {
|
|
636
|
+
triggerRTUEvent?: "for_all_items" | boolean | undefined;
|
|
637
|
+
prepend?: boolean | undefined;
|
|
638
|
+
} | undefined) => void;
|
|
639
|
+
removeItem: (itemId: string) => void;
|
|
640
|
+
updateItem: (itemId: string, data: Partial<Row>) => void;
|
|
641
|
+
emulateClientMutation: (itemId: string, newData: Row, options?: {
|
|
642
|
+
duration?: number | undefined;
|
|
643
|
+
setDataAt?: number | undefined;
|
|
644
|
+
triggerRTUEvent?: boolean | undefined;
|
|
645
|
+
addServerDataChangeAction?: boolean | undefined;
|
|
646
|
+
mutationId?: string | number | undefined;
|
|
647
|
+
}) => Promise<Row>;
|
|
648
|
+
addItem: (itemId: string, data: Row, options?: {
|
|
649
|
+
duration?: number | undefined;
|
|
650
|
+
setDataAt?: number | undefined;
|
|
651
|
+
triggerRTUEvent?: boolean | undefined;
|
|
652
|
+
addServerDataChangeAction?: boolean | undefined;
|
|
653
|
+
mutationId?: string | number | undefined;
|
|
654
|
+
}) => Promise<void>;
|
|
655
|
+
addItemWithAutoGeneratedKey: (tableId: string, createData: (id: number, itemId: string) => Row, options?: {
|
|
656
|
+
duration?: number | undefined;
|
|
657
|
+
setDataAt?: number | undefined;
|
|
658
|
+
triggerRTUEvent?: boolean | undefined;
|
|
659
|
+
addServerDataChangeAction?: boolean | undefined;
|
|
660
|
+
mutationId?: string | number | undefined;
|
|
661
|
+
}) => Promise<{
|
|
662
|
+
id: number;
|
|
663
|
+
itemId: string;
|
|
664
|
+
data: Row;
|
|
665
|
+
}>;
|
|
666
|
+
deleteItem: (itemId: string, options?: {
|
|
667
|
+
duration?: number | undefined;
|
|
668
|
+
setDataAt?: number | undefined;
|
|
669
|
+
triggerRTUEvent?: boolean | undefined;
|
|
670
|
+
addServerDataChangeAction?: boolean | undefined;
|
|
671
|
+
mutationId?: string | number | undefined;
|
|
672
|
+
}) => Promise<void>;
|
|
673
|
+
wsEvents: import("evtmitter").Emitter<{
|
|
674
|
+
data_changed: {
|
|
675
|
+
itemId: string;
|
|
676
|
+
data: Row;
|
|
677
|
+
};
|
|
678
|
+
item_deleted: {
|
|
679
|
+
itemId: string;
|
|
680
|
+
};
|
|
681
|
+
item_added: {
|
|
682
|
+
itemId: string;
|
|
683
|
+
data: Row;
|
|
684
|
+
};
|
|
685
|
+
list_changed: undefined;
|
|
686
|
+
}>;
|
|
687
|
+
getItemHistory: (itemId: string) => Row[];
|
|
688
|
+
setFetchDurations(itemId: string, ...durations: number[]): void;
|
|
689
|
+
setNextFetchError(itemId: string, error: string | {
|
|
690
|
+
message: string;
|
|
691
|
+
path?: string | undefined;
|
|
692
|
+
method?: "DELETE" | "GET" | "PATCH" | "POST" | "PUT" | undefined;
|
|
693
|
+
code?: number | undefined;
|
|
694
|
+
}): void;
|
|
695
|
+
addListFetchStartDelay(delayMs: number): void;
|
|
696
|
+
setNextListFetchError(error: string | {
|
|
697
|
+
message: string;
|
|
698
|
+
path?: string | undefined;
|
|
699
|
+
method?: "DELETE" | "GET" | "PATCH" | "POST" | "PUT" | undefined;
|
|
700
|
+
code?: number | undefined;
|
|
701
|
+
}): void;
|
|
702
|
+
getNextFetchError(itemId: string): {
|
|
703
|
+
message: string;
|
|
704
|
+
path?: string | undefined;
|
|
705
|
+
method?: "DELETE" | "GET" | "PATCH" | "POST" | "PUT" | undefined;
|
|
706
|
+
code?: number | undefined;
|
|
707
|
+
} | undefined;
|
|
708
|
+
readonly numOfStartedFetches: number;
|
|
709
|
+
readonly numOfFinishedFetches: number;
|
|
710
|
+
fetchHistory: ({
|
|
711
|
+
type: "fetch";
|
|
712
|
+
itemId: string;
|
|
713
|
+
fields: string[] | undefined;
|
|
714
|
+
result: "aborted" | "error" | Row;
|
|
715
|
+
startedAt: number;
|
|
716
|
+
duration: number;
|
|
717
|
+
} | {
|
|
718
|
+
type: "list";
|
|
719
|
+
itemIds: string[] | undefined;
|
|
720
|
+
offset: number;
|
|
721
|
+
limit: number | undefined;
|
|
722
|
+
fields: string[] | undefined;
|
|
723
|
+
filters: import("../../mocks/serverTableMock").FilterOperator[] | undefined;
|
|
724
|
+
batchKey: string | undefined;
|
|
725
|
+
startedAt: number;
|
|
726
|
+
duration: number;
|
|
727
|
+
results: "aborted" | {
|
|
728
|
+
itemId: string;
|
|
729
|
+
data: "error" | Row;
|
|
730
|
+
}[];
|
|
731
|
+
})[];
|
|
732
|
+
clearFetchHistory(): void;
|
|
733
|
+
getRequestHistory(fetchType?: "all" | "item" | "list", options?: {
|
|
734
|
+
includeTime?: boolean | undefined;
|
|
735
|
+
} | undefined): {
|
|
736
|
+
_type: "item" | "list" | undefined;
|
|
737
|
+
payload: unknown;
|
|
738
|
+
time?: string | undefined;
|
|
739
|
+
returned_items?: number | undefined;
|
|
740
|
+
}[];
|
|
741
|
+
}, "wsEvents">;
|
|
742
|
+
readonly uiChanges: Record<string, unknown>[];
|
|
743
|
+
readonly actions: {
|
|
744
|
+
action: string;
|
|
745
|
+
time: number;
|
|
746
|
+
uiValue: unknown;
|
|
747
|
+
actionValue?: unknown;
|
|
748
|
+
id?: string | number | undefined;
|
|
749
|
+
itemId?: string | undefined;
|
|
750
|
+
itemUiValues?: Record<string, unknown> | undefined;
|
|
751
|
+
}[];
|
|
752
|
+
trackItemUI: (itemId: string, value: unknown) => unknown;
|
|
753
|
+
addTimelineComments: (reference: "afterLastAction" | "beforeNextAction" | {
|
|
754
|
+
action: string;
|
|
755
|
+
id?: string | number | undefined;
|
|
756
|
+
}, comments: (string | {
|
|
757
|
+
comment: string;
|
|
758
|
+
deltaMs?: number | undefined;
|
|
759
|
+
})[]) => void;
|
|
760
|
+
getItemKey: (tableId: string, rowId: number) => string;
|
|
761
|
+
getStoreItemKey: (tableId: string, rowId: number) => string;
|
|
762
|
+
getStoreItemKeyFromRaw: (rawKey: string) => string;
|
|
763
|
+
getQueryKey: (params: ListQueryParams) => string;
|
|
764
|
+
getItemQueryState: (rawItemKey: string) => import("../../../src/main").TSDFItemQuery<string> | null | undefined;
|
|
765
|
+
scheduleFetch: (fetchType: import("../../../src/requestScheduler").FetchType, params: ListQueryParams, size?: number | undefined, options?: {
|
|
766
|
+
mediumPriorityDelayMs?: number | undefined;
|
|
767
|
+
} | undefined) => "scheduled" | "skipped" | "started" | "triggered";
|
|
768
|
+
scheduleItemFetch: (fetchType: import("../../../src/requestScheduler").FetchType, itemPayload: string, options?: {
|
|
769
|
+
mediumPriorityDelayMs?: number | undefined;
|
|
770
|
+
} | undefined) => "scheduled" | "skipped" | "started" | "triggered";
|
|
771
|
+
forceListUpdate: (params: ListQueryParams) => "started" | "triggered";
|
|
772
|
+
performClientItemUpdateAction: (itemId: string, newValue: Partial<Row>, { withRevalidation, withOptimisticUpdate, duration, triggerRTU, addServerDataChangeAction, error, }?: {
|
|
773
|
+
withRevalidation?: boolean | undefined;
|
|
774
|
+
withOptimisticUpdate?: boolean | undefined;
|
|
775
|
+
duration?: number | undefined;
|
|
776
|
+
triggerRTU?: boolean | undefined;
|
|
777
|
+
addServerDataChangeAction?: boolean | undefined;
|
|
778
|
+
error?: string | undefined;
|
|
779
|
+
}) => Promise<import("t-result").Result<unknown, import("../../../src/main").MutationSkipped | import("../../../src/main").StoreMutationError>>;
|
|
780
|
+
readonly timelineString: string;
|
|
781
|
+
clearTimeline(): void;
|
|
782
|
+
getRelativeTime: () => number;
|
|
783
|
+
};
|
|
784
|
+
export {};
|