reactfire 4.2.3-exp.4329c43 → 4.2.3-exp.85cb2bb

package/dist/sdk.d.ts

@@ -20,34 +20,34 @@ export declare const FunctionsSdkContext: React.Context<Functions | undefined>;
 export declare const StorageSdkContext: React.Context<FirebaseStorage | undefined>;
 export declare const PerformanceSdkContext: React.Context<FirebasePerformance | undefined>;
 export declare const RemoteConfigSdkContext: React.Context<RemoteConfig | undefined>;
-declare type FirebaseSdks = Analytics | AppCheck | Auth | Database | Firestore | FirebasePerformance | FirebaseStorage | Functions | RemoteConfig;
+type FirebaseSdks = Analytics | AppCheck | Auth | Database | Firestore | FirebasePerformance | FirebaseStorage | Functions | RemoteConfig;
 export declare const AppCheckProvider: (props: React.PropsWithChildren<{
     sdk: AppCheck;
-}>) => JSX.Element;
+}>) => React.JSX.Element;
 export declare const AuthProvider: (props: React.PropsWithChildren<{
     sdk: Auth;
-}>) => JSX.Element;
+}>) => React.JSX.Element;
 export declare const AnalyticsProvider: (props: React.PropsWithChildren<{
     sdk: Analytics;
-}>) => JSX.Element;
+}>) => React.JSX.Element;
 export declare const DatabaseProvider: (props: React.PropsWithChildren<{
     sdk: Database;
-}>) => JSX.Element;
+}>) => React.JSX.Element;
 export declare const FirestoreProvider: (props: React.PropsWithChildren<{
     sdk: Firestore;
-}>) => JSX.Element;
+}>) => React.JSX.Element;
 export declare const FunctionsProvider: (props: React.PropsWithChildren<{
     sdk: Functions;
-}>) => JSX.Element;
+}>) => React.JSX.Element;
 export declare const PerformanceProvider: (props: React.PropsWithChildren<{
     sdk: FirebasePerformance;
-}>) => JSX.Element;
+}>) => React.JSX.Element;
 export declare const StorageProvider: (props: React.PropsWithChildren<{
     sdk: FirebaseStorage;
-}>) => JSX.Element;
+}>) => React.JSX.Element;
 export declare const RemoteConfigProvider: (props: React.PropsWithChildren<{
     sdk: RemoteConfig;
-}>) => JSX.Element;
+}>) => React.JSX.Element;
 export declare const useAppCheck: () => AppCheck;
 export declare const useAuth: () => Auth;
 export declare const useAnalytics: () => Analytics;
@@ -57,7 +57,7 @@ export declare const useFunctions: () => Functions;
 export declare const usePerformance: () => FirebasePerformance;
 export declare const useStorage: () => FirebaseStorage;
 export declare const useRemoteConfig: () => RemoteConfig;
-declare type InitSdkHook<Sdk extends FirebaseSdks> = (initializer: (firebaseApp: FirebaseApp) => Promise<Sdk>, options?: ReactFireOptions<Sdk>) => ObservableStatus<Sdk>;
+type InitSdkHook<Sdk extends FirebaseSdks> = (initializer: (firebaseApp: FirebaseApp) => Promise<Sdk>, options?: ReactFireOptions<Sdk>) => ObservableStatus<Sdk>;
 export declare const useInitAppCheck: InitSdkHook<AppCheck>;
 export declare const useInitAuth: InitSdkHook<Auth>;
 export declare const useInitAnalytics: InitSdkHook<Analytics>;

package/dist/storage.d.ts

@@ -16,11 +16,10 @@ export declare function useStorageTask<T = unknown>(task: UploadTask, ref: Stora
  * @param options
  */
 export declare function useStorageDownloadURL<T = string>(ref: StorageReference, options?: ReactFireOptions<T>): ObservableStatus<string | T>;
-declare type StorageImageProps = {
+export type StorageImageProps = {
     storagePath: string;
     storage?: FirebaseStorage;
     suspense?: boolean;
     placeHolder?: JSX.Element;
 };
-export declare function StorageImage(props: StorageImageProps & React.DetailedHTMLProps<React.ImgHTMLAttributes<HTMLImageElement>, HTMLImageElement>): JSX.Element;
-export {};
+export declare function StorageImage(props: StorageImageProps & React.DetailedHTMLProps<React.ImgHTMLAttributes<HTMLImageElement>, HTMLImageElement>): React.JSX.Element;

package/dist/useObservable.d.ts

@@ -2,7 +2,7 @@ import { Observable } from 'rxjs';
 import { SuspenseSubject } from './SuspenseSubject';
 import { ReactFireOptions } from './';
 export declare function preloadObservable<T>(source: Observable<T>, id: string, suspenseEnabled?: boolean): SuspenseSubject<T>;
-export interface ObservableStatus<T> {
+interface ObservableStatusBase<T> {
     /**
      * The loading status.
      *
@@ -28,7 +28,7 @@ export interface ObservableStatus<T> {
      *
      * If `initialData` is passed in, the first value of `data` will be the valuea provided in `initialData` **UNLESS** the underlying observable is ready, in which case it will skip `initialData`.
      */
-    data: T;
+    data: T | undefined;
     /**
      * Any error that may have occurred in the underlying observable
      */
@@ -38,4 +38,20 @@ export interface ObservableStatus<T> {
      */
     firstValuePromise: Promise<void>;
 }
+export interface ObservableStatusSuccess<T> extends ObservableStatusBase<T> {
+    status: 'success';
+    data: T;
+}
+export interface ObservableStatusError<T> extends ObservableStatusBase<T> {
+    status: 'error';
+    isComplete: true;
+    error: Error;
+}
+export interface ObservableStatusLoading<T> extends ObservableStatusBase<T> {
+    status: 'loading';
+    data: undefined;
+    hasEmitted: false;
+}
+export type ObservableStatus<T> = ObservableStatusLoading<T> | ObservableStatusError<T> | ObservableStatusSuccess<T>;
 export declare function useObservable<T = unknown>(observableId: string, source: Observable<T>, config?: ReactFireOptions): ObservableStatus<T>;
+export {};

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "4.2.3-exp.4329c43",
+  "version": "4.2.3-exp.85cb2bb",
   "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 || >=9.11.0-20220929164943 || next",
+    "firebase": "^9.0.0 || next",
     "react": ">=16 || experimental"
   },
   "husky": {
@@ -71,43 +71,44 @@
     }
   ],
   "devDependencies": {
-    "@rollup/plugin-typescript": "^8.3.4",
-    "@size-limit/preset-small-lib": "^7.0.8",
-    "@testing-library/jest-dom": "^5.16.4",
-    "@testing-library/react": "^12.1.5",
-    "@testing-library/react-hooks": "^8.0.1",
-    "@types/react": "^17.0.2",
-    "@types/react-dom": "^17.0.2",
-    "@typescript-eslint/eslint-plugin": "^5.32.0",
-    "@typescript-eslint/parser": "^5.32.0",
-    "@vitejs/plugin-react": "^2.0.0",
-    "@vitest/ui": "^0.20.3",
-    "cross-fetch": "^3.1.5",
-    "eslint": "^8.20.0",
-    "eslint-plugin-no-only-tests": "^2.6.0",
-    "eslint-plugin-react": "^7.30.1",
+    "@rollup/plugin-typescript": "^11.1.1",
+    "@size-limit/preset-small-lib": "^8.2.6",
+    "@testing-library/jest-dom": "^5.16.5",
+    "@testing-library/react": "^14.0.0",
+    "@types/react": "^18.2.0",
+    "@types/react-dom": "^18.2.0",
+    "@types/use-sync-external-store": "^0.0.3",
+    "@typescript-eslint/eslint-plugin": "^5.60.1",
+    "@typescript-eslint/parser": "^5.60.1",
+    "@vitejs/plugin-react": "^4.0.1",
+    "@vitest/ui": "^0.32.2",
+    "cross-fetch": "^3.1.6",
+    "eslint": "^8.43.0",
+    "eslint-plugin-no-only-tests": "^3.1.0",
+    "eslint-plugin-react": "^7.32.2",
     "eslint-plugin-react-hooks": "^4.6.0",
     "firebase": "^9.9.0",
-    "firebase-tools": "^11.3.0",
+    "firebase-tools": "^12.4.0",
     "globalthis": "^1.0.3",
-    "husky": "^8.0.1",
-    "jest-environment-jsdom": "^28.1.3",
-    "jsdom": "^20.0.0",
+    "husky": "^8.0.3",
+    "jest-environment-jsdom": "^29.5.0",
+    "jsdom": "^22.1.0",
     "markdown-toc": "^1.2.0",
-    "prettier": "^2.7.1",
-    "react": "^17.0.2",
-    "react-dom": "^17.0.2",
-    "react-test-renderer": "^17.0.2",
-    "rollup-plugin-visualizer": "^5.7.1",
-    "size-limit": "^7.0.8",
-    "typedoc": "^0.23.8",
-    "typedoc-plugin-markdown": "^3.13.3",
-    "typescript": "^4.7.4",
-    "vite": "^3.0.2",
-    "vitest": "^0.18.1"
+    "prettier": "^2.8.8",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "react-test-renderer": "^18.2.0",
+    "rollup-plugin-visualizer": "^5.9.2",
+    "size-limit": "^8.2.6",
+    "typedoc": "^0.24.8",
+    "typedoc-plugin-markdown": "^3.15.3",
+    "typescript": "^5.1.3",
+    "vite": "^4.3.9",
+    "vitest": "^0.32.2"
   },
   "dependencies": {
     "rxfire": "^6.0.3",
-    "rxjs": "^6.6.3 || ^7.0.1"
+    "rxjs": "^6.6.3 || ^7.0.1",
+    "use-sync-external-store": "^1.2.0"
   }
 }

package/src/SuspenseSubject.ts

@@ -1,5 +1,6 @@
 import { empty, Observable, Subject, Subscriber, Subscription } from 'rxjs';
 import { catchError, shareReplay, tap } from 'rxjs/operators';
+import { ObservableStatus } from './useObservable';
 
 export class SuspenseSubject<T> extends Subject<T> {
   private _value: T | undefined;
@@ -9,6 +10,8 @@ export class SuspenseSubject<T> extends Subject<T> {
   private _error: any = undefined;
   private _innerObservable: Observable<T>;
   private _warmupSubscription: Subscription;
+  private _immutableStatus: ObservableStatus<T>;
+  private _isComplete = false;
 
   // @ts-expect-error: TODO: double check to see if this is an RXJS thing or if we should listen to TS
   private _innerSubscriber: Subscription;
@@ -18,6 +21,16 @@ export class SuspenseSubject<T> extends Subject<T> {
   constructor(innerObservable: Observable<T>, private _timeoutWindow: number, private _suspenseEnabled: boolean) {
     super();
     this._firstEmission = new Promise<void>((resolve) => (this._resolveFirstEmission = resolve));
+
+    this._immutableStatus = {
+      status: 'loading',
+      hasEmitted: false,
+      isComplete: false,
+      data: undefined,
+      error: undefined,
+      firstValuePromise: this._firstEmission
+    };
+
     this._innerObservable = innerObservable.pipe(
       tap({
         next: (v) => {
@@ -28,7 +41,12 @@ export class SuspenseSubject<T> extends Subject<T> {
           // resolve the promise, so suspense tries again
           this._error = e;
           this._resolveFirstEmission();
+          this._updateImmutableStatus();
         },
+        complete: () => {
+          this._isComplete = true;
+          this._updateImmutableStatus();
+        }
       }),
       catchError(() => empty()),
       shareReplay(1)
@@ -40,7 +58,6 @@ export class SuspenseSubject<T> extends Subject<T> {
     // and reschedule again on unsubscribe
     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);
@@ -70,10 +87,27 @@ export class SuspenseSubject<T> extends Subject<T> {
     return this._firstEmission;
   }
 
+  private _updateImmutableStatus() {
+    // @ts-expect-error
+    // TS fails here because ObservableStatus defines specific
+    // relationships between the fields. This is difficult to
+    // code for here, so the relationships between the ObservableStatus fields
+    // are mostly checked in tests instead
+    this._immutableStatus = {
+      status: this._error ? 'error' : (this._hasValue ? 'success' : 'loading'),
+      hasEmitted: this._hasValue,
+      isComplete: this._isComplete,
+      data: this._value,
+      error: this._error,
+      firstValuePromise: this._firstEmission
+    };
+  }
+
   private _next(value: T) {
     this._hasValue = true;
     this._value = value;
     this._resolveFirstEmission();
+    this._updateImmutableStatus();
   }
 
   private _reset() {
@@ -85,6 +119,7 @@ export class SuspenseSubject<T> extends Subject<T> {
     this._value = undefined;
     this._error = undefined;
     this._firstEmission = new Promise<void>((resolve) => (this._resolveFirstEmission = resolve));
+    this._updateImmutableStatus();
   }
 
   _subscribe(subscriber: Subscriber<T>): Subscription {
@@ -98,4 +133,8 @@ export class SuspenseSubject<T> extends Subject<T> {
   get ourError() {
     return this._error;
   }
+
+  get immutableStatus() {
+    return this._immutableStatus;
+  }
 }

package/src/auth.tsx

@@ -28,7 +28,7 @@ export function useUser<T = unknown>(options?: ReactFireOptions<T>): ObservableS
   return useObservable(observableId, observable$, options);
 }
 
-export function useIdTokenResult(user: User, forceRefresh: boolean = false, options?: ReactFireOptions<IdTokenResult>): ObservableStatus<IdTokenResult> {
+export function useIdTokenResult(user: User, forceRefresh = false, options?: ReactFireOptions<IdTokenResult>): ObservableStatus<IdTokenResult> {
   if (!user) {
     throw new Error('you must provide a user');
   }
@@ -201,7 +201,14 @@ function getClaimsObjectValidator(requiredClaims: Claims): ClaimsValidator {
  * Meant for Concurrent mode only (`<FirebaseAppProvider suspense=true />`). [More detail](https://github.com/FirebaseExtended/reactfire/issues/325#issuecomment-827654376).
  */
 export function ClaimsCheck({ user, fallback, children, requiredClaims }: ClaimsCheckProps) {
-  const { data } = useIdTokenResult(user, false);
+  const { data, status, error } = useIdTokenResult(user, false);
+  
+  if (status === 'loading') {
+    throw new Error('ClaimsCheck must be run in Suspense mode');
+  } else if (status === 'error') {
+    throw error
+  }
+
   const { claims } = data;
   const missingClaims: { [key: string]: { expected: string; actual: string | undefined } } = {};
 

package/src/firebaseApp.tsx

@@ -9,7 +9,7 @@ const DEFAULT_APP_NAME = '[DEFAULT]';
 const FirebaseAppContext = React.createContext<FirebaseApp | undefined>(undefined);
 const SuspenseEnabledContext = React.createContext<boolean>(false);
 
-interface FirebaseAppProviderProps {
+export interface FirebaseAppProviderProps {
   firebaseApp?: FirebaseApp;
   firebaseConfig?: FirebaseOptions;
   appName?: string;
@@ -65,7 +65,7 @@ export function useIsSuspenseEnabled(): boolean {
 }
 
 export function useSuspenseEnabledFromConfigAndContext(suspenseFromConfig?: boolean): boolean {
-  let suspenseFromContext = React.useContext(SuspenseEnabledContext);
+  const suspenseFromContext = React.useContext(SuspenseEnabledContext);
 
   // prioritize config over context
   if (suspenseFromConfig !== undefined) {

package/src/firestore.tsx

@@ -6,13 +6,13 @@ import { first } from 'rxjs/operators';
 import { Query as FirestoreQuery, QuerySnapshot, DocumentReference, queryEqual, DocumentData, DocumentSnapshot } from 'firebase/firestore';
 
 // Since we're side-effect free, we need to ensure our observableId cache is global
-const cachedQueries: Array<FirestoreQuery> = (globalThis as any as ReactFireGlobals)._reactFireFirestoreQueryCache || [];
+const cachedQueries: Array<FirestoreQuery<any>> = (globalThis as any as ReactFireGlobals)._reactFireFirestoreQueryCache || [];
 
 if (!(globalThis as any as ReactFireGlobals)._reactFireFirestoreQueryCache) {
   (globalThis as any as ReactFireGlobals)._reactFireFirestoreQueryCache = cachedQueries;
 }
 
-function getUniqueIdForFirestoreQuery(query: FirestoreQuery) {
+function getUniqueIdForFirestoreQuery<T = DocumentData>(query: FirestoreQuery<T>) {
   const index = cachedQueries.findIndex((cachedQuery) => queryEqual(cachedQuery, query));
   if (index > -1) {
     return index;
@@ -30,7 +30,7 @@ export async function preloadFirestoreDoc(refProvider: () => Promise<DocumentRef
   return preloadObservable(doc(ref), getDocObservableId(ref));
 }
 
-function getDocObservableId(ref: DocumentReference) {
+function getDocObservableId<T = DocumentData>(ref: DocumentReference<T>) {
   return `firestore:doc:${ref.firestore.app.name}:${ref.path}`;
 }
 

package/src/storage.tsx

@@ -33,7 +33,7 @@ export function useStorageDownloadURL<T = string>(ref: StorageReference, options
   return useObservable(observableId, observable$, options);
 }
 
-type StorageImageProps = {
+export type StorageImageProps = {
   storagePath: string;
   storage?: FirebaseStorage;
   suspense?: boolean;
@@ -49,7 +49,7 @@ function StorageFromContext(props: StorageImageProps & React.DetailedHTMLProps<R
 }
 
 function INTERNALStorageImage(props: StorageImageProps & React.DetailedHTMLProps<React.ImgHTMLAttributes<HTMLImageElement>, HTMLImageElement>): JSX.Element {
-  let { storage, storagePath, suspense, placeHolder, ...imgProps } = props;
+  const { storage, storagePath, suspense, placeHolder, ...imgProps } = props;
 
   const reactfireOptions: ReactFireOptions<string> = {
     suspense: useSuspenseEnabledFromConfigAndContext(suspense),
@@ -76,7 +76,7 @@ function INTERNALStorageImage(props: StorageImageProps & React.DetailedHTMLProps
 }
 
 export function StorageImage(props: StorageImageProps & React.DetailedHTMLProps<React.ImgHTMLAttributes<HTMLImageElement>, HTMLImageElement>) {
-  let { storage } = props;
+  const { storage } = props;
 
   if (storage) {
     return <INTERNALStorageImage {...props} />;

package/src/useObservable.ts

@@ -1,4 +1,5 @@
 import * as React from 'react';
+import { useSyncExternalStore } from 'use-sync-external-store/shim';
 import { Observable } from 'rxjs';
 import { SuspenseSubject } from './SuspenseSubject';
 import { useSuspenseEnabledFromConfigAndContext } from './firebaseApp';
@@ -26,7 +27,7 @@ export function preloadObservable<T>(source: Observable<T>, id: string, suspense
   }
 }
 
-export interface ObservableStatus<T> {
+interface ObservableStatusBase<T> {
   /**
    * The loading status.
    *
@@ -52,7 +53,7 @@ export interface ObservableStatus<T> {
    *
    * If `initialData` is passed in, the first value of `data` will be the valuea provided in `initialData` **UNLESS** the underlying observable is ready, in which case it will skip `initialData`.
    */
-  data: T;
+  data: T | undefined;
   /**
    * Any error that may have occurred in the underlying observable
    */
@@ -63,42 +64,33 @@ export interface ObservableStatus<T> {
   firstValuePromise: Promise<void>;
 }
 
-function reducerFactory<T>(observable: SuspenseSubject<T>) {
-  return function reducer(state: ObservableStatus<T>, action: 'value' | 'error' | 'complete'): ObservableStatus<T> {
-    // always make sure these values are in sync with the observable
-    const newState = {
-      ...state,
-      hasEmitted: state.hasEmitted || observable.hasValue,
-      error: observable.ourError,
-      firstValuePromise: observable.firstEmission,
-    };
-    if (observable.hasValue) {
-      newState.data = observable.value;
-    }
-
-    switch (action) {
-      case 'value':
-        newState.status = 'success';
-        return newState;
-      case 'error':
-        newState.status = 'error';
-        return newState;
-      case 'complete':
-        newState.isComplete = true;
-        return newState;
-      default:
-        throw new Error(`invalid action "${action}"`);
-    }
-  };
+export interface ObservableStatusSuccess<T> extends ObservableStatusBase<T> {
+  status: 'success';
+  data: T;
 }
 
+export interface ObservableStatusError<T> extends ObservableStatusBase<T> {
+  status: 'error';
+  isComplete: true;
+  error: Error;
+}
+
+export interface ObservableStatusLoading<T> extends ObservableStatusBase<T> {
+  status: 'loading';
+  data: undefined;
+  hasEmitted: false;
+}
+
+export type ObservableStatus<T> = ObservableStatusLoading<T> | ObservableStatusError<T> | ObservableStatusSuccess<T>;
+
 export function useObservable<T = unknown>(observableId: string, source: Observable<T>, config: ReactFireOptions = {}): ObservableStatus<T> {
-  // Register the observable with the cache
   if (!observableId) {
     throw new Error('cannot call useObservable without an observableId');
   }
+
   const suspenseEnabled = useSuspenseEnabledFromConfigAndContext(config.suspense);
 
+  // Register the observable with the cache
   const observable = preloadObservable(source, observableId, suspenseEnabled);
 
   // Suspend if suspense is enabled and no initial data exists
@@ -108,31 +100,43 @@ export function useObservable<T = unknown>(observableId: string, source: Observa
     throw observable.firstEmission;
   }
 
-  const initialState: ObservableStatus<T> = {
-    status: hasData ? 'success' : 'loading',
-    hasEmitted: hasData,
-    isComplete: false,
-    data: observable.hasValue ? observable.value : config?.initialData ?? config?.startWithValue,
-    error: observable.ourError,
-    firstValuePromise: observable.firstEmission,
-  };
-  const [status, dispatch] = React.useReducer<React.Reducer<ObservableStatus<T>, 'value' | 'error' | 'complete'>>(reducerFactory<T>(observable), initialState);
-
-  React.useEffect(() => {
-    const subscription = observable.subscribe({
-      next: () => {
-        dispatch('value');
-      },
-      error: (e) => {
-        dispatch('error');
-        throw e;
-      },
-      complete: () => {
-        dispatch('complete');
-      },
-    });
-    return () => subscription.unsubscribe();
+  const subscribe = React.useCallback((onStoreChange: () => void) => {
+      const subscription = observable.subscribe({
+        next: () => {
+          onStoreChange();
+        },
+        error: (e) => {
+          onStoreChange();
+          throw e;
+        },
+        complete: () => {
+          onStoreChange();
+        },
+      });
+
+      return () => {
+        subscription.unsubscribe();
+      }
+  }, [observable])
+
+  const getSnapshot = React.useCallback<() => ObservableStatus<T>>(() => {
+    return observable.immutableStatus;
   }, [observable]);
 
-  return status;
+  const update = useSyncExternalStore(subscribe, getSnapshot);
+
+  // modify the value if initialData exists
+  if (!observable.hasValue && hasData) {
+    update.data = config?.initialData ?? config?.startWithValue;
+    update.status = 'success';
+    update.hasEmitted = true;
+  }
+
+  // throw an error if there is an error
+  // TODO(jhuleatt) this is the current, tested-for, behavior. But do we actually want it?
+  if (update.error) {
+    throw update.error;
+  }
+
+  return update;
 }