react-native-onyx 3.0.87 → 3.0.89

package/dist/storage/providers/types.d.ts

@@ -1,5 +1,7 @@
+import type { ValueOf } from 'type-fest';
 import type { OnyxKey, OnyxValue } from '../../types';
 import type { FastMergeReplaceNullPatch } from '../../utils';
+import type { StorageErrorClass } from '../errors';
 type StorageKeyValuePair = [key: OnyxKey, value: OnyxValue<OnyxKey>, replaceNullPatches?: FastMergeReplaceNullPatch[]];
 type StorageKeyList = OnyxKey[];
 type DatabaseSize = {
@@ -68,6 +70,12 @@ type StorageProvider<TStore> = {
      * Gets the total bytes of the database file
      */
     getDatabaseSize: () => Promise<DatabaseSize>;
+    /**
+     * Classifies a write error from THIS engine into the shared {@link StorageErrorClass} taxonomy.
+     * Each provider owns its own matchers (IndexedDB DOMExceptions, SQLite messages, …) so the central
+     * taxonomy stays engine-agnostic. Anything the provider doesn't recognize must return UNKNOWN.
+     */
+    classifyError: (error: unknown) => ValueOf<typeof StorageErrorClass>;
     /**
      * @param onStorageKeyChanged Storage synchronization mechanism keeping all opened tabs in sync
      */

package/dist/types.d.ts

@@ -188,36 +188,20 @@ type BaseConnectOptions = {
 type DefaultConnectCallback<TKey extends OnyxKey> = (value: OnyxEntry<KeyValueMapping[TKey]>, key: TKey) => void;
 /** Represents the callback function used in `Onyx.connect()` method with a collection key. */
 type CollectionConnectCallback<TKey extends OnyxKey> = (value: NonUndefined<OnyxCollection<KeyValueMapping[TKey]>>, key: TKey, sourceValue?: OnyxValue<TKey>) => void;
-/** Represents the options used in `Onyx.connect()` method with a regular key. */
-type DefaultConnectOptions<TKey extends OnyxKey> = BaseConnectOptions & {
-    /** The Onyx key to subscribe to. */
-    key: TKey;
-    /** A function that will be called when the Onyx data we are subscribed changes. */
-    callback?: DefaultConnectCallback<TKey>;
-    /** If set to `true`, it will return the entire collection to the callback as a single object. */
-    waitForCollectionCallback?: false;
-};
-/** Represents the options used in `Onyx.connect()` method with a collection key. */
-type CollectionConnectOptions<TKey extends OnyxKey> = BaseConnectOptions & {
-    /** The Onyx key to subscribe to. */
-    key: TKey extends CollectionKeyBase ? TKey : never;
-    /** A function that will be called when the Onyx data we are subscribed changes. */
-    callback?: CollectionConnectCallback<TKey>;
-    /** If set to `true`, it will return the entire collection to the callback as a single object. */
-    waitForCollectionCallback: true;
-};
 /**
  * Represents the options used in `Onyx.connect()` method.
- * The type is built from `DefaultConnectOptions`/`CollectionConnectOptions` depending on the `waitForCollectionCallback` property.
- * It includes two different forms, depending on whether we are waiting for a collection callback or not.
- *
- * If `waitForCollectionCallback` is `true`, it expects `key` to be a Onyx collection key and `callback` will be triggered with the whole collection
- * and will pass `value` as an `OnyxCollection`.
  *
- * If `waitForCollectionCallback` is `false` or not specified, the `key` can be any Onyx key and `callback` will be triggered with updates of each collection item
- * and will pass `value` as an `OnyxEntry`.
+ * For a collection root key (e.g. `ONYXKEYS.COLLECTION.REPORT`), the callback fires
+ * with the entire collection object whenever any member changes (signature
+ * `(collection, key, sourceValue)`). For any other key, the callback fires with the value at
+ * that key (signature `(value, key)`).
  */
-type ConnectOptions<TKey extends OnyxKey> = DefaultConnectOptions<TKey> | CollectionConnectOptions<TKey>;
+type ConnectOptions<TKey extends OnyxKey> = BaseConnectOptions & {
+    /** The Onyx key to subscribe to. */
+    key: TKey;
+    /** A function that will be called when the Onyx data we are subscribed changes. */
+    callback?: (value: TKey extends CollectionKeyBase ? NonUndefined<OnyxCollection<KeyValueMapping[TKey]>> : OnyxEntry<KeyValueMapping[TKey]>, key: TKey, sourceValue?: TKey extends CollectionKeyBase ? NonUndefined<OnyxCollection<KeyValueMapping[TKey]>> : never) => void;
+};
 type CallbackToStateMapping<TKey extends OnyxKey> = ConnectOptions<TKey> & {
     subscriptionID: number;
 };
@@ -379,4 +363,4 @@ type MixedOperationsQueue = {
     mergeReplaceNullPatches: MultiMergeReplaceNullPatches;
     set: OnyxInputKeyValueMapping;
 };
-export type { BaseConnectOptions, Collection, CollectionConnectCallback, CollectionConnectOptions, CollectionKey, CollectionKeyBase, ConnectOptions, CustomTypeOptions, DeepRecord, DefaultConnectCallback, DefaultConnectOptions, ExtractOnyxCollectionValue, GenericFunction, InitOptions, Key, KeyValueMapping, CallbackToStateMapping, NonNull, NonUndefined, OnyxInputKeyValueMapping, NullishDeep, OnyxCollection, OnyxEntry, OnyxKey, OnyxInputValue, OnyxCollectionInputValue, OnyxInput, OnyxSetInput, OnyxMultiSetInput, OnyxMergeInput, OnyxMergeCollectionInput, OnyxSetCollectionInput, OnyxMethod, OnyxMethodMap, OnyxUpdate, OnyxValue, Selector, SetOptions, SetParams, SetCollectionParams, MergeCollectionWithPatchesParams, MultiMergeReplaceNullPatches, MixedOperationsQueue, RetriableOnyxOperation, };
+export type { BaseConnectOptions, Collection, CollectionConnectCallback, CollectionKey, CollectionKeyBase, ConnectOptions, CustomTypeOptions, DeepRecord, DefaultConnectCallback, ExtractOnyxCollectionValue, GenericFunction, InitOptions, Key, KeyValueMapping, CallbackToStateMapping, NonNull, NonUndefined, OnyxInputKeyValueMapping, NullishDeep, OnyxCollection, OnyxEntry, OnyxKey, OnyxInputValue, OnyxCollectionInputValue, OnyxInput, OnyxSetInput, OnyxMultiSetInput, OnyxMergeInput, OnyxMergeCollectionInput, OnyxSetCollectionInput, OnyxMethod, OnyxMethodMap, OnyxUpdate, OnyxValue, Selector, SetOptions, SetParams, SetCollectionParams, MergeCollectionWithPatchesParams, MultiMergeReplaceNullPatches, MixedOperationsQueue, RetriableOnyxOperation, };

package/dist/useOnyx.js

@@ -41,7 +41,6 @@ const react_1 = require("react");
 const OnyxCache_1 = __importStar(require("./OnyxCache"));
 const OnyxConnectionManager_1 = __importDefault(require("./OnyxConnectionManager"));
 const OnyxUtils_1 = __importDefault(require("./OnyxUtils"));
-const OnyxKeys_1 = __importDefault(require("./OnyxKeys"));
 const OnyxSnapshotCache_1 = __importDefault(require("./OnyxSnapshotCache"));
 const useLiveRef_1 = __importDefault(require("./useLiveRef"));
 function useOnyx(key, options, dependencies = []) {
@@ -232,7 +231,6 @@ function useOnyx(key, options, dependencies = []) {
                 // Finally, we signal that the store changed, making `getSnapshot()` be called again.
                 onStoreChange();
             },
-            waitForCollectionCallback: OnyxKeys_1.default.isCollectionKey(key),
             reuseConnection: options === null || options === void 0 ? void 0 : options.reuseConnection,
         });
         return () => {

package/package.json

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