v2.0.0-beta.17 (#334)

* fix(populate): undefined populate child responds unmodified as expected - #310
* fix(auth): `UNLOAD_PROFILE` action type no longer dispatched (did not fix issue) - #301
* feat(populate): support for populating ordered data with multiple populates where one populate child missing
* feat(query): parsed query param added to allow disabling of automatic parsing - #302
* feat(config): `preserveOnLogin` config option added to allow preserving of pieces of state affected by `LOGIN` action (called by `login` action creator)
* feat(tests): test added to check profile state consistency on `LOGIN` dispatch - #301
* feat(tests): tests added for `getVal` helper
* feat(tests): Unit tests added for populating ordered data

Author: prescottprue

docs/api/helpers.md

@@ -31,7 +31,7 @@ import { connect } from 'react-redux'
 import { firebaseConnect, getVal } from 'react-redux-firebase'
 
 const enhance = compose(
-  firebaseConnect(['/todos/user1']),
+  firebaseConnect(['todos/user1']),
   connect(({ firebase }) => ({
     // this.props.todos loaded from state.firebase.data.todos
     todos: getVal(firebase, 'data/todos/user1')
@@ -60,18 +60,21 @@ _Default Value_
 import { compose } from 'redux'
 import { connect } from 'react-redux'
 import { firebaseConnect, getVal } from 'react-redux-firebase'
+
 const defaultValue = {
  1: {
    text: 'Example Todo'
  }
 }
+
 const enhance = compose(
-  firebaseConnect(['/todos/user1']),
+  firebaseConnect(['todos/user1']),
   connect(({ firebase }) => ({
     // this.props.todos loaded from state.firebase.data.todos
     todos: getVal(firebase, 'data/todos/user1', defaultValue)
   })
 )
+
 export default enhance(SomeComponent)
 ```
 
@@ -90,10 +93,38 @@ Detect whether items are loaded yet or not
 **Examples**
 
 ```javascript
-import React, { Component } from 'react'
+import React from 'react'
 import PropTypes from 'prop-types'
+import { compose } from 'redux'
 import { connect } from 'react-redux'
-import { firebaseConnect, isLoaded } from 'react-redux-firebase'
+import { firebaseConnect, isLoaded, isEmpty } from 'react-redux-firebase'
+
+const enhance = compose(
+  firebaseConnect(['todos']),
+  connect(({ firebase: { data: { todos } } }) => ({
+    todos // state.firebase.data.todos from redux passed as todos prop
+  }))
+)
+
+const Todos = ({ todos }) => {
+  // Message for if todos are loading
+  if(!isLoaded(todos)) {
+    return <span>Loading...</span>
+  }
+
+  // Message if todos are empty
+  if(isEmpty(todos)) {
+    return <span>No Todos Found</span>
+  }
+
+  return <div><pre>{JSON.stringify(todos, null, 2)}</pre></div>
+}
+
+Todos.propTypes = {
+  todos: PropTypes.object
+}
+
+export default enhance(Todos)
 ```
 
 Returns **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Whether or not item is loaded
@@ -111,10 +142,38 @@ Detect whether items are empty or not
 **Examples**
 
 ```javascript
-import React, { Component } from 'react'
+import React from 'react'
 import PropTypes from 'prop-types'
+import { compose } from 'redux'
 import { connect } from 'react-redux'
-import { firebaseConnect, isEmpty } from 'react-redux-firebase'
+import { firebaseConnect, isEmpty, isLoaded } from 'react-redux-firebase'
+
+const enhance = compose(
+  firebaseConnect(['todos']),
+  connect(({ firebase: { data: { todos } } }) => ({
+    todos // state.firebase.data.todos from redux passed as todos prop
+  }))
+)
+
+const Todos = ({ todos }) => {
+  // Message for if todos are loading
+  if(!isLoaded(todos)) {
+    return <span>Loading...</span>
+  }
+
+  // Message if todos are empty
+  if(isEmpty(todos)) {
+    return <span>No Todos Found</span>
+  }
+
+  return <todos>{JSON.stringify(todos)}</todos>
+}
+
+Todos.propTypes = {
+  todos: PropTypes.object
+}
+
+export default enhance(Todos)
 ```
 
 Returns **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Whether or not item is empty
@@ -135,20 +194,24 @@ Populate with data from redux.
 _Basic_
 
 ```javascript
+import { compose } from 'redux'
 import { connect } from 'react-redux'
 import { firebaseConnect } from 'react-redux-firebase'
 const populates = [{ child: 'owner', root: 'users' }]
 
-const fbWrapped = firebaseConnect([
-  { path: '/todos', populates } // load "todos" and matching "users" to redux
-])(App)
+const enhance = compose(
+  firebaseConnect([
+    { path: 'todos', populates } // load "todos" and matching "users" to redux
+  ]),
+  connect((state) => ({
+    // this.props.todos loaded from state.firebase.data.todos
+    // each todo has child 'owner' populated from matching uid in 'users' root
+    // for loading un-populated todos use state.firebase.data.todos
+    todos: populate(state.firebase, 'todos', populates),
+  })
+)
 
-export default connect((state) => ({
-  // this.props.todos loaded from state.firebase.data.todos
-  // each todo has child 'owner' populated from matching uid in 'users' root
-  // for loading un-populated todos use state.firebase.data.todos
-  todos: populate(state.firebase, 'todos', populates),
-}))(fbWrapped)
+export default enhance(SomeComponent)
 ```
 
 Returns **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Data located at path within Immutable Object

docs/queries.md

@@ -161,11 +161,13 @@ queryParams: [`limitToFirst=${limitToFirst}`, `startAt=${startAt}`, 'orderByValu
 queryParams: ['orderByValue', `limitToFirst=${limitToFirst}`, `startAt=${startAt}`],
 ```
 
-If you would like to prevent parsing yourself (i.e. keep limit values as strings), you can pass [`notParsed`](#notParsed) as a queryParam:
+If you would like to prevent or cause parsing of query params yourself, you can pass [`notParsed`](#notParsed) or [`parsed`](#parsed) as a queryParam:
 
 ```js
 // limitToFirst and startAt remain as strings and are NOT automatically parsed
 queryParams: ['notParsed', `limitToFirst=${limitToFirst}`, `startAt=${startAt}`, 'orderByValue'],
+// limitToFirst and startAt are parsed into numbers if possible
+queryParams: ['parsed', `limitToFirst=${limitToFirst}`, `startAt=${startAt}`, 'orderByValue'],
 ```
 
 More on [`notParsed` below](#notParsed)
@@ -344,6 +346,7 @@ firebaseConnect([
 ])
 ```
 
+
 ## notParsed {#notParsed}
 
 Can be used to keep internal parsing from happening. Useful when attempting to search a number string using `equalTo`
@@ -363,6 +366,27 @@ firebaseConnect([
 ])
 ```
 
+## parsed {#parsed}
+
+Internally parse following query params. Useful when attempting to parse
+
+**NOTE**: `orderByChild`, `orderByPriority`, and `orderByValue` will cause this to be enabled by default. Parsing will remain enabled for the rest of the query params until `notParsed` is called.
+
+#### Examples
+1. Order by child parameter equal to a number string. Equivalent of searching for `'123'` (where as not using `notParsed` would search for children equal to `123`)
+```js
+firebaseConnect([
+  {
+    path: '/todos',
+    queryParams: [
+      'parsed', // causes automatic parsing
+      'equalTo=123' // 123 is treated as a number instead of a string
+      'orderByChild=createdBy',
+    ]
+  }
+])
+```
+
 ## storeAs {#populate}
 
 By default the results of queries are stored in redux under the path of the query. If you would like to change where the query results are stored in redux, use `storeAs`:

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "react-redux-firebase",
-  "version": "2.0.0-beta.16",
+  "version": "2.0.0-beta.17",
   "description": "Redux integration for Firebase. Comes with a Higher Order Components for use with React.",
   "main": "lib/index.js",
   "module": "es/index.js",
@@ -56,12 +56,6 @@
     "redux-react-firebase"
   ],
   "dependencies": {
-    "gitbook-plugin-anchorjs": "^1.1.1",
-    "gitbook-plugin-edit-link": "^2.0.2",
-    "gitbook-plugin-ga": "^1.0.1",
-    "gitbook-plugin-github": "^2.0.0",
-    "gitbook-plugin-prism": "^2.3.0",
-    "gitbook-plugin-versions-select": "^0.1.1",
     "hoist-non-react-statics": "^2.3.1",
     "lodash": "^4.17.4",
     "prop-types": "^15.5.10",

package.json

@@ -73,14 +73,19 @@ const getProfileFromSnap = (snap) => {
 export const handleProfileWatchResponse = (dispatch, firebase, userProfileSnap) => {
   const {
     profileParamsToPopulate,
-    autoPopulateProfile
+    autoPopulateProfile,
+    useFirestoreForProfile
   } = firebase._.config
   const profile = getProfileFromSnap(userProfileSnap)
   if (
     !profileParamsToPopulate ||
+    useFirestoreForProfile || // populating profile through firestore not yet supported
     (!isArray(profileParamsToPopulate) &&
       !isString(profileParamsToPopulate))
   ) {
+    if (useFirestoreForProfile && profileParamsToPopulate) {
+      console.warn('Profile population is not yet supported for Firestore') // eslint-disable-line no-console
+    }
     dispatch({ type: actionTypes.SET_PROFILE, profile })
   } else {
     // Convert array of populate config into an array of once query promises
@@ -322,7 +327,11 @@ const handleAuthStateChange = (dispatch, firebase, authData) => {
 
     watchUserProfile(dispatch, firebase)
 
-    dispatch({ type: actionTypes.LOGIN, auth: authData })
+    dispatch({
+      type: actionTypes.LOGIN,
+      auth: authData,
+      preserve: config.preserveOnLogin
+    })
 
     // Run onAuthStateChanged if it exists in config
     if (isFunction(config.onAuthStateChanged)) {
@@ -349,7 +358,11 @@ export const handleRedirectResult = (dispatch, firebase, authData) => {
     firebase._.authUid = user.uid // eslint-disable-line no-param-reassign
     watchUserProfile(dispatch, firebase)
 
-    dispatch({ type: actionTypes.LOGIN, auth: user })
+    dispatch({
+      type: actionTypes.LOGIN,
+      auth: user,
+      preserve: firebase._.config.preserveOnLogin
+    })
 
     createUserProfile(dispatch, firebase, user, {
       email: user.email,
@@ -422,7 +435,6 @@ export const init = (dispatch, firebase) => {
 export const login = (dispatch, firebase, credentials) => {
   if (firebase._.config.resetBeforeLogin) {
     dispatchLoginError(dispatch, null)
-    dispatch({ type: actionTypes.UNLOAD_PROFILE })
   }
 
   const { method, params } = getLoginMethodAndParams(firebase, credentials)

src/actions/auth.js

@@ -62,7 +62,6 @@ export const actionTypes = {
   REMOVE: `${actionsPrefix}/REMOVE`,
   MERGE: `${actionsPrefix}/MERGE`,
   SET_PROFILE: `${actionsPrefix}/SET_PROFILE`,
-  UNLOAD_PROFILE: `${actionsPrefix}/UNLOAD_PROFILE`,
   LOGIN: `${actionsPrefix}/LOGIN`,
   LOGOUT: `${actionsPrefix}/LOGOUT`,
   LOGIN_ERROR: `${actionsPrefix}/LOGIN_ERROR`,