v2.0.0-rc.2 (prescottprue#364)

* fix(firestore): profile update with firestore - prescottprue#360 - @barnomics
* fix(auth): `loginWithCustomToken` supports passing `profile` parameter - prescottprue#359
* feat(auth): error messages for not logged using same wording for all methods (i.e. “User must be logged in”)
* feat(docs): `loginWithCustomToken` section updated with note about how `profile` is required in certain cases - prescottprue#359
* feat(docs): roadmap updated to include option for re-rendering HOCs based on auth state change - prescottprue#367
* feat(docs): link added to sidebar for each of the separate reducers
* feat(docs): note added to FAQ about why `yarn.lock` file is not included
* fix(test): extended timeout added to unit tests for `login` to prevent fail on slow connections
* feat(docs): note added to reducer docs about how it is multiple slice reducers combined with `combineReducers`
* feat(test): unit tests added for auth/query actions not previously covered (`updateEmail`, `updateAuth`, `orderedFromSnapshot`, etc)
* fix(test): tests simplified by moving reused functions to test utils
* fix(test): remove lint warning caused by `mocha.opts` being ignored
* update(deps): `prop-types` dependency updated from `v15.5.*` to v15.6.*`
* update(deps): tons of dev dependencies updated including `babel-cli`, `babel-core`, `eslint`,  `sinon`, `mocha`, `jsdom`

##### Note

`v2.0.0` syntax is now considered stable 🍾 (multiple production applications have switched from `v1.5.*` to `v2.*.*` following [the migration guide](docs.react-redux-firebase.com/history/v2.0.0/docs/v2-migration-guide.html), and test coverage is better than for `v1.5.*`). Merge conflicts with `master` have also been resolved. All of this means this release will be the final RC released on `next` before moving [`v2.0.0`](https://github.com/prescottprue/react-redux-firebase/tree/v2.0.0) to the `latest` tag on npm (the `latest` tag release will include merging to `master`).

Author: prescottprue

README.md

@@ -19,17 +19,14 @@
 The [Material Example](https://github.com/prescottprue/react-redux-firebase/tree/master/examples/complete/material) is deployed to [demo.react-redux-firebase.com](https://demo.react-redux-firebase.com).
 
 ## Features
-- Support for updating and nested props
-- [Population capability](http://react-redux-firebase.com/docs/populate) (similar to mongoose's `populate` or SQL's `JOIN`)
+- Integrated into redux
 - Out of the box support for authentication (with auto load user profile)
-- Firebase Database, Firestore, Auth, Storage, and Messaging Support
+- Full Firebase Platform Support Including Real Time Database, Firestore, and Storage
+- Automatic binding/unbinding of listeners through React Higher Order Components (`firebaseConnect`  and `firestoreConnect`)
+- [Population capability](http://react-redux-firebase.com/docs/populate) (similar to mongoose's `populate` or SQL's `JOIN`)
 - Support small data ( using `value` ) or large datasets ( using `child_added`, `child_removed`, `child_changed` )
-- queries including `orderByChild`, `orderByKey`, `orderByValue`, `orderByPriority`, `limitToLast`, `limitToFirst`, `startAt`, `endAt`, `equalTo`
-- Automatic binding/unbinding through `firestoreConnect` (manual through `watchEvent`)
-- Declarative decorator syntax for React components
-- Tons of integrations including [`redux-thunk`](https://github.com/gaearon/redux-thunk) and [`redux-observable`](https://redux-observable.js.org/)
-- Action Types and other Constants exported for external use (such as in `redux-observable`)
-- Firebase v3+ support
+- Multiple queries types supported including `orderByChild`, `orderByKey`, `orderByValue`, `orderByPriority`, `limitToLast`, `limitToFirst`, `startAt`, `endAt`, `equalTo`
+- Tons of examples of integrations including [`redux-thunk`](https://github.com/gaearon/redux-thunk) and [`redux-observable`](https://redux-observable.js.org/)
 - Server Side Rendering Support
 - [`react-native` support](/docs/recipes/react-native.md) using [native modules](http://docs.react-redux-firebase.com/history/v2.0.0/docs/recipes/react-native.html#native-modules) or [web sdk](/docs/recipes/react-native.md#jsweb)
 
@@ -44,6 +41,9 @@ npm install --save react-redux-firebase@next
 Include `reactReduxFirebase` in your store compose function and  `firebaseReducer` in your reducers:
 
 ```javascript
+import React from 'react'
+import { render } from 'react-dom'
+import { Provider } from 'react-redux'
 import { createStore, combineReducers, compose } from 'redux'
 import { reactReduxFirebase, firebaseReducer } from 'react-redux-firebase'
 import firebase from 'firebase'
@@ -69,7 +69,7 @@ const createStoreWithFirebase = compose(
   // reduxFirestore(firebase) // <- needed if using firestore
 )(createStore)
 
-// Add Firebase to reducers
+// Add firebase to reducers
 const rootReducer = combineReducers({
   firebase: firebaseReducer,
   // firestore: firestoreReducer // <- needed if using firestore
@@ -78,9 +78,18 @@ const rootReducer = combineReducers({
 // Create store with reducers and initial state
 const initialState = {}
 const store = createStoreWithFirebase(rootReducer, initialState)
+
+// Setup react-redux so that connect HOC can be used
+const App = () => (
+  <Provider store={store}>
+    <Todos />
+  </Provider>
+);
+
+render(<App/>, document.getElementById('root'));
 ```
 
-In components:
+Todos component (`./Todos`):
 
 **Add Data**
 
@@ -241,7 +250,6 @@ export default compose(
 )(Todos)
 ```
 
-
 ## [Docs](http://react-redux-firebase.com)
 See full documentation at [react-redux-firebase.com](http://react-redux-firebase.com)
 
@@ -290,6 +298,14 @@ View docs for recipes on integrations with:
 * [react-native](/docs/integrations/react-native.md)
 * [react-native-firebase](http://docs.react-redux-firebase.com/history/v2.0.0/docs/integrations/react-native.html#native-modules) - requires `v2.0.0`
 
+## Firestore
+
+If you plan to use Firestore, you should checkout [`redux-firestore`][redux-firestore]. It integrates nicely with `react-redux-firebase` (v2 only) and it allows you to run Real Time Database and Firestore along side each other.
+
+`react-redux-firebase` provides the `firestoreConnect` HOC (similar to `firebaseConnect`) for easy setting/unsetting of listeners.
+
+Currently `react-redux-firebase` still handles auth when using [`redux-firestore`][redux-firestore] - The future plan is to also have auth standalone auth library that will allow the developer to choose which pieces they do/do not want.
+
 ## Starting A Project
 
 ### Generator
@@ -308,7 +324,7 @@ Please visit the [FAQ section of the docs](http://docs.react-redux-firebase.com/
 
 This project exists thanks to all the people who contribute.
 
-<a href="graphs/contributors"><img src="https://opencollective.com/react-redux-firebase/contributors.svg?width=890" /></a>
+<a href="https://github.com/prescottprue/react-redux-firebase/graphs/contributors"><img src="https://opencollective.com/react-redux-firebase/contributors.svg?width=890" /></a>
 
 ## Backers
 
@@ -337,3 +353,4 @@ Thank you to all our backers! 🙏
 [code-style-url]: http://standardjs.com/
 [gitter-image]: https://img.shields.io/gitter/room/redux-firebase/gitter.svg?style=flat-square
 [gitter-url]: https://gitter.im/redux-firebase/Lobby
+[redux-firestore]: https://github.com/prescottprue/redux-firestore

SUMMARY.md

@@ -31,7 +31,18 @@
   * [withFirebase](/docs/api/withFirebase.md)
   * [firestoreConnect](/docs/api/firestoreConnect.md)
   * [withFirestore](/docs/api/withFirestore.md)
-  * [firebaseStateReducer](/docs/api/reducer.md)
+  * [firebaseReducer](/docs/api/reducer.md)
+    * [isInitializingReducer](/docs/api/reducers.md#isinitializingreducer)
+    * [requestingReducer](/docs/api/reducers.md#requestingreducer)
+    * [requestedReducer](/docs/api/reducers.md#requestedreducer)
+    * [timestampsReducer](/docs/api/reducers.md#timestampsreducer)
+    * [authReducer](/docs/api/reducers.md#authreducer)
+    * [authErrorReducer](/docs/api/reducers.md#autherrorreducer)
+    * [profileReducer](/docs/api/reducers.md#profilereducer)
+    * [errorsReducer](/docs/api/reducers.md#errorsreducer)
+    * [listenersTeducer](/docs/api/reducers.md#listenersreducer)
+    * [dataReducer](/docs/api/reducers.md#datareducer)
+    * [orderedReducer](/docs/api/reducers.md#orderedreducer)
   * [reactReduxFirebase](/docs/api/enhancer.md)
   * [props.firebase](/docs/api/props-firebase.md)
   * [getFirebase](/docs/api/get-firebase.md)

bin/api-docs-generate.js

@@ -28,6 +28,10 @@ const files = [
     src: 'helpers.js',
     dest: 'helpers.md'
   },
+  {
+    src: 'reducers.js',
+    dest: 'reducers.md'
+  },
   {
     src: 'reducer.js',
     dest: 'reducer.md'

docs/FAQ.md

@@ -16,7 +16,7 @@
     * [Complete Firebase Auth Integration](http://react-redux-firebase.com/docs/auth.html#examples) including `signInWithRedirect` compatibility for OAuth Providers
 
     #### Well why not combine?
-    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.
+    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][gitter-url] 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`](https://github.com/prescottprue/redux-firebase)). Eventually `react-redux-firebase` and potentially other framework libraries can depend on that core (the new `redux-firebase`).
@@ -34,8 +34,14 @@
 
     ![data flow](/docs/static/dataFlow.png)
 
-5. How do I help?
+5. Where is the `yarn.lock` file?
+
+  There isn't one, there is just a `package-lock.json`. `npm v5.x.x` adds support for a `package-lock.json` file which serves a similar purpose to a `yarn.lock` file. Instead of managing multiple lock files, the single `package-lock.json` contains exact version information for dependencies.
+
+6. How do I help?
 
   * Join the conversion on [gitter][gitter-url]
   * Post Issues
   * Create Pull Requests
+
+[gitter-url]: gitter.im/redux-firebase/Lobby

docs/api/connect.md

@@ -15,7 +15,7 @@ needing to access a firebase instance created under a different store key.
 
 **Parameters**
 
--   `storeKey` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Name of redux store which contains
+-   `storeKey` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Name of redux store which contains
     Firebase state (state.firebase) (optional, default `'store'`)
 
 **Examples**
@@ -31,7 +31,7 @@ const firebaseConnect = createFirebaseConnect('anotherStore')
 export default firebaseConnect()(SomeComponent)
 ```
 
-Returns **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)** HOC that accepts a watchArray and wraps a component
+Returns **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** HOC that accepts a watchArray and wraps a component
 
 ## firebaseConnect
 
@@ -42,14 +42,16 @@ to provided firebase paths using React's Lifecycle hooks.
 
 **Parameters**
 
--   `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.
+-   `watchArray` **[Array](https://developer.mozilla.org/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**
 
 _Basic_
 
 ```javascript
-// this.props.firebase set on App component as firebase object with helpers
+// props.firebase set on App component as firebase object with helpers
 import { firebaseConnect } from 'react-redux-firebase'
 export default firebaseConnect()(App)
 ```
@@ -121,4 +123,4 @@ export default compose(
 )(SomeComponent)
 ```
 
-Returns **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)** that accepts a component to wrap and returns the wrapped component
+Returns **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** that accepts a component to wrap and returns the wrapped component