Merge pull request #536 from fratzinger/find-copies

support copies in find-getter and other things

Author: marshallswain

docs/composition-api.md

@@ -119,6 +119,7 @@ And here's a look at each individual property:
   - Set `params.paginate` to `true` to turn off realtime updates for the results and defer pagination to the API server.  Pagination works the same as for the [makeFindMixin pagination](./mixins.html#pagination-with-fall-through-cacheing).
   - Set `params.debounce` to an integer and the API requests will automatically be debounced by that many milliseconds.  For example, setting `debounce: 1000` will assure that the API request will be made at most every 1 second.
   - Set `params.temps` to `true` to include temporary (local-only) items in the results. Temporary records are instances that have been created but not yet saved to the database.
+  - Set `params.copies` to `true` to include cloned items in the results. The queried items get replaced with the corresponding copies from `copiesById`
 - `fetchParams` This is a separate set of params that, when provided, will become the params sent to the API server.  The `params` will then only be used to query data from the local data store.
   - Explicitly returning `null` will prevent an API request from being made.
 - `queryWhen` must be a `computed` property which returns a `boolean`. It provides a logical separation for preventing API requests *outside* of the `params`.

docs/service-plugin.md

@@ -211,7 +211,10 @@ Service modules include the following getters:
 
 - `list {Array}` - an array of items. The array form of `keyedById`  Read only.
 - `find(params) {Function}` - a helper function that allows you to use the [Feathers Adapter Common API](https://docs.feathersjs.com/api/databases/common) and [Query API](https://docs.feathersjs.com/api/databases/querying) to pull data from the store.  This allows you to treat the store just like a local Feathers database adapter (but without hooks).
-  - `params {Object}` - an object with a `query` object and optional `paginate` and `temps` boolean properties. The `query` is in the FeathersJS query format. You can set `params.paginate` to `false` to disable pagination for a single request.
+  - `params {Object}` - an object with a `query` object and optional properties. You can set the following  properties:
+    - `params.query {Boolean}` - The `query` is in the FeathersJS query format.
+    - `params.temps {Boolean}` - **Default:** `false` - if `true` also consider temporary records from `tempsById`
+    - `params.copies {Boolean}` - **Default:** `false` - if `true`: first search for the regular records and then replace the records with the related copies from `copiesById`
 - `count(params) {Function}` - a helper function that counts items in the store matching the provided query in the params and returns this number <Badge text="3.12.0+" />
   - `params {Object}` - an object with a `query` object and an optional `temps` boolean property.
 - `get(id[, params]) {Function}` - a function that allows you to query the store for a single item, by id.  It works the same way as `get` requests in Feathers database adapters.

src/service-module/make-base-model.ts

@@ -80,7 +80,8 @@ export default function makeBaseModel(options: FeathersVuexOptions) {
     public static serverAlias: string = options.serverAlias
 
     public static readonly models = globalModels as GlobalModels // Can access other Models here
-    public static copiesById: {
+
+    public static readonly copiesById: {
       [key: string]: Model | undefined
       [key: number]: Model | undefined
     } = {}
@@ -397,7 +398,9 @@ export default function makeBaseModel(options: FeathersVuexOptions) {
      * Calls service patch with the current instance data
      * @param params
      */
-    public patch<D extends {} = AnyData>(params?: PatchParams<D>): Promise<this> {
+    public patch<D extends {} = AnyData>(
+      params?: PatchParams<D>
+    ): Promise<this> {
       const { idField, _dispatch } = this.constructor as typeof BaseModel
       const id = getId(this, idField)
 
@@ -442,7 +445,9 @@ export default function makeBaseModel(options: FeathersVuexOptions) {
         }
         return _dispatch.call(this.constructor, 'remove', [id, params])
       } else {
+        // is temp
         _commit.call(this.constructor, 'removeTemps', [this[tempIdField]])
+        _commit.call(this.constructor, 'clearCopy', [this[tempIdField]])
         return Promise.resolve(this)
       }
     }

src/service-module/service-module.getters.ts

@@ -16,6 +16,21 @@ import { Id } from '@feathersjs/feathers'
 const FILTERS = ['$sort', '$limit', '$skip', '$select']
 const additionalOperators = ['$elemMatch']
 
+const getCopiesById = ({
+  keepCopiesInStore,
+  servicePath,
+  serverAlias,
+  copiesById
+}) => {
+  if (keepCopiesInStore) {
+    return copiesById
+  } else {
+    const Model = _get(models, [serverAlias, 'byServicePath', servicePath])
+
+    return Model.copiesById
+  }
+}
+
 export default function makeServiceGetters() {
   return {
     list(state) {
@@ -30,6 +45,9 @@ export default function makeServiceGetters() {
       // Set params.temps to true to include the tempsById records
       params.temps = params.hasOwnProperty('temps') ? params.temps : false
 
+      // Set params.copies to true to include the copiesById records
+      params.copies = params.hasOwnProperty('copies') ? params.copies : false
+
       const { paramsForServer, whitelist, keyedById } = state
       const q = _omit(params.query || {}, paramsForServer)
 
@@ -39,11 +57,23 @@ export default function makeServiceGetters() {
       let values = _.values(keyedById)
 
       if (params.temps) {
-        values = values.concat(_.values(state.tempsById))
+        values.push(..._.values(state.tempsById))
       }
 
       values = values.filter(sift(query))
 
+      if (params.copies) {
+        const { idField } = state
+        const copiesById = getCopiesById(state)
+        values.forEach((val, i, arr) => {
+          const copy = copiesById[val[idField]]
+          if (copy) {
+            // replace keyedById value with existing clone value
+            arr[i] = copy
+          }
+        })
+      }
+
       const total = values.length
 
       if (filters.$sort) {
@@ -102,15 +132,8 @@ export default function makeServiceGetters() {
       return tempRecord || null
     },
     getCopyById: state => id => {
-      const { servicePath, keepCopiesInStore, serverAlias } = state
-
-      if (keepCopiesInStore) {
-        return state.copiesById[id]
-      } else {
-        const Model = _get(models, [serverAlias, 'byServicePath', servicePath])
-
-        return Model.copiesById[id]
-      }
+      const copiesById = getCopiesById(state)
+      return copiesById[id]
     },
 
     isCreatePendingById: ({ isIdCreatePending }: ServiceState) => (id: Id) =>
@@ -126,8 +149,7 @@ export default function makeServiceGetters() {
       getters.isUpdatePendingById(id) ||
       getters.isPatchPendingById(id),
     isPendingById: (state: ServiceState, getters) => (id: Id) =>
-      getters.isSavePendingById(id) ||
-      getters.isRemovePendingById(id)
+      getters.isSavePendingById(id) || getters.isRemovePendingById(id)
   }
 }
 

src/service-module/service-module.mutations.ts

@@ -188,9 +188,17 @@ export default function makeServiceMutations() {
       const isIdOk = idToBeRemoved !== null && idToBeRemoved !== undefined
       const index = state.ids.findIndex(i => i === idToBeRemoved)
 
+      const Model = _get(models, `[${state.serverAlias}][${state.modelName}]`)
+      const copiesById = state.keepCopiesInStore
+        ? state.copiesById
+        : Model.copiesById
+
       if (isIdOk && index !== null && index !== undefined) {
         Vue.delete(state.ids, index)
         Vue.delete(state.keyedById, idToBeRemoved)
+        if (copiesById.hasOwnProperty(idToBeRemoved)) {
+          Vue.delete(copiesById, idToBeRemoved)
+        }
       }
     },
 
@@ -226,8 +234,21 @@ export default function makeServiceMutations() {
         map[id] = true
         return map
       }, {})
+
+      const Model = _get(models, [
+        state.serverAlias,
+        'byServicePath',
+        state.servicePath
+      ])
+      const copiesById = state.keepCopiesInStore
+        ? state.copiesById
+        : Model.copiesById
+
       idsToRemove.forEach(id => {
         Vue.delete(state.keyedById, id)
+        if (copiesById.hasOwnProperty(id)) {
+          Vue.delete(copiesById, id)
+        }
       })
 
       // Get indexes to remove from the ids array.
@@ -257,6 +278,19 @@ export default function makeServiceMutations() {
     clearAll(state) {
       state.ids = []
       state.keyedById = {}
+
+      if (state.keepCopiesInStore) {
+        state.copiesById = {}
+      } else {
+        const Model = _get(models, [
+          state.serverAlias,
+          'byServicePath',
+          state.servicePath
+        ])
+        Object.keys(Model.copiesById).forEach(k =>
+          Vue.delete(Model.copiesById, k)
+        )
+      }
     },
 
     // Creates a copy of the record with the passed-in id, stores it in copiesById
@@ -265,13 +299,18 @@ export default function makeServiceMutations() {
       const current = state.keyedById[id] || state.tempsById[id]
       const Model = _get(models, [serverAlias, 'byServicePath', servicePath])
 
+      let item
+
       if (Model) {
-        var model = new Model(current, { clone: true })
+        item = new Model(current, { clone: true })
       } else {
-        var copyData = mergeWithAccessors({}, current)
+        const existingClone = state.copiesById[id]
+
+        item = existingClone
+          ? mergeWithAccessors(existingClone, current)
+          : mergeWithAccessors({}, current)
       }
 
-      let item = model || copyData
       if (keepCopiesInStore) {
         state.copiesById[id] = item
       } else {
@@ -330,9 +369,18 @@ export default function makeServiceMutations() {
 
     // Removes the copy from copiesById
     clearCopy(state, id) {
-      const newCopiesById = Object.assign({}, state.copiesById)
-      delete newCopiesById[id]
-      state.copiesById = newCopiesById
+      const { keepCopiesInStore } = state
+      const Model = _get(models, [
+        state.serverAlias,
+        'byServicePath',
+        state.servicePath
+      ])
+
+      const copiesById = keepCopiesInStore ? state.copiesById : Model.copiesById
+
+      if (copiesById[id]) {
+        Vue.delete(copiesById, id)
+      }
     },
 
     /**

src/service-module/types.ts

@@ -57,6 +57,7 @@ export interface MakeServicePluginOptions {
   replaceItems?: boolean
   skipRequestIfExists?: boolean
   nameStyle?: string
+  keepCopiesInStore?: boolean
   debounceEventsTime?: number
   debounceEventsMaxWait?: number
 

src/utils.ts

@@ -28,6 +28,8 @@ interface Params {
   provider?: string
   route?: { [key: string]: string }
   headers?: { [key: string]: any }
+  temps?: boolean
+  copies?: boolean
 
   [key: string]: any // (JL) not sure if we want this
 }

test/make-find-mixin.test.ts

@@ -30,7 +30,7 @@ function makeContext() {
 Vue.use(Vuex)
 Vue.use(FeathersVuex)
 
-describe('Find Mixin', function() {
+describe('Find Mixin', function () {
   const { makeServicePlugin, FindModel } = makeContext()
   const serviceName = 'todos'
   const store = new Vuex.Store({
@@ -42,7 +42,7 @@ describe('Find Mixin', function() {
     ]
   })
 
-  it('correctly forms mixin data', function() {
+  it('correctly forms mixin data', function () {
     const todosMixin = makeFindMixin({ service: 'todos' })
     interface TodosComponent {
       todos: []
@@ -99,7 +99,7 @@ describe('Find Mixin', function() {
     )
   })
 
-  it('correctly forms mixin data for dynamic service', function() {
+  it('correctly forms mixin data for dynamic service', function () {
     const tasksMixin = makeFindMixin({
       service() {
         return this.serviceName