reactfire 4.2.2 → 4.2.3-exp.4329c43

package/dist/useObservable.d.ts

@@ -1,7 +1,7 @@
 import { Observable } from 'rxjs';
 import { SuspenseSubject } from './SuspenseSubject';
 import { ReactFireOptions } from './';
-export declare function preloadObservable<T>(source: Observable<T>, id: string): SuspenseSubject<T>;
+export declare function preloadObservable<T>(source: Observable<T>, id: string, suspenseEnabled?: boolean): SuspenseSubject<T>;
 export interface ObservableStatus<T> {
     /**
      * The loading status.

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "4.2.2",
+  "version": "4.2.3-exp.4329c43",
   "license": "MIT",
   "type": "module",
   "main": "dist/index.umd.cjs",
@@ -36,7 +36,7 @@
     "docs:fork": "typedoc --options typedoc.json --gitRemote upstream && markdown-toc -i docs/use.md"
   },
   "peerDependencies": {
-    "firebase": "^9.0.0",
+    "firebase": "^9.0.0 || >=9.11.0-20220929164943 || next",
     "react": ">=16 || experimental"
   },
   "husky": {

package/src/SuspenseSubject.ts

@@ -15,7 +15,7 @@ export class SuspenseSubject<T> extends Subject<T> {
   // @ts-expect-error: TODO: double check to see if this is an RXJS thing or if we should listen to TS
   private _resolveFirstEmission: () => void;
 
-  constructor(innerObservable: Observable<T>, private _timeoutWindow: number) {
+  constructor(innerObservable: Observable<T>, private _timeoutWindow: number, private _suspenseEnabled: boolean) {
     super();
     this._firstEmission = new Promise<void>((resolve) => (this._resolveFirstEmission = resolve));
     this._innerObservable = innerObservable.pipe(
@@ -38,7 +38,13 @@ export class SuspenseSubject<T> extends Subject<T> {
 
     // set a timeout for resetting the cache, subscriptions will cancel the timeout
     // and reschedule again on unsubscribe
-    this._timeoutHandler = setTimeout(this._reset.bind(this), this._timeoutWindow);
+    if (this._suspenseEnabled) {
+      // Noop if suspense is enabled
+      console.log('SuspenseSubject: Suspense is enabled');
+      this._timeoutHandler = setTimeout(() => {}, this._timeoutWindow);
+    } else {
+      this._timeoutHandler = setTimeout(this._reset.bind(this), this._timeoutWindow);
+    }
   }
 
   get hasValue(): boolean {

package/src/auth.tsx

@@ -24,15 +24,8 @@ export function useUser<T = unknown>(options?: ReactFireOptions<T>): ObservableS
 
   const observableId = `auth:user:${auth.name}`;
   const observable$ = user(auth);
-  const _options: ReactFireOptions<T> = { ...options } ?? {};
 
-  // only set/override initialData if auth has finished loading
-  if (auth.currentUser !== undefined) {
-    _options.initialData = auth.currentUser;
-    _options.startWithValue = auth.currentUser;
-  }
-
-  return useObservable(observableId, observable$, _options);
+  return useObservable(observableId, observable$, options);
 }
 
 export function useIdTokenResult(user: User, forceRefresh: boolean = false, options?: ReactFireOptions<IdTokenResult>): ObservableStatus<IdTokenResult> {
@@ -117,15 +110,15 @@ export interface SignInCheckOptionsClaimsValidator extends SignInCheckOptionsBas
  *
  * ```ts
  * // pass in an object describing the custom claims a user must have
- * const {status, data: signInCheckResult} = useSignInCheck({requiredClaims: {admin: true}});
+ * const {status, data: signInCheckResult} = useSigninCheck({requiredClaims: {admin: true}});
  *
  * // pass in a custom claims validator function
- * const {status, data: signInCheckResult} = useSignInCheck({validateCustomClaims: (userClaims) => {
+ * const {status, data: signInCheckResult} = useSigninCheck({validateCustomClaims: (userClaims) => {
  *   // custom validation logic...
  * }});
  *
  * // You can optionally force-refresh the token
- * const {status, data: signInCheckResult} = useSignInCheck({forceRefresh: true, requiredClaims: {admin: true}});
+ * const {status, data: signInCheckResult} = useSigninCheck({forceRefresh: true, requiredClaims: {admin: true}});
  * ```
  */
 export function useSigninCheck(
@@ -180,7 +173,7 @@ export function useSigninCheck(
     })
   );
 
-  return useObservable(observableId, observable);
+  return useObservable(observableId, observable, options);
 }
 
 function getClaimsObjectValidator(requiredClaims: Claims): ClaimsValidator {
@@ -201,7 +194,7 @@ function getClaimsObjectValidator(requiredClaims: Claims): ClaimsValidator {
 }
 
 /**
- * @deprecated Use `useSignInCheck` instead
+ * @deprecated Use `useSigninCheck` instead
  *
  * Conditionally render children based on [custom claims](https://firebase.google.com/docs/auth/admin/custom-claims).
  *
@@ -238,7 +231,7 @@ export function ClaimsCheck({ user, fallback, children, requiredClaims }: Claims
 }
 
 /**
- * @deprecated Use `useSignInCheck` instead
+ * @deprecated Use `useSigninCheck` instead
  *
  * Conditionally render children based on signed-in status and [custom claims](https://firebase.google.com/docs/auth/admin/custom-claims).
  *

package/src/firestore.tsx

@@ -35,7 +35,7 @@ function getDocObservableId(ref: DocumentReference) {
 }
 
 /**
- * Suscribe to Firestore Document changes
+ * Subscribe to Firestore Document changes
  *
  * You can preload data for this hook by calling `preloadFirestoreDoc`
  */
@@ -57,7 +57,7 @@ export function useFirestoreDocOnce<T = DocumentData>(ref: DocumentReference<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 function useFirestoreDocData<T = unknown>(ref: DocumentReference<T>, options?: ReactFireOptions<T>): ObservableStatus<T> {
   const idField = options ? checkIdField(options) : 'NO_ID_FIELD';

package/src/useObservable.ts

@@ -16,11 +16,11 @@ if (!(globalThis as any as ReactFireGlobals)._reactFirePreloadedObservables) {
 // Starts listening to an Observable.
 // Call this once you know you're going to render a
 // child that will consume the observable
-export function preloadObservable<T>(source: Observable<T>, id: string) {
+export function preloadObservable<T>(source: Observable<T>, id: string, suspenseEnabled = false) {
   if (preloadedObservables.has(id)) {
     return preloadedObservables.get(id) as SuspenseSubject<T>;
   } else {
-    const observable = new SuspenseSubject(source, DEFAULT_TIMEOUT);
+    const observable = new SuspenseSubject(source, DEFAULT_TIMEOUT, suspenseEnabled);
     preloadedObservables.set(id, observable);
     return observable;
   }
@@ -97,12 +97,13 @@ export function useObservable<T = unknown>(observableId: string, source: Observa
   if (!observableId) {
     throw new Error('cannot call useObservable without an observableId');
   }
-  const observable = preloadObservable(source, observableId);
+  const suspenseEnabled = useSuspenseEnabledFromConfigAndContext(config.suspense);
+
+  const observable = preloadObservable(source, observableId, suspenseEnabled);
 
   // Suspend if suspense is enabled and no initial data exists
   const hasInitialData = config.hasOwnProperty('initialData') || config.hasOwnProperty('startWithValue');
   const hasData = observable.hasValue || hasInitialData;
-  const suspenseEnabled = useSuspenseEnabledFromConfigAndContext(config.suspense);
   if (suspenseEnabled === true && !hasData) {
     throw observable.firstEmission;
   }