react-native-onyx 3.0.112 → 3.0.113

package/API.md

@@ -58,6 +58,11 @@ value will be saved to storage after the default value.</p>
 <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>
+<dt><a href="#exportState">exportState()</a></dt>
+<dd><p>Returns persisted Onyx key-value pairs as a plain object.
+Live RAM-only values and writes that have not reached storage are not included.
+Treat the returned object and its nested values as read-only.</p>
+</dd>
 </dl>
 
 <a name="init"></a>
@@ -257,3 +262,11 @@ Onyx.setCollection(ONYXKEYS.COLLECTION.REPORT, {
     [`${ONYXKEYS.COLLECTION.REPORT}2`]: report2,
 });
 ```
+<a name="exportState"></a>
+
+## exportState()
+Returns persisted Onyx key-value pairs as a plain object.
+Live RAM-only values and writes that have not reached storage are not included.
+Treat the returned object and its nested values as read-only.
+
+**Kind**: global function  

package/README.md

@@ -288,6 +288,10 @@ function signOut() {
 }
 ```
 
+## Export persisted state
+
+`Onyx.exportState()` returns a plain object containing persisted keys and values from the active storage provider. It works on native and web without opening another database connection. The export excludes stale persisted rows for keys that are now RAM-only. Current RAM-only values and writes still in progress are never included. Treat the returned object and its nested values as read-only because some providers return references to their stored values. The result can contain sensitive data; callers should redact it before sharing.
+
 ## Storage Providers
 `Onyx.get`, `Onyx.set`, and the rest of the API accesses the underlying storage
 differently depending on the platform

package/dist/Onyx.d.ts

@@ -1,5 +1,5 @@
 import * as Logger from './Logger';
-import type { CollectionKeyBase, ConnectOptions, InitOptions, OnyxKey, OnyxMergeCollectionInput, OnyxMergeInput, OnyxMultiSetInput, OnyxSetCollectionInput, OnyxSetInput, OnyxUpdate, SetOptions } from './types';
+import type { CollectionKeyBase, ConnectOptions, InitOptions, OnyxKey, OnyxMergeCollectionInput, OnyxMergeInput, OnyxMultiSetInput, OnyxSetCollectionInput, OnyxSetInput, OnyxUpdate, OnyxValue, SetOptions } from './types';
 import type { Connection } from './OnyxConnectionManager';
 /** Initialize the store with actions and listening for storage events */
 declare function init({ keys, initialKeyStates, evictableKeys, shouldSyncMultipleInstances, enableDevTools, skippableCollectionMemberIDs, ramOnlyKeys, snapshotMergeKeys, }: InitOptions): void;
@@ -152,6 +152,12 @@ declare function update<TKey extends OnyxKey>(data: Array<OnyxUpdate<TKey>>): Pr
  * @param collection Object collection keyed by individual collection member keys and values
  */
 declare function setCollection<TKey extends CollectionKeyBase>(collectionKey: TKey, collection: OnyxSetCollectionInput<TKey>): Promise<void>;
+/**
+ * Returns persisted Onyx key-value pairs as a plain object.
+ * Live RAM-only values and writes that have not reached storage are not included.
+ * Treat the returned object and its nested values as read-only.
+ */
+declare function exportState(): Promise<Record<OnyxKey, OnyxValue<OnyxKey>>>;
 declare const Onyx: {
     METHOD: {
         readonly SET: "set";
@@ -171,6 +177,7 @@ declare const Onyx: {
     setCollection: typeof setCollection;
     update: typeof update;
     clear: typeof clear;
+    exportState: typeof exportState;
     init: typeof init;
     registerLogger: typeof Logger.registerLogger;
 };

package/dist/Onyx.js

@@ -554,6 +554,23 @@ function update(data) {
 function setCollection(collectionKey, collection) {
     return OnyxUtils_1.default.afterInit(() => OnyxUtils_1.default.setCollectionWithRetry({ collectionKey, collection }));
 }
+/**
+ * Returns persisted Onyx key-value pairs as a plain object.
+ * Live RAM-only values and writes that have not reached storage are not included.
+ * Treat the returned object and its nested values as read-only.
+ */
+function exportState() {
+    return OnyxUtils_1.default.afterInit(() => storage_1.default.getAll().then((entries) => {
+        const state = {};
+        for (const [key, value] of entries) {
+            if (OnyxKeys_1.default.isRamOnlyKey(key)) {
+                continue;
+            }
+            state[key] = value;
+        }
+        return state;
+    }));
+}
 const Onyx = {
     METHOD: OnyxUtils_1.default.METHOD,
     connect,
@@ -566,6 +583,7 @@ const Onyx = {
     setCollection,
     update,
     clear,
+    exportState,
     init,
     registerLogger: Logger.registerLogger,
 };

package/package.json

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