react-native-onyx 2.0.111 → 2.0.112

package/dist/Onyx.d.ts

@@ -2,7 +2,7 @@ import * as Logger from './Logger';
 import type { CollectionKeyBase, ConnectOptions, InitOptions, Mapping, OnyxKey, OnyxMergeCollectionInput, OnyxMergeInput, OnyxMultiSetInput, OnyxSetInput, OnyxUpdate } from './types';
 import type { Connection } from './OnyxConnectionManager';
 /** Initialize the store with actions and listening for storage events */
-declare function init({ keys, initialKeyStates, evictableKeys, maxCachedKeysCount, shouldSyncMultipleInstances, debugSetState, enablePerformanceMetrics, skippableCollectionMemberIDs, }: InitOptions): void;
+declare function init({ keys, initialKeyStates, evictableKeys, maxCachedKeysCount, shouldSyncMultipleInstances, debugSetState, enablePerformanceMetrics, skippableCollectionMemberIDs, fullyMergedSnapshotKeys, }: InitOptions): void;
 /**
  * Connects to an Onyx key given the options passed and listens to its changes.
  *

package/dist/Onyx.js

@@ -40,7 +40,7 @@ const OnyxConnectionManager_1 = __importDefault(require("./OnyxConnectionManager
 const GlobalSettings = __importStar(require("./GlobalSettings"));
 const metrics_1 = __importDefault(require("./metrics"));
 /** Initialize the store with actions and listening for storage events */
-function init({ keys = {}, initialKeyStates = {}, evictableKeys = [], maxCachedKeysCount = 1000, shouldSyncMultipleInstances = !!global.localStorage, debugSetState = false, enablePerformanceMetrics = false, skippableCollectionMemberIDs = [], }) {
+function init({ keys = {}, initialKeyStates = {}, evictableKeys = [], maxCachedKeysCount = 1000, shouldSyncMultipleInstances = !!global.localStorage, debugSetState = false, enablePerformanceMetrics = false, skippableCollectionMemberIDs = [], fullyMergedSnapshotKeys = [], }) {
     var _a;
     if (enablePerformanceMetrics) {
         GlobalSettings.setPerformanceMetricsEnabled(true);
@@ -61,7 +61,7 @@ function init({ keys = {}, initialKeyStates = {}, evictableKeys = [], maxCachedK
     if (maxCachedKeysCount > 0) {
         OnyxCache_1.default.setRecentKeysLimit(maxCachedKeysCount);
     }
-    OnyxUtils_1.default.initStoreValues(keys, initialKeyStates, evictableKeys);
+    OnyxUtils_1.default.initStoreValues(keys, initialKeyStates, evictableKeys, fullyMergedSnapshotKeys);
     // Initialize all of our keys with data provided then give green light to any pending connections
     Promise.all([OnyxCache_1.default.addEvictableKeysToRecentlyAccessedList(OnyxUtils_1.default.isCollectionKey, OnyxUtils_1.default.getAllKeys), OnyxUtils_1.default.initializeWithDefaultKeyStates()]).then(OnyxUtils_1.default.getDeferredInitTask().resolve);
 }

package/dist/OnyxUtils.d.ts

@@ -43,8 +43,9 @@ declare function setSkippableCollectionMemberIDs(ids: Set<string>): void;
  * @param keys - `ONYXKEYS` constants object from Onyx.init()
  * @param initialKeyStates - initial data to set when `init()` and `clear()` are called
  * @param evictableKeys - This is an array of keys (individual or collection patterns) that when provided to Onyx are flagged as "safe" for removal.
+ * @param fullyMergedSnapshotKeys - Array of snapshot collection keys where full merge is supported and data structure can be changed after merge.
  */
-declare function initStoreValues(keys: DeepRecord<string, OnyxKey>, initialKeyStates: Partial<KeyValueMapping>, evictableKeys: OnyxKey[]): void;
+declare function initStoreValues(keys: DeepRecord<string, OnyxKey>, initialKeyStates: Partial<KeyValueMapping>, evictableKeys: OnyxKey[], fullyMergedSnapshotKeysParam?: string[]): void;
 /**
  * Sends an action to DevTools extension
  *
@@ -105,7 +106,7 @@ declare function getCollectionKeys(): Set<OnyxKey>;
  * is associated with a collection of keys.
  */
 declare function isCollectionKey(key: OnyxKey): key is CollectionKeyBase;
-declare function isCollectionMemberKey<TCollectionKey extends CollectionKeyBase>(collectionKey: TCollectionKey, key: string, collectionKeyLength: number): key is `${TCollectionKey}${string}`;
+declare function isCollectionMemberKey<TCollectionKey extends CollectionKeyBase>(collectionKey: TCollectionKey, key: string): key is `${TCollectionKey}${string}`;
 /**
  * Splits a collection member key into the collection key part and the ID part.
  * @param key - The collection member key to split.

package/dist/OnyxUtils.js

@@ -29,6 +29,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 /* eslint-disable no-continue */
 const fast_equals_1 = require("fast-equals");
 const clone_1 = __importDefault(require("lodash/clone"));
+const pick_1 = __importDefault(require("lodash/pick"));
 const DevTools_1 = __importDefault(require("./DevTools"));
 const Logger = __importStar(require("./Logger"));
 const OnyxCache_1 = __importStar(require("./OnyxCache"));
@@ -65,6 +66,7 @@ let batchUpdatesQueue = [];
 // Used for comparison with a new update to avoid invoking the Onyx.connect callback with the same data.
 const lastConnectionCallbackData = new Map();
 let snapshotKey = null;
+let fullyMergedSnapshotKeys;
 // Keeps track of the last subscriptionID that was used so we can keep incrementing it
 let lastSubscriptionID = 0;
 // Connections can be made before `Onyx.init`. They would wait for this task before resolving
@@ -116,8 +118,9 @@ function setSkippableCollectionMemberIDs(ids) {
  * @param keys - `ONYXKEYS` constants object from Onyx.init()
  * @param initialKeyStates - initial data to set when `init()` and `clear()` are called
  * @param evictableKeys - This is an array of keys (individual or collection patterns) that when provided to Onyx are flagged as "safe" for removal.
+ * @param fullyMergedSnapshotKeys - Array of snapshot collection keys where full merge is supported and data structure can be changed after merge.
  */
-function initStoreValues(keys, initialKeyStates, evictableKeys) {
+function initStoreValues(keys, initialKeyStates, evictableKeys, fullyMergedSnapshotKeysParam) {
     var _a;
     // We need the value of the collection keys later for checking if a
     // key is a collection. We store it in a map for faster lookup.
@@ -133,6 +136,7 @@ function initStoreValues(keys, initialKeyStates, evictableKeys) {
     OnyxCache_1.default.setEvictionAllowList(evictableKeys);
     if (typeof keys.COLLECTION === 'object' && typeof keys.COLLECTION.SNAPSHOT === 'string') {
         snapshotKey = keys.COLLECTION.SNAPSHOT;
+        fullyMergedSnapshotKeys = new Set(fullyMergedSnapshotKeysParam !== null && fullyMergedSnapshotKeysParam !== void 0 ? fullyMergedSnapshotKeysParam : []);
     }
 }
 function sendActionToDevTools(method, key, value, mergedValue = undefined) {
@@ -361,8 +365,8 @@ function getCollectionKeys() {
 function isCollectionKey(key) {
     return onyxCollectionKeySet.has(key);
 }
-function isCollectionMemberKey(collectionKey, key, collectionKeyLength) {
-    return key.startsWith(collectionKey) && key.length > collectionKeyLength;
+function isCollectionMemberKey(collectionKey, key) {
+    return key.startsWith(collectionKey) && key.length > collectionKey.length;
 }
 /**
  * Splits a collection member key into the collection key part and the ID part.
@@ -372,7 +376,7 @@ function isCollectionMemberKey(collectionKey, key, collectionKeyLength) {
  * or throws an Error if the key is not a collection one.
  */
 function splitCollectionMemberKey(key, collectionKey) {
-    if (collectionKey && !isCollectionMemberKey(collectionKey, key, collectionKey.length)) {
+    if (collectionKey && !isCollectionMemberKey(collectionKey, key)) {
         throw new Error(`Invalid '${collectionKey}' collection key provided, it isn't compatible with '${key}' key.`);
     }
     if (!collectionKey) {
@@ -450,13 +454,12 @@ function tryGetCachedValue(key, mapping) {
 function getCachedCollection(collectionKey, collectionMemberKeys) {
     const allKeys = collectionMemberKeys || OnyxCache_1.default.getAllKeys();
     const collection = {};
-    const collectionKeyLength = collectionKey.length;
     // forEach exists on both Set and Array
     allKeys.forEach((key) => {
         // If we don't have collectionMemberKeys array then we have to check whether a key is a collection member key.
         // Because in that case the keys will be coming from `cache.getAllKeys()` and we need to filter out the keys that
         // are not part of the collection.
-        if (!collectionMemberKeys && !isCollectionMemberKey(collectionKey, key, collectionKeyLength)) {
+        if (!collectionMemberKeys && !isCollectionMemberKey(collectionKey, key)) {
             return;
         }
         const cachedValue = OnyxCache_1.default.get(key);
@@ -479,7 +482,6 @@ function keysChanged(collectionKey, partialCollection, partialPreviousCollection
     // individual collection key member for the collection that is being updated. It is important to note that the collection parameter cane be a PARTIAL collection
     // and does not represent all of the combined keys and values for a collection key. It is just the "new" data that was merged in via mergeCollection().
     const stateMappingKeys = Object.keys(callbackToStateMapping);
-    const collectionKeyLength = collectionKey.length;
     for (const stateMappingKey of stateMappingKeys) {
         const subscriber = callbackToStateMapping[stateMappingKey];
         if (!subscriber) {
@@ -496,7 +498,7 @@ function keysChanged(collectionKey, partialCollection, partialPreviousCollection
         /**
          * e.g. Onyx.connect({key: `${ONYXKEYS.COLLECTION.REPORT}{reportID}`, callback: ...});
          */
-        const isSubscribedToCollectionMemberKey = isCollectionMemberKey(collectionKey, subscriber.key, collectionKeyLength);
+        const isSubscribedToCollectionMemberKey = isCollectionMemberKey(collectionKey, subscriber.key);
         // Regular Onyx.connect() subscriber found.
         if (typeof subscriber.callback === 'function') {
             if (!notifyConnectSubscribers) {
@@ -1121,7 +1123,6 @@ function updateSnapshots(data, mergeFn) {
         return [];
     const promises = [];
     const snapshotCollection = OnyxUtils.getCachedCollection(snapshotCollectionKey);
-    const snapshotCollectionKeyLength = snapshotCollectionKey.length;
     Object.entries(snapshotCollection).forEach(([snapshotEntryKey, snapshotEntryValue]) => {
         // Snapshots may not be present in cache. We don't know how to update them so we skip.
         if (!snapshotEntryValue) {
@@ -1130,7 +1131,7 @@ function updateSnapshots(data, mergeFn) {
         let updatedData = {};
         data.forEach(({ key, value }) => {
             // snapshots are normal keys so we want to skip update if they are written to Onyx
-            if (OnyxUtils.isCollectionMemberKey(snapshotCollectionKey, key, snapshotCollectionKeyLength)) {
+            if (OnyxUtils.isCollectionMemberKey(snapshotCollectionKey, key)) {
                 return;
             }
             if (typeof snapshotEntryValue !== 'object' || !('data' in snapshotEntryValue)) {
@@ -1149,7 +1150,17 @@ function updateSnapshots(data, mergeFn) {
                 return;
             }
             const oldValue = updatedData[key] || {};
-            updatedData = Object.assign(Object.assign({}, updatedData), { [key]: Object.assign(oldValue, value) });
+            let collectionKey;
+            try {
+                collectionKey = getCollectionKey(key);
+            }
+            catch (e) {
+                // If getCollectionKey() throws an error it means the key is not a collection key.
+                collectionKey = undefined;
+            }
+            const shouldFullyMerge = fullyMergedSnapshotKeys === null || fullyMergedSnapshotKeys === void 0 ? void 0 : fullyMergedSnapshotKeys.has(collectionKey || key);
+            const newValue = shouldFullyMerge ? value : (0, pick_1.default)(value, Object.keys(snapshotData[key]));
+            updatedData = Object.assign(Object.assign({}, updatedData), { [key]: Object.assign(oldValue, newValue) });
         });
         // Skip the update if there's no data to be merged
         if (utils_1.default.isEmptyObject(updatedData)) {

package/dist/types.d.ts

@@ -403,6 +403,13 @@ type InitOptions = {
      * Additionally, any subscribers from these keys to won't receive any data from Onyx.
      */
     skippableCollectionMemberIDs?: string[];
+    /**
+     * Array of snapshot collection keys where full merge is supported and data structure can be changed after merge.
+     * For e.g. if oldSnapshotData is {report_1: {name 'Fitsum'}} and BE update is {report_1: {name:'Fitsum2', nickName:'Fitse'}}
+     * if it is fullyMergedSnapshotkey the `nickName` prop that didn't exist in the previous data will be merged
+     * otherwise only existing prop will be picked from the BE update and merged (in this case only name).
+     */
+    fullyMergedSnapshotKeys?: string[];
 };
 type GenericFunction = (...args: any[]) => any;
 /**

package/dist/useOnyx.js

@@ -74,9 +74,7 @@ function useOnyx(key, options, dependencies = []) {
         try {
             const previousCollectionKey = OnyxUtils_1.default.splitCollectionMemberKey(previousKey)[0];
             const collectionKey = OnyxUtils_1.default.splitCollectionMemberKey(key)[0];
-            if (OnyxUtils_1.default.isCollectionMemberKey(previousCollectionKey, previousKey, previousCollectionKey.length) &&
-                OnyxUtils_1.default.isCollectionMemberKey(collectionKey, key, collectionKey.length) &&
-                previousCollectionKey === collectionKey) {
+            if (OnyxUtils_1.default.isCollectionMemberKey(previousCollectionKey, previousKey) && OnyxUtils_1.default.isCollectionMemberKey(collectionKey, key) && previousCollectionKey === collectionKey) {
                 return;
             }
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-onyx",
-  "version": "2.0.111",
+  "version": "2.0.112",
   "author": "Expensify, Inc.",
   "homepage": "https://expensify.com",
   "description": "State management for React Native",