v1.0.0-alpha.2 (#149)

* fix(orderedReducer): fix issue where adding a document would break ordered structure - #151
* fix(ci): add alpha to travis branches config so tests run for alpha version - #151
* feat(query): support for populate using v1 state pattern (may have unexpected results, see note below) - #48
* fix(examples): complete example updated with `react-scripts` and `[email protected]`

NOTE: The `populate` helper will need to work differently for v1.0.0 since things are stored differently in state. It will most likely not work when populating off of any `root` settings that are not at the base of the state tree.

Author: prescottprue

.babelrc

@@ -10,8 +10,9 @@
   ],
   "plugins": [
     "lodash",
+    "transform-runtime",
     "transform-object-rest-spread",
-    "transform-object-assign",
+    "transform-object-assign"
   ],
   "env": {
     "es": {
@@ -28,7 +29,6 @@
     },
     "test": {
       "plugins": [
-        "transform-runtime",
         "transform-async-to-generator",
         ["module-resolver", {
          "root": ["./src"]

.eslintignore

@@ -1,4 +1,3 @@
-examples/**
 build/use-lodash-es.js
 coverage/**
 node_modules/**

.eslintrc

@@ -20,3 +20,4 @@ rules:
   no-confusing-arrow: 0
   no-case-declarations: 0
   arrow-parens: [2, "as-needed"]
+  prefer-default-export: 0

.travis.yml

@@ -22,6 +22,7 @@ branches:
   only:
     - master
     - next
+    - alpha
 
 script:
   - npm run lint

README.md

@@ -123,7 +123,7 @@ const enhance = compose(
       props.store.firestore.add(todosQuery(), { ...newTodo, owner: 'Anonymous' }),
   }),
   lifecycle({
-    componentWillMount(props) {
+    componentDidMount(props) {
       props.loadData()
     }
   }),
@@ -151,7 +151,7 @@ class Todos extends Component {
     store: PropTypes.object.isRequired
   }
 
-  componentWillMount () {
+  componentDidMount () {
     const { firestore } = this.context.store
     firestore.get('todos')
   }
@@ -457,16 +457,16 @@ Storing data under a different path within redux is as easy as passing the `stor
 Other Firebase statics (such as [FieldValue](https://firebase.google.com/docs/reference/js/firebase.firestore.FieldValue)) are available through the firestore instance:
 
 ```js
+import PropTypes from 'prop-types'
 import { connect } from 'react-redux'
 import {
   compose,
   withHandlers,
-  lifecycle,
   withContext,
   getContext
 } from 'recompose'
 
-const withFirestore = compose(
+const withStore = compose(
   withContext({ store: PropTypes.object }, () => {}),
   getContext({ store: PropTypes.object }),
 )
@@ -487,6 +487,82 @@ const enhance = compose(
 export default enhance(SomeComponent)
 ```
 
+### Population
+Population, made popular in [react-redux-firebase](http://react-redux-firebase.com/docs/recipes/populate.html), also works with firestore.
+
+
+#### Automatic Listeners
+```js
+import { connect } from 'react-redux'
+import { firestoreConnect, populate } from 'react-redux-firebase'
+import {
+  compose,
+  withHandlers,
+  lifecycle,
+  withContext,
+  getContext
+} from 'recompose'
+
+const populates = [{ child: 'createdBy', root: 'users' }]
+const collection = 'projects'
+
+const withPopulatedProjects = compose(
+  firestoreConnect((props) => [
+    {
+      collection,
+      populates
+    }
+  ]),
+  connect((state, props) => ({
+    projects: populate(state.firestore, collection, populates)
+  }))
+)
+```
+
+#### Manually using setListeners
+```js
+import { withFirestore, populate } from 'react-redux-firebase'
+import { connect } from 'react-redux'
+import { compose, lifecycle } from 'recompose'
+
+const collection = 'projects'
+const populates = [{ child: 'createdBy', root: 'users' }]
+
+const enhance = compose(
+  withFirestore,
+  lifecycle({
+    componentDidMount() {
+      this.props.firestore.setListener({ collection, populates })
+    }
+  }),
+  connect(({ firestore }) => ({ // state.firestore
+    todos: firestore.ordered.todos,
+  }))
+)
+```
+
+#### Manually using get
+```js
+import { withFirestore, populate } from 'react-redux-firebase'
+import { connect } from 'react-redux'
+import { compose, lifecycle } from 'recompose'
+
+const collection = 'projects'
+const populates = [{ child: 'createdBy', root: 'users' }]
+
+const enhance = compose(
+  withFirestore,
+  lifecycle({
+    componentDidMount() {
+      this.props.store.firestore.get({ collection, populates })
+    }
+  }),
+  connect(({ firestore }) => ({ // state.firestore
+    todos: firestore.ordered.todos,
+  }))
+)
+```
+
 ## Config Options
 Optional configuration options for redux-firestore, provided to reduxFirestore enhancer as optional second argument. Combine any of them together in an object.
 

examples/basic/jsconfig.json

@@ -0,0 +1,9 @@
+{
+  "compilerOptions": {
+    "baseUrl": "./src"
+  },
+  "exclude": [
+    "node_modules",
+    "public",
+  ]
+}

examples/complete/.env.local

@@ -0,0 +1,4 @@
+NODE_PATH=src/
+CI=false
+# Needed to skip warnings from jest@beta in package.json
+SKIP_PREFLIGHT_CHECK=true

examples/complete/.eslintignore

@@ -1,4 +1,4 @@
-coverage/**
+**/coverage/**
 **/node_modules/**
 dist/**
 src/index.html

examples/complete/.eslintrc

@@ -0,0 +1,61 @@
+module.exports = {
+  root: true,
+  extends: ['react-app', 'prettier'],
+  plugins: ['import', 'babel', 'react', 'prettier'],
+  settings: {
+    react: {
+      version: '16.6'
+    },
+    'import/resolver': {
+      node: {
+        moduleDirectory: ['node_modules', '/']
+      }
+    }
+  },
+  rules: {
+    semi: [
+      2, 'never'
+    ],
+    'no-console': 'error',
+    'react/forbid-prop-types': 0,
+    'react/require-default-props': 0,
+    'react/jsx-filename-extension': 0,
+    'import/no-named-as-default': 0,
+    'prettier/prettier': [
+      'error',
+      {
+        singleQuote: true,
+        trailingComma: 'none',
+        semi: false,
+        bracketSpacing: true,
+        jsxBracketSameLine: true,
+        printWidth: 80,
+        tabWidth: 2,
+        useTabs: false
+      }
+    ]
+  },
+  overrides: [
+    {
+      files: ['*.test.js', '*.spec.js'],
+      env: {
+        jest: true
+      }
+    },
+    {
+      files: ['config/*', 'scripts/*'],
+      rules: {
+        'no-console': 0,
+        'func-names': 0,
+        'prefer-destructuring': 0,
+        'no-use-before-define': 0,
+        'import/order': 0,
+        'consistent-return': 0,
+        'no-param-reassign': 0,
+        'import/no-extraneous-dependencies': 0,
+        'global-require': 0,
+        'import/no-dynamic-require': 0
+      }
+    }
+  ]
+}

examples/complete/.eslintrc.js

@@ -1,40 +1,30 @@
 {
   "projects": {
-    "master": "redux-firebasev3",
-    "prod": "redux-firebasev3"
+    "default": "redux-firestore",
+    "master": "redux-firestore",
+    "prod": "redux-firestore"
   },
   "ci": {
+    "copyVersion": true,
     "createConfig": {
       "master": {
-        "version": "${npm_package_version}",
-        "env": "development",
+        "env": "staging",
         "firebase": {
-          "apiKey": "AIzaSyCTUERDM-Pchn_UDTsfhVPiwM4TtNIxots",
-          "authDomain": "redux-firebasev3.firebaseapp.com",
-          "databaseURL": "https://redux-firebasev3.firebaseio.com",
-          "projectId": "redux-firebasev3",
-          "storageBucket": "redux-firebasev3.appspot.com"
-        },
-        "reduxFirebase": {
-          "userProfile": "users",
-          "enableLogging": false,
-          "updateProfileOnLogin": false
+          "apiKey": "${STAGE_FIREBASE_API_KEY}",
+          "authDomain": "redux-firestore.firebaseapp.com",
+          "databaseURL": "https://redux-firestore.firebaseio.com",
+          "projectId": "redux-firestore",
+          "storageBucket": "redux-firestore.appspot.com"
         }
       },
       "prod": {
-        "version": "${npm_package_version}",
         "env": "production",
         "firebase": {
-          "apiKey": "AIzaSyCTUERDM-Pchn_UDTsfhVPiwM4TtNIxots",
-          "authDomain": "redux-firebasev3.firebaseapp.com",
-          "databaseURL": "https://redux-firebasev3.firebaseio.com",
-          "projectId": "redux-firebasev3",
-          "storageBucket": "redux-firebasev3.appspot.com"
-        },
-        "reduxFirebase": {
-          "userProfile": "users",
-          "enableLogging": false,
-          "updateProfileOnLogin": false
+          "apiKey": "${PROD_FIREBASE_API_KEY}",
+          "authDomain": "redux-firestore.firebaseapp.com",
+          "databaseURL": "https://redux-firestore.firebaseio.com",
+          "projectId": "redux-firestore",
+          "storageBucket": "redux-firestore.appspot.com"
         }
       }
     }

examples/complete/.firebaserc

@@ -1,7 +1,13 @@
+# OS
 *.log
 **/*.log
 .DS_Store
 **/.DS_Store
-**/dist
+
+# Dependencies
 **/node_modules
-coverage
+
+# React App
+**/dist
+src/config.js
+.env