v0.4.0

* feat(core): Queries for multiple documents now support single document state updates using `docChanges` (changes reference of document instead of collection)
* fix(dataReducer): delete does not remove data from `state.data` - #45
* feat(query): nested subcollections - @thiagovice - #73
* fix(query): queryStr parsing of deep nested collections - @thiagovice
* feat(query): `oneListenerPerPath` config option to only attach one callback per listener path - @compojoom

Author: prescottprue

.babelrc

@@ -29,7 +29,10 @@
     "test": {
       "plugins": [
         "transform-runtime",
-        "transform-async-to-generator"
+        "transform-async-to-generator",
+        ["module-resolver", {
+         "root": ["./src"]
+       }]
       ]
     }
   }

.travis.yml

@@ -3,6 +3,7 @@ sudo: false
 language: node_js
 
 node_js:
+  - 6.11.5
   - 8
   - 9 # LTS
 
@@ -20,6 +21,15 @@ branches:
   only:
     - master
 
+deploy:
+  skip_cleanup: true
+  provider: npm
+  email: $NPM_EMAIL
+  api_key: $NPM_KEY
+  on:
+    node: '9'
+    branch: 'master'
+
 script:
   - npm run lint
   - npm run test:cov

README.md

@@ -418,6 +418,11 @@ 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
+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
+
 #### preserveOnDelete
 Default: `null`
 

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "redux-firestore",
-  "version": "0.3.2",
+  "version": "0.4.0",
   "description": "Redux bindings for Firestore.",
   "main": "lib/index.js",
   "module": "es/index.js",
@@ -22,8 +22,9 @@
     "build:umd:min": "cross-env BABEL_ENV=commonjs NODE_ENV=production webpack",
     "build": "npm run build:commonjs && npm run build:es && npm run build:umd && npm run build:umd:min",
     "watch": "npm run build:es -- --watch",
+    "watch:commonjs": "npm run build:commonjs -- --watch",
     "test": "mocha -R spec ./test/unit/**",
-    "test:cov": "istanbul cover ./node_modules/mocha/bin/_mocha ./test/unit/**",
+    "test:cov": "istanbul cover  $(npm bin)/_mocha ./test/unit/**",
     "codecov": "cat coverage/lcov.info | codecov",
     "lint": "eslint .",
     "lint:fix": "npm run lint -- --fix",
@@ -42,6 +43,7 @@
     "babel-eslint": "^8.0.1",
     "babel-loader": "^7.1.2",
     "babel-plugin-lodash": "^3.2.11",
+    "babel-plugin-module-resolver": "^3.1.1",
     "babel-plugin-transform-async-to-generator": "^6.24.1",
     "babel-plugin-transform-inline-environment-variables": "^0.2.0",
     "babel-plugin-transform-object-assign": "^6.22.0",

package.json

@@ -8,9 +8,12 @@ import {
   orderedFromSnap,
   dataByIdSnapshot,
   getQueryConfig,
+  getQueryName,
   firestoreRef,
 } from '../utils/query';
 
+const pathListenerCounts = {};
+
 /**
  * Add data to a collection or document on Cloud Firestore with the call to
  * the Firebase library being wrapped in action dispatches.
@@ -155,12 +158,35 @@ export function deleteRef(firebase, dispatch, queryOption) {
         type: actionTypes.DELETE_SUCCESS,
         preserve: firebase._.config.preserveOnDelete,
       },
-      actionTypes.DELETE_SUCCESS,
       actionTypes.DELETE_FAILURE,
     ],
   });
 }
 
+const changeTypeToEventType = {
+  added: actionTypes.DOCUMENT_ADDED,
+  removed: actionTypes.DOCUMENT_REMOVED,
+  modified: actionTypes.DOCUMENT_MODIFIED,
+};
+
+/**
+ * Action creator for document change event. Used to create action objects
+ * to be passed to dispatch.
+ * @param  {Object} change - Document change object from Firebase callback
+ * @param  {Object} [originalMeta={}] - Original meta data of action
+ * @return {Object}                   [description]
+ */
+function docChangeEvent(change, originalMeta = {}) {
+  return {
+    type: changeTypeToEventType[change.type] || actionTypes.DOCUMENT_MODIFIED,
+    meta: { ...originalMeta, doc: change.doc.id },
+    payload: {
+      data: change.doc.data(),
+      ordered: { oldIndex: change.oldIndex, newIndex: change.newIndex },
+    },
+  };
+}
+
 /**
  * Set listener to Cloud Firestore with the call to the Firebase library
  * being wrapped in action dispatches.. Internall calls Firebase's onSnapshot()
@@ -186,18 +212,33 @@ export function setListener(firebase, dispatch, queryOpts, successCb, errorCb) {
   // Create listener
   const unsubscribe = firestoreRef(firebase, dispatch, meta).onSnapshot(
     docData => {
-      dispatch({
-        type: actionTypes.LISTENER_RESPONSE,
-        meta,
-        payload: {
-          data: dataByIdSnapshot(docData),
-          ordered: orderedFromSnap(docData),
-        },
-        merge: {
-          docs: mergeOrdered && mergeOrderedDocUpdates,
-          collections: mergeOrdered && mergeOrderedCollectionUpdates,
-        },
-      });
+      // Dispatch different actions for doc changes (only update doc(s) by key)
+      if (docData.docChanges && docData.docChanges.length < docData.size) {
+        if (docData.docChanges.length === 1) {
+          // Dispatch doc update if there is only one
+          dispatch(docChangeEvent(docData.docChanges[0], meta));
+        } else {
+          // Loop to dispatch for each change if there are multiple
+          // TODO: Option for dispatching multiple changes in single action
+          docData.docChanges.forEach(change => {
+            dispatch(docChangeEvent(change, meta));
+          });
+        }
+      } else {
+        // Dispatch action for whole collection change
+        dispatch({
+          type: actionTypes.LISTENER_RESPONSE,
+          meta,
+          payload: {
+            data: dataByIdSnapshot(docData),
+            ordered: orderedFromSnap(docData),
+          },
+          merge: {
+            docs: mergeOrdered && mergeOrderedDocUpdates,
+            collections: mergeOrdered && mergeOrderedCollectionUpdates,
+          },
+        });
+      }
       // Invoke success callback if it exists
       if (successCb) successCb(docData);
     },
@@ -240,12 +281,31 @@ export function setListeners(firebase, dispatch, listeners) {
     );
   }
 
+  const { config } = firebase._;
+  const oneListenerPerPath = !!config.oneListenerPerPath;
+
+  if (oneListenerPerPath) {
+    return listeners.forEach(listener => {
+      const path = getQueryName(listener);
+      const oldListenerCount = pathListenerCounts[path] || 0;
+      pathListenerCounts[path] = oldListenerCount + 1;
+
+      // If we already have an attached listener exit here
+      if (oldListenerCount > 0) {
+        return;
+      }
+
+      setListener(firebase, dispatch, listener);
+    });
+  }
+
   return listeners.forEach(listener => {
     // Config for supporting attaching of multiple listeners
-    const { config } = firebase._;
+
     const multipleListenersEnabled = isFunction(config.allowMultipleListeners)
       ? config.allowMultipleListeners(listener, firebase._.listeners)
       : config.allowMultipleListeners;
+
     // Only attach listener if it does not already exist or
     // if multiple listeners config is true or is a function which returns
     // truthy value
@@ -282,6 +342,22 @@ export function unsetListeners(firebase, dispatch, listeners) {
       'Listeners must be an Array of listener configs (Strings/Objects).',
     );
   }
+  const { config } = firebase._;
+  const oneListenerPerPath = !!config.oneListenerPerPath;
+
+  if (oneListenerPerPath) {
+    listeners.forEach(listener => {
+      const path = getQueryName(listener);
+      pathListenerCounts[path] -= 1;
+
+      // If we aren't supposed to have listners for this path, then remove them
+      if (pathListenerCounts[path] === 0) {
+        unsetListener(firebase, dispatch, listener);
+      }
+    });
+
+    return;
+  }
 
   listeners.forEach(listener => {
     // Remove listener only if it exists

src/actions/firestore.js

@@ -72,6 +72,9 @@ export const actionTypes = {
   ON_SNAPSHOT_REQUEST: `${actionsPrefix}/ON_SNAPSHOT_REQUEST`,
   ON_SNAPSHOT_SUCCESS: `${actionsPrefix}/ON_SNAPSHOT_SUCCESS`,
   ON_SNAPSHOT_FAILURE: `${actionsPrefix}/ON_SNAPSHOT_FAILURE`,
+  DOCUMENT_ADDED: `${actionsPrefix}/DOCUMENT_ADDED`,
+  DOCUMENT_MODIFIED: `${actionsPrefix}/DOCUMENT_MODIFIED`,
+  DOCUMENT_REMOVED: `${actionsPrefix}/DOCUMENT_REMOVED`,
 };
 
 /**