react-native-onyx 1.0.64 → 1.0.66

package/lib/Onyx.js

@@ -14,6 +14,7 @@ const METHOD = {
     SET: 'set',
     MERGE: 'merge',
     MERGE_COLLECTION: 'mergecollection',
+    MULTI_SET: 'multiset',
     CLEAR: 'clear',
 };
 
@@ -26,8 +27,8 @@ let lastConnectionID = 0;
 // Holds a mapping of all the react components that want their state subscribed to a store key
 const callbackToStateMapping = {};
 
-// Stores all of the keys that Onyx can use. Must be defined in init().
-let onyxKeys = {};
+// Keeps a copy of the values of the onyx collection keys as a map for faster lookups
+let onyxCollectionKeyMap = {};
 
 // Holds a list of keys that have been directly subscribed to or recently modified from least to most recent
 let recentlyAccessedKeys = [];
@@ -140,7 +141,7 @@ function getAllKeys() {
  * @returns {Boolean}
  */
 function isCollectionKey(key) {
-    return _.contains(_.values(onyxKeys.COLLECTION), key);
+    return onyxCollectionKeyMap.has(key);
 }
 
 /**
@@ -1285,16 +1286,21 @@ function mergeCollection(collectionKey, collection) {
 /**
  * Insert API responses and lifecycle data into Onyx
  *
- * @param {Array} data An array of objects with shape {onyxMethod: oneOf('set', 'merge', 'mergeCollection'), key: string, value: *}
+ * @param {Array} data An array of objects with shape {onyxMethod: oneOf('set', 'merge', 'mergeCollection', 'multiSet', 'clear'), key: string, value: *}
  * @returns {Promise} resolves when all operations are complete
  */
 function update(data) {
     // First, validate the Onyx object is in the format we expect
-    _.each(data, ({onyxMethod, key}) => {
-        if (!_.contains([METHOD.CLEAR, METHOD.SET, METHOD.MERGE, METHOD.MERGE_COLLECTION], onyxMethod)) {
+    _.each(data, ({onyxMethod, key, value}) => {
+        if (!_.contains([METHOD.CLEAR, METHOD.SET, METHOD.MERGE, METHOD.MERGE_COLLECTION, METHOD.MULTI_SET], onyxMethod)) {
             throw new Error(`Invalid onyxMethod ${onyxMethod} in Onyx update.`);
         }
-        if (onyxMethod !== METHOD.CLEAR && !_.isString(key)) {
+        if (onyxMethod === METHOD.MULTI_SET) {
+            // For multiset, we just expect the value to be an object
+            if (!_.isObject(value) || _.isArray(value) || _.isFunction(value)) {
+                throw new Error('Invalid value provided in Onyx multiSet. Onyx multiSet value must be of type object.');
+            }
+        } else if (onyxMethod !== METHOD.CLEAR && !_.isString(key)) {
             throw new Error(`Invalid ${typeof key} key provided in Onyx update. Onyx key must be of type string.`);
         }
     });
@@ -1313,6 +1319,9 @@ function update(data) {
             case METHOD.MERGE_COLLECTION:
                 promises.push(() => mergeCollection(key, value));
                 break;
+            case METHOD.MULTI_SET:
+                promises.push(() => multiSet(value));
+                break;
             case METHOD.CLEAR:
                 clearPromise = clear();
                 break;
@@ -1383,8 +1392,13 @@ function init({
         cache.setRecentKeysLimit(maxCachedKeysCount);
     }
 
-    // Let Onyx know about all of our keys
-    onyxKeys = keys;
+    // 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.
+    const collectionValues = _.values(keys.COLLECTION);
+    onyxCollectionKeyMap = _.reduce(collectionValues, (acc, val) => {
+        acc.set(val, true);
+        return acc;
+    }, new Map());
 
     // Set our default key states to use when initializing and clearing Onyx data
     defaultKeyStates = initialKeyStates;

package/package.json

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