Docs/Roadmap updated to reflect recent feature requests + issues.

* Populate section added to recipes
* Profile Params list populate added to roadmap to address #24
* firebase-admin support added to roadmap to address #22
* AuthRequired and Loading decorators added to roadmap

Author: Scott Prue

SUMMARY.md

@@ -10,6 +10,7 @@
   * [Upload](/docs/recipes/upload.md)
   * [Actions](/docs/recipes/actions.md)
   * [Thunks](/docs/recipes/thunks.md)
+  * [Populate](/docs/recipes/populate.md)
 * [API Reference](/docs/api/README.md)
   * [constants](/docs/api/constants.md)
   * [firebaseConnect](/docs/api/connect.md)

docs/api/compose.md

@@ -16,7 +16,7 @@ Middleware that handles configuration (placed in redux's `compose` call)
     -   `config.enableLogging` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Location on firebase to store user profiles. default: `false`
     -   `config.profileDecorator` **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)** Location on firebase to store user profiles. default: `false`
     -   `config.updateProfileOnLogin` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Whether or not to update profile when logging in. default: `false`
-    -   `config.profileParamsToPopulate` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Whether or not to update profile when logging in. default: `false`
+    -   `config.profileParamsToPopulate` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Parameters within profile object to populate
 
 **Examples**
 
@@ -48,4 +48,4 @@ const createStoreWithFirebase = compose(
 const store = createStoreWithFirebase(rootReducer, initialState)
 ```
 
-Returns **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)** That accepts a component a returns a wrapped version of component
+Returns **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)** Middleware function

docs/auth.md

@@ -96,7 +96,8 @@ this.props.firebase.login({
 ```js
  // Call with info
  this.props.firebase.login({
-   provider: 'google'
+   provider: 'google',
+   type: 'redirect'
  })
  ```
 

docs/populate.md

@@ -13,7 +13,7 @@ Populate allows you to replace the owner parameter with another value on Firebas
 ##### Example Data
 ```javascript
 todos: {
-  123: {
+  ASDF123: {
     text: 'Some Todo Item',
     owner: "Iq5b0qK2NtgggT6U3bU6iZRGyma2"
    }
@@ -47,7 +47,7 @@ When trying to replace the owner parameter with a string such as a displayName f
 
 ##### Result
 ```javascript
-123: {
+ASDF123: {
   text: 'Some Todo Item',
   owner: 'Scott Prue'
  }
@@ -67,7 +67,7 @@ Population can also be used to populate a parameter with an object. An example o
 ##### Example Result
 
 ```javascript
-123: {
+ASDF123: {
   text: 'Some Todo Item',
   owner: {
     displayName: 'Scott Prue',
@@ -96,8 +96,93 @@ There is also the option to load a parameter from within a population object. An
 ##### Example Result
 
 ```javascript
-123: {
+ASDF123: {
   text: 'Some Todo Item',
   owner: '[email protected]'
 }
 ```
+
+## Profile Parameters
+**NOTE:** This functionality is still under construction. Please confirm you have the most recent version.
+
+To Populate parameters within profile/user object, include the `profileParamsToPopulate` parameter when [calling `reactReduxFirebase` in your compose function](/api/compose).
+
+### Parameter
+
+##### Example Config
+Populating username with username from usernames ref.
+
+```javascript
+const config = {
+  userProfile: 'users',
+  profileParamsToPopulate: [ 'username:usernames' ]
+}
+```
+##### Initial Data
+
+```javascript
+{
+  users: {
+    $uid: {
+      email: '[email protected]',
+      displayName: 'Iq5b0qK2NtgggT6U3bU6iZRGyma2'
+    }
+  }
+}
+```
+##### Example Result
+
+```javascript
+{
+  users: {
+    $uid: {
+      email: '[email protected]',
+      displayName: 'someuser'
+    }
+  }
+}
+```
+
+### List of Items (Coming Soon)
+**Note:** This feature does not currently work, but is being added to `v1.2.0`
+
+##### Example Config
+
+```javascript
+const config = {
+  userProfile: 'users',
+  profileParamsToPopulate: [ 'todos:todos' ] // populate list of todos from todos ref
+}
+```
+
+##### Initial Data
+
+```javascript
+{
+  users: {
+    $uid: {
+      email: '[email protected]',
+      todos: {
+        0: "ASDF123"
+      }
+    }
+  }
+}
+```
+
+##### Example Result
+```js
+{
+  users: {
+    $uid: {
+      email: '[email protected]',
+      todos: {
+        ASDF123: {
+          text: 'Some Todo Item',
+          owner: "Iq5b0qK2NtgggT6U3bU6iZRGyma2"
+        }
+      }
+    }
+  }
+}
+```

docs/recipes/populate.md

@@ -0,0 +1,16 @@
+# Populate
+
+### Populate Profile Parameters
+
+To Populate parameters within profile/user object, include the `profileParamsToPopulate` parameter when [calling `reactReduxFirebase` in your compose function](/api/compose).
+
+#### Examples
+
+##### Populate List of Items
+
+```javascript
+const config = {
+  userProfile: 'users',
+  profileParamsToPopulate: [ 'todos:todos' ] // populate list of todos from todos ref
+}
+```

docs/roadmap.md

@@ -1,7 +1,11 @@
 # Roadmap
 
 ### Short Term
+* List Population within user profile parameter (only single parameter currently supported)
+* `firebase-admin` integration
 * Huge App Example with passing of props to child routes
+* AuthRequired Decorator (redirect if not logged in)
+* Loading Decorator (with custom loading indicator config)
 
 ### Long Term
 * Improve docs readability (maybe include REPL for editable examples)

examples/complete/material/src/config.js

@@ -1,7 +1,7 @@
 export const firebase = {
   apiKey: 'AIzaSyCTUERDM-Pchn_UDTsfhVPiwM4TtNIxots',
-  authDomain: 'react-redux-firebase.firebaseapp.com',
-  databaseURL: 'https://react-redux-firebase.firebaseio.com'
+  authDomain: 'redux-firebasev3.firebaseapp.com',
+  databaseURL: 'https://redux-firebasev3.firebaseio.com'
 }
 
 export const fbPaths = {

src/compose.js

@@ -16,8 +16,8 @@ let firebaseInstance
  * @param {Boolean} config.enableLogging - Location on firebase to store user profiles. default: `false`
  * @param {Function} config.profileDecorator - Location on firebase to store user profiles. default: `false`
  * @param {Boolean} config.updateProfileOnLogin - Whether or not to update profile when logging in. default: `false`
- * @param {Boolean} config.profileParamsToPopulate - Whether or not to update profile when logging in. default: `false`
- * @return {Function} That accepts a component a returns a wrapped version of component
+ * @param {Boolean} config.profileParamsToPopulate - Parameters within profile object to populate
+ * @return {Function} Middleware function
  * @example <caption>Data</caption>
  * import { createStore, compose } from 'redux'
  * import { reactReduxFirebase } from 'react-redux-firebase'