Merge pull request #212 from fratzinger/patch-1

Patch 1

Author: marshallswain

docs/service-module.md

@@ -52,11 +52,17 @@ Each service comes loaded with the following default state:
 {
     ids: [],
     keyedById: {}, // A hash map, keyed by id of each item
+    copiesById: {}, // objects cloned with Model.clone()
     currentId: undefined, // The id of the item marked as current
     copy: undefined, // A deep copy of the current item
     idField: 'id',
     servicePath: 'v1/todos' // The full service path
     autoRemove: false, // Indicates that this service will not automatically remove results missing from subsequent requests.
+    enableEvents: true, // Listens to socket.io events when available
+    addOnUpsert: false, // Add new records pushed by 'updated/patched' socketio events into store, instead of discarding them
+    diffOnPatch: false, // Only send changed data on patch
+    skipRequestIfExists: false, // For get action, if the record already exists in store, skip the remote request
+    preferUpdate: false, // When true, calling model.save() will do an update instead of a patch.
     replaceItems: false, // When set to true, updates and patches will replace the record in the store instead of merging changes
     paginate: false, // Indicates if pagination is enabled on the Feathers service.
 
@@ -86,11 +92,17 @@ The following attributes are available in each service module's state:
 
 - `ids {Array}` - an array of plain ids representing the ids that belong to each object in the `keyedById` map.
 - `keyedById {Object}` - a hash map keyed by the id of each item.
+- `copiesById {Object}` - objects cloned with Model.clone()
 - `currentId {Number|String}` - the id of the item marked as current.
 - `copy {Object}` - a deep copy of the current item at the moment it was marked as current. You can make changes to the copy without modifying the `current`.  You can then use the `commitCopy` mutation to save the changes as the `current` or `rejectCopy` to revert `copy` to once again match `current`.  You may prefer to use the new [clone API]() for [managing multiple copies with model instances](./common-patterns.md#Multiple-Copies).
 - `servicePath {String}` - the full service path, even if you alias the namespace to something else.
 - `modelName {String}` - the key in the $FeathersVuex plugin where the model will be found.
-- `autoRemove {Boolean` - indicates that this service will not automatically remove results missing from subsequent requests.  Only use with feathers-rest. Default is false.
+- `autoRemove {Boolean}` - indicates that this service will not automatically remove results missing from subsequent requests.  Only use with feathers-rest. Default is false.
+- `enableEvents {Boolean}` - Listens to socket.io events when available
+- `addOnUpsert {Boolean}` -  Add new records pushed by 'updated/patched' socketio events into store, instead of discarding them
+- `diffOnPatch {Boolean}` - Only send changed data on patch
+- `skipRequestIfExists {Boolean}` - For get action, if the record already exists in store, skip the remote request
+- `preferUpdate {Boolean}`, // When true, calling model.save() will do an update instead of a patch.
 - `replaceItems {Boolean}` - When set to true, updates and patches will replace the record in the store instead of merging changes.  Default is false
 - `idField {String}` - the name of the field that holds each item's id. *Default: `'id'`*
 - `paginate {Boolean}` - Indicates if the service has pagination turned on.
@@ -152,15 +164,21 @@ Removes a single item.  `item` can be
 Removes the passed in items or ids from the store.
 - `items {Array}` - An array of ids or of objects with ids that will be removed from the data store.
 
-### `setCurrent(state, item)`
+### `setCurrent(state, itemOrId)`
 - `item {Number|String|Object}` - the object with id to be set as the current item, or the id of the object in the store that should become the `current` item.  Setting the `current` item or id also create the deep-cloned `copy`.
 
-### `commitCopy(state)`
+### `createCopy(state, id)`
+Creates a copy of the record with the passed-in id, stores it in copiesById
+
+### `commitCopy(state, id)`
 Saves changes from the `copy` to the `current` item.
 
-### `rejectCopy(state)`
+### `rejectCopy(state, id)`
 Re-copies the data from `current` to `copy`, restoring the original copy.
 
+### `clearCopy(state, id)`
+Removes the copy from copiesById
+
 ### `clearCurrent(state)`
 Clears the `current` item, which also clears the copy.
 
@@ -170,6 +188,10 @@ Clears the `list`, excepting the `current` item.
 ### `clearAll(state)`
 Clears all data from `ids`, `keyedById`, and `currentId`
 
+### `updatePaginationForQuery(state, { qid, response, query })`
+Stores pagination data on state.pagination based on the query identifier (qid)
+The qid must be manually assigned to `params.qid`
+
 ### Mutations for Managing Pending State
 The following mutations are called automatically by the service actions, and will rarely, if ever, need to be used manually.
 - `setFindPending(state)` - sets `isFindPending` to `true`

src/service-module/mutations.js

@@ -145,28 +145,6 @@ export default function makeServiceMutations (servicePath, { debug, globalModels
       }
     },
 
-    clearAll (state) {
-      state.ids = []
-      state.currentId = null
-      state.copy = null
-      state.keyedById = {}
-    },
-
-    clearList (state) {
-      let currentId = state.currentId
-      let current = state.keyedById[currentId]
-
-      if (currentId && current) {
-        state.keyedById = {
-          [currentId]: current
-        }
-        state.ids = [currentId]
-      } else {
-        state.keyedById = {}
-        state.ids = []
-      }
-    },
-
     setCurrent (state, itemOrId) {
       const { idField } = state
       const Model = globalModels.byServicePath[servicePath]
@@ -190,13 +168,6 @@ export default function makeServiceMutations (servicePath, { debug, globalModels
       state.copy = null
     },
 
-    // Removes the copy from copiesById
-    clearCopy (state, id) {
-      const newCopiesById = Object.assign({}, state.copiesById)
-      delete newCopiesById[id]
-      state.copiesById = newCopiesById
-    },
-
     // Creates a copy of the record with the passed-in id, stores it in copiesById
     createCopy (state, id) {
       const current = state.keyedById[id]
@@ -211,8 +182,8 @@ export default function makeServiceMutations (servicePath, { debug, globalModels
       }
     },
 
-    // Resets the copy to match the original record, locally
-    rejectCopy (state, id) {
+    // Deep assigns copy to original record, locally
+    commitCopy (state, id) {
       const isIdOk = checkId(id, undefined, debug)
       const current = isIdOk ? state.keyedById[id] : state.keyedById[state.currentId]
       const Model = globalModels.byServicePath[servicePath]
@@ -224,11 +195,13 @@ export default function makeServiceMutations (servicePath, { debug, globalModels
         copy = Model.copiesById[id]
       }
 
-      _merge(copy, current)
-    },
+      updateOriginal(copy, current)
 
-    // Deep assigns copy to original record, locally
-    commitCopy (state, id) {
+      // Object.assign(current, copy)
+    },
+    
+    // Resets the copy to match the original record, locally
+    rejectCopy (state, id) {
       const isIdOk = checkId(id, undefined, debug)
       const current = isIdOk ? state.keyedById[id] : state.keyedById[state.currentId]
       const Model = globalModels.byServicePath[servicePath]
@@ -240,9 +213,36 @@ export default function makeServiceMutations (servicePath, { debug, globalModels
         copy = Model.copiesById[id]
       }
 
-      updateOriginal(copy, current)
+      _merge(copy, current)
+    },
 
-      // Object.assign(current, copy)
+    // Removes the copy from copiesById
+    clearCopy (state, id) {
+      const newCopiesById = Object.assign({}, state.copiesById)
+      delete newCopiesById[id]
+      state.copiesById = newCopiesById
+    },
+    
+    clearAll (state) {
+      state.ids = []
+      state.currentId = null
+      state.copy = null
+      state.keyedById = {}
+    },
+
+    clearList (state) {
+      let currentId = state.currentId
+      let current = state.keyedById[currentId]
+
+      if (currentId && current) {
+        state.keyedById = {
+          [currentId]: current
+        }
+        state.ids = [currentId]
+      } else {
+        state.keyedById = {}
+        state.ids = []
+      }
     },
 
     // Stores pagination data on state.pagination based on the query identifier (qid)

src/service-module/state.js

@@ -18,8 +18,6 @@ export default function makeDefaultState (servicePath, options) {
     copiesById: {},
     currentId: null,
     copy: null,
-    setCurrentOnGet: true,
-    setCurrentOnCreate: true,
     idField,
     servicePath,
     autoRemove,
@@ -32,6 +30,9 @@ export default function makeDefaultState (servicePath, options) {
     pagination: {},
     paramsForServer,
     whitelist,
+    
+    setCurrentOnGet: true,
+    setCurrentOnCreate: true,
 
     isFindPending: false,
     isGetPending: false,