Merge pull request #444 from fratzinger/patch-7

Update docs & removeTemps

Author: marshallswain

.vscode/settings.json

@@ -7,11 +7,12 @@
   "search.exclude": {
     "lib/**": true,
     "**/node_modules": true,
-    "**/bower_components": true
+    "**/bower_components": true,
+    "**/yarn.lock": true
   },
   "workbench.colorCustomizations": {
     "activityBar.background": "#2B3011",
     "titleBar.activeBackground": "#3C4418",
     "titleBar.activeForeground": "#FAFBF4"
   }
-}
+}

docs/3.0-major-release.md

@@ -65,14 +65,14 @@ This behavior exactly matches the new `useFind` utility.
 
 ## Deprecations
 
-### The `keepCopiesInStore` Option
+### The `keepCopiesInStore` Option<Badge text="deprecated" type="warning"/>
 
 The `keepCopiesInStore` option is now deprecated.  This was a part of the "clone and commit" API which basically disabled the reason for creating the "clone and commit" API in the first place.
 
 If you're not familiar with the Feathers-Vuex "clone and commit" API, you can learn more about the [built-in data modeling](./model-classes.md) API and the section about [Working with Forms](./feathers-vuex-forms.md#the-clone-and-commit-pattern).
 
 The `keepCopiesInStore` feature is set to be removed in Feathers-Vuex 4.0.
 
-### Auth Plugin State: `user`
+### Auth Plugin State: `user`<Badge text="deprecated" type="warning"/>
 
 As described, earlier on this page, since the Auth Plugin's `user` state is no longer reactive and has been replaced by a `user` getter that IS reactive, the `user` state will be removed in the Feathers-Vuex 4.0.

docs/common-patterns.md

@@ -174,42 +174,15 @@ in the above example of component code, the `upcomingAppointments` and `pastAppo
 
 ## Organizing the services in your project
 
-You can use the file system to organize each service into its own module. This is especially useful in organizing larger-sized projects.  Here's an example `store.js`.  It uses Webpack's require.context feature save repetitive imports:
+You can use the file system to organize each service into its own module. This is especially useful in organizing larger-sized projects.  Here's an example `store.js`.  It uses Webpack's require.context feature save repetitive imports.
 
-```js
-import Vue from 'vue'
-import Vuex from 'vuex'
-import { FeathersVuex } from '../feathers-client'
-import auth from './store.auth'
-
-Vue.use(Vuex)
-Vue.use(FeathersVuex)
-
-const requireModule = require.context(
-  // The path where the service modules live
-  './services',
-  // Whether to look in subfolders
-  false,
-  // Only include .js files (prevents duplicate imports`)
-  /.js$/
-)
-const servicePlugins = requireModule
-  .keys()
-  .map(modulePath => requireModule(modulePath).default)
-
-export default new Vuex.Store({
-  state: {},
-  mutations: {},
-  actions: {},
-  plugins: [...servicePlugins, auth]
-})
-```
+See it [here](/getting-started.html#auth-plugin)
 
 With the `store.js` file in place, we can start adding services to the `services` folder.
 
-- [Learn how to setup a Vuex plugin for a Feathers service.](/api-overview.html#service-plugins)
-- [Learn how to setup the feathers-client.js file](/api-overview.html)
-- [Learn how to setup the auth plugin](/api-overview.html#auth-plugin)
+- [Learn how to setup the feathers-client.js file](/getting-started.html#feathers-client-feathers-vuex)
+- [Learn how to setup a Vuex plugin for a Feathers service](/getting-started.html#service-plugins)
+- [Learn how to setup the auth plugin](/getting-started.html#auth-plugin)
 
 ## Actions return reactive store records
 
@@ -482,7 +455,7 @@ todoCopy.commit()
 todoCopy2.commit()
 ```
 
-You can use the `keepCopiesInStore` option to make this service keep all of its copies in `state.copiesById`.  Remember that to comply with Vuex `strict` mode (if that's a concern for you), you'll have to write custom mutations.  If it's not a concern (maybe you're the sole developer or whatever reason), you could technically turn off `strict` mode, enable `keepCopiesInStore`, and modify them however you desire, ignoring custom mutations.
+You can use the `keepCopiesInStore`<Badge text="deprecated" type="warning"/> option to make this service keep all of its copies in `state.copiesById`.  Remember that to comply with Vuex `strict` mode (if that's a concern for you), you'll have to write custom mutations.  If it's not a concern (maybe you're the sole developer or whatever reason), you could technically turn off `strict` mode, enable `keepCopiesInStore`, and modify them however you desire, ignoring custom mutations.
 
 ```js
 import Vue from 'vue'

docs/getting-started.md

@@ -269,22 +269,42 @@ The following default options are available for configuration:
 
 ```js
 const defaultOptions = {
-  autoRemove: false, // Automatically remove records missing from responses (only use with feathers-rest)
-  addOnUpsert: false, // Add new records pushed by 'updated/patched' socketio events into store, instead of discarding them
-  enableEvents: true, // Listens to socket.io events when available. See the `handleEvents` API for more details
-  idField: 'id', // The field in each record that will contain the id
-  tempIdField: '__id',
-  debug: false, // Set to true to enable logging messages.
-  keepCopiesInStore: false, // Set to true to store cloned copies in the store instead of on the Model.
-  nameStyle: 'short', // Determines the source of the module name. 'short', 'path', or 'explicit'
-  paramsForServer: [], // Custom query operators that are ignored in the find getter, but will pass through to the server.
-  preferUpdate: false, // When true, calling model.save() will do an update instead of a patch.
-  replaceItems: false, // Instad of merging in changes in the store, replace the entire record.
+  // configured globally
   serverAlias: 'api',
-  skipRequestIfExists: false, // For get action, if the record already exists in store, skip the remote request
-  whitelist: [] // Custom query operators that will be allowed in the find getter.
+  keepCopiesInStore: false,
+  paramsForServer: [],
+  whitelist: []
+
+  // also configurable per service
+  idField: 'id',
+  tempIdField: '__id',
+  debug: false,
+  addOnUpsert: false,
+  autoRemove: false,
+  enableEvents: true,
+  preferUpdate: false,
+  replaceItems: false,
+  skipRequestIfExists: false,
+  nameStyle: 'short',
 }
 ```
+- `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
+- `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.
+
+Also see the [Configs per Service](/service-plugin.html#configuration)
 
 ### Note about feathers-reactive
 

docs/model-classes.md

@@ -10,7 +10,7 @@ Feathers-Vuex 1.0 introduced some lightweight data modeling.  Every service had
 
 ## Extending the BaseModel Class
 
-While [setting up Feathers-Vuex](/api-overview.html#feathers-client-feathers-vuex), we exported the `BaseModel` class so that we could extend it.  The below example shows how to import and extend the `BaseModel`.  Each service must now have its own unique Model class.
+While [setting up Feathers-Vuex](/getting-started.html#feathers-client-feathers-vuex), we exported the `BaseModel` class so that we could extend it.  The below example shows how to import and extend the `BaseModel`.  Each service must now have its own unique Model class.
 
 ```js
 import feathersClient, { makeServicePlugin, BaseModel } from '../feathers-client'
@@ -360,7 +360,7 @@ console.log(todoCopy.description) // --> 'Do something else!'
 
 There's another use case for using `.clone()`.  Vuex has a `strict` mode that's really useful in development.  It throws errors if any changes occur in the Vuex store `state` outside of mutations.  Clone really comes in handy here, because you can make changes to the clone without having to write custom Vuex mutations. When you're finished making changes, call `.commit()` to update the store. This gives you `strict` mode compliance with little effort!
 
-> Nonte: You could previously use the `keepCopiesInStore` option to keep copies in `state.copiesById`.  In 2.0, this feature is deprecated and will be removed from the next release.
+> Note: You could previously use the `keepCopiesInStore`<Badge text="deprecated" type="warning"/> option to keep copies in `state.copiesById`.  In 2.0, this feature is deprecated and will be removed from the next release.
 
 ### `instance.commit()`
 

docs/nuxt.md

@@ -16,7 +16,7 @@ The `models` and `$FeathersVuex` variables are the same object.
 
 ## Preventing Memory Leaks
 
-The default settings of Feathers-Vuex include having realtime events enabled by default.  This will result in increased memory usage over time on the SSR server.  It can be turned off when you configure `feathers-vuex`.  The example below has been modified from the example of [Setting up the Feathers Client & Feathers-Vuex](./api-overview.md#feathers-client-feathers-vuex).  Look specifically at the `enableEvents` option.
+The default settings of Feathers-Vuex include having realtime events enabled by default.  This will result in increased memory usage over time on the SSR server.  It can be turned off when you configure `feathers-vuex`.  The example below has been modified from the example of [Setting up the Feathers Client & Feathers-Vuex](./getting-started.html#feathers-client-feathers-vuex).  Look specifically at the `enableEvents` option.
 
 ```js
 const { makeServicePlugin, makeAuthPlugin, BaseModel, models, FeathersVuex } = feathersVuex(