v0.2.8

* fix(errorsReducer): correctly update on `LISTENER_ERROR` dispatch - [RRF #386](prescottprue/react-redux-firebase#386)
* feat(tests): more unit tests added for `orderedReducer` (including one covering update of existing document within subcollection)
* fix(types): typescript typings updated (non existent constants removed)

Author: prescottprue

index.d.ts

@@ -1,86 +1,85 @@
-/** Declaration file generated by dts-gen */
-
+/**
+ * Action types used within actions dispatched internally. These action types
+ * can be manually dispatched to update state.
+ */
 export const actionTypes: {
-    AUTHENTICATION_INIT_FINISHED: string;
-    AUTHENTICATION_INIT_STARTED: string;
-    AUTH_UPDATE_ERROR: string;
-    AUTH_UPDATE_START: string;
-    AUTH_UPDATE_SUCCESS: string;
-    EMAIL_UPDATE_ERROR: string;
-    EMAIL_UPDATE_START: string;
-    EMAIL_UPDATE_SUCCESS: string;
-    ERROR: string;
-    FILE_DELETE_COMPLETE: string;
-    FILE_DELETE_ERROR: string;
-    FILE_DELETE_START: string;
-    FILE_UPLOAD_COMPLETE: string;
-    FILE_UPLOAD_ERROR: string;
-    FILE_UPLOAD_PROGRESS: string;
-    FILE_UPLOAD_START: string;
-    LOGIN: string;
-    LOGIN_ERROR: string;
-    LOGOUT: string;
-    NO_VALUE: string;
-    PROFILE_UPDATE_ERROR: string;
-    PROFILE_UPDATE_START: string;
-    PROFILE_UPDATE_SUCCESS: string;
-    SET: string;
-    SET_PROFILE: string;
-    START: string;
-    UNAUTHORIZED_ERROR: string;
-    UNSET_LISTENER: string;
+  START: string;
+  ERROR: string;
+  CLEAR_DATA: string;
+  CLEAR_ERROR: string;
+  CLEAR_ERRORS: string;
+  SET_LISTENER: string;
+  UNSET_LISTENER: string;
+  GET_REQUEST: string;
+  GET_SUCCESS: string;
+  GET_FAILURE: string;
+  SET_REQUEST: string;
+  SET_SUCCESS: string;
+  SET_FAILURE: string;
+  ADD_REQUEST: string;
+  ADD_SUCCESS: string;
+  ADD_FAILURE: string;
+  UPDATE_REQUEST: string;
+  UPDATE_SUCCESS: string;
+  UPDATE_FAILURE: string;
+  DELETE_REQUEST: string;
+  DELETE_SUCCESS: string;
+  DELETE_FAILURE: string;
+  ATTACH_LISTENER: string;
+  LISTENER_RESPONSE: string;
+  LISTENER_ERROR: string;
+  ON_SNAPSHOT_REQUEST: string;
+  ON_SNAPSHOT_SUCCESS: string;
+  ON_SNAPSHOT_FAILURE: string;
 };
 
+/**
+ * Constants used within redux-firetore. Includes actionTypes, actionsPrefix,
+ * and default config.
+ */
 export const constants: {
-    actionTypes: {
-        AUTHENTICATION_INIT_FINISHED: string;
-        AUTHENTICATION_INIT_STARTED: string;
-        AUTH_UPDATE_ERROR: string;
-        AUTH_UPDATE_START: string;
-        AUTH_UPDATE_SUCCESS: string;
-        EMAIL_UPDATE_ERROR: string;
-        EMAIL_UPDATE_START: string;
-        EMAIL_UPDATE_SUCCESS: string;
-        ERROR: string;
-        FILE_DELETE_COMPLETE: string;
-        FILE_DELETE_ERROR: string;
-        FILE_DELETE_START: string;
-        FILE_UPLOAD_COMPLETE: string;
-        FILE_UPLOAD_ERROR: string;
-        FILE_UPLOAD_PROGRESS: string;
-        FILE_UPLOAD_START: string;
-        LOGIN: string;
-        LOGIN_ERROR: string;
-        LOGOUT: string;
-        NO_VALUE: string;
-        PROFILE_UPDATE_ERROR: string;
-        PROFILE_UPDATE_START: string;
-        PROFILE_UPDATE_SUCCESS: string;
-        SET: string;
-        SET_PROFILE: string;
-        START: string;
-        UNAUTHORIZED_ERROR: string;
-        UNSET_LISTENER: string;
-    };
-    defaultConfig: {
-        autoPopulateProfile: boolean;
-        dispatchOnUnsetListener: boolean;
-        enableEmptyAuthChanges: boolean;
-        enableLogging: boolean;
-        enableRedirectHandling: boolean;
-        setProfilePopulateResults: boolean;
-        updateProfileOnLogin: boolean;
-        userProfile: any;
-    };
-    defaultInitProps: string[];
-    defaultJWTProps: string[];
-    metaParams: string[];
-    paramSplitChar: string;
-    supportedAuthProviders: string[];
+  actionTypes: {
+    START: string;
+    ERROR: string;
+    CLEAR_DATA: string;
+    CLEAR_ERROR: string;
+    CLEAR_ERRORS: string;
+    SET_LISTENER: string;
+    UNSET_LISTENER: string;
+    GET_REQUEST: string;
+    GET_SUCCESS: string;
+    GET_FAILURE: string;
+    SET_REQUEST: string;
+    SET_SUCCESS: string;
+    SET_FAILURE: string;
+    ADD_REQUEST: string;
+    ADD_SUCCESS: string;
+    ADD_FAILURE: string;
+    UPDATE_REQUEST: string;
+    UPDATE_SUCCESS: string;
+    UPDATE_FAILURE: string;
+    DELETE_REQUEST: string;
+    DELETE_SUCCESS: string;
+    DELETE_FAILURE: string;
+    ATTACH_LISTENER: string;
+    LISTENER_RESPONSE: string;
+    LISTENER_ERROR: string;
+    ON_SNAPSHOT_REQUEST: string;
+    ON_SNAPSHOT_SUCCESS: string;
+    ON_SNAPSHOT_FAILURE: string;
+  };
+  actionsPrefix: string;
+  defaultConfig: {
+    enableLogging: boolean;
+    enhancerNamespace: string;
+    helpersNamespace: string;
+    preserveOnListenerError: object;
+  };
 };
 
 /**
- * A redux store enhancer that adds store.firebase
+ * A redux store enhancer that adds store.firebase (passed to React component
+ * context through react-redux's <Provider>).
  */
 export function reduxFirestore(firebaseInstance: object, otherConfig: object): any;
 
@@ -94,16 +93,14 @@ export function getFirestore(firebaseInstance: object, otherConfig: object): any
  * A redux store reducer for Firestore state
  */
 export namespace firestoreReducer {
-    const prototype: {
-    };
-
+  const prototype: {
+  };
 }
 
 /**
  * A redux store reducer for Firestore state
  */
 export namespace reduxFirestore {
-    const prototype: {
-    };
-
+  const prototype: {
+  };
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "redux-firestore",
-  "version": "0.2.7",
+  "version": "0.2.8",
   "description": "Redux bindings for Firestore.",
   "main": "lib/index.js",
   "module": "es/index.js",

src/actions/firestore.js

@@ -160,6 +160,7 @@ export const setListener = (
   errorCb,
 ) => {
   const meta = getQueryConfig(queryOpts);
+  // Create listener
   const unsubscribe = firestoreRef(firebase, dispatch, meta).onSnapshot(
     docData => {
       dispatch({

src/reducers/dataReducer.js

@@ -38,7 +38,7 @@ export default function dataReducer(state = {}, action) {
       const data = docName ? get(payload.data, docName) : payload.data;
       // Get previous data at path to check for existence
       const previousData = get(state, pathFromMeta(meta));
-      // Only merge if data does not already exist or if meta contains subcollections
+      // Set data (without merging) if no previous data exists or if there are subcollections
       if (!previousData || meta.subcollections) {
         // Set data to state immutabily (lodash/fp's setWith creates copy)
         return setWith(Object, pathFromMeta(meta), data, state);
@@ -53,6 +53,7 @@ export default function dataReducer(state = {}, action) {
         return pick(state, action.preserve); // pick returns a new object
       }
       return {};
+    // TODO: LISTENER_ERROR that sets null in a way that is configurable (v0.3.0)
     default:
       return state;
   }

src/reducers/errorsReducer.js

@@ -1,13 +1,7 @@
 import { actionTypes } from '../constants';
 import { combineReducers, pathFromMeta } from '../utils/reducers';
 
-const {
-  CLEAR_ERRORS,
-  CLEAR_ERROR,
-  LOGIN_ERROR,
-  LISTENER_ERROR,
-  ERROR,
-} = actionTypes;
+const { CLEAR_ERRORS, CLEAR_ERROR, LISTENER_ERROR, ERROR } = actionTypes;
 
 /**
  * Reducer for errors state. Changed by `ERROR`
@@ -18,17 +12,17 @@ const {
  * @return {Object} Profile state after reduction
  */
 const errorsAllIds = (state = [], { meta, type }) => {
-  if (!meta || !meta.id) {
-    return state;
-  }
   switch (type) {
-    case LOGIN_ERROR:
+    case LISTENER_ERROR:
     case ERROR:
-      return [...state, meta.id];
+      if (state.indexOf(pathFromMeta(meta)) !== -1) {
+        return state;
+      }
+      return [...state, pathFromMeta(meta)];
     case CLEAR_ERRORS:
       return [];
     case CLEAR_ERROR:
-      return state.filter(lId => lId !== meta.id);
+      return state.filter(lId => lId !== pathFromMeta(meta));
     default:
       return state;
   }
@@ -43,25 +37,18 @@ const errorsAllIds = (state = [], { meta, type }) => {
  * @return {Object} Profile state after reduction
  */
 const errorsByQuery = (state = {}, { meta, payload, type }) => {
-  if (!meta || !meta.id) {
-    return state;
-  }
   switch (type) {
-    case LOGIN_ERROR:
     case ERROR:
-      return {
-        ...state,
-        [meta.id]: payload,
-      };
     case LISTENER_ERROR:
       return {
         ...state,
         [pathFromMeta(meta)]: payload,
       };
-    case CLEAR_ERRORS:
-      return [];
     case CLEAR_ERROR:
-      return state.filter(lId => lId !== payload.id);
+      return {
+        ...state,
+        [pathFromMeta(meta)]: null,
+      };
     default:
       return state;
   }

src/reducers/listenersReducer.js

@@ -29,8 +29,7 @@ const listenersById = (state = {}, { type, path, payload }) => {
 };
 
 /**
- * Reducer for listeners state. Changed by `ERROR`
- * and `LOGOUT` actions.
+ * Reducer for listeners state. Changed by `ERROR` and `LOGOUT` actions.
  * @param  {Object} [state=[]] - Current authError redux state
  * @param  {Object} action - Object containing the action that was dispatched
  * @param  {String} action.type - Type of action that was dispatched

src/reducers/orderedReducer.js

@@ -1,6 +1,6 @@
 import { pick, first } from 'lodash';
 import { actionTypes } from '../constants';
-import { updateItemInArray, updateObject } from '../utils/reducers';
+import { updateItemInArray } from '../utils/reducers';
 
 const { GET_SUCCESS, LISTENER_RESPONSE, CLEAR_DATA } = actionTypes;
 
@@ -27,7 +27,8 @@ function updateDocInOrdered(state, action) {
       state[storeUnderKey] || [],
       action.meta.doc,
       item =>
-        updateObject(
+        Object.assign(
+          {},
           item,
           subcollection
             ? { [subcollection.collection]: action.payload.ordered }
@@ -78,6 +79,7 @@ export default function orderedReducer(state = {}, action) {
         return pick(state, action.preserve); // pick returns a new object
       }
       return state;
+    // TODO: LISTENER_ERROR that sets null in a way that is configurable (v0.3.0)
     default:
       return state;
   }

src/utils/reducers.js

@@ -1,3 +1,5 @@
+import { isFunction, isBoolean, isArray, pick } from 'lodash';
+
 /**
  * Create a path array from path string
  * @param  {String} path - Path seperated with slashes
@@ -59,6 +61,7 @@ export const combineReducers = reducers => (state = {}, action) =>
  * action associates with (used for storing data under a path different
  * from its collection/document)
  * @return {String} String path to be used within reducer
+ * @private
  */
 export function pathFromMeta(meta) {
   if (!meta) {
@@ -82,24 +85,14 @@ export function pathFromMeta(meta) {
   return basePath.concat(`.${mappedCollections.join('.')}`);
 }
 
-/**
- * Encapsulate the idea of passing a new object as the first parameter
- * to Object.assign to ensure we correctly copy data instead of mutating
- * @param  {Object} oldObject - Object before update
- * @param  {Object} newValues - New values to add to the object
- * @return {Object} Object with new values
- */
-export function updateObject(oldObject, newValues) {
-  return Object.assign({}, oldObject, newValues);
-}
-
 /**
  * Update a single item within an array
  * @param  {Array} array - Array within which to update item
  * @param  {String} itemId - Id of item to update
  * @param  {Function} updateItemCallback - Callback dictacting how the item
  * is updated
  * @return {Array} Array with item updated
+ * @private
  */
 export function updateItemInArray(array, itemId, updateItemCallback) {
   const updatedItems = array.map(item => {
@@ -115,3 +108,34 @@ export function updateItemInArray(array, itemId, updateItemCallback) {
 
   return updatedItems;
 }
+
+/**
+ * Preserve slice of state based on preserve settings for that slice. Settings
+ * for support can be any of type `Boolean`, `Function`, or `Array`.
+ * @param  {Object} state - slice of redux state to be preserved
+ * @param  {Boolean|Function|Array} preserveSetting [description]
+ * @param  {Object} nextState - What state would have been set to if preserve
+ * was not occuring.
+ * @return {Object} Slice of state with values preserved
+ * @private
+ */
+export function preserveValuesFromState(state, preserveSetting, nextState) {
+  // Return original state if preserve is true
+  if (isBoolean(preserveSetting) && preserveSetting) {
+    return nextState ? { ...state, ...nextState } : state;
+  }
+
+  // Return result of function if preserve is a function
+  if (isFunction(preserveSetting)) {
+    return preserveSetting(state, nextState);
+  }
+
+  // Return keys listed within array
+  if (isArray(preserveSetting)) {
+    return pick(state, preserveSetting); // pick returns a new object
+  }
+
+  throw new Error(
+    'Invalid preserve parameter. It must be an Object or an Array',
+  );
+}