react-native-onyx 2.0.99 → 2.0.100

package/dist/useOnyx.d.ts

@@ -49,10 +49,11 @@ type UseOnyxSelectorOption<TKey extends OnyxKey, TReturnValue> = {
 };
 type UseOnyxOptions<TKey extends OnyxKey, TReturnValue> = BaseUseOnyxOptions & UseOnyxInitialValueOption<TReturnValue> & UseOnyxSelectorOption<TKey, TReturnValue>;
 type FetchStatus = 'loading' | 'loaded';
-type ResultMetadata = {
+type ResultMetadata<TValue> = {
     status: FetchStatus;
+    sourceValue?: NonNullable<TValue> | undefined;
 };
-type UseOnyxResult<TValue> = [NonNullable<TValue> | undefined, ResultMetadata];
+type UseOnyxResult<TValue> = [NonNullable<TValue> | undefined, ResultMetadata<TValue>];
 declare function useOnyx<TKey extends OnyxKey, TReturnValue = OnyxValue<TKey>>(key: TKey, options?: BaseUseOnyxOptions & UseOnyxInitialValueOption<TReturnValue> & Required<UseOnyxSelectorOption<TKey, TReturnValue>>, dependencies?: DependencyList): UseOnyxResult<TReturnValue>;
 declare function useOnyx<TKey extends OnyxKey, TReturnValue = OnyxValue<TKey>>(key: TKey, options?: BaseUseOnyxOptions & UseOnyxInitialValueOption<NoInfer<TReturnValue>>, dependencies?: DependencyList): UseOnyxResult<TReturnValue>;
 export default useOnyx;

package/dist/useOnyx.js

@@ -87,6 +87,8 @@ function useOnyx(key, options, dependencies = []) {
     const onStoreChangeFnRef = (0, react_1.useRef)(null);
     // Indicates if we should get the newest cached value from Onyx during `getSnapshot()` execution.
     const shouldGetCachedValueRef = (0, react_1.useRef)(true);
+    // Inside useOnyx.ts, we need to track the sourceValue separately
+    const sourceValueRef = (0, react_1.useRef)(undefined);
     (0, react_1.useEffect)(() => {
         // These conditions will ensure we can only handle dynamic collection member keys from the same collection.
         if ((options === null || options === void 0 ? void 0 : options.allowDynamicKey) || previousKey === key) {
@@ -191,7 +193,13 @@ function useOnyx(key, options, dependencies = []) {
             previousValueRef.current = newValueRef.current;
             // If the new value is `null` we default it to `undefined` to ensure the consumer gets a consistent result from the hook.
             const newStatus = newFetchStatus !== null && newFetchStatus !== void 0 ? newFetchStatus : 'loaded';
-            resultRef.current = [(_c = previousValueRef.current) !== null && _c !== void 0 ? _c : undefined, { status: newStatus }];
+            resultRef.current = [
+                (_c = previousValueRef.current) !== null && _c !== void 0 ? _c : undefined,
+                {
+                    status: newStatus,
+                    sourceValue: sourceValueRef.current,
+                },
+            ];
             // If `canBeMissing` is set to `false` and the Onyx value of that key is not defined,
             // we log an alert so it can be acknowledged by the consumer. Additionally, we won't log alerts
             // if there's a `Onyx.clear()` task in progress.
@@ -206,7 +214,7 @@ function useOnyx(key, options, dependencies = []) {
         onStoreChangeFnRef.current = onStoreChange;
         connectionRef.current = OnyxConnectionManager_1.default.connect({
             key,
-            callback: () => {
+            callback: (value, callbackKey, sourceValue) => {
                 isConnectingRef.current = false;
                 onStoreChangeFnRef.current = onStoreChange;
                 // Signals that the first connection was made, so some logics in `getSnapshot()`
@@ -214,6 +222,8 @@ function useOnyx(key, options, dependencies = []) {
                 isFirstConnectionRef.current = false;
                 // Signals that we want to get the newest cached value again in `getSnapshot()`.
                 shouldGetCachedValueRef.current = true;
+                // sourceValue is unknown type, so we need to cast it to the correct type.
+                sourceValueRef.current = sourceValue;
                 // Finally, we signal that the store changed, making `getSnapshot()` be called again.
                 onStoreChange();
             },

package/package.json

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