docs updates

Author: marshallswain

docs/2.0-major-release.md

@@ -1,3 +1,8 @@
+---
+title: 2.0 Breaking Changes
+sidebarDepth: 3
+---
+
 # 2.0 Breaking Changes
 
 The biggest change in Feathers-Vuex 2.0 is that it has been refactored with TypeScript!  (It's mostly ES6, still)
@@ -104,188 +109,6 @@ const store = new Vuex.Store({
 })
 ```
 
-## Setting up a project
-
-There are four steps to setting up the entirety of `feathers-vuex`:
-
-1. Setup the FeathersJS Client.
-2. Setup each Service plugin
-3. Setup the Auth plugin
-4. Register all plugins with Vuex
-
-### Setup the FeathersJS Client
-
-It's now recommended that the FeathersJS and client live together in the same file.  This cleans up imports when setting up services.  So let's start with the `feathers-client.js` file.  I usually put this in `src/feathers-client.js`, but you can put it in the store folder if you want.
-
-```js
-// src/feathers-client.js
-import feathers from '@feathersjs/feathers'
-import socketio from '@feathersjs/socketio-client'
-import authClient from '@feathersjs/authentication-client'
-import io from 'socket.io-client'
-import feathersVuex from 'feathers-vuex' // or '@/libs/feathers-vuex' if you're copying feathers-vuex as mentioned earlier.
-
-// Setup the Feathers client
-const host = process.env.VUE_APP_API_URL // or set a string here, directly
-const socket = io(host, { transports: ['websocket'] })
-const feathersClient = feathers()
-  .configure(socketio(socket))
-  .configure(authClient({ storage: window.localStorage }))
-
-export default feathersClient
-
-// Setup feathers-vuex
-const {
-  makeServicePlugin,
-  makeAuthPlugin,
-  BaseModel,
-  models,
-  clients,
-  FeathersVuex
-} = feathersVuex(feathersClient, {
-  serverAlias: 'api', // or whatever that makes sense for your project
-  idField: '_id' // `id` and `_id` are both supported, so this is only necessary if you're using something else.
-})
-
-export {
-  makeAuthPlugin,
-  makeServicePlugin,
-  BaseModel,
-  models,
-  clients,
-  FeathersVuex
-}
-
-```
-
-Now that we have setup the client, we can use the configured exports in each of our services.
-
-### Setup the Services Plugins
-
-Now let's setup a Vuex plugin for each service. I use Webpack's `require.context` to automatically import all of the services instead of explicitly typing them all.  So, I'll put the services in the `src/store/services` folder.
-
-```js
-// Bring in the imports from the feathers-client.js file.
-import feathersClient, {
-  makeServicePlugin,
-  BaseModel
-} from '../../feathers-client'
-
-// Extend the base class
-class User extends BaseModel {
-  constructor(data, options) {
-    super(data, options)
-  }
-  static modelName = 'User'
-  static instanceDefaults() {
-    return {
-      firstName: '',
-      lastName: '',
-      email: '',
-      password: ''
-    }
-  }
-  get fullName() {
-    return `${this.firstName} ${this.lastName}`
-  }
-}
-const servicePath = 'users'
-const servicePlugin = makeServicePlugin({
-  Model: User,
-  service: feathersClient.service(servicePath),
-  servicePath
-})
-
-// Optionally add service-level hooks, here:
-feathersClient.service(servicePath).hooks({
-  before: {
-    all: [],
-    find: [],
-    get: [],
-    create: [],
-    update: [],
-    patch: [],
-    remove: []
-  },
-  after: {
-    all: [],
-    find: [],
-    get: [],
-    create: [],
-    update: [],
-    patch: [],
-    remove: []
-  },
-  error: {
-    all: [],
-    find: [],
-    get: [],
-    create: [],
-    update: [],
-    patch: [],
-    remove: []
-  }
-})
-
-export default servicePlugin
-
-```
-
-Once the service plugin is exported, we can register it with Vuex, but first let's setup the auth plugin.
-
-### Setup the Auth Plugin
-
-We'll use the `makeAuthPlugin` method to tell the auth plugin where to find our `/users` service:
-
-```js
-// src/store/store.auth.js
-import feathersClient, { makeAuthPlugin } from '../feathers-client'
-
-export default makeAuthPlugin({ userService: 'users' })
-
-```
-
-Once you've added the export, we're finally ready to setup the store.
-
-### Register all plugins with Vuex
-
-The final step is to add all of the plugins to the Vuex store.
-
-```js
-// src/store/store.js
-import Vue from 'vue'
-import Vuex from 'vuex'
-import { FeathersVuex } from 'feathers-vuex'
-import auth from './store.auth'
-
-Vue.use(Vuex)
-Vue.use(FeathersVuex)
-
-// Require the entire folder of service plugins with Webpack
-const requireModule = require.context( './services', false, /.js$/ )
-const servicePlugins = requireModule
-  .keys()
-  .map(modulePath => requireModule(modulePath).default)
-
-// Or you can import them manually for Rollup, etc.
-import users from './services/users'
-
-export default new Vuex.Store({
-  state: {},
-  getters: {},
-  mutations: {},
-  actions: {},
-  plugins: [
-    ...servicePlugins, // if you're using require.context, spread the plugins into the array.
-    users, // if you're manually importing, just add the plugins into the array, like this
-    auth
-  ]
-})
-
-```
-
-With the above four steps accomplished, the base of most any application using `feathers-vuex` is ready to build something awesome!
-
 ## Feathers-Vuex Vue plugin changes
 
 The Vue plugin is registered in exactly the same way.  The difference comes when you try to find the Model classes in the `$FeathersVuex` object.  Instead of finding models directly on the `$FeathersVuex` object, they are namespaced by the `serverAlias` you provided.  This allows cleaner support for multiple APIs.  Supposing you had this code in a component, previously...
@@ -320,7 +143,7 @@ Because of the new ability to handle temporary records, a message is only logged
 
 ## Getters Work with Temporary Records
 
-The `find` getter has been updated to include records from `state.tempsById`, by default.  You can pass `temps: false` in the params to only search `state.keyedById`: `find({ query: {}, temps: false })`
+The `find` getter has been updated to include records from `state.tempsById` when you pass `temps: true` in the params.
 
 The `get` getter has also been updated to work with temp ids.  Pass the tempId the way you normally would pass the id:  `get(tempId)`
 
@@ -804,21 +627,21 @@ The above code will override the `responseHandler` auth action to work with the
 
 Don't try to perform a query from within a getter like the example, below.  It will result in an infinite loop:
 
-```
+```js
 get user () {
-            if (this.userId) {
-              const user = Models.User.getFromStore(this.userId)
+  if (this.userId) {
+    const user = Models.User.getFromStore(this.userId)
 
-              // Fetch the User record if we don't already have it
-              if (!user) {
-                Models.User.get(this.userId)
-              }
+    // Fetch the User record if we don't already have it
+    if (!user) {
+      Models.User.get(this.userId)
+    }
 
-              return user
-            } else {
-              return null
-            }
-          }
+    return user
+  } else {
+    return null
+  }
+}
 ```
 
 ### Using custom query parameters
@@ -829,13 +652,3 @@ There are two places where the query operators have to be allowed.
 - Inside feathers-vuex (for the getters): Check out the `paramsForServer` and  `whitelist` options for `feathers-vuex`. Both accept an array of strings representing prop names, but now I can't remember why I determined that I needed both. :)
 
 For the Feathers Client, follow the FeathersJS docs for your database adapter.
-
-### Access `$FeathersVuex` models in Nuxt `asyncData`
-
-In `feathers-vuex@2.x`, you can get access to the `$FeathersVuex` object by importing the `models` object from the main export:
-
-```
-import { models } from 'feathers-vuex'
-```
-
-`models` and `$FeathersVuex` are the same object.

docs/composition-api.md

@@ -95,6 +95,7 @@ And here's a look at each individual property:
   - You can use `params.qid` to dynamically specify the query identifier for any API request. The `qid` is used for tracking pagination data and enabling the fall-through cache across multiple queries.
   - 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.
 - `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/index.md

@@ -11,6 +11,6 @@ features:
 - title: Simplified Auth & Services
   details: Includes service and auth plugins powered by Vuex. All plugins can be easily customized to fit your app.  Fully flexible.
 - title: Best Practices, Baked In
-  details: Common Redux patterns come included. Fall-through cache comes standard. Query the vuex store like a database.
+  details: Vue Composition API 😎 Common Redux patterns included. Fall-through cache by default. Query the Vuex store like a database.
 footer: MIT Licensed | Copyright © 2017-present Marshall Thompson
 ---

docs/nuxt.md

@@ -4,6 +4,16 @@ title: Nuxt
 
 # Nuxt
 
+### Access `$FeathersVuex` models in Nuxt `asyncData`
+
+In `[email protected]`, you can get access to the `$FeathersVuex` object by importing the `models` object from the main export:
+
+```
+import { models } from 'feathers-vuex'
+```
+
+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.

src/service-module/notes.md

@@ -384,12 +384,6 @@ Feathers-Vuex 2.0 supports tracking temporary items and automatically assigns a
 
 Because of the new ability to handle temporary records, a message is only logged when assigning a temporary id to a record.  The `checkId` utility function has been removed, since this was its main purpose.
 
-## Getters Work with Temporary Records
-
-The `find` getter has been updated to include records from `state.tempsById`, by default.  You can pass `temps: false` in the params to only search `state.keyedById`: `find({ query: {}, temps: false })`
-
-The `get` getter has also been updated to work with temp ids.  Pass the tempId the way you normally would pass the id:  `get(tempId)`
-
 ## The "currentItem" workflow is no longer supported
 
 The `setCurrent` mutation and `currentId` state encouraged use of a very limiting API.  It's much more common for apps to require more than one current record.  The `createCopy`, `resetCopy` (formerly called `rejectCopy`), `commitCopy`, and `clearCopy` mutations (since v1.x) provide a more flexible solution for implementing the same functionality.  As a result of this, following have been removed from the modules: