react-native-onyx 3.0.115 → 3.0.117

package/dist/OnyxUtils.d.ts

@@ -1,6 +1,6 @@
 import type { ValueOf } from 'type-fest';
 import type Onyx from './Onyx';
-import type { CollectionKeyBase, ConnectOptions, DeepRecord, KeyValueMapping, CallbackToStateMapping, MultiMergeReplaceNullPatches, OnyxCollection, OnyxEntry, OnyxInput, OnyxKey, OnyxMergeCollectionInput, OnyxUpdate, OnyxValue, Selector, MergeCollectionWithPatchesParams, SetCollectionParams, SetParams, OnyxMultiSetInput, RetriableOnyxOperation } from './types';
+import type { CollectionKeyBase, DeepRecord, KeyValueMapping, MultiMergeReplaceNullPatches, OnyxCollection, OnyxEntry, OnyxInput, OnyxKey, OnyxMergeCollectionInput, OnyxUpdate, OnyxValue, Selector, MergeCollectionWithPatchesParams, SetCollectionParams, SetParams, OnyxMultiSetInput, RetriableOnyxOperation } from './types';
 import type { FastMergeResult } from './utils';
 import type { DeferredTask } from './createDeferredTask';
 import type { StorageKeyValuePair } from './storage/providers/types';
@@ -98,45 +98,22 @@ declare function multiGet<TKey extends OnyxKey>(keys: CollectionKeyBase[]): Prom
 declare function tupleGet<Keys extends readonly OnyxKey[]>(keys: Keys): Promise<{
     [Index in keyof Keys]: OnyxValue<Keys[Index]>;
 }>;
-/**
- * Stores a subscription ID associated with a given key.
- *
- * @param subscriptionID - A subscription ID of the subscriber.
- * @param key - A key that the subscriber is subscribed to.
- */
-declare function storeKeyBySubscriptions(key: OnyxKey, subscriptionID: number): void;
-/**
- * Deletes a subscription ID associated with its corresponding key.
- *
- * @param subscriptionID - The subscription ID to be deleted.
- */
-declare function deleteKeyBySubscriptions(subscriptionID: number): void;
 /** Returns current key names stored in persisted storage */
 declare function getAllKeys(): Promise<Set<OnyxKey>>;
-/**
- * Tries to get a value from the cache. If the value is not present in cache it will return the default value or undefined.
- * If the requested key is a collection, it will return an object with all the collection members.
- */
-declare function tryGetCachedValue<TKey extends OnyxKey>(key: TKey): OnyxValue<OnyxKey>;
 declare function getCachedCollection<TKey extends CollectionKeyBase>(collectionKey: TKey, collectionMemberKeys?: string[]): NonNullable<OnyxCollection<KeyValueMapping[TKey]>>;
 /**
- * When a collection of keys change, search for any callbacks matching the collection key and trigger those callbacks
- */
-declare function keysChanged<TKey extends CollectionKeyBase>(collectionKey: TKey, partialCollection: OnyxCollection<KeyValueMapping[TKey]>, partialPreviousCollection: OnyxCollection<KeyValueMapping[TKey]> | undefined): void;
-/**
- * When a key change happens, search for any callbacks matching the key or collection key and trigger those callbacks
+ * Notify subscribers of a single-key write. Wrapper over `onyxSubscriptionManager.notifyKey()`
+ * that also performs LRU bookkeeping for eviction.
  */
-declare function keyChanged<TKey extends OnyxKey>(key: TKey, value: OnyxValue<TKey>, canUpdateSubscriber?: (subscriber?: CallbackToStateMapping<OnyxKey>) => boolean): void;
+declare function notifyKey<TKey extends OnyxKey>(key: TKey, value: OnyxValue<TKey>): void;
 /**
- * Sends the data obtained from the keys to the connection.
+ * Notify subscribers of a batch collection update. Wrapper over
+ * `onyxSubscriptionManager.notifyCollection()` that also performs LRU bookkeeping per
+ * changed member.
  */
-declare function sendDataToConnection<TKey extends OnyxKey>(mapping: CallbackToStateMapping<TKey>, matchedKey: TKey | undefined): void;
+declare function notifyCollection<TKey extends CollectionKeyBase>(collectionKey: TKey, partialCollection: OnyxCollection<KeyValueMapping[TKey]>, partialPreviousCollection?: OnyxCollection<KeyValueMapping[TKey]>): void;
 /**
- * Gets the data for a given an array of matching keys, combines them into an object, and sends the result back to the subscriber.
- */
-declare function getCollectionDataAndSendAsObject<TKey extends OnyxKey>(matchingKeys: CollectionKeyBase[], mapping: CallbackToStateMapping<TKey>): void;
-/**
- * Remove a key from Onyx and update the subscribers
+ * Remove a key from Onyx and update the subscribers.
  */
 declare function remove<TKey extends OnyxKey>(key: TKey): Promise<void>;
 declare function reportStorageQuota(error?: Error): Promise<void>;
@@ -164,6 +141,10 @@ declare function retryOperation<TMethod extends RetriableOnyxOperation>(error: E
  */
 declare function broadcastUpdate<TKey extends OnyxKey>(key: TKey, value: OnyxValue<TKey>, hasChanged?: boolean): void;
 declare function hasPendingMergeForKey(key: OnyxKey): boolean;
+type PendingMergeEntry = [OnyxKey, Array<OnyxValue<OnyxKey>>, number];
+declare function getPendingMergeEntries(keysToPreserve: OnyxKey[]): PendingMergeEntry[];
+declare function cancelPendingMerges(entries: PendingMergeEntry[]): void;
+declare function hasStaleMergeRead(queuedChanges: Array<OnyxValue<OnyxKey>>): boolean;
 /**
  * Storage expects array like: [["@MyApp_user", value_1], ["@MyApp_key", value_2]]
  * This method transforms an object like {'@MyApp_user': myUserValue, '@MyApp_key': myKeyValue}
@@ -198,19 +179,6 @@ declare function isValidNonEmptyCollectionForMerge<TKey extends CollectionKeyBas
  * Verify if all the collection keys belong to the same parent
  */
 declare function doAllCollectionItemsBelongToSameParent<TKey extends CollectionKeyBase>(collectionKey: TKey, collectionKeys: string[]): boolean;
-/**
- * Subscribes to an Onyx key and listens to its changes.
- *
- * @param connectOptions The options object that will define the behavior of the connection.
- * @returns The subscription ID to use when calling `OnyxUtils.unsubscribeFromKey()`.
- */
-declare function subscribeToKey<TKey extends OnyxKey>(connectOptions: ConnectOptions<TKey>): number;
-/**
- * Disconnects and removes the listener from the Onyx key.
- *
- * @param subscriptionID Subscription ID returned by calling `OnyxUtils.subscribeToKey()`.
- */
-declare function unsubscribeFromKey(subscriptionID: number): void;
 declare function updateSnapshots<TKey extends OnyxKey>(data: Array<OnyxUpdate<TKey>>, mergeFn: typeof Onyx.merge): Array<() => Promise<void>>;
 /**
  * Writes a value to our store with the given key.
@@ -271,6 +239,10 @@ declare function mergeCollectionWithPatches<TKey extends CollectionKeyBase>({ co
 declare function partialSetCollection<TKey extends CollectionKeyBase>({ collectionKey, collection }: SetCollectionParams<TKey>, retryAttempt?: number): Promise<void>;
 declare function logKeyChanged(onyxMethod: Extract<OnyxMethod, 'set' | 'merge'>, key: OnyxKey, value: unknown, hasChanged: boolean): void;
 declare function logKeyRemoved(onyxMethod: Extract<OnyxMethod, 'set' | 'merge'>, key: OnyxKey): void;
+/**
+ * Put Onyx back to "not initialised" state, useful for tests that need a cold start.
+ */
+declare function resetDeferredInitTask(): void;
 /**
  * Clear internal variables used in this file, useful in test environments.
  */
@@ -284,6 +256,7 @@ declare const OnyxUtils: {
         readonly MULTI_SET: "multiset";
         readonly CLEAR: "clear";
     };
+    NOT_DELIVERED: symbol;
     getMergeQueue: typeof getMergeQueue;
     getMergeQueuePromise: typeof getMergeQueuePromise;
     getDefaultKeyStates: typeof getDefaultKeyStates;
@@ -293,18 +266,18 @@ declare const OnyxUtils: {
     sendActionToDevTools: typeof sendActionToDevTools;
     get: typeof get;
     getAllKeys: typeof getAllKeys;
-    tryGetCachedValue: typeof tryGetCachedValue;
     getCachedCollection: typeof getCachedCollection;
-    keysChanged: typeof keysChanged;
-    keyChanged: typeof keyChanged;
-    sendDataToConnection: typeof sendDataToConnection;
-    getCollectionDataAndSendAsObject: typeof getCollectionDataAndSendAsObject;
+    notifyKey: typeof notifyKey;
+    notifyCollection: typeof notifyCollection;
     remove: typeof remove;
     reportStorageQuota: typeof reportStorageQuota;
     resetDiskPressureLogThrottle: typeof resetDiskPressureLogThrottle;
     retryOperation: typeof retryOperation;
     broadcastUpdate: typeof broadcastUpdate;
     hasPendingMergeForKey: typeof hasPendingMergeForKey;
+    getPendingMergeEntries: typeof getPendingMergeEntries;
+    cancelPendingMerges: typeof cancelPendingMerges;
+    hasStaleMergeRead: typeof hasStaleMergeRead;
     prepareKeyValuePairsForStorage: typeof prepareKeyValuePairsForStorage;
     mergeChanges: typeof mergeChanges;
     mergeAndMarkChanges: typeof mergeAndMarkChanges;
@@ -314,14 +287,10 @@ declare const OnyxUtils: {
     tupleGet: typeof tupleGet;
     isValidNonEmptyCollectionForMerge: typeof isValidNonEmptyCollectionForMerge;
     doAllCollectionItemsBelongToSameParent: typeof doAllCollectionItemsBelongToSameParent;
-    subscribeToKey: typeof subscribeToKey;
-    unsubscribeFromKey: typeof unsubscribeFromKey;
     getSkippableCollectionMemberIDs: typeof getSkippableCollectionMemberIDs;
     setSkippableCollectionMemberIDs: typeof setSkippableCollectionMemberIDs;
     getSnapshotMergeKeys: typeof getSnapshotMergeKeys;
     setSnapshotMergeKeys: typeof setSnapshotMergeKeys;
-    storeKeyBySubscriptions: typeof storeKeyBySubscriptions;
-    deleteKeyBySubscriptions: typeof deleteKeyBySubscriptions;
     reduceCollectionWithSelector: typeof reduceCollectionWithSelector;
     updateSnapshots: typeof updateSnapshots;
     mergeCollectionWithPatches: typeof mergeCollectionWithPatches;
@@ -334,4 +303,4 @@ declare const OnyxUtils: {
 };
 export type { OnyxMethod };
 export default OnyxUtils;
-export { clearOnyxUtilsInternals };
+export { clearOnyxUtilsInternals, resetDeferredInitTask };