fix(hooks): remove unnessesary create functions from useFirebase and useFirestore

Author: Scott Prue

docs/api/useFirebase.md

@@ -2,30 +2,8 @@
 
 ### Table of Contents
 
--   [createUseFirebase](#createusefirebase)
 -   [useFirebase](#usefirebase)
 
-## createUseFirebase
-
-Function that creates a react hook which provides `firebase` object.
-
-**WARNING!!** This is an advanced feature, and should only be used when
-needing to access a firebase instance created under a different store key.
-Firebase state (`state.firebase`)
-
-**Examples**
-
-_Basic_
-
-```javascript
-import { createUseFirebase } from 'react-redux-firebase'
-
-// create useFirebase
-const useFirebase = createUseFirebase()
-```
-
-Returns **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** A hook fucntion that return firebase object.
-
 ## useFirebase
 
 React hook that provides `firebase` object.
@@ -44,14 +22,20 @@ import { useFirebase } from 'react-redux-firebase'
 
 function AddData() {
   const firebase = useFirebase()
+
+  function addTodo() {
+    const exampleTodo = { done: false, text: 'Sample' }
+    return firebase.push('todos', exampleTodo)
+  }
+
   return (
     <div>
-      <button onClick={() => firebase.push('todos', { done: false, text: 'Sample' })}>
+      <button onClick={addTodo}>
         Add Sample Todo
       </button>
     </div>
   )
 }
 ```
 
-Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Firebase instance
+Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Extended Firebase instance

docs/api/useFirestore.md

@@ -2,43 +2,10 @@
 
 ### Table of Contents
 
--   [createUseFirestore](#createusefirestore)
 -   [useFirestore](#usefirestore)
 
-## createUseFirestore
-
-Function that creates a hook that which provides
-`firestore` object.
-
-**WARNING!!** This is an advanced feature, and should only be used when
-needing to access a firebase instance created under a different store key.
-
-**Parameters**
-
--   `storeKey` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Name of redux store which contains
-    Firestore state (`state.firestore`) (optional, default `'store'`)
-
-**Examples**
-
-_Basic_
-
-```javascript
-import { createUseFirestore } from 'react-redux-firebase'
-
-// create useFirestore that uses another redux store
-const useFirestore = createUseFirestore()
-
-// use the useFirestore to wrap a component
-export default useFirestore(SomeComponent)
-```
-
-Returns **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** Higher Order Component which accepts an array of
-watchers config and wraps a React Component
-
 ## useFirestore
 
-**Extends React.Component**
-
 React hook that return firestore object.
 Firestore instance is gathered from `store.firestore`, which is attached
 to store by the store enhancer (`reduxFirestore`) during setup of
@@ -54,12 +21,15 @@ import { useFirestore } from 'react-redux-firebase'
 
 function AddData({ firebase: { add } }) {
   const firestore = useFirestore()
-  const add = todo => {
-    firestore.collection('todos').add(todo)
+
+  function addTodo() {
+    const exampleTodo = { done: false, text: 'Sample' }
+    return firestore.collection('todos').add(exampleTodo)
   }
+
   return (
     <div>
-      <button onClick={() => add({ done: false, text: 'Sample' })}>
+      <button onClick={addTodo}>
         Add Sample Todo
       </button>
     </div>
@@ -69,4 +39,4 @@ function AddData({ firebase: { add } }) {
 export default AddTodo
 ```
 
-Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Firestore instance
+Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Extended Firestore instance

docs/api/useFirestoreConnect.md

@@ -8,17 +8,17 @@
 ## createUseFirestoreConnect
 
 React hook that automatically listens/unListens to provided
-firebase paths.
+firestore paths.
 **WARNING!!** This is an advanced feature, and should only be used when
 needing to access a firebase instance created under a different store key.
-Firebase state (state.firebase)
+Firebase state (state.firestore)
 
 **Examples**
 
 _Basic_
 
 ```javascript
-// props.firebase set on App component as firebase object with helpers
+// props.firestore set on App component as firestore object with helpers
 import { createUseFirestoreConnect } from 'react-redux-firebase'
 
 const firestoreConnect = createUseFirestoreConnect()

src/firebaseConnect.js

@@ -61,6 +61,7 @@ export const createFirebaseConnect = (storeKey = 'store') => (
       const { firebase, dispatch } = this.props
       const inputAsFunc = createCallable(dataOrFn)
       const data = inputAsFunc(np, this.store)
+
       // Handle a data parameter having changed
       if (!isEqual(data, this.prevData)) {
         const itemsToSubscribe = differenceWith(data, this.prevData, isEqual)

src/firestoreConnect.js

@@ -68,6 +68,7 @@ export const createFirestoreConnect = (storeKey = 'store') => (
 
         // Remove listeners for inactive subscriptions
         firestore.unsetListeners(changes.removed)
+
         // Add listeners for new subscriptions
         firestore.setListeners(changes.added)
       }
@@ -86,7 +87,7 @@ export const createFirestoreConnect = (storeKey = 'store') => (
   }
 
   FirestoreConnectWrapped.propTypes = {
-    dispatch: PropTypes.func,
+    dispatch: PropTypes.func.isRequired,
     firebase: PropTypes.object,
     firestore: PropTypes.object
   }

src/useFirebase.js

@@ -1,25 +1,6 @@
 import { useContext } from 'react'
 import ReactReduxFirebaseContext from './ReactReduxFirebaseContext'
 
-/**
- * @name createUseFirebase
- * @description Function that creates a react hook which provides `firebase` object.
- *
- * **WARNING!!** This is an advanced feature, and should only be used when
- * needing to access a firebase instance created under a different store key.
- * Firebase state (`state.firebase`)
- * @return {Function} - A hook fucntion that return firebase object.
- * @example <caption>Basic</caption>
- * import { createUseFirebase } from 'react-redux-firebase'
- *
- * // create useFirebase
- * const useFirebase = createUseFirebase()
- */
-export const createUseFirebase = () =>
-  function useFirebase() {
-    return useContext(ReactReduxFirebaseContext)
-  }
-
 /**
  * @name useFirebase
  * @description React hook that provides `firebase` object.
@@ -28,19 +9,28 @@ export const createUseFirebase = () =>
  * **NOTE**: This version of the Firebase library has extra methods, config,
  * and functionality which give it it's capabilities such as dispatching
  * actions.
- * @return {Object} - Firebase instance
+ * @return {Object} - Extended Firebase instance
  * @example <caption>Basic</caption>
  * import { useFirebase } from 'react-redux-firebase'
  *
  * function AddData() {
  *   const firebase = useFirebase()
+ *
+ *   function addTodo() {
+ *     const exampleTodo = { done: false, text: 'Sample' }
+ *     return firebase.push('todos', exampleTodo)
+ *   }
+ *
  *   return (
  *     <div>
- *       <button onClick={() => firebase.push('todos', { done: false, text: 'Sample' })}>
+ *       <button onClick={addTodo}>
  *         Add Sample Todo
  *       </button>
  *     </div>
  *   )
  * }
  */
-export default createUseFirebase()
+
+export default function useFirebase() {
+  return useContext(ReactReduxFirebaseContext)
+}

src/useFirestore.js

@@ -1,51 +1,28 @@
 import { useContext } from 'react'
 import ReduxFirestoreContext from './ReduxFirestoreContext'
 
-/**
- * @name createUseFirestore
- * @description Function that creates a hook that which provides
- * `firestore` object.
- *
- * **WARNING!!** This is an advanced feature, and should only be used when
- * needing to access a firebase instance created under a different store key.
- * @param {String} [storeKey='store'] - Name of redux store which contains
- * Firestore state (`state.firestore`)
- * @return {Function} - Higher Order Component which accepts an array of
- * watchers config and wraps a React Component
- * @example <caption>Basic</caption>
- * import { createUseFirestore } from 'react-redux-firebase'
- *
- * // create useFirestore that uses another redux store
- * const useFirestore = createUseFirestore()
- *
- * // use the useFirestore to wrap a component
- * export default useFirestore(SomeComponent)
- */
-export const createUseFirestore = () =>
-  function useFirestore() {
-    return useContext(ReduxFirestoreContext)
-  }
-
 /**
  * @name useFirestore
- * @extends React.Component
  * @description React hook that return firestore object.
  * Firestore instance is gathered from `store.firestore`, which is attached
  * to store by the store enhancer (`reduxFirestore`) during setup of
  * [`redux-firestore`](https://github.com/prescottprue/redux-firestore)
- * @return {Object} - Firestore instance
+ * @return {Object} - Extended Firestore instance
  * @example <caption>Basic</caption>
  * import React from 'react'
  * import { useFirestore } from 'react-redux-firebase'
  *
  * function AddData({ firebase: { add } }) {
  *   const firestore = useFirestore()
- *   const add = todo => {
- *     firestore.collection('todos').add(todo)
+ *
+ *   function addTodo() {
+ *     const exampleTodo = { done: false, text: 'Sample' }
+ *     return firestore.collection('todos').add(exampleTodo)
  *   }
+ *
  *   return (
  *     <div>
- *       <button onClick={() => add({ done: false, text: 'Sample' })}>
+ *       <button onClick={addTodo}>
  *         Add Sample Todo
  *       </button>
  *     </div>
@@ -54,4 +31,6 @@ export const createUseFirestore = () =>
  *
  * export default AddTodo
  */
-export default createUseFirestore()
+export default function useFirestore() {
+  return useContext(ReduxFirestoreContext)
+}