react-native-onyx 1.0.28 → 1.0.30

package/README.md

@@ -335,6 +335,6 @@ To quickly test small changes you can directly go to `node_modules/react-native-
 To continuously work on Onyx we have to set up a task that copies content to parent project's `node_modules/react-native-onyx`:
 1. Work on Onyx feature or a fix
 2. Save files
-3. Optional: run `npm build` (if you're working or want to test on a non react-native project)
+3. Optional: run `npm run build` (if you're working or want to test on a non react-native project)
    - `npm link` would actually work outside of `react-native` and it can be used to link Onyx locally for a web only project
 4. Copy Onyx to consumer project's `node_modules/react-native-onyx`

package/dist/web.development.js

@@ -1152,7 +1152,10 @@ function getCollectionDataAndSendAsObject(matchingKeys, mapping) {
  * @param {Boolean} [mapping.initWithStoredValues] If set to false, then no data will be prefilled into the
  *  component
  * @param {Boolean} [mapping.waitForCollectionCallback] If set to true, it will return the entire collection to the callback as a single object
- * @param {String|Function} [mapping.selector] THIS PARAM IS ONLY USED WITH withOnyx(). If included, this will be used to subscribe to a subset of an Onyx key's data. If the selector is a string, the selector is passed to lodashGet on the sourceData. If the selector is a function, the sourceData is passed to the selector and should return the simplified data. Using this setting on `withOnyx` can have very positive performance benefits because the component will only re-render when the subset of data changes. Otherwise, any change of data on any property would normally cause the component to re-render (and that can be expensive from a performance standpoint).
+ * @param {String|Function} [mapping.selector] THIS PARAM IS ONLY USED WITH withOnyx(). If included, this will be used to subscribe to a subset of an Onyx key's data.
+ *       If the selector is a string, the selector is passed to lodashGet on the sourceData. If the selector is a function, the sourceData is passed to the selector and should return the
+ *       simplified data. Using this setting on `withOnyx` can have very positive performance benefits because the component will only re-render when the subset of data changes.
+ *       Otherwise, any change of data on any property would normally cause the component to re-render (and that can be expensive from a performance standpoint).
  * @returns {Number} an ID to use when calling disconnect
  */
 function connect(mapping) {
@@ -1516,17 +1519,37 @@ function initializeWithDefaultKeyStates() {
  * Storage.setItem() from Onyx.clear() will have already finished and the merged
  * value will be saved to storage after the default value.
  *
+ * @param {Array} keysToPreserve is a list of ONYXKEYS that should not be cleared with the rest of the data
  * @returns {Promise<void>}
  */
-function clear() {
+function clear() {var keysToPreserve = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
   return getAllKeys().
   then(function (keys) {
-    _underscore.default.each(keys, function (key) {
-      var resetValue = (0, _get.default)(defaultKeyStates, key, null);
-      _OnyxCache.default.set(key, resetValue);
-      notifySubscribersOnNextTick(key, resetValue);
+    var keyValuesToReset = [];
+    var defaultKeys = _underscore.default.keys(defaultKeyStates);
+
+    // The only keys that should not be cleared are:
+    // 1. Anything specifically passed in keysToPreserve (because some keys like language preferences, offline status, or activeClients need to remain in Onyx even when signed out)
+    // 2. Any keys with a default state (because they need to remain in Onyx as their default, and setting them to null would cause unknown behavior)
+    var keysToClear = _underscore.default.difference(keys, keysToPreserve, defaultKeys);
+    keyValuesToReset.push.apply(keyValuesToReset, (0, _toConsumableArray2.default)(_underscore.default.map(keysToClear, function (key) {return [key, null];})));
+
+    // Remove any keysToPreserve from the defaultKeyStates because if they are passed in it has been explicitly called out to preserve those values instead of resetting them back
+    // to the default.
+    var defaultKeyValuePairs = _underscore.default.pairs(_underscore.default.omit.apply(_underscore.default, [defaultKeyStates].concat((0, _toConsumableArray2.default)(keysToPreserve))));
+
+    // Add the default key value pairs to the keyValuesToReset so that they get set back to their default values when we clear Onyx
+    keyValuesToReset.push.apply(keyValuesToReset, (0, _toConsumableArray2.default)(defaultKeyValuePairs));
+
+    // Make sure that we also reset the cache values before clearing the values from storage.
+    // We do this before clearing Storage so that any call to clear() followed by merge() on a key with a default state results in the merged value getting saved, since the update
+    // from the merge() call would happen on the tick after the update from this clear()
+    _underscore.default.each(keyValuesToReset, function (keyValue) {
+      _OnyxCache.default.set(keyValue[0], keyValue[1]);
+      notifySubscribersOnNextTick(keyValue[0], keyValue[1]);
     });
-    return _storage.default.clear();
+
+    return _storage.default.multiSet(keyValuesToReset);
   });
 }
 
@@ -2228,7 +2251,7 @@ function logSetStateCall(mapping, previousValue, newValue, caller, keyThatChange
 
 Object.defineProperty(exports, "__esModule", ({ value: true }));exports.decorateWithMetrics = decorateWithMetrics;exports.getMetrics = getMetrics;exports.resetMetrics = resetMetrics;exports.printMetrics = printMetrics; // For web-only implementations of Onyx, this module will just be a no-op
 
-function decorateWithMetrics() {}
+function decorateWithMetrics(func) {return func;}
 function getMetrics() {}
 function printMetrics() {}
 function resetMetrics() {}