Version v2.0.0 Beta 2 (#197)

* Node v8 support (`package.lock.json` added, and `8` added to node versions in travis config)
* `credential` support for login method - #186
* createUserProfile called with Facebook authentication - #187
* Switched back to using constructor to set context vars (attempt to fix undefined vars in component mount)
* Merged changes that set `displayName` and `wrappedComponent`
* Docs sections `redux-observable` and `epics` combined
* Docs updated with changes to compose function (no longer supports passing fbConfig)
* Docs added about `presence` and `sessions` config options

Author: prescottprue

.travis.yml

@@ -2,6 +2,7 @@ language: node_js
 
 node_js:
   - "6"
+  - "8"
 
 sudo: false
 

SUMMARY.md

@@ -11,7 +11,6 @@
   * [Profile](/docs/recipes/profile.md)
   * [Auth](/docs/recipes/auth.md)
   * [Actions](/docs/recipes/actions.md)
-  * [Epics](/docs/recipes/epics.md)
   * [Routing](/docs/recipes/routing.md)
   * [Roles](/docs/recipes/roles.md)
   * [Populate](/docs/recipes/populate.md)
@@ -20,6 +19,7 @@
   * [Redux Form](/docs/recipes/redux-form.md)
   * [Redux Persist](/docs/recipes/redux-persist.md)
   * [Redux Saga](/docs/recipes/redux-saga.md)
+  * [Redux Observable](/docs/recipes/redux-observable.md)
   * [React Native](/docs/recipes/react-native.md)
   * [React Chrome Redux](/docs/recipes/react-chrome-redux.md)
   * [Server Side Rendering](/docs/recipes/ssr.md)

bin/api-docs-generate.js

@@ -1,7 +1,7 @@
 const exec = require('child_process').exec
 const files = [
   {
-    src: 'connect.js',
+    src: 'firebaseConnect.js',
     dest: 'connect.md'
   },
   {

docs/api/compose.md

@@ -5,18 +5,17 @@ Middleware that handles configuration (placed in redux's
 
 **Properties**
 
--   `fbConfig` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Object containing Firebase config including
-    databaseURL or Firebase instance
-    -   `fbConfig.apiKey` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Firebase apiKey
-    -   `fbConfig.authDomain` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Firebase auth domain
-    -   `fbConfig.databaseURL` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Firebase database url
-    -   `fbConfig.storageBucket` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Firebase storage bucket
--   `config` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Containing react-redux-firebase specific config
-    such as userProfile
-    -   `config.userProfile` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Location on firebase to store user
-        profiles
-    -   `config.enableLogging` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Whether or not to enable Firebase
-        database logging
+-   `firebaseInstance` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Initiated firebase instance (can also
+    be library following Firebase JS API such as `react-native-firebase`)
+-   `config` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Containing react-redux-firebase specific configuration
+    -   `config.userProfile` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Location on firebase to store user profiles
+    -   `config.enableLogging` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Whether or not to enable Firebase database logging.
+        **Note**: Only works if instance has enableLogging function.
+    -   `config.profileFactory` **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)** Factory for modifying how user profile is saved.
+    -   `config.presence` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Location on Firebase to store currently
+        online users list. Often set to `'presence'` or `'onlineUsers'`.
+    -   `config.sessions` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Location on Firebase where user
+        sessions are stored (only if presense is set). Often set to `'sessions'` or `'onlineUsers'`.
     -   `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.enableRedirectHandling` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Whether or not to enable
@@ -32,15 +31,13 @@ Middleware that handles configuration (placed in redux's
         result is returned. Argument Pattern: `(authData, firebase, dispatch)`
     -   `config.customAuthParameters` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Object for setting which
         customAuthParameters are passed to external auth providers.
-    -   `config.profileFactory` **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)** Factory for modifying how user
-        profile is saved.
     -   `config.uploadFileDataFactory` **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)** Factory for modifying
         how file meta data is written during file uploads
     -   `config.profileParamsToPopulate` **([Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array) \| [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String))** Parameters within
-        profile object to populate
-    -   `config.autoPopulateProfile` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Whether or not to
-        automatically populate profile with data loaded through
-        profileParamsToPopulate config. (default: `true`)
+        profile object to populate. As of `v2.0.0` data is only loaded for population, not actually automatically populated
+        (allows access to both unpopulated and populated profile data).
+    -   `config.autoPopulateProfile` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** **NOTE**: Not yet enabled for v2.0.0. Whether or not to
+        automatically populate profile with data loaded through profileParamsToPopulate config. (default: `true`)
     -   `config.setProfilePopulateResults` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Whether or not to
         call SET actions for data that results from populating profile to redux under
         the data path. For example: role paramter on profile populated from 'roles'
@@ -76,19 +73,5 @@ const createStoreWithFirebase = compose(
 const store = createStoreWithFirebase(rootReducer, initialState)
 ```
 
-_Custom Auth Parameters_
-
-```javascript
-// Follow Setup example with the following config:
-const config = {
-  customAuthParameters: {
-     google: {
-       // prompts user to select account on every google login
-       prompt: 'select_account'
-     }
-  }
-}
-```
-
 Returns **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)** That accepts a component and returns a Component which
 wraps the provided component (higher order component).

docs/api/constants.md

@@ -64,8 +64,8 @@ Default configuration options
 -   `presence` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** `null` Location on Firebase where of currently
     online users is stored. Often set to `'presence'` or `'onlineUsers'`.
 -   `sessions` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** `sessions` Location on Firebase where user
-    sessions are stored (only if presense is set). Often set to `'presence'` or
-    `'onlineUsers'`.
+    sessions are stored (only if presense is set). Often set to `'sessions'` or
+    `'userSessions'`.
 -   `enableLogging` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** `false` Whether or not firebase
     database logging is enabled.
 -   `updateProfileOnLogin` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** `true` Whether or not to update

docs/recipes/epics.md

@@ -16,6 +16,24 @@ const somethingEpic = (action$, store, getFirebase) =>
     )
 ```
 
-## Write To Firebase As User Types
+## Write User Input To Firebase
 
-`redux-observable` can easily be used with `redux-form` to write changes to Firebase as a user types into an input, [see the `redux-form` recipes section for more details](/docs/recipes/redux-form.md)
+`redux-observable` can easily be used with `redux-form` to write changes to Firebase as a user types into an input, [see the `redux-form` recipes section for more details](/docs/recipes/redux-form.md)/
+
+In the Angular world this has been called "3-Way Data Binding".
+
+### Debounced Notifications
+Debounce writing to a ref on Firebase such as `/notifications` (useful so that tons of similar notifications aren't created).
+
+```js
+const SEND_NOTIFICATION = 'SEND_NOTIFICATION';
+
+export const notificationEpic = (action$, { getState, dispatch }, { getFirebase }) =>
+  action$.ofType(SEND_NOTIFICATION) // stream of notification actions
+    .debounceTime(2000) // debounce SEND_NOTIFICATION actions by 2 seconds
+    .do((action) => {
+      // push the notification object to the notifications ref
+      return getFirebase().push('/notifications', action.payload)
+    })
+    .mapTo({ type: 'EMAIL_NOTIFICATION_CREATED' });
+```

docs/recipes/redux-observable.md

@@ -11,6 +11,7 @@
   * allows any version of Firebase to be used
   * allows [`react-native-firebase`](https://github.com/invertase/react-native-firebase) to be passed (for using native modules instead of JS within `react-native`)
   * firebase is no longer a dependency (shrinks umd bundle size)
+* `profileParamsToPopulate` does not automatically populate profile, populated version can be loaded with `populate` (there will most likely be an option to enable auto populating before `v2.0.0` is out of pre-release)
 
 ### Pass In Firebase instance