react-native-onyx 1.0.11 → 1.0.14

package/README.md

@@ -86,11 +86,18 @@ Onyx.merge(ONYXKEYS.POLICY, {employeeList: ['Jack']}); // -> {employeeList: ['Ja
 
 ### Should I use `merge()` or `set()` or both?
 
-- Use `merge()` if we want to merge partial data into an existing `Array` or `Object`
-- Use `set()` if we are working with simple values (`String`, `Boolean`, etc), need to completely overwrite a complex property of an `Object`, or reset some data entirely.
+- Use `merge()` when creating a new object
+- Use `merge()` to merge partial data into an existing object
+- Use `merge()` when storing simple values (`String`, `Boolean`, `Number`)
+- Use `set()` when you need to delete an Onyx key completely from storage
+- Use `set()` when you need to completely reset an object or array of data
 
 Consecutive calls to `Onyx.merge()` with the same key are batched in a stack and processed in the order that they were called. This helps avoid race conditions where one merge possibly finishes before another. However, it's important to note that calls to `Onyx.set()` are not batched together with calls to `Onyx.merge()`. For this reason, it is usually preferable to use one or the other, but not both. Onyx is a work-in-progress so always test code to make sure assumptions are correct!
 
+### Should I store things as an array or an object?
+
+You should avoid arrays as much as possible. They do not work well with `merge()` because it can't update a single element in an array, it must always set the entire array each time. This forces you to use `set()` a lot, and as seen above, `merge()` is more performant and better to use in almost any situation. If you are working with an array of objects, then you should be using an Onyx collection because it's optimized for working with arrays of objects.
+
 ## Subscribing to data changes
 
 To set up a basic subscription for a given key use the `Onyx.connect()` method.

package/dist/web.development.js

@@ -489,7 +489,7 @@ function logInfo(message) {
   \*********************/
 /***/ ((__unused_webpack_module, exports, __webpack_require__) => {
 
-var _interopRequireDefault = __webpack_require__(/*! @babel/runtime/helpers/interopRequireDefault */ "./node_modules/@babel/runtime/helpers/interopRequireDefault.js");Object.defineProperty(exports, "__esModule", ({ value: true }));exports["default"] = void 0;var _slicedToArray2 = _interopRequireDefault(__webpack_require__(/*! @babel/runtime/helpers/slicedToArray */ "./node_modules/@babel/runtime/helpers/slicedToArray.js"));var _toConsumableArray2 = _interopRequireDefault(__webpack_require__(/*! @babel/runtime/helpers/toConsumableArray */ "./node_modules/@babel/runtime/helpers/toConsumableArray.js"));var _defineProperty2 = _interopRequireDefault(__webpack_require__(/*! @babel/runtime/helpers/defineProperty */ "./node_modules/@babel/runtime/helpers/defineProperty.js"));var _extends4 = _interopRequireDefault(__webpack_require__(/*! @babel/runtime/helpers/extends */ "./node_modules/@babel/runtime/helpers/extends.js"));var _underscore = _interopRequireDefault(__webpack_require__(/*! underscore */ "underscore"));
+var _interopRequireDefault = __webpack_require__(/*! @babel/runtime/helpers/interopRequireDefault */ "./node_modules/@babel/runtime/helpers/interopRequireDefault.js");Object.defineProperty(exports, "__esModule", ({ value: true }));exports["default"] = void 0;var _slicedToArray2 = _interopRequireDefault(__webpack_require__(/*! @babel/runtime/helpers/slicedToArray */ "./node_modules/@babel/runtime/helpers/slicedToArray.js"));var _toConsumableArray2 = _interopRequireDefault(__webpack_require__(/*! @babel/runtime/helpers/toConsumableArray */ "./node_modules/@babel/runtime/helpers/toConsumableArray.js"));var _extends2 = _interopRequireDefault(__webpack_require__(/*! @babel/runtime/helpers/extends */ "./node_modules/@babel/runtime/helpers/extends.js"));var _defineProperty2 = _interopRequireDefault(__webpack_require__(/*! @babel/runtime/helpers/defineProperty */ "./node_modules/@babel/runtime/helpers/defineProperty.js"));var _underscore = _interopRequireDefault(__webpack_require__(/*! underscore */ "underscore"));
 var _str = _interopRequireDefault(__webpack_require__(/*! expensify-common/lib/str */ "expensify-common/lib/str"));
 var _merge = _interopRequireDefault(__webpack_require__(/*! lodash/merge */ "lodash/merge"));
 var _get = _interopRequireDefault(__webpack_require__(/*! lodash/get */ "lodash/get"));
@@ -723,10 +723,10 @@ function getCachedCollection(collectionKey) {
     if (!cachedValue) {
       return prev;
     }
-    return (0, _extends4.default)({},
-    prev, (0, _defineProperty2.default)({},
-    curr, cachedValue));
 
+    // eslint-disable-next-line no-param-reassign
+    prev[curr] = cachedValue;
+    return prev;
   }, {});
 }
 
@@ -751,6 +751,12 @@ function keysChanged(collectionKey, collection) {
     if (isSubscribedToCollectionKey) {
       if (_underscore.default.isFunction(subscriber.callback)) {
         var cachedCollection = getCachedCollection(collectionKey);
+
+        if (subscriber.waitForCollectionCallback) {
+          subscriber.callback(cachedCollection);
+          return;
+        }
+
         _underscore.default.each(collection, function (data, dataKey) {
           subscriber.callback(cachedCollection[dataKey], dataKey);
         });
@@ -780,7 +786,7 @@ function keysChanged(collectionKey, collection) {
       }
 
       subscriber.withOnyxInstance.setState(function (prevState) {return (0, _defineProperty2.default)({},
-        subscriber.statePropertyName, _underscore.default.isObject(dataFromCollection) ? (0, _extends4.default)({},
+        subscriber.statePropertyName, _underscore.default.isObject(dataFromCollection) ? (0, _extends2.default)({},
 
         prevState[subscriber.statePropertyName],
         dataFromCollection) :
@@ -935,10 +941,11 @@ function connect(mapping) {
     // initial data as a single object when using collection keys.
     if (mapping.withOnyxInstance && isCollectionKey(mapping.key) || mapping.waitForCollectionCallback) {
       Promise.all(_underscore.default.map(matchingKeys, function (key) {return get(key);})).
-      then(function (values) {return _underscore.default.reduce(values, function (finalObject, value, i) {return (0, _extends4.default)({},
-          finalObject, (0, _defineProperty2.default)({},
-          matchingKeys[i], value));},
-        {});}).
+      then(function (values) {return _underscore.default.reduce(values, function (finalObject, value, i) {
+          // eslint-disable-next-line no-param-reassign
+          finalObject[matchingKeys[i]] = value;
+          return finalObject;
+        }, {});}).
       then(function (val) {return sendDataToConnection(mapping, val);});
     } else {
       _underscore.default.each(matchingKeys, function (key) {