react-native-onyx 3.0.31 → 3.0.33

package/dist/Onyx.d.ts

@@ -2,7 +2,7 @@ import * as Logger from './Logger';
 import type { CollectionKeyBase, ConnectOptions, InitOptions, OnyxKey, OnyxMergeCollectionInput, OnyxSetCollectionInput, OnyxMergeInput, OnyxMultiSetInput, OnyxSetInput, OnyxUpdate, SetOptions } 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, enablePerformanceMetrics, enableDevTools, skippableCollectionMemberIDs, }: InitOptions): void;
+declare function init({ keys, initialKeyStates, evictableKeys, maxCachedKeysCount, shouldSyncMultipleInstances, enablePerformanceMetrics, enableDevTools, skippableCollectionMemberIDs, snapshotMergeKeys, }: InitOptions): void;
 /**
  * Connects to an Onyx key given the options passed and listens to its changes.
  * This method will be deprecated soon. Please use `Onyx.connectWithoutView()` instead.

package/dist/Onyx.js

@@ -48,7 +48,7 @@ const GlobalSettings = __importStar(require("./GlobalSettings"));
 const metrics_1 = __importDefault(require("./metrics"));
 const OnyxMerge_1 = __importDefault(require("./OnyxMerge"));
 /** Initialize the store with actions and listening for storage events */
-function init({ keys = {}, initialKeyStates = {}, evictableKeys = [], maxCachedKeysCount = 1000, shouldSyncMultipleInstances = !!global.localStorage, enablePerformanceMetrics = false, enableDevTools = true, skippableCollectionMemberIDs = [], }) {
+function init({ keys = {}, initialKeyStates = {}, evictableKeys = [], maxCachedKeysCount = 1000, shouldSyncMultipleInstances = !!global.localStorage, enablePerformanceMetrics = false, enableDevTools = true, skippableCollectionMemberIDs = [], snapshotMergeKeys = [], }) {
     var _a;
     if (enablePerformanceMetrics) {
         GlobalSettings.setPerformanceMetricsEnabled(true);
@@ -57,6 +57,7 @@ function init({ keys = {}, initialKeyStates = {}, evictableKeys = [], maxCachedK
     (0, DevTools_1.initDevTools)(enableDevTools);
     storage_1.default.init();
     OnyxUtils_1.default.setSkippableCollectionMemberIDs(new Set(skippableCollectionMemberIDs));
+    OnyxUtils_1.default.setSnapshotMergeKeys(new Set(snapshotMergeKeys));
     if (shouldSyncMultipleInstances) {
         (_a = storage_1.default.keepInstancesSync) === null || _a === void 0 ? void 0 : _a.call(storage_1.default, (key, value) => {
             OnyxCache_1.default.set(key, value);
@@ -289,8 +290,10 @@ function clear(keysToPreserve = []) {
         var _a;
         OnyxCache_1.default.clearNullishStorageKeys();
         const keysToBeClearedFromStorage = [];
-        const keyValuesToResetAsCollection = {};
         const keyValuesToResetIndividually = {};
+        // We need to store old and new values for collection keys to properly notify subscribers when clearing Onyx
+        // because the notification process needs the old values in cache but at that point they will be already removed from it.
+        const keyValuesToResetAsCollection = {};
         const allKeys = new Set([...cachedKeys, ...initialKeys]);
         // The only keys that should not be cleared are:
         // 1. Anything specifically passed in keysToPreserve (because some keys like language preferences, offline
@@ -320,9 +323,10 @@ function clear(keysToPreserve = []) {
                     }
                     if (collectionKey) {
                         if (!keyValuesToResetAsCollection[collectionKey]) {
-                            keyValuesToResetAsCollection[collectionKey] = {};
+                            keyValuesToResetAsCollection[collectionKey] = { oldValues: {}, newValues: {} };
                         }
-                        keyValuesToResetAsCollection[collectionKey][key] = newValue !== null && newValue !== void 0 ? newValue : undefined;
+                        keyValuesToResetAsCollection[collectionKey].oldValues[key] = oldValue;
+                        keyValuesToResetAsCollection[collectionKey].newValues[key] = newValue !== null && newValue !== void 0 ? newValue : undefined;
                     }
                     else {
                         keyValuesToResetIndividually[key] = newValue !== null && newValue !== void 0 ? newValue : undefined;
@@ -341,7 +345,7 @@ function clear(keysToPreserve = []) {
             updatePromises.push(OnyxUtils_1.default.scheduleSubscriberUpdate(key, value));
         }
         for (const [key, value] of Object.entries(keyValuesToResetAsCollection)) {
-            updatePromises.push(OnyxUtils_1.default.scheduleNotifyCollectionSubscribers(key, value));
+            updatePromises.push(OnyxUtils_1.default.scheduleNotifyCollectionSubscribers(key, value.newValues, value.oldValues));
         }
         const defaultKeyValuePairs = Object.entries(Object.keys(defaultKeyStates)
             .filter((key) => !keysToPreserve.includes(key))

package/dist/OnyxUtils.d.ts

@@ -34,10 +34,18 @@ declare function getDeferredInitTask(): DeferredTask;
  * Getter - returns the skippable collection member IDs.
  */
 declare function getSkippableCollectionMemberIDs(): Set<string>;
+/**
+ * Getter - returns the snapshot merge keys allowlist.
+ */
+declare function getSnapshotMergeKeys(): Set<string>;
 /**
  * Setter - sets the skippable collection member IDs.
  */
 declare function setSkippableCollectionMemberIDs(ids: Set<string>): void;
+/**
+ * Setter - sets the snapshot merge keys allowlist.
+ */
+declare function setSnapshotMergeKeys(keys: Set<string>): void;
 /**
  * Sets the initial values for the Onyx store
  *
@@ -354,6 +362,8 @@ declare const OnyxUtils: {
     unsubscribeFromKey: typeof unsubscribeFromKey;
     getSkippableCollectionMemberIDs: typeof getSkippableCollectionMemberIDs;
     setSkippableCollectionMemberIDs: typeof setSkippableCollectionMemberIDs;
+    getSnapshotMergeKeys: typeof getSnapshotMergeKeys;
+    setSnapshotMergeKeys: typeof setSnapshotMergeKeys;
     storeKeyBySubscriptions: typeof storeKeyBySubscriptions;
     deleteKeyBySubscriptions: typeof deleteKeyBySubscriptions;
     addKeyToRecentlyAccessedIfNeeded: typeof addKeyToRecentlyAccessedIfNeeded;

package/dist/OnyxUtils.js

@@ -38,7 +38,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.clearOnyxUtilsInternals = clearOnyxUtilsInternals;
 const fast_equals_1 = require("fast-equals");
-const pick_1 = __importDefault(require("lodash/pick"));
 const underscore_1 = __importDefault(require("underscore"));
 const DevTools_1 = __importDefault(require("./DevTools"));
 const Logger = __importStar(require("./Logger"));
@@ -94,6 +93,8 @@ let lastSubscriptionID = 0;
 const deferredInitTask = (0, createDeferredTask_1.default)();
 // Holds a set of collection member IDs which updates will be ignored when using Onyx methods.
 let skippableCollectionMemberIDs = new Set();
+// Holds a set of keys that should always be merged into snapshot entries.
+let snapshotMergeKeys = new Set();
 function getSnapshotKey() {
     return snapshotKey;
 }
@@ -127,12 +128,24 @@ function getDeferredInitTask() {
 function getSkippableCollectionMemberIDs() {
     return skippableCollectionMemberIDs;
 }
+/**
+ * Getter - returns the snapshot merge keys allowlist.
+ */
+function getSnapshotMergeKeys() {
+    return snapshotMergeKeys;
+}
 /**
  * Setter - sets the skippable collection member IDs.
  */
 function setSkippableCollectionMemberIDs(ids) {
     skippableCollectionMemberIDs = ids;
 }
+/**
+ * Setter - sets the snapshot merge keys allowlist.
+ */
+function setSnapshotMergeKeys(keys) {
+    snapshotMergeKeys = keys;
+}
 /**
  * Sets the initial values for the Onyx store
  *
@@ -1011,7 +1024,14 @@ function updateSnapshots(data, mergeFn) {
                 continue;
             }
             const oldValue = updatedData[key] || {};
-            const newValue = (0, pick_1.default)(value, Object.keys(snapshotData[key]));
+            // Snapshot entries are stored as a "shape" of the last known data per key, so by default we only
+            // merge fields that already exist in the snapshot to avoid unintentionally bloating snapshot data.
+            // Some clients need specific fields (like pending status) even when they are missing in the snapshot,
+            // so we allow an explicit, opt-in list of keys to always include during snapshot merges.
+            const snapshotExistingKeys = Object.keys(snapshotData[key] || {});
+            const allowedNewKeys = getSnapshotMergeKeys();
+            const keysToCopy = new Set([...snapshotExistingKeys, ...allowedNewKeys]);
+            const newValue = typeof value === 'object' && value !== null ? utils_1.default.pick(value, [...keysToCopy]) : {};
             updatedData = Object.assign(Object.assign({}, updatedData), { [key]: Object.assign(oldValue, newValue) });
         }
         // Skip the update if there's no data to be merged
@@ -1411,6 +1431,8 @@ const OnyxUtils = {
     unsubscribeFromKey,
     getSkippableCollectionMemberIDs,
     setSkippableCollectionMemberIDs,
+    getSnapshotMergeKeys,
+    setSnapshotMergeKeys,
     storeKeyBySubscriptions,
     deleteKeyBySubscriptions,
     addKeyToRecentlyAccessedIfNeeded,

package/dist/types.d.ts

@@ -364,6 +364,14 @@ type InitOptions = {
      * Additionally, any subscribers from these keys to won't receive any data from Onyx.
      */
     skippableCollectionMemberIDs?: string[];
+    /**
+     * A list of field names that should always be merged into snapshot entries even if those fields are
+     * missing in the snapshot. Snapshots are saved "views" of a key's data used to populate read-only
+     * or cached lists, and by default Onyx only merges fields that already exist in that saved view.
+     * Use this to opt-in to additional fields that must appear in snapshots (for example, pending flags)
+     * without hardcoding app-specific logic inside Onyx.
+     */
+    snapshotMergeKeys?: string[];
 };
 type GenericFunction = (...args: any[]) => any;
 /**

package/dist/useOnyx.js

@@ -254,7 +254,7 @@ function useOnyx(key, options, dependencies = []) {
             OnyxSnapshotCache_1.default.setCachedResult(key, cacheKey, resultRef.current);
         }
         return resultRef.current;
-    }, [options === null || options === void 0 ? void 0 : options.initWithStoredValues, options === null || options === void 0 ? void 0 : options.allowStaleData, options === null || options === void 0 ? void 0 : options.canBeMissing, key, memoizedSelector, cacheKey]);
+    }, [options === null || options === void 0 ? void 0 : options.initWithStoredValues, options === null || options === void 0 ? void 0 : options.allowStaleData, options === null || options === void 0 ? void 0 : options.canBeMissing, key, memoizedSelector, cacheKey, previousKey]);
     const subscribe = (0, react_1.useCallback)((onStoreChange) => {
         isConnectingRef.current = true;
         onStoreChangeFnRef.current = onStoreChange;

package/package.json

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