react-native-onyx 1.0.79 → 1.0.81

package/API.md

@@ -6,7 +6,7 @@
 
 <dl>
 <dt><a href="#getSubsetOfData">getSubsetOfData(sourceData, selector, [withOnyxInstanceState])</a> ⇒ <code>Mixed</code></dt>
-<dd><p>Uses a selector string or function to return a simplified version of sourceData</p>
+<dd><p>Uses a selector function to return a simplified version of sourceData</p>
 </dd>
 <dt><a href="#reduceCollectionWithSelector">reduceCollectionWithSelector(collection, selector, [withOnyxInstanceState])</a> ⇒ <code>Object</code></dt>
 <dd><p>Takes a collection of items (eg. {testKey_1:{a:&#39;a&#39;}, testKey_2:{b:&#39;b&#39;}})
@@ -15,6 +15,10 @@ The resulting collection will only contain items that are returned by the select
 </dd>
 <dt><a href="#isCollectionMemberKey">isCollectionMemberKey(collectionKey, key)</a> ⇒ <code>Boolean</code></dt>
 <dd></dd>
+<dt><a href="#tryGetCachedValue">tryGetCachedValue(key, mapping)</a> ⇒ <code>Mixed</code></dt>
+<dd><p>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.</p>
+</dd>
 <dt><a href="#connect">connect(mapping)</a> ⇒ <code>Number</code></dt>
 <dd><p>Subscribes a react component&#39;s state directly to a store key</p>
 </dd>
@@ -32,18 +36,21 @@ behavior just yet.</p>
 so that keysChanged() is triggered for the collection and not keyChanged(). If this was not done, then the
 subscriber callbacks receive the data in a different format than they normally expect and it breaks code.</p>
 </dd>
+<dt><a href="#broadcastUpdate">broadcastUpdate(key, value, hasChanged, method)</a></dt>
+<dd><p>Notifys subscribers and writes current value to cache</p>
+</dd>
+<dt><a href="#hasPendingMergeForKey">hasPendingMergeForKey(key)</a> ⇒ <code>Boolean</code></dt>
+<dd></dd>
 <dt><a href="#set">set(key, value)</a> ⇒ <code>Promise</code></dt>
 <dd><p>Write a value to our store with the given key</p>
 </dd>
 <dt><a href="#multiSet">multiSet(data)</a> ⇒ <code>Promise</code></dt>
 <dd><p>Sets multiple keys and values</p>
 </dd>
-<dt><a href="#merge">merge(key, value)</a> ⇒ <code>Promise</code></dt>
+<dt><a href="#merge">merge(key, changes)</a> ⇒ <code>Promise</code></dt>
 <dd><p>Merge a new value into an existing value at a key.</p>
-<p>The types of values that can be merged are <code>Object</code> and <code>Array</code>. To set another type of value use <code>Onyx.set()</code>. Merge
-behavior uses lodash/merge under the hood for <code>Object</code> and simple concatenation for <code>Array</code>. However, it&#39;s important
-to note that if you have an array value property on an <code>Object</code> that the default behavior of lodash/merge is not to
-concatenate. See here: <a href="https://github.com/lodash/lodash/issues/2872">https://github.com/lodash/lodash/issues/2872</a></p>
+<p>The types of values that can be merged are <code>Object</code> and <code>Array</code>. To set another type of value use <code>Onyx.set()</code>.
+Values of type <code>Object</code> get merged with the old value, whilst for <code>Array</code>&#39;s we simply replace the current value with the new one.</p>
 <p>Calls to <code>Onyx.merge()</code> are batched so that any calls performed in a single tick will stack in a queue and get
 applied in the order they were called. Note: <code>Onyx.set()</code> calls do not work this way so use caution when mixing
 <code>Onyx.merge()</code> and <code>Onyx.set()</code>.</p>
@@ -70,6 +77,9 @@ value will be saved to storage after the default value.</p>
 <dt><a href="#update">update(data)</a> ⇒ <code>Promise</code></dt>
 <dd><p>Insert API responses and lifecycle data into Onyx</p>
 </dd>
+<dt><a href="#setMemoryOnlyKeys">setMemoryOnlyKeys(keyList)</a></dt>
+<dd><p>When set these keys will not be persisted to storage</p>
+</dd>
 <dt><a href="#init">init([options])</a></dt>
 <dd><p>Initialize the store with actions and listening for storage events</p>
 </dd>
@@ -78,15 +88,15 @@ value will be saved to storage after the default value.</p>
 <a name="getSubsetOfData"></a>
 
 ## getSubsetOfData(sourceData, selector, [withOnyxInstanceState]) ⇒ <code>Mixed</code>
-Uses a selector string or function to return a simplified version of sourceData
+Uses a selector function to return a simplified version of sourceData
 
 **Kind**: global function  
 
 | Param | Type | Description |
 | --- | --- | --- |
 | sourceData | <code>Mixed</code> |  |
-| selector | <code>String</code> \| <code>function</code> |  |
-| [withOnyxInstanceState] | <code>Object</code> | If it's a string, the selector is passed to lodashGet on the sourceData      If it's a function, it is passed the sourceData and it should return the simplified data |
+| selector | <code>function</code> | Function that takes sourceData and returns a simplified version of it |
+| [withOnyxInstanceState] | <code>Object</code> |  |
 
 <a name="reduceCollectionWithSelector"></a>
 
@@ -113,6 +123,19 @@ The resulting collection will only contain items that are returned by the select
 | collectionKey | <code>String</code> | 
 | key | <code>String</code> | 
 
+<a name="tryGetCachedValue"></a>
+
+## tryGetCachedValue(key, mapping) ⇒ <code>Mixed</code>
+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.
+
+**Kind**: global function  
+
+| Param | Type |
+| --- | --- |
+| key | <code>String</code> | 
+| mapping | <code>Object</code> | 
+
 <a name="connect"></a>
 
 ## connect(mapping) ⇒ <code>Number</code>
@@ -130,7 +153,7 @@ Subscribes a react component's state directly to a store key
 | [mapping.callback] | <code>function</code> | a method that will be called with changed data      This is used by any non-React code to connect to Onyx |
 | [mapping.initWithStoredValues] | <code>Boolean</code> | If set to false, then no data will be prefilled into the  component |
 | [mapping.waitForCollectionCallback] | <code>Boolean</code> | If set to true, it will return the entire collection to the callback as a single object |
-| [mapping.selector] | <code>String</code> \| <code>function</code> | 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 and withOnyx state are       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). |
+| [mapping.selector] | <code>function</code> | THIS PARAM IS ONLY USED WITH withOnyx(). If included, this will be used to subscribe to a subset of an Onyx key's data.       The sourceData and withOnyx state are 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). |
 
 **Example**  
 ```js
@@ -189,6 +212,29 @@ subscriber callbacks receive the data in a different format than they normally e
 | key | <code>String</code> | 
 | value | <code>\*</code> | 
 
+<a name="broadcastUpdate"></a>
+
+## broadcastUpdate(key, value, hasChanged, method)
+Notifys subscribers and writes current value to cache
+
+**Kind**: global function  
+
+| Param | Type |
+| --- | --- |
+| key | <code>String</code> | 
+| value | <code>\*</code> | 
+| hasChanged | <code>Boolean</code> | 
+| method | <code>String</code> | 
+
+<a name="hasPendingMergeForKey"></a>
+
+## hasPendingMergeForKey(key) ⇒ <code>Boolean</code>
+**Kind**: global function  
+
+| Param | Type |
+| --- | --- |
+| key | <code>String</code> | 
+
 <a name="set"></a>
 
 ## set(key, value) ⇒ <code>Promise</code>
@@ -218,13 +264,11 @@ Onyx.multiSet({'key1': 'a', 'key2': 'b'});
 ```
 <a name="merge"></a>
 
-## merge(key, value) ⇒ <code>Promise</code>
+## merge(key, changes) ⇒ <code>Promise</code>
 Merge a new value into an existing value at a key.
 
-The types of values that can be merged are `Object` and `Array`. To set another type of value use `Onyx.set()`. Merge
-behavior uses lodash/merge under the hood for `Object` and simple concatenation for `Array`. However, it's important
-to note that if you have an array value property on an `Object` that the default behavior of lodash/merge is not to
-concatenate. See here: https://github.com/lodash/lodash/issues/2872
+The types of values that can be merged are `Object` and `Array`. To set another type of value use `Onyx.set()`.
+Values of type `Object` get merged with the old value, whilst for `Array`'s we simply replace the current value with the new one.
 
 Calls to `Onyx.merge()` are batched so that any calls performed in a single tick will stack in a queue and get
 applied in the order they were called. Note: `Onyx.set()` calls do not work this way so use caution when mixing
@@ -235,7 +279,7 @@ applied in the order they were called. Note: `Onyx.set()` calls do not work this
 | Param | Type | Description |
 | --- | --- | --- |
 | key | <code>String</code> | ONYXKEYS key |
-| value | <code>Object</code> \| <code>Array</code> | Object or Array value to merge |
+| changes | <code>Object</code> \| <code>Array</code> | Object or Array value to merge |
 
 **Example**  
 ```js
@@ -300,7 +344,18 @@ Insert API responses and lifecycle data into Onyx
 
 | Param | Type | Description |
 | --- | --- | --- |
-| data | <code>Array</code> | An array of objects with shape {onyxMethod: oneOf('set', 'merge', 'mergeCollection'), key: string, value: *} |
+| data | <code>Array</code> | An array of objects with shape {onyxMethod: oneOf('set', 'merge', 'mergeCollection', 'multiSet', 'clear'), key: string, value: *} |
+
+<a name="setMemoryOnlyKeys"></a>
+
+## setMemoryOnlyKeys(keyList)
+When set these keys will not be persisted to storage
+
+**Kind**: global function  
+
+| Param | Type |
+| --- | --- |
+| keyList | <code>Array.&lt;string&gt;</code> | 
 
 <a name="init"></a>
 

package/dist/web.development.js

@@ -77,9 +77,10 @@ __webpack_require__.r(__webpack_exports__);
 /* harmony import */ var _OnyxCache__WEBPACK_IMPORTED_MODULE_3__ = __webpack_require__(/*! ./OnyxCache */ "./lib/OnyxCache.js");
 /* harmony import */ var _Str__WEBPACK_IMPORTED_MODULE_6__ = __webpack_require__(/*! ./Str */ "./lib/Str.js");
 /* harmony import */ var _createDeferredTask__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__(/*! ./createDeferredTask */ "./lib/createDeferredTask.js");
-/* harmony import */ var _fastMerge__WEBPACK_IMPORTED_MODULE_9__ = __webpack_require__(/*! ./fastMerge */ "./lib/fastMerge.js");
+/* harmony import */ var _fastMerge__WEBPACK_IMPORTED_MODULE_10__ = __webpack_require__(/*! ./fastMerge */ "./lib/fastMerge.js");
 /* harmony import */ var _metrics_PerformanceUtils__WEBPACK_IMPORTED_MODULE_7__ = __webpack_require__(/*! ./metrics/PerformanceUtils */ "./lib/metrics/PerformanceUtils.js");
 /* harmony import */ var _storage__WEBPACK_IMPORTED_MODULE_4__ = __webpack_require__(/*! ./storage */ "./lib/storage/index.web.js");
+/* harmony import */ var _utils__WEBPACK_IMPORTED_MODULE_9__ = __webpack_require__(/*! ./utils */ "./lib/utils.js");
 /* harmony import */ var _batch__WEBPACK_IMPORTED_MODULE_8__ = __webpack_require__(/*! ./batch */ "./lib/batch.js");
 /* eslint-disable no-continue */
 
@@ -93,6 +94,7 @@ __webpack_require__.r(__webpack_exports__);
 
 
 
+
 // Method constants
 const METHOD = {
   SET: 'set',
@@ -1073,24 +1075,6 @@ function hasPendingMergeForKey(key) {
   return Boolean(mergeQueue[key]);
 }
 
-/**
- * We generally want to remove top-level nullish values from objects written to disk and cache, because it decreases the amount of data stored in memory and on disk.
- * On native, when merging an existing value with new changes, SQLite will use  JSON_PATCH, which removes top-level nullish values.
- * To be consistent with the behaviour for merge, we'll also want to remove nullish values for "set" operations.
- * On web, IndexedDB will keep the top-level keys along with a null value and this uses up storage and memory.
- * This method will ensure that keys for null values are removed before an object is written to disk and cache so that all platforms are storing the data in the same efficient way.
- * @private
- * @param {*} value
- * @returns {*}
- */
-function removeNullObjectValues(value) {
-  if (underscore__WEBPACK_IMPORTED_MODULE_1___default().isArray(value) || !underscore__WEBPACK_IMPORTED_MODULE_1___default().isObject(value)) {
-    return value;
-  }
-
-  return underscore__WEBPACK_IMPORTED_MODULE_1___default().omit(value, (objectValue) => underscore__WEBPACK_IMPORTED_MODULE_1___default().isNull(objectValue));
-}
-
 /**
  * Write a value to our store with the given key
  *
@@ -1108,7 +1092,7 @@ function set(key, value) {
     _Logger__WEBPACK_IMPORTED_MODULE_5__.logAlert(`Onyx.set() called after Onyx.merge() for key: ${key}. It is recommended to use set() or merge() not both.`);
   }
 
-  const valueWithNullRemoved = removeNullObjectValues(value);
+  const valueWithNullRemoved = _utils__WEBPACK_IMPORTED_MODULE_9__["default"].removeNullObjectValues(value);
 
   const hasChanged = _OnyxCache__WEBPACK_IMPORTED_MODULE_3__["default"].hasValueChanged(key, valueWithNullRemoved);
 
@@ -1178,7 +1162,7 @@ function applyMerge(existingValue, changes) {
     // Object values are merged one after the other
     // lodash adds a small overhead so we don't use it here
     // eslint-disable-next-line prefer-object-spread, rulesdir/prefer-underscore-method
-    return underscore__WEBPACK_IMPORTED_MODULE_1___default().reduce(changes, (modifiedData, change) => (0,_fastMerge__WEBPACK_IMPORTED_MODULE_9__["default"])(modifiedData, change),
+    return underscore__WEBPACK_IMPORTED_MODULE_1___default().reduce(changes, (modifiedData, change) => (0,_fastMerge__WEBPACK_IMPORTED_MODULE_10__["default"])(modifiedData, change),
     existingValue || {});
   }
 
@@ -1227,14 +1211,14 @@ function merge(key, changes) {
       delete mergeQueuePromise[key];
 
       // After that we merge the batched changes with the existing value
-      const modifiedData = removeNullObjectValues(applyMerge(existingValue, [batchedChanges]));
+      const modifiedData = _utils__WEBPACK_IMPORTED_MODULE_9__["default"].removeNullObjectValues(applyMerge(existingValue, [batchedChanges]));
 
       // On native platforms we use SQLite which utilises JSON_PATCH to merge changes.
       // JSON_PATCH generally removes top-level nullish values from the stored object.
       // When there is no existing value though, SQLite will just insert the changes as a new value and thus the top-level nullish values won't be removed.
       // Therefore we need to remove nullish values from the `batchedChanges` which are sent to the SQLite, if no existing value is present.
       if (!existingValue) {
-        batchedChanges = removeNullObjectValues(batchedChanges);
+        batchedChanges = _utils__WEBPACK_IMPORTED_MODULE_9__["default"].removeNullObjectValues(batchedChanges);
       }
 
       const hasChanged = _OnyxCache__WEBPACK_IMPORTED_MODULE_3__["default"].hasValueChanged(key, modifiedData);
@@ -1268,7 +1252,7 @@ function initializeWithDefaultKeyStates() {
   then((pairs) => {
     const asObject = underscore__WEBPACK_IMPORTED_MODULE_1___default().object(pairs);
 
-    const merged = (0,_fastMerge__WEBPACK_IMPORTED_MODULE_9__["default"])(asObject, defaultKeyStates);
+    const merged = (0,_fastMerge__WEBPACK_IMPORTED_MODULE_10__["default"])(asObject, defaultKeyStates);
     _OnyxCache__WEBPACK_IMPORTED_MODULE_3__["default"].merge(merged);
     underscore__WEBPACK_IMPORTED_MODULE_1___default().each(merged, (val, key) => keyChanged(key, val));
   });
@@ -1977,6 +1961,10 @@ __webpack_require__.r(__webpack_exports__);
 /* harmony export */ __webpack_require__.d(__webpack_exports__, {
 /* harmony export */   "default": () => (__WEBPACK_DEFAULT_EXPORT__)
 /* harmony export */ });
+/* harmony import */ var underscore__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! underscore */ "underscore");
+/* harmony import */ var underscore__WEBPACK_IMPORTED_MODULE_0___default = /*#__PURE__*/__webpack_require__.n(underscore__WEBPACK_IMPORTED_MODULE_0__);
+
+
 // Mostly copied from https://medium.com/@lubaka.a/how-to-remove-lodash-performance-improvement-b306669ad0e1
 
 /**
@@ -2033,10 +2021,7 @@ function mergeObject(target, source) {
  * @returns {Object|Array}
 */
 function fastMerge(target, source) {
-  // lodash adds a small overhead so we don't use it here
-  // eslint-disable-next-line rulesdir/prefer-underscore-method
-  const array = Array.isArray(source);
-  if (array) {
+  if (underscore__WEBPACK_IMPORTED_MODULE_0___default().isArray(source) || underscore__WEBPACK_IMPORTED_MODULE_0___default().isNull(source) || underscore__WEBPACK_IMPORTED_MODULE_0___default().isUndefined(source)) {
     return source;
   }
   return mergeObject(target, source);
@@ -2282,6 +2267,8 @@ __webpack_require__.r(__webpack_exports__);
 /* harmony import */ var underscore__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! underscore */ "underscore");
 /* harmony import */ var underscore__WEBPACK_IMPORTED_MODULE_1___default = /*#__PURE__*/__webpack_require__.n(underscore__WEBPACK_IMPORTED_MODULE_1__);
 /* harmony import */ var _fastMerge__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__(/*! ../../fastMerge */ "./lib/fastMerge.js");
+/* harmony import */ var _utils__WEBPACK_IMPORTED_MODULE_3__ = __webpack_require__(/*! ../../utils */ "./lib/utils.js");
+
 
 
 
@@ -2329,7 +2316,7 @@ const provider = {
       const upsertMany = underscore__WEBPACK_IMPORTED_MODULE_1___default().map(pairs, (_ref2, index) => {let [key, value] = _ref2;
         const prev = values[index];
         const newValue = underscore__WEBPACK_IMPORTED_MODULE_1___default().isObject(prev) ? (0,_fastMerge__WEBPACK_IMPORTED_MODULE_2__["default"])(prev, value) : value;
-        return (0,idb_keyval__WEBPACK_IMPORTED_MODULE_0__.promisifyRequest)(store.put(newValue, key));
+        return (0,idb_keyval__WEBPACK_IMPORTED_MODULE_0__.promisifyRequest)(store.put(_utils__WEBPACK_IMPORTED_MODULE_3__["default"].removeNullObjectValues(newValue), key));
       });
       return Promise.all(upsertMany);
     });
@@ -2414,6 +2401,45 @@ const provider = {
 
 /***/ }),
 
+/***/ "./lib/utils.js":
+/*!**********************!*\
+  !*** ./lib/utils.js ***!
+  \**********************/
+/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => {
+
+"use strict";
+__webpack_require__.r(__webpack_exports__);
+/* harmony export */ __webpack_require__.d(__webpack_exports__, {
+/* harmony export */   "default": () => (__WEBPACK_DEFAULT_EXPORT__)
+/* harmony export */ });
+/* harmony import */ var underscore__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! underscore */ "underscore");
+/* harmony import */ var underscore__WEBPACK_IMPORTED_MODULE_0___default = /*#__PURE__*/__webpack_require__.n(underscore__WEBPACK_IMPORTED_MODULE_0__);
+
+
+/**
+ * We generally want to remove top-level nullish values from objects written to disk and cache, because it decreases the amount of data stored in memory and on disk.
+ * On native, when merging an existing value with new changes, SQLite will use  JSON_PATCH, which removes top-level nullish values.
+ * To be consistent with the behaviour for merge, we'll also want to remove nullish values for "set" operations.
+ * On web, IndexedDB will keep the top-level keys along with a null value and this uses up storage and memory.
+ * This method will ensure that keys for null values are removed before an object is written to disk and cache so that all platforms are storing the data in the same efficient way.
+ * @private
+ * @param {*} value
+ * @returns {*}
+ */
+function removeNullObjectValues(value) {
+  if (underscore__WEBPACK_IMPORTED_MODULE_0___default().isArray(value) || !underscore__WEBPACK_IMPORTED_MODULE_0___default().isObject(value)) {
+    return value;
+  }
+
+  const objectWithoutNullObjectValues = underscore__WEBPACK_IMPORTED_MODULE_0___default().omit(value, (objectValue) => underscore__WEBPACK_IMPORTED_MODULE_0___default().isNull(objectValue));
+
+  return objectWithoutNullObjectValues;
+}
+
+/* harmony default export */ const __WEBPACK_DEFAULT_EXPORT__ = ({ removeNullObjectValues });
+
+/***/ }),
+
 /***/ "./lib/withOnyx.js":
 /*!*************************!*\
   !*** ./lib/withOnyx.js ***!