react-native-onyx 2.0.68 → 2.0.70

package/dist/OnyxUtils.d.ts

@@ -75,7 +75,8 @@ declare function isCollectionMemberKey<TCollectionKey extends CollectionKeyBase>
 /**
  * Splits a collection member key into the collection key part and the ID part.
  * @param key - The collection member key to split.
- * @returns A tuple where the first element is the collection part and the second element is the ID part.
+ * @returns A tuple where the first element is the collection part and the second element is the ID part,
+ * or throws an Error if the key is not a collection one.
  */
 declare function splitCollectionMemberKey<TKey extends CollectionKey, CollectionKeyType = TKey extends `${infer Prefix}_${string}` ? `${Prefix}_` : never>(key: TKey): [CollectionKeyType, string];
 /**
@@ -86,7 +87,7 @@ declare function isKeyMatch(configKey: OnyxKey, key: OnyxKey): boolean;
 /** Checks to see if this key has been flagged as safe for removal. */
 declare function isSafeEvictionKey(testKey: OnyxKey): boolean;
 /**
- * It extracts the non-numeric collection identifier of a given key.
+ * Extracts the collection identifier of a given collection member key.
  *
  * For example:
  * - `getCollectionKey("report_123")` would return "report_"
@@ -94,10 +95,10 @@ declare function isSafeEvictionKey(testKey: OnyxKey): boolean;
  * - `getCollectionKey("report_-1_something")` would return "report_"
  * - `getCollectionKey("sharedNVP_user_-1_something")` would return "sharedNVP_user_"
  *
- * @param {OnyxKey} key - The key to process.
- * @return {string} The plain collection key.
+ * @param key - The collection key to process.
+ * @returns The plain collection key or throws an Error if the key is not a collection one.
  */
-declare function getCollectionKey(key: OnyxKey): string;
+declare function getCollectionKey(key: CollectionKey): string;
 /**
  * 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.

package/dist/OnyxUtils.js

@@ -332,7 +332,8 @@ function isCollectionMemberKey(collectionKey, key, collectionKeyLength) {
 /**
  * Splits a collection member key into the collection key part and the ID part.
  * @param key - The collection member key to split.
- * @returns A tuple where the first element is the collection part and the second element is the ID part.
+ * @returns A tuple where the first element is the collection part and the second element is the ID part,
+ * or throws an Error if the key is not a collection one.
  */
 function splitCollectionMemberKey(key) {
     const collectionKey = getCollectionKey(key);
@@ -350,7 +351,7 @@ function isSafeEvictionKey(testKey) {
     return evictionAllowList.some((key) => isKeyMatch(key, testKey));
 }
 /**
- * It extracts the non-numeric collection identifier of a given key.
+ * Extracts the collection identifier of a given collection member key.
  *
  * For example:
  * - `getCollectionKey("report_123")` would return "report_"
@@ -358,8 +359,8 @@ function isSafeEvictionKey(testKey) {
  * - `getCollectionKey("report_-1_something")` would return "report_"
  * - `getCollectionKey("sharedNVP_user_-1_something")` would return "sharedNVP_user_"
  *
- * @param {OnyxKey} key - The key to process.
- * @return {string} The plain collection key.
+ * @param key - The collection key to process.
+ * @returns The plain collection key or throws an Error if the key is not a collection one.
  */
 function getCollectionKey(key) {
     // Start by finding the position of the last underscore in the string
@@ -1034,7 +1035,7 @@ function subscribeToKey(connectOptions) {
         // Performance improvement
         // If the mapping is connected to an onyx key that is not a collection
         // we can skip the call to getAllKeys() and return an array with a single item
-        if (Boolean(mapping.key) && typeof mapping.key === 'string' && !mapping.key.endsWith('_') && OnyxCache_1.default.getAllKeys().has(mapping.key)) {
+        if (Boolean(mapping.key) && typeof mapping.key === 'string' && !isCollectionKey(mapping.key) && OnyxCache_1.default.getAllKeys().has(mapping.key)) {
             return new Set([mapping.key]);
         }
         return getAllKeys();

package/dist/useOnyx.js

@@ -26,7 +26,7 @@ function useOnyx(key, options) {
     const newValueRef = (0, react_1.useRef)(null);
     // Stores the previously result returned by the hook, containing the data from cache and the fetch status.
     // We initialize it to `undefined` and `loading` fetch status to simulate the initial result when the hook is loading from the cache.
-    // However, if `initWithStoredValues` is `true` we set the fetch status to `loaded` since we want to signal that data is ready.
+    // However, if `initWithStoredValues` is `false` we set the fetch status to `loaded` since we want to signal that data is ready.
     const resultRef = (0, react_1.useRef)([
         undefined,
         {
@@ -74,6 +74,10 @@ function useOnyx(key, options) {
     }, [key, options === null || options === void 0 ? void 0 : options.canEvict]);
     const getSnapshot = (0, react_1.useCallback)(() => {
         var _a, _b, _c;
+        // We return the initial result right away during the first connection if `initWithStoredValues` is set to `false`.
+        if (isFirstConnectionRef.current && (options === null || options === void 0 ? void 0 : options.initWithStoredValues) === false) {
+            return resultRef.current;
+        }
         // We get the value from cache while the first connection to Onyx is being made,
         // so we can return any cached value right away. After the connection is made, we only
         // update `newValueRef` when `Onyx.connect()` callback is fired.
@@ -123,7 +127,7 @@ function useOnyx(key, options) {
             resultRef.current = [previousValueRef.current, { status: newFetchStatus !== null && newFetchStatus !== void 0 ? newFetchStatus : 'loaded' }];
         }
         return resultRef.current;
-    }, [key, selectorRef, options === null || options === void 0 ? void 0 : options.allowStaleData, options === null || options === void 0 ? void 0 : options.initialValue]);
+    }, [key, selectorRef, options === null || options === void 0 ? void 0 : options.initWithStoredValues, options === null || options === void 0 ? void 0 : options.allowStaleData, options === null || options === void 0 ? void 0 : options.initialValue]);
     const subscribe = (0, react_1.useCallback)((onStoreChange) => {
         connectionRef.current = OnyxConnectionManager_1.default.connect({
             key,

package/package.json

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