v1.5.0 (#270)

🍾 🥂 The long awaited v1.5.0 release 🥂 🍾 

### Breaking Changes
* `browser` field has been removed from `package.json` which means commonJS build is used instead of `UMD` build from Webpack (much smaller)
* [firebaseConnect] Uses `prop-types` instead of importing from React - #122 

### Core
* [firebaseConnect] Allow usage of different stores in `firebaseConnect` - #148, #29
* [firebaseConnect] statics are now hoisted thanks to `hoist-non-react-statics`
* [firebaseConnect] exposed `createFirebaseConnect` for creating `firebaseConnect` HOCs connected to different stores
* [auth] `login` method supports `credential` parameter (with matching docs and tests updates)
* [auth] deprecation warning added for `token` and `provider` combo in `login` method
* [auth] Adds `updateProfile`, `updateAuth`, and `updateEmail` methods that dispatch associated start/success/failure actions
* [helpers] `deleteFile` method response no longer includes `dbPath` if it is undefined (test added to check this case)
* [helpers] No more race condition with `uniqueSet` - #207
* [typescript] Typescript typings - #142, #214 
* [query] `watchEvent` accepts options object as third argument
* [populate] Lodash path syntax support - #132
* [populate] accept a function for populate for item based populate config - #132
* [populate] Profile population (`profileParamsToPopulate`) supports single item and list population - #203
* [storage] `uploadFile` and `uploadFiles` no longer track progress by default (`storageRef.put` called directly)
* [config] Usage of `profileFactory` is wrapped in try/catch to handle and reject errors within provided factory function
* [config] `distpatchOnUnsetListener` spelling fixed to be `dispatchOnUnsetListener` (depreciation warning added along with a test confirm it is displayed)
* [config] `enableEmptyAuthChanges` config option added - #137


### Build
* Firebase is now an external in Webpack config (shrinks UMD build size)
* `.npmignore` expanded to include more files that do not needed to be included in published version (including `.babelrc` which can cause build errors)
* `.babelrc` settings are now environment specific (decorators only used in testing)
* `babel-preset-stage-1` removed (unnecessary)
* `.eslintrc` added to tests folder which contains globals that are only necessary for testing (simplifies top level eslint config)
* `.eslintrc` file now using yaml format instead of JSON format (easier to read)
* `async/await` added to unit tests
* Webpack 2
* [`firebase-server`](https://github.com/urish/firebase-server) used in tests instead of connecting to a real Firebase instance

### Docs
* Query docs updated with `storeAs` and `keyProp` query options
* `redux-persist` recipe added

Author: prescottprue

.babelrc

@@ -1,12 +1,25 @@
 {
-  "presets": ["es2015", "stage-1", "react"],
+  "presets": ["es2015", "react"],
   "plugins": [
-    "es6-promise",
-    "add-module-exports",
     "lodash",
+    "add-module-exports",
     "transform-object-rest-spread",
     "transform-object-assign",
-    "transform-class-properties",
-    "transform-decorators-legacy"
-  ]
+    "transform-class-properties"
+  ],
+  "env": {
+    "es": {
+      "comments": false
+    },
+    "commonjs": {
+      "comments": false
+    },
+    "test": {
+      "plugins": [
+        "transform-runtime",
+        "transform-decorators-legacy",
+        "transform-async-to-generator"
+      ]
+    }
+  }
 }

.eslintrc

@@ -1,24 +1,20 @@
-{
-  "parser"  : "babel-eslint",
-  "extends" : [
-    "standard",
-    "standard-react"
-  ],
-  "plugins": [
-    "babel"
-  ],
-  "env"     : {
-    "browser" : true
-  },
-  "globals" : {
-    "__DEV__"      : false,
-    "__PROD__"     : false,
-    "__DEBUG__"    : false,
-    "__COVERAGE__" : false,
-    "__BASENAME__" : false
-  },
-  "rules": {
-    "semi" : [2, "never"],
-    "no-console": "error"
-  }
-}
+root: true
+
+parser: babel-eslint
+
+extends: [standard, standard-react]
+plugins: [babel, react]
+
+env:
+  browser: true
+  es6: true
+  jasmine: true
+  node: true
+
+ecmaFeatures:
+  jsx: true
+  modules: true
+
+rules:
+  semi: [2, 'never']
+  no-console: 'error'

.npmignore

@@ -0,0 +1,21 @@
+docs
+bin
+examples
+tests
+coverage
+.istanbul.yml
+_book
+.babelrc
+SUMMARY.md
+webpack.config.js
+.eslintignore
+.eslintrc
+book.json
+CNAME
+.github
+yarn.lock
+.travis.yml
+CODE_OF_CONDUCT.md
+CHANGELOG.md
+.codeclimate.yml
+PATRONS.md

README.md

@@ -253,7 +253,7 @@ Join us on the [redux-firebase gitter](https://gitter.im/redux-firebase/Lobby).
 View docs for recipes on integrations with:
 
 * [redux-thunk](/docs/recipes/thunks.md)
-* [redux-observable](/docs/recipes/redux-observable.md)
+* [redux-observable](/docs/recipes/epics.md)
 * [redux-saga](/docs/recipes/redux-saga.md)
 * [redux-form](/docs/recipes/redux-form.md)
 * [redux-auth-wrapper](/docs/recipes/routing.md#advanced)
@@ -292,7 +292,7 @@ The [examples folder](/examples) contains full applications that can be copied/a
     I have been talking to the author of [redux-react-firebase](https://github.com/tiberiuc/redux-react-firebase) about combining, but we are not sure that the users of both want that at this point. Join us on the [redux-firebase gitter](https://gitter.im/redux-firebase/Lobby) if you haven't already since a ton of this type of discussion goes on there.
 
     #### What about [redux-firebase](https://github.com/colbyr/redux-firebase)?
-    The author of [redux-firebase](https://github.com/colbyr/redux-firebase) has agreed to share the npm namespace! Currently the plan is to take the framework agnostic redux core logic of `react-redux-firebase` and place it into `redux-firebase`. Eventually `react-redux-firebase` and potentially other framework libraries can depend on that core (the new `redux-firebase`).
+    The author of [redux-firebase](https://github.com/colbyr/redux-firebase) has agreed to share the npm namespace! Currently the plan is to take the framework agnostic redux core logic of `react-redux-firebase` and [place it into `redux-firebase`](https://github.com/prescottprue/redux-firebase)). Eventually `react-redux-firebase` and potentially other framework libraries can depend on that core (the new `redux-firebase`).
 
 2. Why use redux if I have Firebase to store state?
 

SUMMARY.md

@@ -17,6 +17,7 @@
   * [Upload](/docs/recipes/upload.md)
   * [Redux Thunk](/docs/recipes/thunks.md)
   * [Redux Form](/docs/recipes/redux-form.md)
+  * [Redux Persist](/docs/recipes/redux-persist.md)
   * [Redux Saga](/docs/recipes/redux-saga.md)
   * [React Native](/docs/recipes/react-native.md)
   * [React Chrome Redux](/docs/recipes/react-chrome-redux.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

@@ -36,6 +36,11 @@ Middleware that handles configuration (placed in redux's
         auth redirect handling listener. (default: `true`)
     -   `config.onAuthStateChanged` **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)** Function run when auth state
         changes. Argument Pattern: `(authData, firebase, dispatch)`
+    -   `config.enableEmptyAuthChanges` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Whether or not to enable
+        empty auth changes. When set to true, `onAuthStateChanged` will be fired with,
+        empty auth changes such as undefined on initialization. See
+        [#137](https://github.com/prescottprue/react-redux-firebase/issues/137) for
+        more details. (default: `false`)
     -   `config.onRedirectResult` **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)** Function run when redirect
         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

docs/api/connect.md

@@ -13,7 +13,7 @@ to provided firebase paths using React's Lifecycle hooks.
 
 **Parameters**
 
--   `dataOrFn`   (optional, default `[]`)
+-   `storeKey`   (optional, default `'store'`)
 -   `watchArray` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)** Array of objects or strings for paths to sync from Firebase. Can also be a function that returns the array. The function is passed the current props and the firebase object.
 
 **Examples**
@@ -52,15 +52,30 @@ import { connect } from 'react-redux'
 import { firebaseConnect, dataToJS } from 'react-redux-firebase'
 
 // sync /todos from firebase into redux
-const fbWrapped = firebaseConnect((props, firebase) => ([
-  `todos/${firebase.database().currentUser.uid}/${props.type}`
+const fbWrapped = firebaseConnect((props) => ([
+  `todos/${props.type}`
 ])(App)
 
 // pass todos list for the specified type of todos from redux as `this.props.todosList`
 export default connect(({ firebase, type }) => ({
-  todosList: dataToJS(firebase, `data/todos/${firebase.getIn(['auth', 'uid'])}/${type}`),
-  profile: pathToJS(firebase, 'profile'), // pass profile data as this.props.profile
-  auth: pathToJS(firebase, 'auth') // pass auth data as this.props.auth
+  todosList: dataToJS(firebase, `data/todos/${type}`),
+}))(fbWrapped)
+```
+
+_Data that depends on auth state_
+
+```javascript
+import { connect } from 'react-redux'
+import { firebaseConnect, dataToJS } from 'react-redux-firebase'
+
+// sync /todos from firebase into redux
+const fbWrapped = firebaseConnect((props, firebase) => ([
+  `todos/${firebase._.authUid}`
+])(App)
+
+// pass todos list for the specified type of todos from redux as `this.props.todosList`
+export default connect(({ firebase }) => ({
+  todosList: dataToJS(firebase, `data/todos/${firebase.getIn(['auth', 'uid'])}`),
 }))(fbWrapped)
 ```
 

docs/api/constants.md

@@ -44,6 +44,15 @@ Object containing all action types
 -   `FILE_DELETE_START` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** `@@reactReduxFirebase/FILE_DELETE_START`
 -   `FILE_DELETE_ERROR` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** `@@reactReduxFirebase/FILE_DELETE_ERROR`
 -   `FILE_DELETE_COMPLETE` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** `@@reactReduxFirebase/FILE_DELETE_COMPLETE`
+-   `AUTH_UPDATE_START` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** `@@reactReduxFirebase/AUTH_UPDATE_START`
+-   `AUTH_UPDATE_ERROR` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** `@@reactReduxFirebase/AUTH_UPDATE_ERROR`
+-   `AUTH_UPDATE_COMPLETE` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** `@@reactReduxFirebase/AUTH_UPDATE_COMPLETE`
+-   `PROFILE_UPDATE_START` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** `@@reactReduxFirebase/PROFILE_UPDATE_START`
+-   `PROFILE_UPDATE_ERROR` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** `@@reactReduxFirebase/PROFILE_UPDATE_ERROR`
+-   `PROFILE_UPDATE_COMPLETE` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** `@@reactReduxFirebase/PROFILE_UPDATE_COMPLETE`
+-   `EMAIL_UPDATE_START` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** `@@reactReduxFirebase/EMAIL_UPDATE_START`
+-   `EMAIL_UPDATE_ERROR` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** `@@reactReduxFirebase/EMAIL_UPDATE_ERROR`
+-   `EMAIL_UPDATE_COMPLETE` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** `@@reactReduxFirebase/EMAIL_UPDATE_COMPLETE`
 
 **Examples**
 
@@ -69,6 +78,11 @@ Default configuration options
 -   `enableRedirectHandling` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** `true` Whether or not to enable
     redirect handling. This must be disabled if environment is not http/https
     such as with react-native.
+-   `enableEmptyAuthChanges` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** `false` Whether or not to enable
+    empty auth changes. When set to true, `onAuthStateChanged` will be fired with,
+    empty auth changes such as `undefined` on initialization
+    (see [#137](https://github.com/prescottprue/react-redux-firebase/issues/137)).
+    Requires `v1.5.0-alpha` or higher.
 -   `autoPopulateProfile` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** `true` Whether or not to
     automatically populate profile with data loaded through
     profileParamsToPopulate config.
@@ -77,7 +91,7 @@ Default configuration options
     the data path. For example role parameter on profile populated from 'roles'
     root. True will call SET_PROFILE as well as a SET action with the role that
     is loaded (places it in data/roles).
--   `distpatchOnUnsetListener` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** `false` Whether or not to
+-   `dispatchOnUnsetListener` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** `false` Whether or not to
     dispatch UNSET_LISTENER when disabling listeners for a specific path. USE WITH CAUTION
     Setting this to true allows an action to be called that removes data
     from redux (which might not always be expected).

docs/api/helpers.md

@@ -22,7 +22,8 @@ Detect whether items are loaded yet or not
 **Examples**
 
 ```javascript
-import React, { Component, PropTypes } from 'react'
+import React, { Component } from 'react'
+import PropTypes from 'prop-types'
 import { connect } from 'react-redux'
 import { firebaseConnect, isLoaded, dataToJS } from 'react-redux-firebase'
 ```
@@ -41,7 +42,8 @@ Detect whether items are empty or not
 **Examples**
 
 ```javascript
-import React, { Component, PropTypes } from 'react'
+import React, { Component } from 'react'
+import PropTypes from 'prop-types'
 import { connect } from 'react-redux'
 import { firebaseConnect, isEmpty, dataToJS } from 'react-redux-firebase'
 ```