react-native-onyx 2.0.80 → 2.0.81

package/API.md

@@ -50,6 +50,10 @@ value will be saved to storage after the default value.</p>
 <dt><a href="#update">update(data)</a> ⇒</dt>
 <dd><p>Insert API responses and lifecycle data into Onyx</p>
 </dd>
+<dt><a href="#setCollection">setCollection(collectionKey, collection)</a></dt>
+<dd><p>Sets a collection by replacing all existing collection members with new values.
+Any existing collection members not included in the new data will be removed.</p>
+</dd>
 </dl>
 
 <a name="init"></a>
@@ -209,3 +213,23 @@ Insert API responses and lifecycle data into Onyx
 | --- | --- |
 | data | An array of objects with update expressions |
 
+<a name="setCollection"></a>
+
+## setCollection(collectionKey, collection)
+Sets a collection by replacing all existing collection members with new values.
+Any existing collection members not included in the new data will be removed.
+
+**Kind**: global function  
+
+| Param | Description |
+| --- | --- |
+| collectionKey | e.g. `ONYXKEYS.COLLECTION.REPORT` |
+| collection | Object collection keyed by individual collection member keys and values |
+
+**Example**  
+```js
+Onyx.setCollection(ONYXKEYS.COLLECTION.REPORT, {
+    [`${ONYXKEYS.COLLECTION.REPORT}1`]: report1,
+    [`${ONYXKEYS.COLLECTION.REPORT}2`]: report2,
+});
+```

package/dist/Onyx.d.ts

@@ -119,11 +119,26 @@ declare function clear(keysToPreserve?: OnyxKey[]): Promise<void>;
  * @returns resolves when all operations are complete
  */
 declare function update(data: OnyxUpdate[]): Promise<void>;
+/**
+ * Sets a collection by replacing all existing collection members with new values.
+ * Any existing collection members not included in the new data will be removed.
+ *
+ * @example
+ * Onyx.setCollection(ONYXKEYS.COLLECTION.REPORT, {
+ *     [`${ONYXKEYS.COLLECTION.REPORT}1`]: report1,
+ *     [`${ONYXKEYS.COLLECTION.REPORT}2`]: report2,
+ * });
+ *
+ * @param collectionKey e.g. `ONYXKEYS.COLLECTION.REPORT`
+ * @param collection Object collection keyed by individual collection member keys and values
+ */
+declare function setCollection<TKey extends CollectionKeyBase, TMap extends string>(collectionKey: TKey, collection: OnyxMergeCollectionInput<TMap>): Promise<void>;
 declare const Onyx: {
     readonly METHOD: {
         readonly SET: "set";
         readonly MERGE: "merge";
         readonly MERGE_COLLECTION: "mergecollection";
+        readonly SET_COLLECTION: "setcollection";
         readonly MULTI_SET: "multiset";
         readonly CLEAR: "clear";
     };
@@ -133,6 +148,7 @@ declare const Onyx: {
     readonly multiSet: typeof multiSet;
     readonly merge: typeof merge;
     readonly mergeCollection: typeof mergeCollection;
+    readonly setCollection: typeof setCollection;
     readonly update: typeof update;
     readonly clear: typeof clear;
     readonly init: typeof init;

package/dist/Onyx.js

@@ -632,6 +632,39 @@ function update(data) {
         .then(() => updateSnapshots(data))
         .then(() => undefined);
 }
+/**
+ * Sets a collection by replacing all existing collection members with new values.
+ * Any existing collection members not included in the new data will be removed.
+ *
+ * @example
+ * Onyx.setCollection(ONYXKEYS.COLLECTION.REPORT, {
+ *     [`${ONYXKEYS.COLLECTION.REPORT}1`]: report1,
+ *     [`${ONYXKEYS.COLLECTION.REPORT}2`]: report2,
+ * });
+ *
+ * @param collectionKey e.g. `ONYXKEYS.COLLECTION.REPORT`
+ * @param collection Object collection keyed by individual collection member keys and values
+ */
+function setCollection(collectionKey, collection) {
+    const newCollectionKeys = Object.keys(collection);
+    if (!OnyxUtils_1.default.doAllCollectionItemsBelongToSameParent(collectionKey, newCollectionKeys)) {
+        Logger.logAlert(`setCollection called with keys that do not belong to the same parent ${collectionKey}. Skipping this update.`);
+        return Promise.resolve();
+    }
+    return OnyxUtils_1.default.getAllKeys().then((persistedKeys) => {
+        const mutableCollection = Object.assign({}, collection);
+        persistedKeys.forEach((key) => {
+            if (!key.startsWith(collectionKey)) {
+                return;
+            }
+            if (newCollectionKeys.includes(key)) {
+                return;
+            }
+            mutableCollection[key] = null;
+        });
+        return multiSet(mutableCollection);
+    });
+}
 const Onyx = {
     METHOD: OnyxUtils_1.default.METHOD,
     connect,
@@ -640,6 +673,7 @@ const Onyx = {
     multiSet,
     merge,
     mergeCollection,
+    setCollection,
     update,
     clear,
     init,

package/dist/OnyxUtils.d.ts

@@ -6,6 +6,7 @@ declare const METHOD: {
     readonly SET: "set";
     readonly MERGE: "merge";
     readonly MERGE_COLLECTION: "mergecollection";
+    readonly SET_COLLECTION: "setcollection";
     readonly MULTI_SET: "multiset";
     readonly CLEAR: "clear";
 };
@@ -228,6 +229,7 @@ declare const OnyxUtils: {
         readonly SET: "set";
         readonly MERGE: "merge";
         readonly MERGE_COLLECTION: "mergecollection";
+        readonly SET_COLLECTION: "setcollection";
         readonly MULTI_SET: "multiset";
         readonly CLEAR: "clear";
     };

package/dist/OnyxUtils.js

@@ -44,6 +44,7 @@ const METHOD = {
     SET: 'set',
     MERGE: 'merge',
     MERGE_COLLECTION: 'mergecollection',
+    SET_COLLECTION: 'setcollection',
     MULTI_SET: 'multiset',
     CLEAR: 'clear',
 };

package/package.json

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