v0.5.5

* fix(orderedReducer): `LISTENER_RESPONSE` and `DOCUMENT_REMOVED` actions
correctly updating state for sub-collections
* feat(tests): tests added for success callback and error callback arguments of `setListener` method
* fix(core): only copy public methods from `firebase.firestore()` instance - #93, #108
* fix(actions): `runTransaction` no longer failing - #108
* fix(orderedReducer): empty listener response correctly updates state when using `storeAs`
* fix(orderedReducer): fix merge setting (`merge.collection` to `merge.collections`) - @danleavitt0
* feat(actions): attempting to delete sub collection at any level throw (previously only top level)
* feat(tests): Add tests for success and error callbacks of setListener
* fix(orderedReducer): return state directly for non-matching action types
* fix(deps): lock prettier version to 1.10.0 (prevents build fail on Travis)

Author: prescottprue

.travis.yml

@@ -3,9 +3,9 @@ sudo: false
 language: node_js
 
 node_js:
-  - 6.11.5
-  - 8
-  - 9 # LTS
+  - 6.14.0 # Cloud Functions Runtime
+  - 9
+  - 10
 
 notifications:
   email:

README.md

@@ -38,7 +38,9 @@ npm install --save react-redux-firebase
 ```javascript
 import { createStore, combineReducers, compose } from 'redux'
 import { reduxFirestore, firestoreReducer } from 'redux-firestore'
-import firebase from 'firebase'
+import firebase from 'firebase/app'
+import 'firebase/auth'
+import 'firebase/database'
 import 'firebase/firestore'
 
 const firebaseConfig = {} // from Firebase Console
@@ -268,6 +270,7 @@ store.firestore.setListeners([
 // props.store.firestore.get('cities/SF'),
 ```
 
+**Note:** When nesting sub-collections, [`storeAs`](#storeas) should be used for more optimal state updates.
 
 ##### Where
 
@@ -292,7 +295,7 @@ Multiple `where` queries are as simple as passing multiple argument arrays (each
 },
 ```
 
-*Should only be used with collections*
+*Can only be used with collections*
 
 ##### orderBy
 
@@ -318,7 +321,7 @@ Multiple `orderBy`s are as simple as passing multiple argument arrays (each one
 },
 ```
 
-*Should only be used with collections*
+*Can only be used with collections*
 
 ##### limit
 
@@ -331,7 +334,7 @@ Limit the query to a certain number of results
 },
 ```
 
-*Should only be used with collections*
+*Can only be used with collections*
 
 ##### startAt
 
@@ -347,7 +350,7 @@ Limit the query to a certain number of results
 },
 ```
 
-*Should only be used with collections*
+*Can only be used with collections*
 
 ##### startAfter
 
@@ -363,7 +366,7 @@ Limit the query to a certain number of results
 },
 ```
 
-*Should only be used with collections*
+*Can only be used with collections*
 
 ##### endAt
 
@@ -380,7 +383,7 @@ Limit the query to a certain number of results
 },
 ```
 
-*Should only be used with collections*
+*Can only be used with collections*
 
 ##### endBefore
 
@@ -397,7 +400,7 @@ Limit the query to a certain number of results
 },
 ```
 
-*Should only be used with collections*
+*Can only be used with collections*
 
 ##### storeAs
 
@@ -451,11 +454,6 @@ export default enhance(SomeComponent)
 
 ## Config Options
 
-#### enableLogging
-Default: `false`
-
-Whether or not to enable Firebase client logging.
-
 #### logListenerError
 Default: `true`
 
@@ -471,7 +469,7 @@ Default: `false`
 
 Whether or not to allow multiple listeners to be attached for the same query. If a function is passed the arguments it receives are `listenerToAttach`, `currentListeners`, and the function should return a boolean.
 
-### oneListenerPerPath
+#### oneListenerPerPath
 Default: `false`
 
 If set to true redux-firestore will attach a listener on the same path just once & will count how many the listener was set. When you try to unset the lisnter, it won't unset until you have less than 1 listeners on this path

examples/basic/package-lock.json

@@ -11,7 +11,7 @@
     "react-scripts": "1.1.4",
     "recompose": "^0.27.0",
     "redux": "^4.0.0",
-    "redux-firestore": "^0.5.2"
+    "redux-firestore": "latest"
   },
   "scripts": {
     "start": "react-scripts start",

examples/basic/package.json

@@ -34,17 +34,19 @@ Todos.propTypes = {
   })
 }
 
+const listenerSettings = {
+  collection: 'todos',
+  orderBy: ['createdAt', 'desc'],
+  limit: 10
+}
+
 // Create HOC that loads data and adds it as todos prop
 const enhance = compose(
   // add redux store (from react context) as a prop
   withFirestore,
   // Handler functions as props
   withHandlers({
-    loadData: props => err => props.firestore.setListener({
-      collection: 'todos',
-      orderBy: ['createdAt', 'desc'],
-      limit: 10
-    }),
+    loadData: props => err => props.firestore.setListener(listenerSettings),
     onNewSubmit: props => newTodo =>
       props.firestore.add('todos', {
         ...newTodo,
@@ -59,11 +61,7 @@ const enhance = compose(
       this.props.loadData()
     },
     componentWillUnmount() {
-      this.props.firestore.unsetListener({
-        collection: 'todos',
-        orderBy: ['createdAt', 'desc'],
-        limit: 10
-      })
+      this.props.firestore.unsetListener(listenerSettings)
     }
   }),
   // Connect todos from redux state to props.todos

examples/basic/src/Todos.js

@@ -1,20 +1,20 @@
 import { createStore, compose } from 'redux'
 import { reduxFirestore } from 'redux-firestore'
 import firebase from 'firebase/app'
+import 'firebase/database'
+import 'firebase/auth'
 import 'firebase/firestore'
 import { fbConfig } from './config'
 import rootReducer from './reducer'
 
-// import 'firebase/storage'
-
-firebase.initializeApp(fbConfig)
-
-// Provide timestamp settings to silence warning about deprecation
-firebase.firestore().settings({ timestampsInSnapshots: true })
-
 export default function configureStore(initialState, history) {
   const enhancers = []
 
+  firebase.initializeApp(fbConfig)
+
+  // Provide timestamp settings to silence warning about deprecation
+  firebase.firestore().settings({ timestampsInSnapshots: true })
+
   // Dev tools store enhancer
   const devToolsExtension = window.devToolsExtension;
   if (typeof devToolsExtension === 'function') {

examples/basic/src/createStore.js

@@ -32,13 +32,13 @@
     "react-dom": "^15.5.4",
     "react-google-button": "^0.3.0",
     "react-redux": "^5.0.4",
-    "react-redux-firebase": "^2.1.1",
+    "react-redux-firebase": "latest",
     "react-router": "^3.0.0",
     "react-tap-event-plugin": "^2.0.1",
     "redbox-react": "^1.3.6",
     "redux": "^3.6.0",
     "redux-auth-wrapper": "^1.0.0",
-    "redux-firestore": "*",
+    "redux-firestore": "latest",
     "redux-form": "^6.6.1",
     "redux-form-material-ui": "^4.2.0",
     "redux-thunk": "^2.2.0",

examples/complete/package-lock.json

@@ -1,47 +1,51 @@
 import React from 'react'
+import PropTypes from 'prop-types'
 import Theme from 'theme'
 import { connect } from 'react-redux'
 import { compose, lifecycle, withHandlers } from 'recompose'
+import { withFirestore } from 'react-redux-firebase'
 import { withStore } from 'utils/components'
 import classes from './Home.scss'
-const authWrapperUrl = 'https://github.com/mjrussell/redux-auth-wrapper'
-const reactRouterUrl = 'https://github.com/ReactTraining/react-router'
 
-export const Home = ({ todos }) => (
+const Home = ({ todos }) => (
   <div
     className={classes.container}
     style={{ color: Theme.palette.primary2Color }}>
     <div className="flex-row-center">
       <h2>Home Route</h2>
     </div>
     <div>
-      {
-        todos.map((todo, i) => (
-          <div key={`${todo.id}-${i}`}>
-            {JSON.stringify(todo)}
-          </div>
-        ))
-      }
+      {todos.map((todo, i) => (
+        <div key={`${todo.id}-${i}`}>{JSON.stringify(todo)}</div>
+      ))}
     </div>
   </div>
 )
 
-export default compose(
+Home.propTypes = {
+  todos: PropTypes.array
+}
+
+const enhance = compose(
   withStore,
+  withFirestore,
   withHandlers({
     loadCollection: props => props.store.firestore.get,
-    onDoneClick: props => (key, done = false) =>
-      props.store.firestore.update('todos', key, { done }),
     onNewSubmit: props => newTodo =>
-      props.store.firestore.add('todos', { ...newTodo, owner: 'Anonymous' })
+      props.store.firestore.add('todos', {
+        ...newTodo,
+        owner: props.uid || 'Anonymous'
+      })
   }),
   lifecycle({
     componentWillMount() {
       this.props.loadCollection('todos')
     }
   }),
-  connect(({ firestore }) => ({
+  connect(({ firestore, firebase }) => ({
     todos: firestore.ordered.todos || [],
-    uid: firestore.profile.uid
+    uid: firebase.auth.uid
   }))
-)(Home)
+)
+
+export default enhance(Home)

examples/complete/package.json

@@ -1,7 +1,9 @@
 import { applyMiddleware, compose, createStore } from 'redux'
 import { browserHistory } from 'react-router'
-import firebase from 'firebase'
+import firebase from 'firebase/app'
 import 'firebase/firestore'
+import 'firebase/database'
+import 'firebase/auth'
 import { reduxFirestore } from 'redux-firestore'
 import { reactReduxFirebase } from 'react-redux-firebase'
 import makeRootReducer from './reducers'
@@ -34,7 +36,7 @@ export default (initialState = {}) => {
   }
 
   firebase.initializeApp(fbConfig)
-  firebase.firestore()
+  firebase.firestore().settings({ timestampsInSnapshots: true })
 
   // ======================================================
   // Store Instantiation and HMR Setup