v2.0.3

* feat(config): support `Boolean` and `Function` types as preserve options for config and when emitting actions
* fix(firestoreConnect): fix issue with unsetting listeners on unmount - prescottprue#384 and [51 on `redux-firestore`](prescottprue/redux-firestore#51) - @danleavitt0 
* feat(docs): query docs updated and formatting simplified
* feat(docs): `Function` capability added to docs about `preserve` config parameters

Author: prescottprue

.codeclimate.yml

@@ -3,7 +3,7 @@ languages:
 
 exclude_paths:
 - "lib/**"
-- "tests/**"
+- "test/**"
 - "examples/**"
 - "LICENSE"
 - "LICENSE.md"

docs/api/constants.md

@@ -95,9 +95,12 @@ Default configuration options
     with parts of state to preserve, and the values are Arrays contain keys
     for keys within that slice of state to preserve.
 -   `preserveOnEmptyAuthChange` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** `null` Data parameters to
-    preserve when logging out. Keys associate with parts of state to preserve,
-    and the values are Arrays contain keys for keys within that slice of state
-    to preserve.
+    preserve when empty auth changes occur. Keys associate with parts of state
+    to preserve, and the values are either Arrays or Functions. If passing an
+    array of keys (i.e. `{ auth: ['key1', 'key2'] }`) - those keys (`'key1'` and
+    `'key2'`) are preserved from that slice of state (`auth`). If passing a
+    function (i.e. `{ auth: (currentAuthState, nextAuthState) => ({}) }`),
+    whatever is returned from the function is set to that slice of state (`auth`).
 -   `updateProfileOnLogin` **[Boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** `true` Whether or not to update
     user profile when logging in.
 -   `resetBeforeLogin` **[Boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** `true` Whether or not to reset auth

docs/api/enhancer.md

@@ -29,8 +29,14 @@ along side applyMiddleware.
         and auth state on login
     -   `config.perserveOnLogout` **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) \| [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array))** Data parameters to perserve
         when logging out. If Array is passed, each item represents keys
-        within state.firebase.data preserve. If an object is passed, Keys associate
-        with parts of state to preserve, and the values are Arrays which
+        within `state.firebase.data` to preserve. If an object is passed,
+        keys associate with slices of state to preserve, and the values can be either
+        an `Array` or a `Function` (argument pattern: `(currentState, nextState)`).
+        If passing an array of keys (i.e. `{ auth: ['key1', 'key2'] }`) - those keys
+        (`'key1'` and `'key2'`) are preserved from that slice of state (`auth`). If
+        passing a function (i.e.
+        `{ auth: (currentAuthState, nextAuthState) => ({}) }`),
+        whatever is returned from the function is set to that slice of state (`auth`).
         associate with which keys to preserve form that section of state.
         (default: `null`)
     -   `config.preserveOnEmptyAuthChange` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** `null` Data parameters to

docs/auth.md

@@ -1,16 +1,19 @@
 # Authentication Methods
 
-Authentication data is attached to `auth`, profile is attached to `profile` if you provide a value to the `userProfile` config option. You can get them within components like so:
+Authentication data is attached to `state.firebase.auth`, profile is attached to `state.firebase.profile` if you provide a value to the `userProfile` config option. You can get them within components like so:
 
 ```js
 import { connect } from 'react-redux'
-connect(
-  // Map state to props
+
+const enhance = connect(
+  // Map redux state to component props
   ({ firebase: { auth, profile } }) => ({
     auth,
     profile
   })
 )
+
+enhance(SomeComponent)
 ```
 
 If you need access to methods that are not available at the top level, you can access Firebase's Full Auth API using `props.firebase.auth()` or `getFirebase().auth()`.
@@ -64,13 +67,13 @@ export default firebaseConnect()(SomeComponent) // or withFirebase(SomeComponent
         {
           provider: "facebook | google | twitter",
           type: "popup | redirect", // popup is default
-          scopes: ['email'] // email is default
+          scopes: Array // email is default
         }
         ```
       * credential (runs `ref.signInWithCredential(credential)`) :
         ```js
         {
-          credential : [firebase.auth.AuthCredential](https://firebase.google.com/docs/reference/js/firebase.auth.AuthCredential.html) // created using specific provider
+          credential: firebase.auth.AuthCredential // created using specific provider
         }
         ```
         The credential parameter is a firebase.auth.AuthCredential specific to the provider (i.e. `firebase.auth.GoogleAuthProvider.credential(null, 'some accessToken')`). For more details [please view the Firebase API reference](https://firebase.google.com/docs/reference/js/firebase.auth.GoogleAuthProvider#methods)
@@ -92,7 +95,7 @@ export default firebaseConnect()(SomeComponent) // or withFirebase(SomeComponent
         ```js
         {
           phoneNumber: String,
-          applicationVerifier: [`firebase.auth.ApplicationVerifier`](https://firebase.google.com/docs/reference/js/firebase.auth.ApplicationVerifier.html)
+          applicationVerifier: firebase.auth.ApplicationVerifier
         }
         ```