Obey the Rules of Hooks (#367)

Author: jhuleatt

docs/reference/interfaces/auth.authcheckprops.md

@@ -8,39 +8,30 @@
 
 ### Properties
 
-- [auth](auth.authcheckprops.md#auth)
 - [children](auth.authcheckprops.md#children)
 - [fallback](auth.authcheckprops.md#fallback)
 - [requiredClaims](auth.authcheckprops.md#requiredclaims)
 
 ## Properties
 
-### auth
-
-• `Optional` **auth**: Auth
-
-Defined in: [src/auth.tsx:61](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L61)
-
-___
-
 ### children
 
 • **children**: ReactNode
 
-Defined in: [src/auth.tsx:63](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L63)
+Defined in: [src/auth.tsx:54](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L54)
 
 ___
 
 ### fallback
 
 • **fallback**: ReactNode
 
-Defined in: [src/auth.tsx:62](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L62)
+Defined in: [src/auth.tsx:53](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L53)
 
 ___
 
 ### requiredClaims
 
 • `Optional` **requiredClaims**: Object
 
-Defined in: [src/auth.tsx:64](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L64)
+Defined in: [src/auth.tsx:55](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L55)

docs/reference/interfaces/auth.claimscheckprops.md

@@ -19,15 +19,15 @@
 
 • **children**: ReactNode
 
-Defined in: [src/auth.tsx:70](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L70)
+Defined in: [src/auth.tsx:61](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L61)
 
 ___
 
 ### fallback
 
 • **fallback**: ReactNode
 
-Defined in: [src/auth.tsx:69](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L69)
+Defined in: [src/auth.tsx:60](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L60)
 
 ___
 
@@ -37,12 +37,12 @@ ___
 
 #### Type declaration:
 
-Defined in: [src/auth.tsx:71](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L71)
+Defined in: [src/auth.tsx:62](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L62)
 
 ___
 
 ### user
 
 • **user**: User
 
-Defined in: [src/auth.tsx:68](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L68)
+Defined in: [src/auth.tsx:59](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L59)

docs/reference/modules/auth.md

@@ -31,7 +31,7 @@
 
 **Returns:** JSX.Element
 
-Defined in: [src/auth.tsx:97](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L97)
+Defined in: [src/auth.tsx:88](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L88)
 
 ___
 
@@ -47,24 +47,24 @@ ___
 
 **Returns:** *Element*
 
-Defined in: [src/auth.tsx:74](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L74)
+Defined in: [src/auth.tsx:65](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L65)
 
 ___
 
 ### preloadUser
 
-▸ **preloadUser**(`options?`: { `firebaseApp?`: firebase.app.App  }): *Promise*<User\>
+▸ **preloadUser**(`options`: { `firebaseApp`: firebase.app.App  }): *Promise*<User\>
 
 #### Parameters:
 
 | Name | Type |
 | :------ | :------ |
-| `options?` | *object* |
-| `options.firebaseApp?` | firebase.app.App |
+| `options` | *object* |
+| `options.firebaseApp` | firebase.app.App |
 
 **Returns:** *Promise*<User\>
 
-Defined in: [src/auth.tsx:8](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L8)
+Defined in: [src/auth.tsx:7](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L7)
 
 ___
 
@@ -82,13 +82,13 @@ ___
 
 **Returns:** [*ObservableStatus*](../interfaces/useobservable.observablestatus.md)<firebase.auth.IdTokenResult\>
 
-Defined in: [src/auth.tsx:45](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L45)
+Defined in: [src/auth.tsx:37](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L37)
 
 ___
 
 ### useUser
 
-▸ **useUser**<T\>(`auth?`: firebase.auth.Auth, `options?`: [*ReactFireOptions*](../interfaces/index.reactfireoptions.md)<T\>): [*ObservableStatus*](../interfaces/useobservable.observablestatus.md)<firebase.User\>
+▸ **useUser**<T\>(`options?`: [*ReactFireOptions*](../interfaces/index.reactfireoptions.md)<T\>): [*ObservableStatus*](../interfaces/useobservable.observablestatus.md)<firebase.User\>
 
 Subscribe to Firebase auth state changes, including token refresh
 
@@ -100,11 +100,10 @@ Subscribe to Firebase auth state changes, including token refresh
 
 #### Parameters:
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `auth?` | firebase.auth.Auth | the [firebase.auth](https://firebase.google.com/docs/reference/js/firebase.auth) object |
-| `options?` | [*ReactFireOptions*](../interfaces/index.reactfireoptions.md)<T\> |  |
+| Name | Type |
+| :------ | :------ |
+| `options?` | [*ReactFireOptions*](../interfaces/index.reactfireoptions.md)<T\> |
 
 **Returns:** [*ObservableStatus*](../interfaces/useobservable.observablestatus.md)<firebase.User\>
 
-Defined in: [src/auth.tsx:24](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L24)
+Defined in: [src/auth.tsx:21](https://github.com/FirebaseExtended/reactfire/blob/main/src/auth.tsx#L21)

docs/reference/modules/firestore.md

@@ -18,19 +18,19 @@
 
 ### preloadFirestoreDoc
 
-▸ **preloadFirestoreDoc**(`refProvider`: (`firestore`: firebase.firestore.Firestore) => firebase.firestore.DocumentReference, `options?`: { `firebaseApp?`: firebase.app.App  }): *Promise*<[*SuspenseSubject*](../classes/suspensesubject.suspensesubject-1.md)<DocumentSnapshot\>\>
+▸ **preloadFirestoreDoc**(`refProvider`: (`firestore`: firebase.firestore.Firestore) => firebase.firestore.DocumentReference, `options`: { `firebaseApp`: firebase.app.App  }): *Promise*<[*SuspenseSubject*](../classes/suspensesubject.suspensesubject-1.md)<DocumentSnapshot\>\>
 
 #### Parameters:
 
 | Name | Type |
 | :------ | :------ |
 | `refProvider` | (`firestore`: firebase.firestore.Firestore) => firebase.firestore.DocumentReference |
-| `options?` | *object* |
-| `options.firebaseApp?` | firebase.app.App |
+| `options` | *object* |
+| `options.firebaseApp` | firebase.app.App |
 
 **Returns:** *Promise*<[*SuspenseSubject*](../classes/suspensesubject.suspensesubject-1.md)<DocumentSnapshot\>\>
 
-Defined in: [src/firestore.tsx:29](https://github.com/FirebaseExtended/reactfire/blob/main/src/firestore.tsx#L29)
+Defined in: [src/firestore.tsx:28](https://github.com/FirebaseExtended/reactfire/blob/main/src/firestore.tsx#L28)
 
 ___
 
@@ -55,7 +55,7 @@ Subscribe to a Firestore collection
 
 **Returns:** [*ObservableStatus*](../interfaces/useobservable.observablestatus.md)<T *extends* {} ? T[] : firebase.firestore.QuerySnapshot\>
 
-Defined in: [src/firestore.tsx:110](https://github.com/FirebaseExtended/reactfire/blob/main/src/firestore.tsx#L110)
+Defined in: [src/firestore.tsx:108](https://github.com/FirebaseExtended/reactfire/blob/main/src/firestore.tsx#L108)
 
 ___
 
@@ -80,7 +80,7 @@ Subscribe to a Firestore collection and unwrap the snapshot.
 
 **Returns:** [*ObservableStatus*](../interfaces/useobservable.observablestatus.md)<T[]\>
 
-Defined in: [src/firestore.tsx:126](https://github.com/FirebaseExtended/reactfire/blob/main/src/firestore.tsx#L126)
+Defined in: [src/firestore.tsx:124](https://github.com/FirebaseExtended/reactfire/blob/main/src/firestore.tsx#L124)
 
 ___
 
@@ -105,7 +105,7 @@ Suscribe to Firestore Document changes
 
 **Returns:** [*ObservableStatus*](../interfaces/useobservable.observablestatus.md)<T *extends* {} ? T : firebase.firestore.DocumentSnapshot\>
 
-Defined in: [src/firestore.tsx:48](https://github.com/FirebaseExtended/reactfire/blob/main/src/firestore.tsx#L48)
+Defined in: [src/firestore.tsx:46](https://github.com/FirebaseExtended/reactfire/blob/main/src/firestore.tsx#L46)
 
 ___
 
@@ -130,7 +130,7 @@ Suscribe to Firestore Document changes
 
 **Returns:** [*ObservableStatus*](../interfaces/useobservable.observablestatus.md)<T\>
 
-Defined in: [src/firestore.tsx:80](https://github.com/FirebaseExtended/reactfire/blob/main/src/firestore.tsx#L80)
+Defined in: [src/firestore.tsx:78](https://github.com/FirebaseExtended/reactfire/blob/main/src/firestore.tsx#L78)
 
 ___
 
@@ -155,7 +155,7 @@ Get a firestore document and don't subscribe to changes
 
 **Returns:** [*ObservableStatus*](../interfaces/useobservable.observablestatus.md)<T\>
 
-Defined in: [src/firestore.tsx:95](https://github.com/FirebaseExtended/reactfire/blob/main/src/firestore.tsx#L95)
+Defined in: [src/firestore.tsx:93](https://github.com/FirebaseExtended/reactfire/blob/main/src/firestore.tsx#L93)
 
 ___
 
@@ -180,4 +180,4 @@ Get a firestore document and don't subscribe to changes
 
 **Returns:** [*ObservableStatus*](../interfaces/useobservable.observablestatus.md)<T *extends* {} ? T : firebase.firestore.DocumentSnapshot\>
 
-Defined in: [src/firestore.tsx:64](https://github.com/FirebaseExtended/reactfire/blob/main/src/firestore.tsx#L64)
+Defined in: [src/firestore.tsx:62](https://github.com/FirebaseExtended/reactfire/blob/main/src/firestore.tsx#L62)

docs/reference/modules/remote_config.md

@@ -16,7 +16,7 @@
 
 ### useRemoteConfigAll
 
-▸ **useRemoteConfigAll**(`key`: *string*, `remoteConfig?`: RemoteConfig): [*ObservableStatus*](../interfaces/useobservable.observablestatus.md)<[*AllParameters*](remote_config_getvalue.md#allparameters)\>
+▸ **useRemoteConfigAll**(`key`: *string*): [*ObservableStatus*](../interfaces/useobservable.observablestatus.md)<[*AllParameters*](remote_config_getvalue.md#allparameters)\>
 
 Convience method similar to useRemoteConfigValue. Returns allRemote Config parameters.
 
@@ -25,17 +25,16 @@ Convience method similar to useRemoteConfigValue. Returns allRemote Config param
 | Name | Type | Description |
 | :------ | :------ | :------ |
 | `key` | *string* | The parameter key in Remote Config |
-| `remoteConfig?` | RemoteConfig | Optional instance. If not provided ReactFire will either grab the default instance or lazy load. |
 
 **Returns:** [*ObservableStatus*](../interfaces/useobservable.observablestatus.md)<[*AllParameters*](remote_config_getvalue.md#allparameters)\>
 
-Defined in: [src/remote-config/index.tsx:79](https://github.com/FirebaseExtended/reactfire/blob/main/src/remote-config/index.tsx#L79)
+Defined in: [src/remote-config/index.tsx:78](https://github.com/FirebaseExtended/reactfire/blob/main/src/remote-config/index.tsx#L78)
 
 ___
 
 ### useRemoteConfigBoolean
 
-▸ **useRemoteConfigBoolean**(`key`: *string*, `remoteConfig?`: RemoteConfig): [*ObservableStatus*](../interfaces/useobservable.observablestatus.md)<boolean\>
+▸ **useRemoteConfigBoolean**(`key`: *string*): [*ObservableStatus*](../interfaces/useobservable.observablestatus.md)<boolean\>
 
 Convience method similar to useRemoteConfigValue. Returns a `boolean` from a Remote Config parameter.
 
@@ -44,17 +43,16 @@ Convience method similar to useRemoteConfigValue. Returns a `boolean` from a Rem
 | Name | Type | Description |
 | :------ | :------ | :------ |
 | `key` | *string* | The parameter key in Remote Config |
-| `remoteConfig?` | RemoteConfig | Optional instance. If not provided ReactFire will either grab the default instance or lazy load. |
 
 **Returns:** [*ObservableStatus*](../interfaces/useobservable.observablestatus.md)<boolean\>
 
-Defined in: [src/remote-config/index.tsx:70](https://github.com/FirebaseExtended/reactfire/blob/main/src/remote-config/index.tsx#L70)
+Defined in: [src/remote-config/index.tsx:69](https://github.com/FirebaseExtended/reactfire/blob/main/src/remote-config/index.tsx#L69)
 
 ___
 
 ### useRemoteConfigNumber
 
-▸ **useRemoteConfigNumber**(`key`: *string*, `remoteConfig?`: RemoteConfig): [*ObservableStatus*](../interfaces/useobservable.observablestatus.md)<number\>
+▸ **useRemoteConfigNumber**(`key`: *string*): [*ObservableStatus*](../interfaces/useobservable.observablestatus.md)<number\>
 
 Convience method similar to useRemoteConfigValue. Returns a `number` from a Remote Config parameter.
 
@@ -63,17 +61,16 @@ Convience method similar to useRemoteConfigValue. Returns a `number` from a Remo
 | Name | Type | Description |
 | :------ | :------ | :------ |
 | `key` | *string* | The parameter key in Remote Config |
-| `remoteConfig?` | RemoteConfig | Optional instance. If not provided ReactFire will either grab the default instance or lazy load. |
 
 **Returns:** [*ObservableStatus*](../interfaces/useobservable.observablestatus.md)<number\>
 
-Defined in: [src/remote-config/index.tsx:61](https://github.com/FirebaseExtended/reactfire/blob/main/src/remote-config/index.tsx#L61)
+Defined in: [src/remote-config/index.tsx:60](https://github.com/FirebaseExtended/reactfire/blob/main/src/remote-config/index.tsx#L60)
 
 ___
 
 ### useRemoteConfigString
 
-▸ **useRemoteConfigString**(`key`: *string*, `remoteConfig?`: RemoteConfig): [*ObservableStatus*](../interfaces/useobservable.observablestatus.md)<string\>
+▸ **useRemoteConfigString**(`key`: *string*): [*ObservableStatus*](../interfaces/useobservable.observablestatus.md)<string\>
 
 Convience method similar to useRemoteConfigValue. Returns a `string` from a Remote Config parameter.
 
@@ -82,17 +79,16 @@ Convience method similar to useRemoteConfigValue. Returns a `string` from a Remo
 | Name | Type | Description |
 | :------ | :------ | :------ |
 | `key` | *string* | The parameter key in Remote Config |
-| `remoteConfig?` | RemoteConfig | Optional instance. If not provided ReactFire will either grab the default instance or lazy load. |
 
 **Returns:** [*ObservableStatus*](../interfaces/useobservable.observablestatus.md)<string\>
 
-Defined in: [src/remote-config/index.tsx:52](https://github.com/FirebaseExtended/reactfire/blob/main/src/remote-config/index.tsx#L52)
+Defined in: [src/remote-config/index.tsx:51](https://github.com/FirebaseExtended/reactfire/blob/main/src/remote-config/index.tsx#L51)
 
 ___
 
 ### useRemoteConfigValue
 
-▸ **useRemoteConfigValue**(`key`: *string*, `remoteConfig?`: RemoteConfig): [*ObservableStatus*](../interfaces/useobservable.observablestatus.md)<RemoteConfigValue\>
+▸ **useRemoteConfigValue**(`key`: *string*): [*ObservableStatus*](../interfaces/useobservable.observablestatus.md)<RemoteConfigValue\>
 
 Accepts a key and optionally a Remote Config instance. Returns a
 Remote Config Value.
@@ -102,8 +98,7 @@ Remote Config Value.
 | Name | Type | Description |
 | :------ | :------ | :------ |
 | `key` | *string* | The parameter key in Remote Config |
-| `remoteConfig?` | RemoteConfig | Optional instance. If not provided ReactFire will either grab the default instance or lazy load. |
 
 **Returns:** [*ObservableStatus*](../interfaces/useobservable.observablestatus.md)<RemoteConfigValue\>
 
-Defined in: [src/remote-config/index.tsx:43](https://github.com/FirebaseExtended/reactfire/blob/main/src/remote-config/index.tsx#L43)
+Defined in: [src/remote-config/index.tsx:42](https://github.com/FirebaseExtended/reactfire/blob/main/src/remote-config/index.tsx#L42)

package.json

@@ -34,7 +34,7 @@
   },
   "eslint": {
     "rules": {
-      "react-hooks/rules-of-hooks": "warn"
+      "react-hooks/rules-of-hooks": "error"
     }
   },
   "prettier": {

src/auth.tsx

@@ -3,11 +3,9 @@ import * as React from 'react';
 import { user } from 'rxfire/auth';
 import { preloadAuth, preloadObservable, ReactFireOptions, useAuth, useObservable, ObservableStatus } from './';
 import { from } from 'rxjs';
-import { useFirebaseApp } from './firebaseApp';
 
-export function preloadUser(options?: { firebaseApp?: firebase.app.App }) {
-  // TODO: Find an alternative that doesn't break the rules of hooks (conditional hook call)
-  const firebaseApp = options?.firebaseApp || useFirebaseApp();
+export function preloadUser(options: { firebaseApp: firebase.app.App }) {
+  const firebaseApp = options.firebaseApp;
 
   return preloadAuth({ firebaseApp }).then(auth => {
     const result = preloadObservable(user(auth()), `auth:user:${firebaseApp.name}`);
@@ -18,16 +16,10 @@ export function preloadUser(options?: { firebaseApp?: firebase.app.App }) {
 /**
  * Subscribe to Firebase auth state changes, including token refresh
  *
- * @param auth - the [firebase.auth](https://firebase.google.com/docs/reference/js/firebase.auth) object
  * @param options
  */
-export function useUser<T = unknown>(auth?: firebase.auth.Auth, options?: ReactFireOptions<T>): ObservableStatus<firebase.User> {
-  // TODO: Find an alternative that doesn't break the rules of hooks (conditional hook call)
-  auth = auth || useAuth();
-
-  if (!auth) {
-    throw new Error('firebase.auth not found');
-  }
+export function useUser<T = unknown>(options?: ReactFireOptions<T>): ObservableStatus<firebase.User> {
+  const auth = useAuth();
 
   const observableId = `auth:user:${auth.app.name}`;
   const observable$ = user(auth);
@@ -58,7 +50,6 @@ export function useIdTokenResult(
 }
 
 export interface AuthCheckProps {
-  auth?: firebase.auth.Auth;
   fallback: React.ReactNode;
   children: React.ReactNode;
   requiredClaims?: Object;
@@ -94,8 +85,8 @@ export function ClaimsCheck({ user, fallback, children, requiredClaims }: Claims
   }
 }
 
-export function AuthCheck({ auth, fallback, children, requiredClaims }: AuthCheckProps): JSX.Element {
-  const { data: user } = useUser<firebase.User>(auth);
+export function AuthCheck({ fallback, children, requiredClaims }: AuthCheckProps): JSX.Element {
+  const { data: user } = useUser<firebase.User>();
 
   if (user) {
     return requiredClaims ? (