Merge branch 'master' of https://github.com/feathersjs-ecosystem/feathers-vuex into find-copies

Author: fratzinger

docs/mixins.md

@@ -339,7 +339,9 @@ const todo = new Todo({ description: 'Do something!' })
 
 The examples above show instantiating a new Model instance without an `id` field. In this case, the record is not added to the Vuex store.  If you instantiate a record **with an `id`** field, it **will** get added to the Vuex store. *Note: This field is customizable using the `idField` option for this service.*
 
-Now that we have Model instances, let's take a look at the functionality they provide. Each instance will include the following methods:
+Now that we have Model instances, let's take a look at the functionality they provide.
+
+Each instance will include the following methods:
 
 - `.save()`
 - `.create()`
@@ -349,6 +351,15 @@ Now that we have Model instances, let's take a look at the functionality they pr
 - `.commit()`
 - `.reset()`
 
+and the following readonly attributes:
+
+- `isCreatePending` - `create` is currently pending on this model
+- `isUpdatePending` - `update` is currently pending on this model
+- `isPatchPending` - `patch` is currently pending on this model
+- `isRemovePending` - `remove` is currently pending on this model
+- `isSavePending` - Any of `create`, `update` or `patch` is currently pending on this model
+- `isPending` - Any method is currently pending on this model
+
 *Remember, if a record already has an attribute with any of these method names, it will be overwritten with the method.*
 
 These methods give access to many of the store `actions` and `mutations`.  Using Model instances, you no longer have to use `mapActions` for `create`, `patch`, `update`, or `remove`.  You also no longer have to use `mapMutations` for `createCopy`, `commitCopy`, or `resetCopy`.

docs/model-classes.md

@@ -156,7 +156,12 @@ Each service comes loaded with the following default state:
     errorOnCreate: undefined,
     errorOnUpdate: undefined,
     errorOnPatch: undefined,
-    errorOnRemove: undefined
+    errorOnRemove: undefined,
+
+    isIdCreatePending: [],
+    isIdUpdatePending: [],
+    isIdPatchPending: [],
+    isIdRemovePending: [],
   }
 ```
 
@@ -193,6 +198,13 @@ The following state attribute will be populated with any request error, serializ
 - `errorOnPatch {Error}`
 - `errorOnRemo {Error}`
 
+The following state attributes allow you to bind to the pending state of requests *per item ID*
+
+- `isIdCreatePending {Array}` - Contains `id` if there's a pending `create` request for `id`.
+- `isIdUpdatePending {Array}` -Contains `id` if there's a pending `update` request for `id`.
+- `isIdPatchPending {Array}` - Contains `id` if there's a pending `patch` request for `id`.
+- `isIdRemovePending {Array}` - Contains `id` if there's a pending `remove` request for `id`.
+
 ## Service Getters
 
 Service modules include the following getters:
@@ -209,6 +221,15 @@ Service modules include the following getters:
   - `id {Number|String}` - the id of the data to be retrieved by id from the store.
   - `params {Object}` - an object containing a Feathers `query` object.
 
+The following getters ease access to per-instance pending status
+
+- `isCreatePendingById(id) {Function}` - Check if `create` is pending for `id`
+- `isUpdatePendingById(id) {Function}` - Check if `update` is pending for `id`
+- `isPatchPendingById(id) {Function}` - Check if `patch` is pending for `id`
+- `isRemovePendingById(id) {Function}` - Check if `remove` is pending for `id`
+- `isSavePendingById(id) {Function}` - Check if `create`, `update`, or `patch` is pending for `id`
+- `isPendingById(id) {Function}` - Check if `create`, `update`, `patch` or `remove` is pending for `id`
+
 ## Service Mutations
 
 The following mutations are included in each service module.
@@ -265,7 +286,9 @@ Clears all data from `ids`, `keyedById`, and `currentId`
 The following mutations are called automatically by the service actions, and will rarely, if ever, need to be used manually.
 
 - `setPending(state, method)` - sets the `is${method}Pending` attribute to true
+- `setIdPending(state, { method, id })` - adds `id` to `isId${method}Pending` array
 - `unsetPending(state, method)` - sets the `is${method}Pending` attribute to false
+- `unsetIdPending(state, { method, id })` - removes `id` from `isId${method}Pending` array
 
 ### Mutations for Managing Errors
 

docs/service-plugin.md

@@ -1,7 +1,7 @@
 {
   "name": "feathers-vuex",
   "description": "FeathersJS, Vue, and Nuxt for the artisan developer",
-  "version": "3.12.3",
+  "version": "3.13.0",
   "homepage": "https:feathers-vuex.feathersjs-ecosystem.com",
   "main": "dist/",
   "module": "dist/",

package-lock.json

@@ -73,12 +73,14 @@ export default {
   }),
   computed: {
     items() {
-      const { query, service, $store, temps } = this
+      let { query, service, $store, temps } = this
       let { params } = this
+      
+      query = query || {}
 
       params = params || { query, temps }
 
-      return query ? $store.getters[`${service}/find`](params).data : []
+      return $store.getters[`${service}/find`](params).data
     },
     pagination() {
       return this.$store.state[this.service].pagination[this.qid]

package.json

@@ -18,7 +18,7 @@ export default function makeFindMixin(options) {
   const {
     service,
     params,
-    fetchQuery,
+    fetchParams,
     queryWhen = () => true,
     local = false,
     qid = 'default',
@@ -224,9 +224,8 @@ export default function makeFindMixin(options) {
       getPaginationForQuery(params = {}) {
         const pagination = this[PAGINATION]
         const { qid, queryId, pageId } = getQueryInfo(params)
-        const queryInfo = _get(pagination, `[${qid}][${queryId}]`) || {}
-        const pageInfo =
-          _get(pagination, `[${qid}][${queryId}][${pageId}]`) || {}
+        const queryInfo = _get(pagination, [qid, queryId], {})
+        const pageInfo = _get(pagination, [qid, queryId, pageId], {})
 
         return { queryInfo, pageInfo }
       }
@@ -319,7 +318,7 @@ export default function makeFindMixin(options) {
 
   setupAttribute(SERVICE_NAME, service, 'computed', true)
   setupAttribute(PARAMS, params)
-  setupAttribute(FETCH_PARAMS, fetchQuery)
+  setupAttribute(FETCH_PARAMS, fetchParams)
   setupAttribute(QUERY_WHEN, queryWhen, 'computed')
   setupAttribute(LOCAL, local)
 

src/FeathersVuexFind.ts

@@ -21,6 +21,7 @@ import _get from 'lodash/get'
 import { EventEmitter } from 'events'
 import { ModelSetupContext } from './types'
 import { Store } from 'vuex'
+import { GetterName } from './service-module.getters'
 
 const defaultOptions = {
   clone: false,
@@ -48,7 +49,7 @@ export default function makeBaseModel(options: FeathersVuexOptions) {
   const { serverAlias } = options
 
   // If this serverAlias already has a BaseModel, return it
-  const ExistingBaseModel = _get(globalModels, `[${serverAlias}].BaseModel`)
+  const ExistingBaseModel = _get(globalModels, [serverAlias, 'BaseModel'])
   if (ExistingBaseModel) {
     return ExistingBaseModel as ModelStatic
   }
@@ -176,6 +177,37 @@ export default function makeBaseModel(options: FeathersVuexOptions) {
       return this
     }
 
+    /**
+     * Calls `getter`, passing this model's ID as the parameter
+     * @param getter name of getter to call
+     */
+    private getGetterWithId(getter: GetterName): unknown {
+      const { _getters, idField, tempIdField } = this
+        .constructor as typeof BaseModel
+      const id =
+        getId(this, idField) != null ? getId(this, idField) : this[tempIdField]
+      return _getters.call(this.constructor, getter, id)
+    }
+
+    get isCreatePending(): boolean {
+      return this.getGetterWithId('isCreatePendingById') as boolean
+    }
+    get isUpdatePending(): boolean {
+      return this.getGetterWithId('isUpdatePendingById') as boolean
+    }
+    get isPatchPending(): boolean {
+      return this.getGetterWithId('isPatchPendingById') as boolean
+    }
+    get isRemovePending(): boolean {
+      return this.getGetterWithId('isRemovePendingById') as boolean
+    }
+    get isSavePending(): boolean {
+      return this.getGetterWithId('isSavePendingById') as boolean
+    }
+    get isPending(): boolean {
+      return this.getGetterWithId('isPendingById') as boolean
+    }
+
     public static getId(record: Record<string, any>): string {
       const { idField } = this.constructor as typeof BaseModel
       return getId(record, idField)
@@ -215,7 +247,7 @@ export default function makeBaseModel(options: FeathersVuexOptions) {
      * @param method the vuex getter name without the namespace
      * @param payload if provided, the getter will be called as a function
      */
-    public static _getters(name: string, idOrParams?: any, params?: any) {
+    public static _getters(name: GetterName, idOrParams?: any, params?: any) {
       const { namespace, store } = this
 
       if (checkNamespace(namespace, this, options.debug)) {

src/make-find-mixin.ts

@@ -6,6 +6,7 @@ eslint
 import { FeathersVuexOptions, MakeServicePluginOptions } from './types'
 import makeServiceModule from './make-service-module'
 import { globalModels, prepareAddModel } from './global-models'
+import enableServiceEvents from './service-module.events'
 import { makeNamespace, getServicePath, assignIfNotPresent } from '../utils'
 import _get from 'lodash/get'
 
@@ -18,6 +19,7 @@ interface ServiceOptionsDefaults {
   actions: {}
   instanceDefaults: () => {}
   setupInstance: (instance: {}) => {}
+  debounceEventsMaxWait: number
 }
 
 const defaults: ServiceOptionsDefaults = {
@@ -28,7 +30,8 @@ const defaults: ServiceOptionsDefaults = {
   mutations: {}, // for custom mutations
   actions: {}, // for custom actions
   instanceDefaults: () => ({}), // Default instanceDefaults returns an empty object
-  setupInstance: instance => instance // Default setupInstance returns the instance
+  setupInstance: instance => instance, // Default setupInstance returns the instance
+  debounceEventsMaxWait: 1000
 }
 const events = ['created', 'patched', 'updated', 'removed']
 
@@ -93,7 +96,7 @@ export default function prepareMakeServicePlugin(
       store.registerModule(options.namespace, module, { preserveState: false })
 
       // (2a^) Monkey patch the BaseModel in globalModels
-      const BaseModel = _get(globalModels, `[${options.serverAlias}].BaseModel`)
+      const BaseModel = _get(globalModels, [options.serverAlias, 'BaseModel'])
       if (BaseModel && !BaseModel.store) {
         Object.assign(BaseModel, {
           store
@@ -120,39 +123,7 @@ export default function prepareMakeServicePlugin(
 
       // (3^) Setup real-time events
       if (options.enableEvents) {
-        const handleEvent = (eventName, item, mutationName) => {
-          const handler = options.handleEvents[eventName]
-          const confirmOrArray = handler(item, {
-            model: Model,
-            models: globalModels
-          })
-          const [affectsStore, modified = item] = Array.isArray(confirmOrArray)
-            ? confirmOrArray
-            : [confirmOrArray]
-          if (affectsStore) {
-            eventName === 'removed'
-              ? store.commit(`${options.namespace}/removeItem`, modified)
-              : store.dispatch(`${options.namespace}/${mutationName}`, modified)
-          }
-        }
-
-        // Listen to socket events when available.
-        service.on('created', item => {
-          handleEvent('created', item, 'addOrUpdate')
-          Model.emit && Model.emit('created', item)
-        })
-        service.on('updated', item => {
-          handleEvent('updated', item, 'addOrUpdate')
-          Model.emit && Model.emit('updated', item)
-        })
-        service.on('patched', item => {
-          handleEvent('patched', item, 'addOrUpdate')
-          Model.emit && Model.emit('patched', item)
-        })
-        service.on('removed', item => {
-          handleEvent('removed', item, 'removeItem')
-          Model.emit && Model.emit('removed', item)
-        })
+        enableServiceEvents({ service, Model, store, options })
       }
     }
   }