reactfire 4.2.3 → 4.2.4

package/README.md

@@ -11,6 +11,10 @@ Firebase.
 - **Access Firebase libraries from any component** - Need the Firestore SDK? `useFirestore`. Remote Config? `useRemoteConfig`.
 - **Safely configure Firebase libraries** - Libraries like Firestore and Remote Config require settings like `enablePersistence` to be set before any data fetches are made. This can be tough to support in React's world of re-renders. ReactFire gives you `useInitFirestore` and `useInitRemoteConfig` hooks that guarantee they're set before anything else.
 
+## Platform support
+
+ReactFire is designed for **web React apps** and wraps the [Firebase Web SDK](https://firebase.google.com/docs/web/setup). It is not compatible with React Native or Expo. For React Native projects, use [react-native-firebase](https://rnfirebase.io/) instead.
+
 ## Install
 
 ```bash

package/dist/SuspenseSubject.d.ts

@@ -1,6 +1,8 @@
 import { Observable, Subject, Subscriber, Subscription } from 'rxjs';
+import { ObservableStatus } from './useObservable';
 export declare class SuspenseSubject<T> extends Subject<T> {
     private _timeoutWindow;
+    private _suspenseEnabled;
     private _value;
     private _hasValue;
     private _timeoutHandler;
@@ -8,14 +10,18 @@ export declare class SuspenseSubject<T> extends Subject<T> {
     private _error;
     private _innerObservable;
     private _warmupSubscription;
+    private _immutableStatus;
+    private _isComplete;
     private _innerSubscriber;
     private _resolveFirstEmission;
-    constructor(innerObservable: Observable<T>, _timeoutWindow: number);
+    constructor(innerObservable: Observable<T>, _timeoutWindow: number, _suspenseEnabled: boolean);
     get hasValue(): boolean;
     get value(): T;
     get firstEmission(): Promise<void>;
+    private _updateImmutableStatus;
     private _next;
     private _reset;
     _subscribe(subscriber: Subscriber<T>): Subscription;
     get ourError(): any;
+    get immutableStatus(): ObservableStatus<T>;
 }

package/dist/auth.d.ts

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import { ReactFireOptions, ObservableStatus } from './';
 import type { Auth, User, IdTokenResult } from 'firebase/auth';
-declare type Claims = IdTokenResult['claims'];
+type Claims = IdTokenResult['claims'];
 export declare function preloadUser(authResolver: () => Promise<Auth>): Promise<User | null | undefined>;
 /**
  * Subscribe to Firebase auth state changes, including token refresh
@@ -26,7 +26,7 @@ export interface ClaimsCheckProps {
 export interface ClaimCheckErrors {
     [key: string]: any[];
 }
-export declare type SigninCheckResult = {
+export type SigninCheckResult = {
     signedIn: false;
     hasRequiredClaims: false;
     errors: {};
@@ -92,7 +92,7 @@ export declare function useSigninCheck(options?: SignInCheckOptionsBasic | SignI
  *
  * Meant for Concurrent mode only (`<FirebaseAppProvider suspense=true />`). [More detail](https://github.com/FirebaseExtended/reactfire/issues/325#issuecomment-827654376).
  */
-export declare function ClaimsCheck({ user, fallback, children, requiredClaims }: ClaimsCheckProps): JSX.Element;
+export declare function ClaimsCheck({ user, fallback, children, requiredClaims }: ClaimsCheckProps): React.JSX.Element;
 /**
  * @deprecated Use `useSigninCheck` instead
  *
@@ -100,5 +100,5 @@ export declare function ClaimsCheck({ user, fallback, children, requiredClaims }
  *
  * Meant for Concurrent mode only (`<FirebaseAppProvider suspense=true />`). [More detail](https://github.com/FirebaseExtended/reactfire/issues/325#issuecomment-827654376).
  */
-export declare function AuthCheck({ fallback, children, requiredClaims }: AuthCheckProps): JSX.Element;
+export declare function AuthCheck({ fallback, children, requiredClaims }: AuthCheckProps): React.ReactElement;
 export {};

package/dist/firebaseApp.d.ts

@@ -1,14 +1,13 @@
 import * as React from 'react';
 import type { FirebaseApp, FirebaseOptions } from 'firebase/app';
-interface FirebaseAppProviderProps {
+export interface FirebaseAppProviderProps {
     firebaseApp?: FirebaseApp;
     firebaseConfig?: FirebaseOptions;
     appName?: string;
     suspense?: boolean;
 }
 export declare const version: string;
-export declare function FirebaseAppProvider(props: React.PropsWithChildren<FirebaseAppProviderProps>): JSX.Element;
+export declare function FirebaseAppProvider(props: React.PropsWithChildren<FirebaseAppProviderProps>): React.JSX.Element;
 export declare function useIsSuspenseEnabled(): boolean;
 export declare function useSuspenseEnabledFromConfigAndContext(suspenseFromConfig?: boolean): boolean;
 export declare function useFirebaseApp(): FirebaseApp;
-export {};

package/dist/firestore.d.ts

@@ -6,9 +6,9 @@ import { Query as FirestoreQuery, QuerySnapshot, DocumentReference, DocumentData
  *
  * Use this to warm up `useFirestoreDoc` for a specific document
  */
-export declare function preloadFirestoreDoc(refProvider: () => Promise<DocumentReference>): Promise<import("./SuspenseSubject").SuspenseSubject<DocumentSnapshot<DocumentData>>>;
+export declare function preloadFirestoreDoc(refProvider: () => Promise<DocumentReference>): Promise<import("./SuspenseSubject").SuspenseSubject<DocumentSnapshot<DocumentData, DocumentData>>>;
 /**
- * Suscribe to Firestore Document changes
+ * Subscribe to Firestore Document changes
  *
  * You can preload data for this hook by calling `preloadFirestoreDoc`
  */
@@ -18,13 +18,13 @@ export declare function useFirestoreDoc<T = DocumentData>(ref: DocumentReference
  */
 export declare function useFirestoreDocOnce<T = DocumentData>(ref: DocumentReference<T>, options?: ReactFireOptions<T>): ObservableStatus<DocumentSnapshot<T>>;
 /**
- * Suscribe to Firestore Document changes and unwrap the document into a plain object
+ * Subscribe to Firestore Document changes and unwrap the document into a plain object
  */
-export declare function useFirestoreDocData<T = unknown>(ref: DocumentReference<T>, options?: ReactFireOptions<T>): ObservableStatus<T>;
+export declare function useFirestoreDocData<T = unknown>(ref: DocumentReference<T>, options?: ReactFireOptions<T>): ObservableStatus<T | undefined>;
 /**
  * Get a Firestore document, unwrap the document into a plain object, and don't subscribe to changes
  */
-export declare function useFirestoreDocDataOnce<T = unknown>(ref: DocumentReference<T>, options?: ReactFireOptions<T>): ObservableStatus<T>;
+export declare function useFirestoreDocDataOnce<T = unknown>(ref: DocumentReference<T>, options?: ReactFireOptions<T>): ObservableStatus<T | undefined>;
 /**
  * Subscribe to a Firestore collection
  */

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { SuspenseSubject } from './SuspenseSubject';
 import type { Query as FirestoreQuery } from 'firebase/firestore';
 import type { Query as DatabaseQuery } from 'firebase/database';
-export declare type ReactFireGlobals = {
+export type ReactFireGlobals = {
     _reactFireDatabaseCachedQueries: Array<DatabaseQuery>;
     _reactFireFirestoreQueryCache: Array<FirestoreQuery>;
     _reactFirePreloadedObservables: Map<string, SuspenseSubject<any>>;