reactfire 4.2.1 → 4.2.3-exp.9754f86

package/dist/sdk.d.ts

@@ -1,70 +1,70 @@
-import * as React from 'react';
-import type { AppCheck } from 'firebase/app-check';
-import type { Auth } from 'firebase/auth';
-import type { Analytics } from 'firebase/analytics';
-import type { Database } from 'firebase/database';
-import type { Firestore } from 'firebase/firestore';
-import type { Functions } from 'firebase/functions';
-import type { FirebasePerformance } from 'firebase/performance';
-import type { FirebaseStorage } from 'firebase/storage';
-import type { RemoteConfig } from 'firebase/remote-config';
-import { FirebaseApp } from 'firebase/app';
-import { ObservableStatus } from './useObservable';
-import { ReactFireOptions } from '.';
-export declare const AppCheckSdkContext: React.Context<AppCheck | undefined>;
-export declare const AuthSdkContext: React.Context<Auth | undefined>;
-export declare const AnalyticsSdkContext: React.Context<Analytics | undefined>;
-export declare const DatabaseSdkContext: React.Context<Database | undefined>;
-export declare const FirestoreSdkContext: React.Context<Firestore | undefined>;
-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;
-export declare const AppCheckProvider: (props: React.PropsWithChildren<{
-    sdk: AppCheck;
-}>) => JSX.Element;
-export declare const AuthProvider: (props: React.PropsWithChildren<{
-    sdk: Auth;
-}>) => JSX.Element;
-export declare const AnalyticsProvider: (props: React.PropsWithChildren<{
-    sdk: Analytics;
-}>) => JSX.Element;
-export declare const DatabaseProvider: (props: React.PropsWithChildren<{
-    sdk: Database;
-}>) => JSX.Element;
-export declare const FirestoreProvider: (props: React.PropsWithChildren<{
-    sdk: Firestore;
-}>) => JSX.Element;
-export declare const FunctionsProvider: (props: React.PropsWithChildren<{
-    sdk: Functions;
-}>) => JSX.Element;
-export declare const PerformanceProvider: (props: React.PropsWithChildren<{
-    sdk: FirebasePerformance;
-}>) => JSX.Element;
-export declare const StorageProvider: (props: React.PropsWithChildren<{
-    sdk: FirebaseStorage;
-}>) => JSX.Element;
-export declare const RemoteConfigProvider: (props: React.PropsWithChildren<{
-    sdk: RemoteConfig;
-}>) => JSX.Element;
-export declare const useAppCheck: () => AppCheck;
-export declare const useAuth: () => Auth;
-export declare const useAnalytics: () => Analytics;
-export declare const useDatabase: () => Database;
-export declare const useFirestore: () => Firestore;
-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>;
-export declare const useInitAppCheck: InitSdkHook<AppCheck>;
-export declare const useInitAuth: InitSdkHook<Auth>;
-export declare const useInitAnalytics: InitSdkHook<Analytics>;
-export declare const useInitDatabase: InitSdkHook<Database>;
-export declare const useInitFirestore: InitSdkHook<Firestore>;
-export declare const useInitFunctions: InitSdkHook<Functions>;
-export declare const useInitPerformance: InitSdkHook<FirebasePerformance>;
-export declare const useInitRemoteConfig: InitSdkHook<RemoteConfig>;
-export declare const useInitStorage: InitSdkHook<FirebaseStorage>;
-export {};
+import * as React from 'react';
+import type { AppCheck } from 'firebase/app-check';
+import type { Auth } from 'firebase/auth';
+import type { Analytics } from 'firebase/analytics';
+import type { Database } from 'firebase/database';
+import type { Firestore } from 'firebase/firestore';
+import type { Functions } from 'firebase/functions';
+import type { FirebasePerformance } from 'firebase/performance';
+import type { FirebaseStorage } from 'firebase/storage';
+import type { RemoteConfig } from 'firebase/remote-config';
+import { FirebaseApp } from 'firebase/app';
+import { ObservableStatus } from './useObservable';
+import { ReactFireOptions } from '.';
+export declare const AppCheckSdkContext: React.Context<AppCheck | undefined>;
+export declare const AuthSdkContext: React.Context<Auth | undefined>;
+export declare const AnalyticsSdkContext: React.Context<Analytics | undefined>;
+export declare const DatabaseSdkContext: React.Context<Database | undefined>;
+export declare const FirestoreSdkContext: React.Context<Firestore | undefined>;
+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;
+export declare const AppCheckProvider: (props: React.PropsWithChildren<{
+    sdk: AppCheck;
+}>) => JSX.Element;
+export declare const AuthProvider: (props: React.PropsWithChildren<{
+    sdk: Auth;
+}>) => JSX.Element;
+export declare const AnalyticsProvider: (props: React.PropsWithChildren<{
+    sdk: Analytics;
+}>) => JSX.Element;
+export declare const DatabaseProvider: (props: React.PropsWithChildren<{
+    sdk: Database;
+}>) => JSX.Element;
+export declare const FirestoreProvider: (props: React.PropsWithChildren<{
+    sdk: Firestore;
+}>) => JSX.Element;
+export declare const FunctionsProvider: (props: React.PropsWithChildren<{
+    sdk: Functions;
+}>) => JSX.Element;
+export declare const PerformanceProvider: (props: React.PropsWithChildren<{
+    sdk: FirebasePerformance;
+}>) => JSX.Element;
+export declare const StorageProvider: (props: React.PropsWithChildren<{
+    sdk: FirebaseStorage;
+}>) => JSX.Element;
+export declare const RemoteConfigProvider: (props: React.PropsWithChildren<{
+    sdk: RemoteConfig;
+}>) => JSX.Element;
+export declare const useAppCheck: () => AppCheck;
+export declare const useAuth: () => Auth;
+export declare const useAnalytics: () => Analytics;
+export declare const useDatabase: () => Database;
+export declare const useFirestore: () => Firestore;
+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>;
+export declare const useInitAppCheck: InitSdkHook<AppCheck>;
+export declare const useInitAuth: InitSdkHook<Auth>;
+export declare const useInitAnalytics: InitSdkHook<Analytics>;
+export declare const useInitDatabase: InitSdkHook<Database>;
+export declare const useInitFirestore: InitSdkHook<Firestore>;
+export declare const useInitFunctions: InitSdkHook<Functions>;
+export declare const useInitPerformance: InitSdkHook<FirebasePerformance>;
+export declare const useInitRemoteConfig: InitSdkHook<RemoteConfig>;
+export declare const useInitStorage: InitSdkHook<FirebaseStorage>;
+export {};

package/dist/storage.d.ts

@@ -1,26 +1,26 @@
-import * as React from 'react';
-import { ReactFireOptions, ObservableStatus } from './';
-import type { UploadTask, UploadTaskSnapshot, StorageReference, FirebaseStorage } from 'firebase/storage';
-/**
- * Subscribe to the progress of a storage task
- *
- * @param task - the task you want to listen to
- * @param ref - reference to the blob the task is acting on
- * @param options
- */
-export declare function useStorageTask<T = unknown>(task: UploadTask, ref: StorageReference, options?: ReactFireOptions<T>): ObservableStatus<UploadTaskSnapshot | T>;
-/**
- * Subscribe to a storage ref's download URL
- *
- * @param ref - reference to the blob you want to download
- * @param options
- */
-export declare function useStorageDownloadURL<T = string>(ref: StorageReference, options?: ReactFireOptions<T>): ObservableStatus<string | T>;
-declare 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 {};
+import * as React from 'react';
+import { ReactFireOptions, ObservableStatus } from './';
+import type { UploadTask, UploadTaskSnapshot, StorageReference, FirebaseStorage } from 'firebase/storage';
+/**
+ * Subscribe to the progress of a storage task
+ *
+ * @param task - the task you want to listen to
+ * @param ref - reference to the blob the task is acting on
+ * @param options
+ */
+export declare function useStorageTask<T = unknown>(task: UploadTask, ref: StorageReference, options?: ReactFireOptions<T>): ObservableStatus<UploadTaskSnapshot | T>;
+/**
+ * Subscribe to a storage ref's download URL
+ *
+ * @param ref - reference to the blob you want to download
+ * @param options
+ */
+export declare function useStorageDownloadURL<T = string>(ref: StorageReference, options?: ReactFireOptions<T>): ObservableStatus<string | T>;
+declare 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 {};

package/dist/useObservable.d.ts

@@ -1,41 +1,41 @@
-import { Observable } from 'rxjs';
-import { SuspenseSubject } from './SuspenseSubject';
-import { ReactFireOptions } from './';
-export declare function preloadObservable<T>(source: Observable<T>, id: string): SuspenseSubject<T>;
-export interface ObservableStatus<T> {
-    /**
-     * The loading status.
-     *
-     * - `loading`: Waiting for the first value from an observable
-     * - `error`: Something went wrong. Check `ObservableStatus.error` for more details
-     * - `success`: The hook has emitted at least one value
-     *
-     * If `initialData` is passed in, this will skip `loading` and go straight to `success`.
-     */
-    status: 'loading' | 'error' | 'success';
-    /**
-     * Indicates whether the hook has emitted a value at some point
-     *
-     * If `initialData` is passed in, this will be `true`.
-     */
-    hasEmitted: boolean;
-    /**
-     * If this is `true`, the hook will be emitting no further items.
-     */
-    isComplete: boolean;
-    /**
-     * The most recent value.
-     *
-     * 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;
-    /**
-     * Any error that may have occurred in the underlying observable
-     */
-    error: Error | undefined;
-    /**
-     * Promise that resolves after first emit from observable
-     */
-    firstValuePromise: Promise<void>;
-}
-export declare function useObservable<T = unknown>(observableId: string, source: Observable<T>, config?: ReactFireOptions): ObservableStatus<T>;
+import { Observable } from 'rxjs';
+import { SuspenseSubject } from './SuspenseSubject';
+import { ReactFireOptions } from './';
+export declare function preloadObservable<T>(source: Observable<T>, id: string): SuspenseSubject<T>;
+export interface ObservableStatus<T> {
+    /**
+     * The loading status.
+     *
+     * - `loading`: Waiting for the first value from an observable
+     * - `error`: Something went wrong. Check `ObservableStatus.error` for more details
+     * - `success`: The hook has emitted at least one value
+     *
+     * If `initialData` is passed in, this will skip `loading` and go straight to `success`.
+     */
+    status: 'loading' | 'error' | 'success';
+    /**
+     * Indicates whether the hook has emitted a value at some point
+     *
+     * If `initialData` is passed in, this will be `true`.
+     */
+    hasEmitted: boolean;
+    /**
+     * If this is `true`, the hook will be emitting no further items.
+     */
+    isComplete: boolean;
+    /**
+     * The most recent value.
+     *
+     * 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;
+    /**
+     * Any error that may have occurred in the underlying observable
+     */
+    error: Error | undefined;
+    /**
+     * Promise that resolves after first emit from observable
+     */
+    firstValuePromise: Promise<void>;
+}
+export declare function useObservable<T = unknown>(observableId: string, source: Observable<T>, config?: ReactFireOptions): ObservableStatus<T>;

package/package.json

@@ -1,27 +1,35 @@
 {
-  "version": "4.2.1",
+  "version": "4.2.3-exp.9754f86",
   "license": "MIT",
-  "main": "dist/index.js",
+  "type": "module",
+  "main": "dist/index.umd.cjs",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.umd.cjs"
+    }
+  },
   "typings": "dist/index.d.ts",
   "files": [
     "dist",
     "src"
   ],
   "engines": {
-    "node": ">=10"
+    "node": ">=14"
   },
   "scripts": {
-    "start": "tsdx watch",
-    "build": "tsdx build",
-    "test:tsdx": "tsdx test",
-    "test": "firebase emulators:exec --project=rxfire-525a3 \"tsdx test\"",
-    "test:firestore": "firebase emulators:exec --only firestore --project=rxfire-525a3 \"tsdx test firestore --verbose\"",
-    "test:database": "firebase emulators:exec --only database --project=rxfire-525a3 \"tsdx test database --verbose\"",
-    "test:auth": "firebase emulators:exec --only auth --project=rxfire-525a3 \"tsdx test auth --verbose\"",
-    "test:functions": "firebase emulators:exec --only functions --project=rxfire-525a3 \"tsdx test functions --verbose\"",
-    "test:storage": "firebase emulators:exec --only storage --project=rxfire-525a3 \"tsdx test storage --verbose\"",
-    "test:useObservable": "tsdx test useObservable --verbose",
-    "lint": "tsdx lint src test",
+    "start": "firebase emulators:exec --project=rxfire-525a3 \"vitest --ui\"",
+    "build": "tsc && vite build && npm run docs",
+    "test": "firebase emulators:exec --project=rxfire-525a3 \"vitest\"",
+    "test:firestore": "firebase emulators:exec --only firestore --ui --project=rxfire-525a3 \"vitest firestore\"",
+    "test:database": "firebase emulators:exec --only database --project=rxfire-525a3 \"vitest database\"",
+    "test:auth": "firebase emulators:exec --only auth --project=rxfire-525a3 \"vitest auth\"",
+    "test:functions": "firebase emulators:exec --only functions --project=rxfire-525a3 \"vitest functions\"",
+    "test:storage": "firebase emulators:exec --only storage --project=rxfire-525a3 \"vitest storage\"",
+    "test:useObservable": "vitest useObservable",
+    "test:firebaseApp": "vitest firebaseApp",
+    "format": "prettier src test vite.config.ts -w",
+    "lint": "eslint src/* test/* vite.config.ts",
     "size": "size-limit",
     "analyze": "size-limit --why",
     "docs": "typedoc --options typedoc.json && markdown-toc -i docs/use.md",
@@ -33,18 +41,9 @@
   },
   "husky": {
     "hooks": {
-      "pre-commit": "yarn lint"
+      "pre-commit": "npm run lint"
     }
   },
-  "eslint": {
-    "rules": {
-      "react-hooks/rules-of-hooks": "error",
-      "no-only-tests/no-only-tests": "error"
-    },
-    "plugins": [
-      "no-only-tests"
-    ]
-  },
   "prettier": {
     "singleQuote": true,
     "printWidth": 160
@@ -60,7 +59,7 @@
     "url": "https://github.com/Firebase/reactfire/issues"
   },
   "homepage": "https://firebaseopensource.com/projects/firebaseextended/reactfire/",
-  "module": "dist/reactfire.esm.js",
+  "module": "./dist/index.js",
   "size-limit": [
     {
       "path": "dist/reactfire.cjs.production.min.js",
@@ -72,42 +71,43 @@
     }
   ],
   "devDependencies": {
-    "@babel/core": "^7.11.6",
-    "@size-limit/preset-small-lib": "^4.6.0",
-    "@testing-library/jest-dom": "^5.11.4",
-    "@testing-library/react": "^11.2.6",
-    "@testing-library/react-hooks": "^5.1.1",
-    "@types/node-fetch": "^2.5.7",
-    "@types/react": "^17.0.15",
-    "@types/react-dom": "^17.0.9",
-    "babel-jest": "^26.6.3",
-    "babel-plugin-minify-replace": "^0.5.0",
+    "@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",
-    "firebase": "^9.0.1",
-    "firebase-tools": "^9.16.0",
-    "globalthis": "^1.0.1",
-    "husky": "^4.3.0",
-    "jest-environment-jsdom": "^26.6.2",
+    "eslint-plugin-react": "^7.30.1",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "firebase": "^9.9.0",
+    "firebase-tools": "^11.3.0",
+    "globalthis": "^1.0.3",
+    "husky": "^8.0.1",
+    "jest-environment-jsdom": "^28.1.3",
+    "jsdom": "^20.0.0",
     "markdown-toc": "^1.2.0",
-    "node-fetch": "^2.6.1",
+    "prettier": "^2.7.1",
     "react": "^17.0.2",
     "react-dom": "^17.0.2",
     "react-test-renderer": "^17.0.2",
-    "size-limit": "^4.6.0",
-    "tsdx": "^0.14.1",
-    "tslib": "^2.2.0",
-    "typedoc": "^0.21.2",
-    "typedoc-plugin-markdown": "^3.6.1",
-    "typescript": "^4.2.4"
+    "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"
   },
   "dependencies": {
-    "rxfire": "^6.0.2",
+    "rxfire": "^6.0.3",
     "rxjs": "^6.6.3 || ^7.0.1"
-  },
-  "resolutions": {
-    "tsdx/**/jest": "^26.6.3",
-    "tsdx/**/ts-jest": "^26.5.5",
-    "tsdx/**/prettier": "^2.2.1",
-    "tsdx/**/typescript": "^4.2.4"
   }
 }

package/src/auth.tsx

@@ -25,14 +25,7 @@ export function useUser<T = unknown>(options?: ReactFireOptions<T>): ObservableS
   const observableId = `auth:user:${auth.name}`;
   const observable$ = user(auth);
 
-  let currentUser = auth.currentUser;
-
-  // Only use options.initialData if auth.currentUser is unavailable
-  if (!currentUser && (options?.initialData ?? options?.startWithValue)) {
-    currentUser = options.initialData ?? options.startWithValue;
-  }
-
-  return useObservable(observableId, observable$, { ...options, initialData: currentUser });
+  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(
@@ -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/firebaseApp.tsx

@@ -16,8 +16,8 @@ interface FirebaseAppProviderProps {
   suspense?: boolean;
 }
 
-// @ts-expect-error: "__REACTFIRE_VERSION__" is replaced with actual ReactFire version (see babel.config.js)
-export const version = __REACTFIRE_VERSION__;
+// REACTFIRE_VERSION is automatically pulled in from `package.json` by Vite
+export const version = process.env.REACTFIRE_VERSION as string;
 
 const shallowEq = (a: { [key: string]: any }, b: { [key: string]: any }) => a === b || [...Object.keys(a), ...Object.keys(b)].every((key) => a[key] === b[key]);