Merge pull request #451 from fratzinger/patch-7

feat: add interfaces & handleEvents for global config

Author: marshallswain

.vscode/settings.json

@@ -8,7 +8,8 @@
     "lib/**": true,
     "**/node_modules": true,
     "**/bower_components": true,
-    "**/yarn.lock": true
+    "**/yarn.lock": true,
+    "**/package-lock.json": true
   },
   "workbench.colorCustomizations": {
     "activityBar.background": "#2B3011",

docs/getting-started.md

@@ -274,40 +274,54 @@ The following default options are available for configuration:
 
 ```js
 const defaultOptions = {
-  // configured globally
+  // only configured globally
   serverAlias: 'api',
   keepCopiesInStore: false,
-  paramsForServer: [],
-  whitelist: []
 
   // also configurable per service
   idField: 'id',
   tempIdField: '__id',
+  nameStyle: 'short',
+
   debug: false,
   addOnUpsert: false,
   autoRemove: false,
   enableEvents: true,
   preferUpdate: false,
   replaceItems: false,
   skipRequestIfExists: false,
-  nameStyle: 'short',
+
+  paramsForServer: [],
+  whitelist: [],
+
+  handleEvents: {
+    created: (item, { model, models }) => options.enableEvents,
+    patched: (item, { model, models }) => options.enableEvents,
+    updated: (item, { model, models }) => options.enableEvents,
+    removed: (item, { model, models }) => options.enableEvents
+  },
 }
 ```
 - `serverAlias` - **Default:** `api` - Models are keyed by `serverAlias`. Access the `$FeathersVuex` Plugin and its models in your components by `this.$FeathersVuex.api.${Model}`
 - `keepCopiesInStore` - **Default:** `false` - Set to true to store cloned copies in the store instead of on the Model. <Badge text="deprecated" type="warning" />
-- `paramsForServer {Array}` - **Default:** `[]` - Custom query operators that are ignored in the find getter, but will pass through to the server.
-- `whitelist {Array}` - **Default:** `[]` - Custom query operators that will be allowed in the find getter.
 
 - `idField {String}` - **Default:** `'id'` - The field in each record that will contain the id
 - `tempIdField {Boolean}` - **Default:** `'__id'` - The field in each temporary record that contains the id
+- `nameStyle {'short'|'path'}` - **Default:** `'short'` - Use the full service path as the Vuex module name, instead of just the last section.
 - `debug {Boolean}` - **Default:** `false` - Enable some logging for debugging
 - `addOnUpsert {Boolean}` - **Default:** `false` - If `true` add new records pushed by 'updated/patched' socketio events into store, instead of discarding them.
 - `autoRemove {Boolean}` - **Default:** `false` - If `true` automatically remove records missing from responses (only use with feathers-rest)
-- `enableEvents {Boolean}` - **Default:** `true` - If `false` socket event listeners will be turned off. See the services [handleEvents API](/service-plugin.html#configuration)
 - `preferUpdate {Boolean}` - **Default:** `false` - If `true`, calling `model.save()` will do an `update` instead of a `patch`.
 - `replaceItems {Boolean}` - **Default:** `false` - If `true`, updates & patches replace the record in the store. Default is false, which merges in changes.
 - `skipRequestIfExists {Boolean}` - **Default:** `false` - For get action, if `true` the record already exists in store, skip the remote request.
-- `nameStyle {'short'|'path'}` - **Default:** `'short'` - Use the full service path as the Vuex module name, instead of just the last section.
+- `paramsForServer {Array}` - **Default:** `[]` - Custom query operators that are ignored in the find getter, but will pass through to the server.
+- `whitelist {Array}` - **Default:** `[]` - Custom query operators that will be allowed in the find getter.
+- `enableEvents {Boolean}` - **Default:** `true` - If `false` socket event listeners will be turned off. See the services
+- `handleEvents {Object}`: For this to work `enableEvents` must be `true`
+  - `created {Function}` - **Default:** `(item, { model, models }) => options.enableEvents` - handle `created` events, return true to add to the store
+  - `patched {Function}` - **Default:** `(item, { model, models }) => options.enableEvents` - handle `created` events, return true to update in the store
+  - `updated {Function}` - **Default:** `(item, { model, models }) => options.enableEvents` - handle `created` events, return true to update in the store
+  - `removed {Function}` - **Default:** `(item, { model, models }) => options.enableEvents` - handle `removed` events, return true to remove from the store
 
 Also see the [Configs per Service](/service-plugin.html#configuration)
 

docs/service-plugin.md

@@ -26,32 +26,36 @@ const servicePlugin = makeServicePlugin({
   Model,
   service: feathersClient.service(servicePath),
 
-  // optional and configurable by global config
+  // optional and configurable also by global config
   idField: 'id',
   tempIdField: '__id',
+  nameStyle: 'short',
   debug: false,
   addOnUpsert: false,
   autoRemove: false,
-  enableEvents: true,
   preferUpdate: false,
   replaceItems: false,
   skipRequestIfExists: false,
-  nameStyle: 'short',
 
-  // optional and only configurable per service
-  servicePath: '',
-  namespace: null,
-  modelName: 'User',
+  paramsForServer: [],
+  whitelist: [],
 
-  instanceDefaults: () => ({}),
-  setupInstance: instance => instance,
+  enableEvents: true,
   handleEvents: {
     created: (item, { model, models }) => options.enableEvents,
     patched: (item, { model, models }) => options.enableEvents,
     updated: (item, { model, models }) => options.enableEvents,
     removed: (item, { model, models }) => options.enableEvents
   },
 
+  // optional and only configurable per service
+  servicePath: '',
+  namespace: null,
+  modelName: 'User',
+
+  instanceDefaults: () => ({}),
+  setupInstance: instance => instance,
+
   state: {},
   getters: {},
   mutations: {},
@@ -64,14 +68,22 @@ The following options can also be configured in [Global Configuration](getting-s
 
 - `idField {String}` - **Default:** `globalConfig: 'id'` - The field in each record that will contain the id
 - `tempIdField {Boolean}` - **Default:** `globalConfig: '__id'` - The field in each temporary record that contains the id
+- `nameStyle {'short'|'path'}` - **Default:** `globalConfig: 'short'` - Use the full service path as the Vuex module name, instead of just the last section.
 - `debug {Boolean}` - **Default:** `globalConfig: false` - Enable some logging for debugging
 - `addOnUpsert {Boolean}` - **Default:** `globalConfig: false` - If `true` add new records pushed by 'updated/patched' socketio events into store, instead of discarding them.
 - `autoRemove {Boolean}` - **Default:** `globalConfig: false` - If `true` automatically remove records missing from responses (only use with feathers-rest)
-- `enableEvents {Boolean}` - **Default:** `globalConfig: true` - If `false` socket event listeners will be turned off
 - `preferUpdate {Boolean}` - **Default:** `globalConfig: false` - If `true`, calling `model.save()` will do an `update` instead of a `patch`.
 - `replaceItems {Boolean}` - **Default:** `globalConfig: false` - If `true`, updates & patches replace the record in the store. Default is false, which merges in changes.
 - `skipRequestIfExists {Boolean}` - **Default:** `globalConfig: false` - For get action, if `true` the record already exists in store, skip the remote request.
-- `nameStyle {'short'|'path'}` - **Default:** `globalConfig: 'short'` - Use the full service path as the Vuex module name, instead of just the last section.
+- `paramsForServer {Array}` - Custom query operators that are ignored in the find getter, but will pass through to the server.
+- `whitelist {Array}` - Custom query operators that will be allowed in the find getter.
+- `enableEvents {Boolean}` - **Default:** `globalConfig: true` - If `false` socket event listeners will be turned off
+- `handleEvents {Object}`: For this to work `enableEvents` must be `true`
+  - `created {Function}` - **Default:** `(item, { model, models }) => options.enableEvents` - handle `created` events, return true to add to the store
+  - `patched {Function}` - **Default:** `(item, { model, models }) => options.enableEvents` - handle `created` events, return true to update in the store
+  - `updated {Function}` - **Default:** `(item, { model, models }) => options.enableEvents` - handle `created` events, return true to update in the store
+  - `removed {Function}` - **Default:** `(item, { model, models }) => options.enableEvents` - handle `removed` events, return true to remove from the store
+  -
 
 The following options can only configured individually per service plugin
 
@@ -80,11 +92,6 @@ The following options can only configured individually per service plugin
 - `modelName {String}` - **Default:** `${ServicePlugin.Model.modelName}`
 - `instanceDefaults {Function}` - **Default:** `() => ({})` - Override this method to provide default data for new instances. If using Model classes, specify this as a static class property.
 - `setupInstance {Function}` - **Default:** `instance => instance` - Override this method to setup data types or related data on an instance. If using Model classes, specify this as a static class property.
-- `handleEvents {Object}`: For this to work `enableEvents` must not be `false`
-  - `created {Function}` - **Default:** `(item, { model, models }) => options.enableEvents` - handle `created` events, return true to add to the store
-  - `patched {Function}` - **Default:** `(item, { model, models }) => options.enableEvents` - handle `created` events, return true to update in the store
-  - `updated {Function}` - **Default:** `(item, { model, models }) => options.enableEvents` - handle `created` events, return true to update in the store
-  - `removed {Function}` - **Default:** `(item, { model, models }) => options.enableEvents` - handle `removed` events, return true to remove from the store
 
   - `state {Object}` - **Default:**: `null` - Pass custom `states` to the service plugin or modify existing ones
   - `getters {Object}` - **Default:** `null` - Pass custom `getters` to the service plugin or modify existing ones