v3.0.3

* feat(profile): add promise support for `profileFactory` - @dannyvaughton
* fix(types): fix `firestore.delete` return type - @rscotten
* feat(tests): add test for promise support of profile factory
* feat(tests): add tests for all top level methods of `createFirebaseInstance`

Author: prescottprue

docs/contributing.md

@@ -84,3 +84,25 @@ It is often convenient to run a local version of `react-redux-firebase` within a
   **What Happened?**
 
   This error most often appears due to Webpack config. A common pattern is to provide `exclude: [/node_modules/]` setting to [babel-loader](https://github.com/babel/babel-loader), which keeps the loader from transforming code within the `node_modules` folder. Now that we have used `npm link`, your project points to your local version of `react-redux-firebase` instead of the one in your `node_modules` folder, so we have to tell the loader to also exclude transforming `react-redux-firebase`.
+
+* `Invalid hook call. Hooks can only be called inside of the body of a function component`:
+
+  **Common Solution**
+
+  Add `react` as an alias in Webpack:
+  
+  **Webpack**
+  
+  ```js
+  {
+    resolve: {  
+      alias: {  
+        react: path.resolve('./node_modules/react')
+      }
+    }
+  }
+  ```
+    
+  **What Happened?**
+  
+  This error often occurs when you have multiple instances of React loading after using `npm link`. The easiest fix is by setting React as an alias in Webpack.

index.d.ts

@@ -433,7 +433,9 @@ export type ReduxFirestoreQueries =
  * Function that recieves component props and returns
  * a list of query configuration objects for redux-firestore
  */
-export type ReduxFirestoreQueriesFunction = (props?: any) => ReduxFirestoreQueries
+export type ReduxFirestoreQueriesFunction = (
+  props?: any
+) => ReduxFirestoreQueries
 
 /**
  * Firestore instance extended with methods which dispatch redux actions.
@@ -477,7 +479,7 @@ interface ExtendedFirestoreInstance extends FirestoreTypes.FirebaseFirestore {
    * Delete a document within firestore.
    * @see https://github.com/prescottprue/redux-firestore#delete
    */
-  delete: (docPath: string | ReduxFirestoreQuerySetting) => void
+  delete: (docPath: string | ReduxFirestoreQuerySetting) => Promise<void>
 
   /**
    * Executes the given updateFunction and then attempts to commit the changes applied within the
@@ -541,7 +543,9 @@ export interface WithFirestoreProps {
   firestore: FirestoreTypes.FirebaseFirestore &
     ExtendedFirestoreInstance &
     FirestoreStatics
-  firebase: ExtendedFirebaseInstance & ExtendedAuthInstance & ExtendedStorageInstance
+  firebase: ExtendedFirebaseInstance &
+    ExtendedAuthInstance &
+    ExtendedStorageInstance
   dispatch: Dispatch
 }
 
@@ -642,7 +646,7 @@ interface ExtendedAuthInstance {
    * @see https://react-redux-firebase.com/docs/api/firebaseInstance.html#signinwithphonenumber
    */
   signInWithPhoneNumber: AuthTypes.FirebaseAuth['signInWithPhoneNumber']
-  
+
   /**
    * Update user's email
    * @param newEmail - Update to be auth object
@@ -775,7 +779,9 @@ interface ExtendedStorageInstance {
 }
 
 export interface WithFirebaseProps<ProfileType> {
-  firebase: ExtendedAuthInstance & ExtendedStorageInstance & ExtendedFirebaseInstance
+  firebase: ExtendedAuthInstance &
+    ExtendedStorageInstance &
+    ExtendedFirebaseInstance
 }
 
 /**
@@ -843,7 +849,9 @@ export function fixPath(path: string): string
  * integrations into external libraries such as redux-thunk and redux-observable.
  * @see https://react-redux-firebase.com/docs/api/getFirebase.html
  */
-export function getFirebase(): ExtendedFirebaseInstance & ExtendedAuthInstance & ExtendedStorageInstance
+export function getFirebase(): ExtendedFirebaseInstance &
+  ExtendedAuthInstance &
+  ExtendedStorageInstance
 
 /**
  * Get a value from firebase using slash notation.  This enables an easy
@@ -882,7 +890,9 @@ export function isLoaded(...args: any[]): boolean
  * instance is gathered from `ReactReduxFirebaseContext`.
  * @see https://react-redux-firebase.com/docs/api/useFirebase.html
  */
-export function useFirebase(): ExtendedFirebaseInstance & ExtendedAuthInstance & ExtendedStorageInstance
+export function useFirebase(): ExtendedFirebaseInstance &
+  ExtendedAuthInstance &
+  ExtendedStorageInstance
 
 /**
  * React hook that automatically listens/unListens
@@ -925,7 +935,6 @@ export function useFirestoreConnect<TInner>(
     | string
 ): void
 
-
 /**
  * Populate with data from multiple paths within redux.
  * @param state - Firebase state object (state.firebase in redux store)

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "react-redux-firebase",
-  "version": "3.0.2",
+  "version": "3.0.3",
   "description": "Redux integration for Firebase. Comes with a Higher Order Components for use with React.",
   "main": "lib/index.js",
   "module": "es/index.js",
@@ -127,7 +127,7 @@
     "uglifyjs-webpack-plugin": "^2.1.3",
     "webpack": "^4.41.0",
     "webpack-bundle-analyzer": "^2.9.0",
-    "webpack-cli": "^3.1.2",
+    "webpack-cli": "^3.3.9",
     "ws": "^3.2.0",
     "xmlhttprequest": "^1.8.0"
   },

package.json

@@ -273,24 +273,29 @@ export const watchUserProfile = (dispatch, firebase) => {
  * @returns {Promise} Resolves after creating user profile
  * @private
  */
-export const createUserProfile = (dispatch, firebase, userData, profile) => {
+export const createUserProfile = async (
+  dispatch,
+  firebase,
+  userData,
+  profile
+) => {
   const { _: { config } } = firebase
   if (!config.userProfile || (!firebase.database && !firebase.firestore)) {
-    return Promise.resolve(userData)
+    return userData
   }
   // use profileFactory if it exists in config
   if (typeof config.profileFactory === 'function') {
     // catch errors in user provided profileFactory function
     try {
-      profile = config.profileFactory(userData, profile, firebase) // eslint-disable-line no-param-reassign
+      profile = await config.profileFactory(userData, profile, firebase) // eslint-disable-line no-param-reassign
     } catch (err) {
       /* eslint-disable no-console */
       console.error(
         'Error occured within profileFactory function:',
         err.message || err
       )
       /* eslint-enable no-console */
-      return Promise.reject(err)
+      throw err
     }
   }
 

src/actions/auth.js

@@ -28,7 +28,8 @@ import {
   createSuccessStub,
   onAuthStateChangedSpy,
   firebaseWithConfig,
-  createFailureStub
+  createFailureStub,
+  sleep
 } from '../../utils'
 // import { promisesForPopulate } from 'utils/populate'
 
@@ -262,7 +263,7 @@ describe('Actions: Auth -', () => {
       expect(profile).to.equal(userData)
     })
 
-    it('creates profile using profileFactory if it exists', async () => {
+    it('creates profile using profileFactory sync function if it exists', async () => {
       const userData = {
         uid: '123',
         email: '[email protected]',
@@ -279,6 +280,28 @@ describe('Actions: Auth -', () => {
       expect(profileFactory).to.have.been.calledOnce
     })
 
+    it('creates profile using profileFactory promise function if it exists', async () => {
+      const userData = {
+        uid: '123',
+        email: '[email protected]',
+        providerData: [{}]
+      }
+      const profileObj = { some: 'asdf' }
+      /* eslint-disable jsdoc/require-jsdoc */
+      async function profileFactoryPromise() {
+        await sleep(500)
+        return profileObj
+      }
+      const profileFactory = sinon.spy(profileFactoryPromise)
+      const profile = await createUserProfile(
+        dispatch,
+        firebaseWithConfig({ profileFactory }),
+        userData
+      )
+      expect(profile).to.have.property('some', profileObj.some)
+      expect(profileFactory).to.have.been.calledOnce
+    })
+
     it('rejects for error in profileFactory function', async () => {
       const profileFactory = () => {
         throw new Error('test')