* feat(docs): add api docs pages for providers and new hooks api

* feat(docs): automatically find files for doc generation instead of having a list

SUMMARY.md

@@ -26,10 +26,13 @@
   * [React Chrome Redux](/docs/integrations/react-chrome-redux.md)
 * [API Reference](/docs/api/README.md)
   * [constants](/docs/api/constants.md)
-  * [firebaseConnect](/docs/api/connect.md)
+  * [firebaseConnect](/docs/api/firebaseConnect.md)
   * [withFirebase](/docs/api/withFirebase.md)
   * [firestoreConnect](/docs/api/firestoreConnect.md)
   * [withFirestore](/docs/api/withFirestore.md)
+  * [useFirebase](/docs/api/useFirebase.md)
+  * [useFirebaseConnect](/docs/api/useFirebaseConnect.md)
+  * [useFirestore](/docs/api/useFirestore.md)
   * [firebaseReducer](/docs/api/reducer.md)
     * [isInitializingReducer](/docs/api/reducers.md#isinitializingreducer)
     * [requestingReducer](/docs/api/reducers.md#requestingreducer)
@@ -44,6 +47,10 @@
     * [orderedReducer](/docs/api/reducers.md#orderedreducer)
   * [props.firebase](/docs/api/props-firebase.md)
   * [firebaseInstance](/docs/api/firebaseInstance.md)
+  * [ReactReduxFirebaseContext](/docs/api/ReactReduxFirebaseContext.md)
+  * [ReactReduxFirebaseProvider](/docs/api/ReactReduxFirebaseProvider.md)
+  * [ReduxFirestoreContext](/docs/api/ReduxFirestoreContext.md)
+  * [ReduxFirestoreProvider](/docs/api/ReduxFirestoreProvider.md)
   * [helpers](/docs/api/helpers.md)
 * Migration Guides
   * [v3 Migration Guide](/docs/v3-migration-guide.md)

bin/api-docs-generate.js

@@ -1,50 +1,18 @@
 /* eslint-disable no-console */
 const exec = require('child-process-promise').exec
+const fs = require('fs')
 
-const files = [
-  {
-    src: 'firebaseConnect.js',
-    dest: 'connect.md'
-  },
-  {
-    src: 'firestoreConnect.js',
-    dest: 'firestoreConnect.md'
-  },
-  {
-    src: 'withFirebase.js',
-    dest: 'withFirebase.md'
-  },
-  {
-    src: 'withFirestore.js',
-    dest: 'withFirestore.md'
-  },
-  {
-    src: 'createFirebaseInstance.js',
-    dest: 'firebaseInstance.md'
-  },
-  {
-    src: 'helpers.js',
-    dest: 'helpers.md'
-  },
-  {
-    src: 'reducers.js',
-    dest: 'reducers.md'
-  },
-  {
-    src: 'reducer.js',
-    dest: 'reducer.md'
-  },
-  {
-    src: 'constants.js',
-    dest: 'constants.md'
-  }
-]
+const SRC_FOLDER = 'src'
+const pathsToSkip = ['index.js', 'utils', '.DS_Store', 'actions']
+const fileRenames = {
+  'createFirebaseInstance.js': 'firebaseInstance'
+}
 
 function generateDocForFile(file) {
   return exec(
-    `$(npm bin)/documentation build src/${file.src} -f md -o docs/api/${
-      file.dest
-    } --shallow`
+    `$(npm bin)/documentation build ${SRC_FOLDER}/${
+      file.src
+    } -f md -o docs/api/${file.dest} --shallow`
   )
     .then(res => {
       console.log('Successfully generated', file.dest || file)
@@ -56,10 +24,31 @@ function generateDocForFile(file) {
     })
 }
 
+function getFileNames() {
+  return new Promise((resolve, reject) => {
+    fs.readdir(SRC_FOLDER, (err, files) => {
+      console.log('files:', files)
+      if (err) {
+        return reject(err)
+      }
+      const cleanedFileNames = files.filter(
+        fileName => !pathsToSkip.includes(fileName)
+      )
+      const mappedFileNames = cleanedFileNames.map(fileName => {
+        const newName = fileRenames[fileName] || fileName
+        return { src: newName, dest: `${newName.replace('.js', '')}.md` }
+      })
+      console.log('mapped file names', mappedFileNames)
+      resolve(mappedFileNames)
+    })
+  })
+}
+
 ;(async function() {
   console.log(
     'Generating API documentation (docs/api) from JSDoc comments within src...\n'
   )
+  const files = await getFileNames()
   try {
     await Promise.all(files.map(generateDocForFile))
     console.log('\nAPI documentation generated successfully!')

docs/README.md

@@ -27,10 +27,14 @@
   * [React Chrome Redux](/docs/integrations/react-chrome-redux.md)
 * [API Reference](/docs/api/README.md)
   * [constants](/docs/api/constants.md)
-  * [firebaseConnect](/docs/api/connect.md)
+  * [firebaseConnect](/docs/api/firebaseConnect.md)
   * [withFirebase](/docs/api/withFirebase.md)
   * [firestoreConnect](/docs/api/firestoreConnect.md)
   * [withFirestore](/docs/api/withFirestore.md)
+  * [useFirebase](/docs/api/useFirebase.md)
+  * [useFirebaseConnect](/docs/api/useFirebaseConnect.md)
+  * [useFirestore](/docs/api/useFirestore.md)
+  * [useFirestoreConnect](/docs/api/useFirestoreConnect.md)
   * [firebaseReducer](/docs/api/reducer.md)
     * [isInitializingReducer](/docs/api/reducers.md#isinitializingreducer)
     * [requestingReducer](/docs/api/reducers.md#requestingreducer)
@@ -45,6 +49,10 @@
     * [orderedReducer](/docs/api/reducers.md#orderedreducer)
   * [props.firebase](/docs/api/props-firebase.md)
   * [firebaseInstance](/docs/api/firebaseInstance.md)
+  * [ReactReduxFirebaseContext](/docs/api/ReactReduxFirebaseContext.md)
+  * [ReactReduxFirebaseProvider](/docs/api/ReactReduxFirebaseProvider.md)
+  * [ReduxFirestoreContext](/docs/api/ReduxFirestoreContext.md)
+  * [ReduxFirestoreProvider](/docs/api/ReduxFirestoreProvider.md)
   * [helpers](/docs/api/helpers.md)
 * [FAQ](/docs/FAQ.md)
 * [Roadmap](/docs/roadmap.md)

docs/api/README.md

@@ -3,8 +3,8 @@
 Just like [redux](http://redux.js.org/docs/api/index.html), the react-redux-firebase API surface is intentionally as small as possible.
 
 ## Top-Level Exports
-* [firebaseConnect](/docs/api/connect.md#firebaseconnect)
-* [createFirebaseConnect](/docs/api/connect.md#createfirebaseconnect)
+* [firebaseConnect](/docs/api/firebaseConnect.md#firebaseconnect)
+* [createFirebaseConnect](/docs/api/firebaseConnect.md#createfirebaseconnect)
 * [withFirebase](/docs/api/withFirebase.md)
 * [firestoreConnect](/docs/api/firestoreConnect.md#firebaseconnect)
 * [createFirestoreConnect](/docs/api/firestoreConnect.md#createfirestoreconnect)

docs/api/ReactReduxFirebaseContext.md

@@ -0,0 +1,10 @@
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+### Table of Contents
+
+-   [ReactReduxFirebaseContext](#reactreduxfirebasecontext)
+
+## ReactReduxFirebaseContext
+
+Context for extended firebase instance created
+by react-redux-firebase

docs/api/ReactReduxFirebaseProvider.md

@@ -0,0 +1,20 @@
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+### Table of Contents
+
+-   [ReactReduxFirebaseProvider](#reactreduxfirebaseprovider)
+
+## ReactReduxFirebaseProvider
+
+Provider for context containing extended firebase instance created
+by react-redux-firebase
+
+**Parameters**
+
+-   `props` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**  (optional, default `{}`)
+    -   `props.config` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** react-redux-firebase config
+    -   `props.dispatch` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** Redux's dispatch function
+    -   `props.firebase` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Firebase library
+    -   `props.initializeAuth` **[Boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Whether or not to initialize auth
+    -   `props.createFirestoreInstance` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** Function for creating
+        extended firestore instance

docs/api/ReduxFirestoreContext.md

@@ -0,0 +1,10 @@
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+### Table of Contents
+
+-   [ReduxFirestoreContext](#reduxfirestorecontext)
+
+## ReduxFirestoreContext
+
+Context for extended firebase instance created
+by react-redux-firebase

docs/api/ReduxFirestoreProvider.md

@@ -0,0 +1,20 @@
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+### Table of Contents
+
+-   [ReduxFirestoreProvider](#reduxfirestoreprovider)
+
+## ReduxFirestoreProvider
+
+Provider for context containing extended firestore instance created
+by react-redux-firebase
+
+**Parameters**
+
+-   `props` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**  (optional, default `{}`)
+    -   `props.config` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** react-redux-firebase config
+    -   `props.dispatch` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** Redux's dispatch function
+    -   `props.firebase` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Firebase library
+    -   `props.initializeAuth` **[Boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Whether or not to initialize auth
+    -   `props.createFirestoreInstance` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** Function for creating
+        extended firestore instance