[
{
"path": ".babelrc",
"content": "{\n \"plugins\": [ \"add-module-exports\" ],\n \"presets\": [\n [ \"env\", { \"modules\": false } ],\n \"es2015\",\n \"stage-2\"\n ]\n}\n"
},
{
"path": ".editorconfig",
"content": "# http://editorconfig.org\nroot = true\n\n[*]\nindent_style = space\nindent_size = 2\nend_of_line = lf\ncharset = utf-8\ntrim_trailing_whitespace = true\ninsert_final_newline = true\n\n[*.md]\ntrim_trailing_whitespace = false\n"
},
{
"path": ".github/FUNDING.yml",
"content": "# These are supported funding model platforms\n\ngithub: marshallswain\n"
},
{
"path": ".github/contributing.md",
"content": "# Contributing to Feathers\n\nThank you for contributing to Feathers! :heart: :tada:\n\nThis repo is the main core and where most issues are reported. Feathers embraces modularity and is broken up across many repos. To make this easier to manage we currently use [Zenhub](https://www.zenhub.com/) for issue triage and visibility. They have a free browser plugin you can install so that you can see what is in flight at any time, but of course you also always see current issues in Github.\n\n## Report a bug\n\nBefore creating an issue please make sure you have checked out the docs, specifically the [FAQ](https://docs.feathersjs.com/help/faq.html) section. You might want to also try searching Github. It's pretty likely someone has already asked a similar question.\n\nIf you haven't found your answer please feel free to join our [slack channel](http://slack.feathersjs.com), create an issue on Github, or post on [Stackoverflow](http://stackoverflow.com) using the `feathers` or `feathersjs` tag. We try our best to monitor Stackoverflow but you're likely to get more immediate responses in Slack and Github.\n\nIssues can be reported in the [issue tracker](https://github.com/feathersjs/feathers/issues). Since feathers combines many modules it can be hard for us to assess the root cause without knowing which modules are being used and what your configuration looks like, so **it helps us immensely if you can link to a simple example that reproduces your issue**.\n\n## Report a Security Concern\n\nWe take security very seriously at Feathers. We welcome any peer review of our 100% open source code to ensure nobody's Feathers app is ever compromised or hacked. As a web application developer you are responsible for any security breaches. We do our very best to make sure Feathers is as secure as possible by default.\n\nIn order to give the community time to respond and upgrade we strongly urge you report all security issues to us. Send one of the core team members a PM in [Slack](http://slack.feathersjs.com) or email us at hello@feathersjs.com with details and we will respond ASAP.\n\nFor full details refer to our [Security docs](https://docs.feathersjs.com/SECURITY.html).\n\n## Pull Requests\n\nWe :heart: pull requests and we're continually working to make it as easy as possible for people to contribute, including a [Plugin Generator](https://github.com/feathersjs/generator-feathers-plugin) and a [common test suite](https://github.com/feathersjs/feathers-service-tests) for database adapters.\n\nWe prefer small pull requests with minimal code changes. The smaller they are the easier they are to review and merge. A core team member will pick up your PR and review it as soon as they can. They may ask for changes or reject your pull request. This is not a reflection of you as an engineer or a person. Please accept feedback graciously as we will also try to be sensitive when providing it.\n\nAlthough we generally accept many PRs they can be rejected for many reasons. We will be as transparent as possible but it may simply be that you do not have the same context or information regarding the roadmap that the core team members have. We value the time you take to put together any contributions so we pledge to always be respectful of that time and will try to be as open as possible so that you don't waste it. :smile:\n\n**All PRs (except documentation) should be accompanied with tests and pass the linting rules.**\n\n### Code style\n\nBefore running the tests from the `test/` folder `npm test` will run ESlint. You can check your code changes individually by running `npm run lint`.\n\n### ES6 compilation\n\nFeathers uses [Babel](https://babeljs.io/) to leverage the latest developments of the JavaScript language. All code and samples are currently written in ES2015. To transpile the code in this repository run\n\n> npm run compile\n\n__Note:__ `npm test` will run the compilation automatically before the tests.\n\n### Tests\n\n[Mocha](http://mochajs.org/) tests are located in the `test/` folder and can be run using the `npm run mocha` or `npm test` (with ESLint and code coverage) command.\n\n### Documentation\n\nFeathers documentation is contained in Markdown files in the [feathers-docs](https://github.com/feathersjs/feathers-docs) repository. To change the documentation submit a pull request to that repo, referencing any other PR if applicable, and the docs will be updated with the next release.\n\n## External Modules\n\nIf you're written something awesome for Feathers, the Feathers ecosystem, or using Feathers please add it to the [showcase](https://docs.feathersjs.com/why/showcase.html). You also might want to check out the [Plugin Generator](https://github.com/feathersjs/generator-feathers-plugin) that can be used to scaffold plugins to be Feathers compliant from the start.\n\nIf you think it would be a good core module then please contact one of the Feathers core team members in [Slack](http://slack.feathersjs.com) and we can discuss whether it belongs in core and how to get it there. :beers:\n\n## Contributor Code of Conduct\n\nAs contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.\n\nWe are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.\n\nExamples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)\n"
},
{
"path": ".github/issue_template.md",
"content": "### Steps to reproduce\n\n(First please check that this issue is not already solved as [described\nhere](https://github.com/feathersjs/feathers/blob/master/.github/contributing.md#report-a-bug))\n\n- [ ] Tell us what broke. The more detailed the better.\n- [ ] If you can, please create a simple example that reproduces the issue and link to a gist, jsbin, repo, etc.\n\n### Expected behavior\nTell us what should happen\n\n### Actual behavior\nTell us what happens instead\n\n### System configuration\n\nTell us about the applicable parts of your setup.\n\n**Module versions** (especially the part that's not working):\n\n**NodeJS version**:\n\n**Operating System**:\n\n**Browser Version**:\n\n**React Native Version**:\n\n**Module Loader**:"
},
{
"path": ".github/pull_request_template.md",
"content": "### Summary\n\n(If you have not already please refer to the contributing guideline as [described\nhere](https://github.com/feathersjs/feathers/blob/master/.github/contributing.md#pull-requests))\n\n- [ ] Tell us about the problem your pull request is solving.\n- [ ] Are there any open issues that are related to this?\n- [ ] Is this PR dependent on PRs in other repos?\n\nIf so, please mention them to keep the conversations linked together.\n\n### Other Information\n\nIf there's anything else that's important and relevant to your pull\nrequest, mention that information here. This could include\nbenchmarks, or other information.\n\nYour PR will be reviewed by a core team member and they will work with you to get your changes merged in a timely manner. If merged your PR will automatically be added to the changelog in the next release.\n\nIf your changes involve documentation updates please mention that and link the appropriate PR in [feathers-docs](https://github.com/feathersjs/feathers-docs).\n\nThanks for contributing to Feathers! :heart:"
},
{
"path": ".gitignore",
"content": ".DS_Store\n\n# Logs\nlogs\n*.log\n\n# Runtime data\npids\n*.pid\n*.seed\n\n# Directory for instrumented libs generated by jscoverage/JSCover\nlib-cov\n\n# Coverage directory used by tools like istanbul\ncoverage\n\n# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)\n.grunt\n\n# Compiled binary addons (http://nodejs.org/api/addons.html)\nbuild/Release\n\n# Dependency directory\n# Commenting this out is preferred by some people, see\n# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git-\nnode_modules\n\n# Users Environment Variables\n.lock-wscript\n\n# The compiled/babelified modules\nlib/\n\n# Editor directories and files\n.idea\n.vscode/settings.json\n*.suo\n*.ntvs*\n*.njsproj\n*.sln\n/dist\n"
},
{
"path": ".istanbul.yml",
"content": "verbose: false\ninstrumentation:\n root: ./src/\n excludes:\n - lib/\n include-all-sources: true\nreporting:\n print: summary\n reports:\n - html\n - text\n - lcov\n watermarks:\n statements: [50, 80]\n lines: [50, 80]\n functions: [50, 80]\n branches: [50, 80]"
},
{
"path": ".npmignore",
"content": ".editorconfig\n.jshintrc\n.travis.yml\n.istanbul.yml\n.babelrc\n.idea/\ntest/\n!lib/\n"
},
{
"path": ".travis.yml",
"content": "language: node_js\nnode_js: node\ncache: yarn\naddons:\n code_climate:\n repo_token: 'your repo token'\n firefox: \"51.0\"\nservices:\n - xvfb\nnotifications:\n email: false"
},
{
"path": ".vscode/launch.json",
"content": "{\n // Use IntelliSense to learn about possible Node.js debug attributes.\n // Hover to view descriptions of existing attributes.\n // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387\n \"version\": \"0.2.0\",\n \"configurations\": [\n {\n \"type\": \"node\",\n \"request\": \"launch\",\n \"name\": \"TS - Mocha Tests\",\n \"program\": \"${workspaceFolder}/node_modules/mocha/bin/_mocha\",\n \"args\": [\n \"--require\",\n \"ts-node/register\",\n \"-u\",\n \"bdd\",\n \"--timeout\",\n \"999999\",\n \"--colors\",\n \"--recursive\",\n \"${workspaceFolder}/test/**/*.ts\"\n ],\n \"env\": {\n \"TS_NODE_PROJECT\": \"tsconfig.test.json\"\n },\n \"internalConsoleOptions\": \"openOnSessionStart\"\n },\n {\n \"type\": \"node\",\n \"request\": \"launch\",\n \"name\": \"Launch Program\",\n \"program\": \"${workspaceRoot}/lib/\",\n \"cwd\": \"${workspaceRoot}\"\n },\n {\n \"type\": \"node\",\n \"request\": \"attach\",\n \"name\": \"Attach to Process\",\n \"port\": 5858\n }\n ]\n}\n"
},
{
"path": "CHANGELOG.md",
"content": "# Change Log\n\n## [v1.0.0-pre.3](https://github.com/feathersjs/feathers-vuex/tree/v1.0.0-pre.3) (2017-08-26)\n[Full Changelog](https://github.com/feathersjs/feathers-vuex/compare/v1.0.0-pre.2...v1.0.0-pre.3)\n\n**Closed issues:**\n\n- \\[Proposal\\] Allow existing store modules to provide additional properties like the customActions, etc. [\\#36](https://github.com/feathersjs/feathers-vuex/issues/36)\n\n## [v1.0.0-pre.2](https://github.com/feathersjs/feathers-vuex/tree/v1.0.0-pre.2) (2017-08-24)\n[Full Changelog](https://github.com/feathersjs/feathers-vuex/compare/v1.0.0-pre.1...v1.0.0-pre.2)\n\n## [v1.0.0-pre.1](https://github.com/feathersjs/feathers-vuex/tree/v1.0.0-pre.1) (2017-08-22)\n[Full Changelog](https://github.com/feathersjs/feathers-vuex/compare/v0.8.0...v1.0.0-pre.1)\n\n**Closed issues:**\n\n- Update mutation not changing store or backend [\\#38](https://github.com/feathersjs/feathers-vuex/issues/38)\n- namespaces cannot be arrays for nested modules \\(supported by vuex\\) [\\#34](https://github.com/feathersjs/feathers-vuex/issues/34)\n- using deep-assign package [\\#15](https://github.com/feathersjs/feathers-vuex/issues/15)\n\n## [v0.8.0](https://github.com/feathersjs/feathers-vuex/tree/v0.8.0) (2017-08-18)\n[Full Changelog](https://github.com/feathersjs/feathers-vuex/compare/v0.7.2...v0.8.0)\n\n**Closed issues:**\n\n- How to setup vuex and vue-router to redirect when a store value is not set? [\\#37](https://github.com/feathersjs/feathers-vuex/issues/37)\n- OAuth with Google and feathers-vuex [\\#33](https://github.com/feathersjs/feathers-vuex/issues/33)\n\n**Merged pull requests:**\n\n- Support array namespaces for module nesting [\\#35](https://github.com/feathersjs/feathers-vuex/pull/35) ([jskrzypek](https://github.com/jskrzypek))\n\n## [v0.7.2](https://github.com/feathersjs/feathers-vuex/tree/v0.7.2) (2017-08-04)\n[Full Changelog](https://github.com/feathersjs/feathers-vuex/compare/v0.7.1...v0.7.2)\n\n**Closed issues:**\n\n- Mapped Action is not a function [\\#31](https://github.com/feathersjs/feathers-vuex/issues/31)\n- Real time updates stops working sometimes depending on the query [\\#28](https://github.com/feathersjs/feathers-vuex/issues/28)\n\n**Merged pull requests:**\n\n- Return Promise.reject for action path of services when catching an er… [\\#32](https://github.com/feathersjs/feathers-vuex/pull/32) ([phenrigomes](https://github.com/phenrigomes))\n\n## [v0.7.1](https://github.com/feathersjs/feathers-vuex/tree/v0.7.1) (2017-07-08)\n[Full Changelog](https://github.com/feathersjs/feathers-vuex/compare/v0.7.0...v0.7.1)\n\n**Closed issues:**\n\n- errorOnAuthenticate is not reset [\\#29](https://github.com/feathersjs/feathers-vuex/issues/29)\n- Hoping to support server paging parameters [\\#23](https://github.com/feathersjs/feathers-vuex/issues/23)\n\n**Merged pull requests:**\n\n- Fix 29 [\\#30](https://github.com/feathersjs/feathers-vuex/pull/30) ([mgesmundo](https://github.com/mgesmundo))\n\n## [v0.7.0](https://github.com/feathersjs/feathers-vuex/tree/v0.7.0) (2017-06-27)\n[Full Changelog](https://github.com/feathersjs/feathers-vuex/compare/v0.6.0...v0.7.0)\n\n**Merged pull requests:**\n\n- Remove “feathers” module completely [\\#27](https://github.com/feathersjs/feathers-vuex/pull/27) ([marshallswain](https://github.com/marshallswain))\n\n## [v0.6.0](https://github.com/feathersjs/feathers-vuex/tree/v0.6.0) (2017-06-27)\n[Full Changelog](https://github.com/feathersjs/feathers-vuex/compare/v0.5.0...v0.6.0)\n\n**Merged pull requests:**\n\n- Allow customizing a service’s default store [\\#26](https://github.com/feathersjs/feathers-vuex/pull/26) ([marshallswain](https://github.com/marshallswain))\n\n## [v0.5.0](https://github.com/feathersjs/feathers-vuex/tree/v0.5.0) (2017-06-27)\n[Full Changelog](https://github.com/feathersjs/feathers-vuex/compare/v0.4.2...v0.5.0)\n\n**Closed issues:**\n\n- Are feathers-reactive and RxJS dependencies necessary? [\\#22](https://github.com/feathersjs/feathers-vuex/issues/22)\n- Weird / destructive behaviour using mapActions service find between components [\\#21](https://github.com/feathersjs/feathers-vuex/issues/21)\n- removeItems action added after create when upgrading version from version 0.4.0 to 0.4.1 [\\#19](https://github.com/feathersjs/feathers-vuex/issues/19)\n\n**Merged pull requests:**\n\n- Remove all non-serializable data from the state [\\#25](https://github.com/feathersjs/feathers-vuex/pull/25) ([marshallswain](https://github.com/marshallswain))\n- Opt in to `autoRemove` [\\#24](https://github.com/feathersjs/feathers-vuex/pull/24) ([marshallswain](https://github.com/marshallswain))\n\n## [v0.4.2](https://github.com/feathersjs/feathers-vuex/tree/v0.4.2) (2017-06-07)\n[Full Changelog](https://github.com/feathersjs/feathers-vuex/compare/v0.4.1...v0.4.2)\n\n**Closed issues:**\n\n- What is the benefit to convert data in feathers to vuex instead of accessing feathers services directly? [\\#18](https://github.com/feathersjs/feathers-vuex/issues/18)\n- items not being removed from the list - fix proposal [\\#12](https://github.com/feathersjs/feathers-vuex/issues/12)\n\n**Merged pull requests:**\n\n- QuickFix: Use idField for removal [\\#20](https://github.com/feathersjs/feathers-vuex/pull/20) ([cmeissl](https://github.com/cmeissl))\n\n## [v0.4.1](https://github.com/feathersjs/feathers-vuex/tree/v0.4.1) (2017-05-26)\n[Full Changelog](https://github.com/feathersjs/feathers-vuex/compare/v0.4.0...v0.4.1)\n\n**Closed issues:**\n\n- Is possible to upload a file using feathers-vuex? [\\#11](https://github.com/feathersjs/feathers-vuex/issues/11)\n- Integration with Nuxt [\\#8](https://github.com/feathersjs/feathers-vuex/issues/8)\n\n**Merged pull requests:**\n\n- Bugfix - add params to patch action service call [\\#14](https://github.com/feathersjs/feathers-vuex/pull/14) ([ndamjan](https://github.com/ndamjan))\n- fix item removal in addOrUpdateList \\(\\#12\\) [\\#13](https://github.com/feathersjs/feathers-vuex/pull/13) ([ndamjan](https://github.com/ndamjan))\n\n## [v0.4.0](https://github.com/feathersjs/feathers-vuex/tree/v0.4.0) (2017-05-01)\n[Full Changelog](https://github.com/feathersjs/feathers-vuex/compare/v0.3.1...v0.4.0)\n\n## [v0.3.1](https://github.com/feathersjs/feathers-vuex/tree/v0.3.1) (2017-05-01)\n[Full Changelog](https://github.com/feathersjs/feathers-vuex/compare/v0.3.0...v0.3.1)\n\n## [v0.3.0](https://github.com/feathersjs/feathers-vuex/tree/v0.3.0) (2017-05-01)\n[Full Changelog](https://github.com/feathersjs/feathers-vuex/compare/v0.2.2...v0.3.0)\n\n**Merged pull requests:**\n\n- Node: Keep functions out of Vuex state [\\#9](https://github.com/feathersjs/feathers-vuex/pull/9) ([marshallswain](https://github.com/marshallswain))\n\n## [v0.2.2](https://github.com/feathersjs/feathers-vuex/tree/v0.2.2) (2017-04-28)\n[Full Changelog](https://github.com/feathersjs/feathers-vuex/compare/v0.2.1...v0.2.2)\n\n## [v0.2.1](https://github.com/feathersjs/feathers-vuex/tree/v0.2.1) (2017-04-18)\n[Full Changelog](https://github.com/feathersjs/feathers-vuex/compare/v0.2.0...v0.2.1)\n\n**Closed issues:**\n\n- `clearList` mutation behaves unexpectedly if `current` isn't defined [\\#5](https://github.com/feathersjs/feathers-vuex/issues/5)\n\n**Merged pull requests:**\n\n- Fix clearList unexpected behavior. Closes \\#5 [\\#6](https://github.com/feathersjs/feathers-vuex/pull/6) ([silvestreh](https://github.com/silvestreh))\n\n## [v0.2.0](https://github.com/feathersjs/feathers-vuex/tree/v0.2.0) (2017-04-18)\n[Full Changelog](https://github.com/feathersjs/feathers-vuex/compare/v0.1.1...v0.2.0)\n\n**Merged pull requests:**\n\n- Actions [\\#4](https://github.com/feathersjs/feathers-vuex/pull/4) ([marshallswain](https://github.com/marshallswain))\n\n## [v0.1.1](https://github.com/feathersjs/feathers-vuex/tree/v0.1.1) (2017-04-18)\n[Full Changelog](https://github.com/feathersjs/feathers-vuex/compare/v0.1.0...v0.1.1)\n\n## [v0.1.0](https://github.com/feathersjs/feathers-vuex/tree/v0.1.0) (2017-04-18)\n[Full Changelog](https://github.com/feathersjs/feathers-vuex/compare/v0.0.5...v0.1.0)\n\n**Merged pull requests:**\n\n- Service tests clear list [\\#3](https://github.com/feathersjs/feathers-vuex/pull/3) ([marshallswain](https://github.com/marshallswain))\n- add before-install script [\\#2](https://github.com/feathersjs/feathers-vuex/pull/2) ([marshallswain](https://github.com/marshallswain))\n\n## [v0.0.5](https://github.com/feathersjs/feathers-vuex/tree/v0.0.5) (2017-04-15)\n[Full Changelog](https://github.com/feathersjs/feathers-vuex/compare/v0.0.4...v0.0.5)\n\n**Merged pull requests:**\n\n- Update readme.md [\\#1](https://github.com/feathersjs/feathers-vuex/pull/1) ([marshallswain](https://github.com/marshallswain))\n\n## [v0.0.4](https://github.com/feathersjs/feathers-vuex/tree/v0.0.4) (2017-04-12)\n[Full Changelog](https://github.com/feathersjs/feathers-vuex/compare/v0.0.3...v0.0.4)\n\n## [v0.0.3](https://github.com/feathersjs/feathers-vuex/tree/v0.0.3) (2017-03-15)\n[Full Changelog](https://github.com/feathersjs/feathers-vuex/compare/v0.0.2...v0.0.3)\n\n## [v0.0.2](https://github.com/feathersjs/feathers-vuex/tree/v0.0.2) (2017-03-15)\n\n\n\\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*"
},
{
"path": "LICENSE",
"content": "The MIT License (MIT)\n\nCopyright (c) 2016 Feathers\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\n"
},
{
"path": "README.md",
"content": "# Feathers-Vuex\n\n[](https://travis-ci.org/feathersjs-ecosystem/feathers-vuex)\n[](https://david-dm.org/feathersjs-ecosystem/feathers-vuex)\n[](https://www.npmjs.com/package/feathers-vuex)\n[](https://greenkeeper.io/)\n\n`Feathers-Vuex` is a first class integration of FeathersJS and Vuex. It implements many Redux best practices under the hood, eliminates _a lot_ of boilerplate code with flexible data modeling, and still allows you to easily customize the Vuex store.\n\n\n\n## Demo & Documentation\n\n[Demo](https://codesandbox.io/s/xk52mqm7o)\n\nSee [https://vuex.feathersjs.com](https://vuex.feathersjs.com) for full documentation.\n\n## Installation\n\n```bash\nnpm install feathers-vuex --save\n```\n\n```bash\nyarn add feathers-vuex\n```\n\nIMPORTANT: Feathers-Vuex is (and requires to be) published in ES6 format for full compatibility with JS classes. If your project uses Babel, it must be configured properly. See the [Project Configuration](https://vuex.feathersjs.com/getting-started.html#project-configuration) section for more information.\n\n## Contributing\n\nThis repo is pre-configured to work with the Visual Studio Code debugger. After running `yarn install`, use the \"Mocha Tests\" debug script for a smooth debugging experience.\n\n## License\n\nCopyright (c) Forever and Ever, or at least the current year.\n\nLicensed under the [MIT license](https://github.com/feathersjs-ecosystem/feathers-vuex/blob/master/LICENSE).\n"
},
{
"path": "docs/.vuepress/config.js",
"content": "module.exports = {\n title: 'FeathersVuex',\n description: 'Integration of FeathersJS, Vue, and Nuxt for the artisan developer',\n head: [['link', { rel: 'icon', href: '/favicon.ico' }]],\n theme: 'default-prefers-color-scheme',\n themeConfig: {\n repo: 'feathersjs-ecosystem/feathers-vuex',\n docsDir: 'docs',\n editLinks: true,\n sidebar: [\n '/api-overview.md',\n '/3.0-major-release.md',\n '/getting-started.md',\n '/example-applications.md',\n '/vue-plugin.md',\n '/service-plugin.md',\n '/auth-plugin.md',\n '/model-classes.md',\n '/common-patterns.md',\n '/composition-api.md',\n '/mixins.md',\n '/data-components.md',\n '/feathers-vuex-forms.md',\n '/nuxt.md',\n '/2.0-major-release.md',\n ],\n serviceWorker: {\n updatePopup: true\n }\n }\n}\n"
},
{
"path": "docs/2.0-major-release.md",
"content": "---\ntitle: 2.0 Breaking Changes\nsidebarDepth: 3\n---\n\n# 2.0 Breaking Changes\n\nThe biggest change in Feathers-Vuex 2.0 is that it has been refactored with TypeScript! (It's mostly ES6, still)\n\nYour project does NOT require to be written in TypeScript. The `dist` is compiled to ES6.\n\n## Fixing the build for older Vue-CLI Apps\n\nAs of October 2019, up-to-date Vue-CLI apps are able to properly build and use `feathers-vuex` after adding `transpileDependencies`. For apps based on older modules, I've found the simplest solution to be to copy the `feathers-vuex` module into `src/libs` inside your project. Create a `copy-deps.sh` file in the root of your project and setup the following:\n\n```bash\nrm -rf src/libs\nmkdir src/libs\n\n# feathers-vuex\ncp -r node_modules/feathers-vuex/dist src/libs/feathers-vuex\n```\n\nThen in `package.json`, create a script that uses the `copy-deps.sh` file:\n\n```json\n{\n \"copy\": \". ./copy-deps.sh\",\n \"serve\": \"npm run copy && vue-cli-service serve\",\n \"build\": \"npm run copy && vue-cli-service build\",\n \"postinstall\": \"npm run copy\"\n}\n```\n\nIt's not the prettiest solution, but it works well and is the simplest for older apps.\n\n## Here's what's new in `feathers-vuex`\n\nCheck out the tests for the best documentation. They've been reorganized. This is still a Work in Progress.\n\n## Changes to Initialization\n\n1. To assist in connecting with multiple FeathersJS API servers, a new `serverAlias` option is now required. This requires a simple addition to the initial options.\n2. The exports have changed.\n - (a) A new `BaseModel` is available. This is the base `FeathersVuexModel` which contains the model methods. Feel free to extend it and make it fit your awesome services!\n - (b) The `service` method has been renamed to `makeServicePlugin`.\n - (c) The `auth` method is now called `makeAuthPlugin`\n - (d) The `models` object is now exported, so you can access them from anywhere. They are keyed by `serverAlias`.\n - (e) A new `clients` object is available. The intention is to allow working with multiple FeathersJS API servers.\n3. You no longer pass a `servicePath` to create a service-plugin. Instead, pass the actual Feathers service.\n4. Since you can customize the Model, you also pass the extended Model into the `makeServicePlugin` method.\n\nBelow is an all-in-one example of a the basic configuration steps. See the next section for how to setup a project.\n\n```js\n// ./src/store/store.js\nimport feathers from './feathers-client'\nimport Vuex from 'vuex'\nimport feathersVuex from 'feathers-vuex'\n\nconst {\n BaseModel, // (2a)\n makeServicePlugin, // (2b)\n makeAuthPlugin, // (2c)\n models, // (2d)\n clients // (2e)\n} = feathersVuex(feathers, {\n idField: '_id',\n serverAlias: 'myApi' // (1)\n})\n\nclass Todo extends BaseModel {\n // required\n constructor (data, options) {\n super(data, options)\n }\n // required\n static modelName = 'Todo'\n\n // optional, but useful\n static instanceDefaults(data) {\n return {\n name: '',\n isComplete: false,\n userId: null,\n user: null // populated on the server\n }\n }\n\n // optional, but useful\n static setupInstance(data) {\n if (data.user) {\n data.user = new models.myApi.User(data.user)\n }\n return data\n }\n // customize the model as you see fit!\n}\n\nconst todosPlugin = makeServicePlugin({\n Model: Todo, // (3)\n service: feathers.service('todos') // (4)\n})\n\nconst store = new Vuex.Store({\n plugins: [\n todosPlugin\n ]\n})\n```\n\n## Feathers-Vuex Vue plugin changes\n\nThe 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...\n\n```js\ncreated () {\n // The old way\n const { Todo } = this.$FeathersVuex\n}\n```\n\nModify it to include the new `serverAlias`. Suppose you set a `serverAlias` of `myApi`, you'd put this in the new version:\n\n```js\ncreated () {\n // The new way includes the `serverAlias` of '.myApi'\n const { Todo } = this.$FeathersVuex.myApi\n}\n```\n\n## Better default `idField` support\n\nSince records are keyed by id, `feathers-vuex` needs to know what the `idField` is for each service. In the last version, the default was `id`, and you had to specify something different. This version supports `id` and `_id` with zero configuration. You only need to set `idField` when you're using something other than `id` or `_id`.\n\nThere's still a warning message when records don't have a property matching the `idField`. Just like in the last version, it only appears when you turn on `debug: true` in the options.\n\n## Support for Temporary Records\n\nFeathers-Vuex 2.0 supports tracking temporary items and automatically assigns a temporary id to new records. It also adds the records to `state.tempsById`. This is customizable using the `tempIdField` option.\n\nBecause 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.\n\n## Getters Work with Temporary Records\n\nThe `find` getter has been updated to include records from `state.tempsById` when you pass `temps: true` in the params.\n\nThe `get` getter has also been updated to work with temp ids. Pass the tempId the way you normally would pass the id: `get(tempId)`\n\n## The \"currentItem\" workflow is no longer supported\n\nThe `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:\n\n- state: `currentID`, `copy`\n- getters: `current`, `getCopy`\n- mutations: `setCurrent`, `clearCurrent`, `clearList`, `commitCopy`, `clearCopy`, `resetCopy`\n\n## The `diffOnPatch` option has been removed\n\n(See the next section for its replacement.)\n\nI have not been able to find a diffing algorithm that works equally well acroos all schemas. It's especially difficult for nested schemas. Because of this, `diffOnPatch` is no longer a global option. It is being replaced by the `diffOnPatch` static Model method. See the next section.\n\n## Model Classes: BYOD (Bring Your Own Diffing)\n\n> Note: As of `feathers-vuex@3.9.0`, you can also pass `params.data` to the patch object to implement partial patching on objects. You might choose to use `params.data` instead of `diffOnPatch`.\n\nFirst, why do any diffing? On the API server, an `update` request replaces an entire object, but a `patch` request only overwrites the attributes that are provided in the data. For services with simple schemas, it doesn't really matter. But if your schema grows really large, it can be supportive to only send the updates instead of the entire object.\n\nA new `diffOnPatch` method is available to override in your extended models. `diffOnPatch` gets called just before sending the data to the API server. It gets called with the data and must return the diffed data. By default, it is set to `diffOnPatch: data => data`.\n\nBelow is an example of how you might implement `diffOnPatch`. You would only ever use this with a cloned instance, otherwise there's nothing to diff.\n\n```js\nimport { diff } from 'deep-object-diff'\nconst { makeServicePlugin, BaseModel } = feathersVuex(feathers, { serverAlias: 'myApi' })\n\nclass Todo extends BaseModel {\n public constructor (data, options?) {\n super(data, options)\n }\n public static modelName = 'Todo'\n public static diffOnPatch (data) {\n const originalObject = Todo.store.state.keyedById[data._id]\n return diff(originalObject, data)\n }\n}\n\nconst store = new Vuex.Store({\n plugins: [\n makeServicePlugin({\n Model: Todo,\n service: feathers.service(servicePath)\n })\n ]\n})\n```\n\n## The `modelName` option has moved\n\nWhile the original intent was to completely remove the `modelName` option, it's still required after transpiling to ES5. This is because during transpilation, the class name gets stripped and can't be put back into place. Since ES5 is the default target for most build environments, the `modelName` is still required to be specified, but it has been moved. Instead of being an option, it's required as a static property of each class.\n\nNote: Once ES6 is the default target for most build systems, modelName will become optional. For future upgradability, it's recommended that you give your `modelName` the exact same name as your model class.\n\n```js\nconst { makeServicePlugin, BaseModel } = feathersVuex(feathers, { serverAlias: 'myApi' })\n\nclass Todo extends BaseModel {\n public constructor (data, options?) {\n super(data, options)\n }\n public static modelName = 'Todo' // modelName is required on all Model classes.\n public static exampleProp: string = 'Hello, World! (notice the comma, folks!)'\n}\n\nconst store = new Vuex.Store({\n plugins: [\n makeServicePlugin({\n Model: Todo,\n service: feathers.service(servicePath)\n })\n ]\n})\n```\n\n## Options are no longer kept on the Model\n\nThe Model class no longer has an `options` property. You can access the same information through the `Model.store.state[Model.namespace]`.\n\n## The 'apiPrefix' option has been removed\n\nFeathers-Vuex now includes full support for communicating with multiple FeathersJS APIs. The `apiPrefix` option was a poorly-implemented, hacky, first attempt at this same feature. Since it didn't work as intended, it has been removed. See this example test for working with multiple APIs:\n\n```js\nimport { assert } from 'chai'\nimport Vue from 'vue'\nimport Vuex from 'vuex'\nimport {\n feathersRestClient as feathers,\n makeFeathersRestClient\n} from '../../test/fixtures/feathers-client'\nimport feathersVuex from './index'\n\nit('works with multiple, independent Feathers servers', function() {\n // Connect to myApi, create a Todo Model & Plugin\n const feathersMyApi = makeFeathersRestClient('https://api.my-api.com')\n const myApi = feathersVuex(feathersMyApi, {\n idField: '_id',\n serverAlias: 'myApi'\n })\n class Todo extends myApi.BaseModel {\n public test: boolean = true\n }\n const todosPlugin = myApi.makeServicePlugin({\n Model: Todo,\n service: feathersMyApi.service('todos')\n })\n\n // Create a Task Model & Plugin on theirApi\n const feathersTheirApi = makeFeathersRestClient('https://api.their-api.com')\n const theirApi = feathersVuex(feathersTheirApi, {\n serverAlias: 'theirApi'\n })\n class Task extends theirApi.BaseModel {\n public test: boolean = true\n }\n const tasksPlugin = theirApi.makeServicePlugin({\n Model: Task,\n service: feathersTheirApi.service('tasks')\n })\n\n // Register the plugins\n new Vuex.Store({\n plugins: [todosPlugin, tasksPlugin]\n })\n const { models } = myApi\n\n assert(models.myApi.Todo === Todo)\n assert(!models.theirApi.Todo, `Todo stayed out of the 'theirApi' namespace`)\n assert(models.theirApi.Task === Task)\n assert(!models.myApi.Task, `Task stayed out of the 'myApi' namespace`)\n\n assert.equal(\n models.myApi.byServicePath[Todo.servicePath],\n Todo,\n 'also registered in models.byServicePath'\n )\n assert.equal(\n models.theirApi.byServicePath[Task.servicePath],\n Task,\n 'also registered in models.byServicePath'\n )\n```\n\n## Services are no longer set up, internally\n\nYou no longer just pass a servicePath. Instead, create the service, then pass the returned service object.\n\n## Simplified Pending Mutations\n\nPreviously, there was a mutation for every single variety of method and set/unset pending. (`setFindPending`, `unsetFindPending`, etc.). There were a total of twelve methods for this simple operation. They are now combined into two methods: `setPending(method)` and `unsetPending(method)`. Here's the difference.\n\n```js\n// The old way\ncommit('setFindPending')\ncommit('unsetFindPending')\n\n// The new way\ncommit('setPending', 'find')\ncommit('unsetPending', 'find')\n```\n\n## Simplified Error Mutations\n\nThe \"error\" mutations have been simplified similar to the \"pending\" mutations:\n\n```js\n// The old way\ncommit('setFindError', error)\ncommit('clearFindError')\n\n// The new way\ncommit('setError', { method: 'find', error })\ncommit('clearError', 'find')\n```\n\n## `instanceDefaults` must be a function\n\nIn the previous version, you could specify instanceDefaults as an object. It was buggy and limiting. In this new version, `instanceDefaults` must always be a function. See the next section for an example.\n\n## Getter and Setter props go on the Model classes\n\nOne of the great features about using Model classes is data-level computed properties. You get to specify computed properties directly on your data structures instead of inside components, which keeps a better separation of concerns. In `feathers-vuex@2.x`, since we have direct access to the Model classes, it's the perfect place to define the computed properties:\n\n```js\nimport feathersClient, {\n makeServicePlugin,\n BaseModel\n} from '../../feathers-client'\n\nclass User extends BaseModel {\n constructor(data, options) {\n super(data, options)\n }\n static modelName = 'User' // required\n // Computed properties don't go on in the instanceDefaults, anymore.\n static instanceDefaults() {\n return {\n firstName: '',\n lastName: '',\n email: '',\n password: '',\n isAdmin: false,\n }\n }\n // Here's a computed getter\n get fullName() {\n return `${this.firstName} ${this.lastName}`\n }\n // Probably not something you'd do in real life, but it's an example of a setter.\n set fullName(fullName) {\n const [ firstName, lastName ] = fullName.split(' ')\n Object.assign(this, { firstName, lastName })\n }\n}\nconst servicePath = 'users'\nconst servicePlugin = makeServicePlugin({\n Model: User,\n service: feathersClient.service(servicePath),\n servicePath\n})\n```\n\n## Relationships have been separated from `instanceDefaults`\n\nFeathers-Vuex 2.0 has a new API for establishing relationships between data. Before we cover how it works, let's review the old API.\n\nFeathers-Vuex 1.x allowed using the `instanceDefaults` API to both setup default values for Vue reactivity AND establishing relationships between services. It supported passing a string name that matched a model name to setup a relationship, as shown in this next example. This was a simple, but very limited API:\n\n```js\n// The old way\ninstanceDefaults: {\n _id: '',\n description: '',\n isCompleted: false,\n user: 'User'\n}\n```\n\nAny instance data with a matching key would overwrite the same property in the instanceDefaults, which resulted in an inconsistent API.\n\nIn Feathers-Vuex 2.0, the `instanceDefaults` work the same for setting defaults with only one exception: They no longer setup the relationships. The new `setupInstance` function provides an API that is much more powerful.\n\nAs mentioned earlier, it MUST be provided as a function:\n\n```js\n// See the `model-instance-defaults.test.ts` file for example usage.\n// This is a brief example.\ninstanceDefaults(data, { models, store}) {\n return {\n _id: '',\n description: '',\n isCompleted: false\n // No user props, here.\n }\n}\n```\n\nNotice in the above example that we did not return `user`. Relationships are now handled in the `setupInstance` method.\n\nWhere `instanceDefaults` props get overwritten with instance data, the props returned from `setupInstance` overwrite the instance data. If it were using `Object.assign`, internally (it's not, but IF it were), it would look like the below example, where `data` is the original instance data passed to the constructor.\n\n```js\nObject.assign({}, instanceDefaults(data), data, setupInstance(data))\n```\n\n## Define Relationships and Modify Data with `setupInstance`\n\nThe new `setupInstance` method allows a lot of flexibility in creating new instances. It has the exact same API as the `instanceDefaults` method. The only difference is the order in which they are applied to the instance data.\n\nAlthough it looks similar to `instanceDefaults`, it can't be used for default values. This is because it overwrites instance data. Having separate methods allows a clean separation between setting up defaults and establishing relationships with other constructors.\n\n```js\n// See the `model-relationships.test.ts` file for example usage.\n// This is a brief example.\nfunction setupInstance(data, { models, store }) {\n const { User, Tag } = models.myServerAlias // Based on the serverAlias you provide, initially\n\n // A single User instance\n if (data.user) {\n data.user = new User(data.user)\n }\n // An array of Tag instances\n if (data.tags) {\n data.tags = data.tags.map(t => new Tag(t))\n }\n // A JavaScript Date Object\n if (data.createdAt) {\n data.createdAt = new Date(data.createdAt)\n }\n return data\n}\n```\n\nOr below is an example that does the exact same thing with one line per attribute:\n\n```js\nfunction setupInstance(data, { models, store }) {\n const { User } = models.myServerAlias\n\n Object.assign(data, {\n ...(data.user && { user: new User(data.user) }), // A single User instance\n ...(data.tags && { tags: data.tags.map(t => new Tag(t)) }), // An array of Tag instances\n ...(data.createdAt && { createdAt: new Date(data.createdAt) }) // A JavaScript Date Object\n })\n return data\n}\n```\n\nWhere `instanceDefaults` props get replaced by instance data, the props returned from `setupInstance` overwrite the instance data. If it were using `Object.assign`, internally (it's not, but IF it were), it would look like the below example, where `data` is the original instance data passed to the constructor.\n\n```js\nObject.assign({}, instanceDefaults(data), data, setupInstance(data))\n```\n\n## Preventing duplicate merge when extending BaseModel with a custom constructor\n\nThe BaseModel constructor calls `mergeWithAccessors(this, newData)`. This utility function correctly copies data between both regular objects and Vue.observable instances. If you create a class where you need to do your own merging, you probably don't want `mergeWithAccessors` to run twice. In this case, you can use the `merge: false` BaseModel ___instance option___ to prevent the internal merge. You can then access the `mergeWithAccessors` method by calling `MyModel.merge(this, newData)`. Here's an example:\n\n```ts\nconst { makeServicePlugin, BaseModel } = feathersVuex(feathersClient, {\n serverAlias: 'myApiServer'\n})\n\nclass Todo extends BaseModel {\n public constructor(data, options?) {\n options.merge = false // Prevent the internal merge from occurring.\n super(data, options)\n\n // ... your custom constructor logic happens here.\n\n // Call the static merge method to do your own merging.\n Todo.merge(this, data)\n }\n}\n```\n\nIt's important to note that setting `merge: false` in the options will disable the `setupinstance` function. You need to manually call it, like this:\n\n```ts\nclass Todo extends BaseModel {\n public constructor(data, options?) {\n options = options || {}\n options.merge = false // Prevent the internal merge from occurring.\n super(data, options)\n\n // ... your custom construcor logic happens here.\n\n // Call setupInstance manually\n const { models, store } = Todo\n // JavaScript fundamentals: if you're using `this` in `setupInstance`, use .call(this, ...)\n const instanceData = Todo.setupInstance.call(this, data, { models, store })\n // If you're not using `this, just call it like normal\n const instanceData = Todo.setupInstance(data, { models, store })\n\n // Call the static merge method to do your own merging.\n Todo.merge(this, instanceData)\n }\n}\n```\n\n## Customizing the BaseModel\n\nBecause we have access to the BaseModel, we can extend it to do whatever custom stuff we need in our application. The `feathers-client.js` file is a great, centralized location for accomplishing this:\n\n```js\n// src/feathers-client.js\nimport feathers from '@feathersjs/feathers'\nimport socketio from '@feathersjs/socketio-client'\nimport authClient from '@feathersjs/authentication-client'\nimport io from 'socket.io-client'\nimport feathersVuex from 'feathers-vuex' // or '@/libs/feathers-vuex' if you're copying feathers-vuex as mentioned earlier.\n\n// Setup the Feathers client\nconst host = process.env.VUE_APP_API_URL // or set a string here, directly\nconst socket = io(host, { transports: ['websocket'] })\nconst feathersClient = feathers()\n .configure(socketio(socket))\n .configure(authClient({ storage: window.localStorage }))\n\nexport default feathersClient\n\n// Setup feathers-vuex\nconst {\n makeServicePlugin,\n makeAuthPlugin,\n BaseModel,\n models,\n clients,\n FeathersVuex\n} = feathersVuex(feathersClient, {\n serverAlias: 'api', // or whatever that makes sense for your project\n idField: '_id' // `id` and `_id` are both supported, so this is only necessary if you're using something else.\n})\n\n// Note that if you want to\n// extend the BaseClass for the rest of the app, this is a great place to do it.\n// After you've extended the BaseClass with your CustomClass, export it, here.\nclass CustomBaseModel extends BaseModel {\n // Optionally add custom functionality for all services, here.\n}\n\n// Export all of the utilities for the rest of the app.\nexport {\n makeAuthPlugin,\n makeServicePlugin,\n BaseModel,\n models,\n clients,\n FeathersVuex,\n CustomBaseModel // Don't forget to export it for use in all other services.\n}\n\n```\n\n\n## Auth plugin changes\n\nWith FeathersJS version 4, the user is returned in the authentication response, by default. This means that it's no longer required to provide a `userService` option to populate the user. 👍\n\nIf you would like to enable backwards compatibility with the previous version of Feathers, pass the below code in the makeAuthPlugin.\n\n```js\nmakeAuthPlugin({\n userService: 'users',\n actions: {\n responseHandler({ commit, state, dispatch }, response) {\n if (response.accessToken) {\n commit('setAccessToken', response.accessToken)\n // Decode the token and set the payload, but return the response\n return feathersClient.passport\n .verifyJWT(response.accessToken)\n .then(payload => {\n commit('setPayload', payload)\n let user = response[state.responseEntityField]\n // If a user was returned in the authenticate response, use that user.\n if (user) {\n if (state.serverAlias && state.userService) {\n const Model = Object.keys(models[state.serverAlias])\n .map(modelName => models[state.serverAlias][modelName])\n .find(model => model.servicePath === state.userService)\n if (Model) {\n user = new Model(user)\n }\n }\n commit('setUser', user)\n // Populate the user if the userService was provided\n } else if (\n state.userService &&\n payload.hasOwnProperty(state.entityIdField)\n ) {\n return dispatch(\n 'populateUser',\n payload[state.entityIdField]\n ).then(() => {\n commit('unsetAuthenticatePending')\n return response\n })\n } else {\n commit('unsetAuthenticatePending')\n }\n return response\n })\n // If there was not an accessToken in the response, allow the response to pass through to handle two-factor-auth\n } else {\n return response\n }\n }\n }\n```\n\nThe above code will override the `responseHandler` auth action to work with the Passport-based version of Feathers Authentication.\n\n\n## Gotchas\n\n\n### Don't Perform Queries (Side Effects) in Getters\n\nDon't try to perform a query from within a getter like the example, below. It will result in an infinite loop:\n\n```js\nget user () {\n if (this.userId) {\n const user = Models.User.getFromStore(this.userId)\n\n // Fetch the User record if we don't already have it\n if (!user) {\n Models.User.get(this.userId)\n }\n\n return user\n } else {\n return null\n }\n}\n```\n\n### Using custom query parameters\n\nThere are two places where the query operators have to be allowed.\n\n- In the Feathers Client (for the actions): refer to the FeathersJS docs for `whitelist`ing operators.\n- 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. :)\n\nFor the Feathers Client, follow the FeathersJS docs for your database adapter.\n"
},
{
"path": "docs/3.0-major-release.md",
"content": "---\ntitle: What's New in 3.0\nsidebarDepth: 3\n---\n\n# What's new in Feathers-Vuex 3.0\n\n## Vue Composition API Support\n\nVersion 3.0 of Feathers-Vuex is the Vue Composition API release! There were quite a few disappointed (and misinformed:) developers in 2019 when the Vue.js team announced what is now called the Vue Composition API. From my perspective:\n\n- It is the most powerful feature added to Vue since its first release.\n- It improves the ability to create dynamic functionality in components.\n- It greatly enhances organization of code in components.\n- It encourages code re-use. Check out the [vue-use-web](https://tarektouati.github.io/vue-use-web/) collection for some great examples.\n\nAnd now it has become the best way to perform queries with Feathers-Vuex. To find out how to take advantage of the new functionality in your apps, read the [Feather-Vuex Composition API docs](./composition-api.md).\n\n## New `extend` option for `makeServicePlugin` \n\nThe `makeServicePlugin` now supports an `extend` method that allows customizing the store and gives access to the actual Vuex `store` object, as shown in this example:\n\n```js\nimport { makeServicePlugin } from ‘feathers-vuex’\nimport { feathersClient } from ‘./feathers-client.js’\n\nclass Todo { /* truncated */ }\n\nexport default makeServicePlugin({\n Model: Todo,\n service: feathersClient.service(‘todos’),\n extend({ store, module }) {\n // Listen to other parts of the store\n store.watch(/* truncated */)\n\n return {\n state: {},\n getters: {},\n mutations: {},\n actions: {}\n }\n }\n})\n```\n\n## Partial data on patch \nAs of version 3.9.0, you can provide an object as `params.data`, and Feathers-Vuex will use `params.data` as the patch data. This change was made to the service-module, itself, so it will work for `patch` across all of feathers-vuex. Here's an example of patching with partial data:\n\n```js\nimport { models } from 'feathers-vuex'\nconst { Todo } = models.api\n\nconst todo = new Todo({ description: 'Do Something', isComplete: false })\n\ntodo.patch({ data: { isComplete: true } })\n\n// also works for patching with instance.save\ntodo.save({ data: { isComplete: true } })\n```\n\n## FeathersVuexPagination Component \n\nTo assist with Server Side Pagination support, Feathers-Vuex now includes the `` component. It's a renderless component that removes the boilerplate behind handling pagination in the UI. Read about it in the [Composition API Docs](/composition-api.html#feathersvuexpagination).\n\n## Custom Handling for Feathers Events \n\nVersion 3.1 of Feathers-Vuex enables ability to add custom handling for each of the FeathersJS realtime events. You can read more about it in the [Service Plugin: Events](./service-plugin.md#service-events) docs.\n\n## Breaking Changes\n\nFeathers-Vuex follows semantic versioning. There are two breaking changes in this release:\n\n### Auth Plugin `user` Not Reactive \n\nDue to changes in how reactivity is applied to service state (it's now using Vue.set under the hood), the `user` state of the `auth` module is no longer reactive. To fix this issue, two getters have been added to the `auth` state. They are available when a `userService` is provided to the `makeAuthPlugin` options.\n\n- `user`: returns the reactive, logged-in user from the `userService` specified in the options.\n- `isAuthenticated`: a easy to remember boolean attribute for if the user is logged in.\n\nIf you depend on a reactive, logged-in user in your apps, here is how to fix the reactivity:\n\n- Replace any reference to `store.state.auth.user` with `store.getters['auth/user']`.\n\nBecause the `user` state is no longer reactive, it is logical for it to be removed in the next version. It will likely be replaced by a `userId` attribute in Feathers-Vuex 4.0.\n\n\n### Server-Side Pagination Support is Off by Default\n\nThe `makeFindMixin` (and the new `useFind` utility) now have server-side pagination support turned off, by default. Real-time arrays of results are now the default setting. This really improves the development experience, especially for new users.\n\nTo migrate your app to version 3.0, you need to update any `params` where you are using server-side pagination. It will work as it has been in version 2.0 once you explicitly set `paginate: true` in the params, like this:\n\n```js\nimport { makeFindMixin } from 'feathers-vuex'\n\nexport default {\n name: 'MyComponent',\n mixins: [ makeFindMixin({ service: 'users', watch: true })],\n computed: {\n usersParams() {\n return {\n query: {},\n paginate: true // explicitly enable pagination, now.\n }\n }\n }\n}\n```\n\nThis behavior exactly matches the new `useFind` utility.\n\n## Deprecations\n\n### The `keepCopiesInStore` Option \n\nThe `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.\n\nIf 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).\n\nThe `keepCopiesInStore` feature is set to be removed in Feathers-Vuex 4.0.\n\n### Auth Plugin State: `user` \n\nAs 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.\n\n### Renderless Data Components: `query`, `fetchQuery` and `temps` \n\nTo keep consistency with mixins and the composition API it's preferred to use `params` and `fetchParams` instead of the old `query` and `fetchQuery` for renderless data components. Also the `:temps=\"true\"` is deprecated in favour of `:params=\"{ query: {}, temps: true }\"`. This way additional params can be passed to the server if you need some more magic like `$populateParams`."
},
{
"path": "docs/api-overview.md",
"content": "---\ntitle: API Overview\nsidebarDepth: 3\n---\n\n\n[](https://travis-ci.org/feathersjs-ecosystem/feathers-vuex)\n[](https://david-dm.org/feathersjs-ecosystem/feathers-vuex)\n[](https://www.npmjs.com/package/feathers-vuex)\n\n\n\n> Integrate the Feathers Client into Vuex\n\n`feathers-vuex` is a first class integration of the Feathers Client and Vuex. It implements many Redux best practices under the hood, eliminates *a lot* of boilerplate code, and still allows you to easily customize the Vuex store.\n\nThese docs are for version 2.x. For feathers-vuex@1.x, please go to [https://feathers-vuex-v1.netlify.com](https://feathers-vuex-v1.netlify.com).\n\n## Features\n\n- Fully powered by Vuex & Feathers\n- Realtime By Default\n- Actions With Reactive Data\n- Local Queries\n- Live Queries\n- Feathers Query Syntax\n- Vuex Strict Mode Support\n- [Client-Side Pagination Support](./service-plugin.md#pagination-and-the-find-getter)\n- Fall-Through Caching\n- [`$FeathersVuex` Plugin for Vue](./vue-plugin.md)\n- [Per-Service Data Modeling](./common-patterns.md#Basic-Data-Modeling-with-instanceDefaults)\n- [Clone & Commit](./feathers-vuex-forms.md#the-clone-and-commit-pattern)\n- Simplified Auth\n- [Per-Record Defaults](./model-classes.md#instancedefaults)\n- [Data Level Computed Properties](./2.0-major-release.md#getter-and-setter-props-go-on-the-model-classes)\n- [Improved Relation Support](./2.0-major-release.md#define-relationships-and-modify-data-with-setupinstance)\n- [Powerful Mixins](./mixins.md)\n- [Renderless Data Components](./data-components.md)\n- [Renderless Form Component](./feathers-vuex-forms.md#feathersvuexformwrapper) for Simplified Vuex Forms\n- [Temporary (Local-only) Record Support](./2.0-major-release.md#support-for-temporary-records) *\n- New `useFind` and `useGet` Vue Composition API super powers! \n- [Server-Powered Pagination Support](./service-plugin.md#pagination-and-the-find-action) *\n- [VuePress Dark Mode Support](https://tolking.github.io/vuepress-theme-default-prefers-color-scheme/) for the Docs\n\n`** Improved in v3.0.0`\n\n## License\n\nLicensed under the [MIT license](LICENSE).\n\nFeathers-Vuex is developed and maintained by [Marshall Thompson](https://www.github.com/marshallswain).\n\n"
},
{
"path": "docs/auth-plugin.md",
"content": "---\ntitle: Auth Plugin\n---\n\nThe Auth module assists setting up user login and logout.\n\n## Setup\n\nSee the [Auth Setup](/getting-started.html#auth-plugin) section for an example of how to setup the Auth Plugin.\n\n## Breaking Changes in 2.0\n\nThe following breaking changes were made between 1.x and 2.0:\n\n- The `auth` method is now called `makeAuthPlugin`.\n\n## Configuration\n\nYou can provide a `userService` in the auth plugin's options to automatically populate the user upon successful login.\n\n## State\n\nIt includes the following state by default:\n\n```js\n{\n accessToken: undefined, // The JWT\n payload: undefined, // The JWT payload\n\n userService: null, // Specify the userService to automatically populate the user upon login.\n entityIdField: 'userId', // The property in the payload storing the user id\n responseEntityField: 'user', // The property in the payload storing the user\n user: null, // Deprecated: This is no longer reactive, so use the `user` getter. See below.\n\n isAuthenticatePending: false,\n isLogoutPending: false,\n\n errorOnAuthenticate: undefined,\n errorOnLogout: undefined\n}\n```\n\n## Getters\n\nTwo getters are available when a `userService` is provided to the `makeAuthPlugin` options.\n\n- `user`: returns the reactive, logged-in user from the `userService` specified in the options. Returns `null` if not logged in.\n- `isAuthenticated`: a easy to remember boolean attribute for if the user is logged in.\n\n## Actions\n\nThe following actions are included in the `auth` module. Login is accomplished through the `authenticate` action. For logout, use the `logout` action. It's important to note that the records that were loaded for a user are NOT automatically cleared upon logout. Because the business logic requirements for that feature would vary from app to app, it can't be baked into Feathers-Vuex. It must be manually implemented. The recommended solution is to simply refresh the browser, which clears the data from memory.\n\n- `authenticate`: use instead of `feathersClient.authenticate()`\n- `logout`: use instead of `feathersClient.logout()`\n\nIf you provided a `userService` and have correctly configured your `entityIdField` and `responseEntityField` (the defaults work with Feathers V4 out of the box), the `user` state will be updated with the logged-in user. The record will also be reactive, which means when the user record updates (in the users service) the auth user will automatically update, as well.\n\n> Note: The Vuex auth store will not update if you use the feathers client version of the above methods.\n\n## Example\n\nHere's a short example that implements the `authenticate` and `logout` actions.\n\n```js\nexport default {\n // ...\n methods: {\n\n login() {\n this.$store.dispatch('auth/authenticate', {\n email: '...',\n password: '...'\n })\n }\n\n // ...\n\n logout() {\n this.$store.dispatch('auth/logout')\n }\n\n }\n // ...\n}\n```\n\nNote that if you customize the auth plugin's `namespace` then the `auth/` prefix in the above example would change to the provided namespace.\n"
},
{
"path": "docs/common-patterns.md",
"content": "---\ntitle: Common Patterns\n---\n\n## Set the `idField`\n\nIf you have a \"WTF this isn't working\" moment while setting up a new service, make sure you've set the `idField` property on your service. In `feathers-vuex@1.x`, the `id` is the default `idField`. You have to manually set `_id`. Starting in `feathers-vuex@2.x`, both the `id` and `_id` fields are supported without any configuration, so you only set the `idField` when your service uses something else.\n\n## Enable debugging\n\nYou can set `debug: true` in the options to enable some logging to assist with debugging.\n\n## Use the `` and `` components\n\nUsing the new `` and `` components provides concise access to the best features of `feathers-vuex`, including live queries, reactive lists, custom pagination tracking per component, and fall-through cacheing of local data in the Vuex store. Check out the [Renderless Data Components](./data-components.html) docs for more details.\n\n## Use the `makeFindMixin` and `makeGetMixin` utilities\n\nThe mixin utilities provide the same functionality as the components, but with more power and flexibility. Check out the [Mixin docs](./mixins.html) for more details.\n\n## Working with TypeScript\n\nAs of version 2.0, Feathers-Vuex has been rewritten in TypeScript.\n\nSee [this issue](https://github.com/feathersjs-ecosystem/feathers-vuex/issues/114) for suggestions for with TypeScript helpers.\n\nIn version 3.0, support for the [Vue Composition API](https://github.com/vuejs/composition-api) was added in the form of the `useFind` and `useGet` utilities. These new utilities provide the best experience for working with TypeScript. This is due to two things:\n\n1. Better general TypeScript support in the Vue Composition API.\n1. Consistent object-key naming and types in the new utilities.\n\nRead more about how to use them in the [Feathers-Vuex Composition API Docs](./composition-api.md)\n\n## Clearing data upon user logout\n\nThe best solution is to simply refresh to clear memory. The alternative to refreshing would be to perform manual cleanup of the service stores. Refreshing is much simpler, so it's the officially supported solution. Feel free to read [this issue](https://github.com/feathersjs-ecosystem/feathers-vuex/issues/10) for more suggestions.\n\n## Accessing the store from hooks\n\nBecause the service's Model [is available](./service-plugin.html#The-FeathersClient-Service) at `service.FeathersVuexModel`, you can access the store inside hooks. This is especially handy if you have some custom attributes in a paginated server response.\n\nAs an example, this `speeding-tickets` service has a `summary` attribute that comes back in the response. We can\n\n```js\nimport { makeServicePlugin, BaseModel } from '../feathers-client'\n\nclass SpeedingTicket extends BaseModel {\n constructor(data, options) {\n super(data, options)\n }\n // Required for $FeathersVuex plugin to work after production transpile.\n static modelName = 'SpeedingTicket'\n // Define default properties here\n static instanceDefaults() {\n return {\n vin: '',\n plateState: ''\n }\n }\n}\nconst servicePath = 'speeding-tickets'\nconst servicePlugin = makeServicePlugin({\n Model: SpeedingTicket,\n service: feathersClient.service(servicePath),\n servicePath,\n mutations: {\n handleSummaryData (state, summaryData) {\n state.mostRecentSummary = summaryData\n }\n }\n})\n\nfeathersClient.service(servicePath)\n .hooks({\n after: {\n find: [\n context => {\n const { service, result } = context\n\n if (result.summary) {\n service.FeathersVuexModel.store.commit('handleSummaryData', result.summary)\n }\n }\n ]\n }\n })\n```\n\n## Handling custom server responses\n\nSometimes your server response may contain more attributes than just database records and pagination data. You could handle this directly in a component, if it's only needed in that one component, But, if you need it in multiple components, there are better options.\n\nDepending on what you need to do, you may be able to solve this by [accessing the store from hooks](#Accessing-the-store-from-hooks). But that solution won't handle a scenario where you need the response data to be already populated in the store.\n\nIf you need the response data to already be in the store, you can use the [`afterFind` action](./service-plugin.html#afterFind-response). Here's what this looks like:\n\n```js\nimport { makeServicePlugin, BaseModel } from '../feathers-client'\n\nclass SpeedingTicket extends BaseModel {\n constructor(data, options) {\n super(data, options)\n }\n // Required for $FeathersVuex plugin to work after production transpile.\n static modelName = 'SpeedingTicket'\n // Define default properties here\n static instanceDefaults() {\n return {\n vin: '',\n plateState: ''\n }\n }\n}\nconst servicePath = 'speeding-tickets'\nconst servicePlugin = makeServicePlugin({\n Model: SpeedingTicket,\n service: feathersClient.service(servicePath),\n servicePath,\n actions: {\n afterFind ({ commit, dispatch, getters, state }, response) {\n if (response.summary) {\n commit('handleSummaryData', response.summary)\n }\n }\n },\n mutations: {\n handleSummaryData (state, summaryData) {\n state.mostRecentSummary = summaryData\n }\n }\n})\n```\n\n## Reactive Lists with Live Queries\n\nUsing Live Queries will greatly simplify app development. The `find` getter enables this feature. Here is how you might setup a component to take advantage of them. The next example shows how to setup two live-query lists using two getters.\n\n```js\nimport { mapState, mapGetters, mapActions } from 'vuex'\n\nexport default {\n name: 'some-component',\n computed: {\n ...mapState('appointments', { areAppointmentsLoading: 'isFindPending' }),\n ...mapGetters('appointments', { findAppointmentsInStore: 'find' } ),\n // Query for future appointments\n queryUpcoming () {\n return { date: { $gt: new Date() }}\n },\n // Query for past appointments\n queryPast () {\n return { date: { $lt: new Date() }}\n },\n // The list of upcoming appointments.\n upcomingAppointments () {\n return this.findAppointmentsInStore({ query: this.queryUpcoming }).data\n },\n // The list of past appointments\n pastAppointments () {\n return this.findAppointmentsInStore({ query: this.queryPast }).data\n }\n },\n methods: {\n ...mapActions('appointments', { findAppointments: 'find' })\n },\n created () {\n // Find all appointments. We'll use the getters to separate them.\n this.findAppointments({ query: {} })\n }\n}\n```\n\nin the above example of component code, the `upcomingAppointments` and `pastAppointments` will automatically update. If a new item is sent from the server, it will get added to one of the lists, automatically. `feathers-vuex` listens to socket events automatically, so you don't have to manually wire any of this up!\n\n## Organizing the services in your project\n\nYou 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.\n\nSee it [here](/getting-started.html#auth-plugin)\n\nWith the `store.js` file in place, we can start adding services to the `services` folder.\n\n- [Learn how to setup the feathers-client.js file](/getting-started.html#feathers-client-feathers-vuex)\n- [Learn how to setup a Vuex plugin for a Feathers service](/getting-started.html#service-plugins)\n- [Learn how to setup the auth plugin](/getting-started.html#auth-plugin)\n\n## Actions return reactive store records\n\nPreviously, when you directly used the response from an action, the individual records were not reactive. This meant that these plain objects wouldn't update when you updated the matching record in the store.\n\n```js\nmethods: {\n ...mapActions('todos', { findTodos: 'find' })\n},\ncreated () {\n this.findTodos({ query: {} })\n .then(response => {\n const todos = response.data || response\n // Suppose firstTodo has an id of 'todo-1'\n const firstTodo = todos[0]\n\n // Now, when you update the data in the store...\n this.$store.state.todos.keyedById['todo-1'].description = 'Updated description'\n\n // ... the instance in the `find` response also updates. Yay!\n console.log(firstTodo.description) // --> 'Updated description'\n })\n}\n```\n\nThis is a super convenient feature, and it works with all actions (except remove, of course) But be aware that **only the individual records returned are reactive**. The lists, themselves, are not reactive. So if another record comes in from the server that matches the query, the list will not update. For reactive lists, you must use the `find` getter, as shown in the following example.\n\n```js\ncomputed: {\n ...mapGetters('todos', { findTodosInStore: 'find' })\n todos () {\n return this.findTodosInStore({ query: {} }).data\n }\n},\nmethods: {\n ...mapActions('todos', { findTodos: 'find' })\n},\ncreated () {\n this.findTodos({ query: {} })\n .then(response => {\n // In the find action, the 'todos' array is not a reactive list, but the individual records are.\n const todos = response.data || response\n })\n}\n```\n\nIn the above example, the computed `todos` will be a reactive list. This means that when new records are added to the store, the list of todos will automatically update in the UI to include the new data.\n\nIn summary, you can plan on individual records in the action response data to be reactive, but if you need the actual arrays to be reactive to live queries, use the 'find' getter.\n\n## Basic Data Modeling with `instanceDefaults`\n\nSee the [instanceDefaults API](./model-classes.html#instancedefaults)\n\n## Handling Non-Reactive Data\n\nIf you are encountering a scenario where certain properties in your records are not reactive, it's probably because they\n\n1. Are not defined in the `instanceDefaults`.\n2. Are getting added to the record after it gets added to the Vuex store.\n\nThere are two ways to solve this:\n\n1. Add the property to the `instanceDefaults` (see the previous section, above) This tends to be the simplest solution.\n2. Make sure the property is added in the responses from the API server.\n\n## Model-Specific Computed Properties\n\nYou may find yourself in a position where model-specific computed properties would be very useful. [github issue](https://github.com/feathersjs-ecosystem/feathers-vuex/issues/163). In Feathers-Vuex 1.7, these could be specified in the `instanceDefaults`. As of 2.0, they are specified directly on each Model class:\n\n```js\nclass Post extends BaseModel {\n // Required for $FeathersVuex plugin to work after production transpile.\n static modelName = 'Post'\n // Define default properties here\n static instanceDefaults() {\n return {\n description: '',\n isComplete: false,\n comments: [],\n }\n }\n\n // Specify computed properties as regular class properties\n get numberOfCommenters () {\n // Put your logic here.\n },\n set someOtherProp () {\n // Setters also work\n }\n}\n```\n\n## Relationships for Populated Data\n\nIf you're looking for a great solution for populating data to work with Feathers-Vuex, check out [feathers-graph-populate](https://feathers-graph-populate.netlify.app/).\n\nA common task with almost any API is properly handling relationships between endpoints. Imagine an API where you have `/todos` and `/users` services. Each todo record can belong to a single user, so a todo has a `userId`.\n\n```js\n// GET todos/1\n{\n id: 1,\n description: 'Learn about the health benefits of a low-carb diet.',\n isComplete: false,\n userId: 5\n}\n```\n\nAnd a user response looks like this:\n\n```js\n// GET users/5\n{\n id: 5,\n name: 'Marshall',\n username: 'marshallswain'\n email: 'marshall@ilovehealthy.com'\n}\n```\n\nSuppose a requirement is put on the `/todos` service to populate the `user` in the response. (As a super handy side note, this task is pretty easy when using [Matt Chaffe's](https://github.com/mattchewone) magical, efficient [feathers-shallow-populate hook](https://www.npmjs.com/package/feathers-shallow-populate)) So now the todo response looks like this:\n\n```js\n{\n id: 1,\n description: 'Learn about the health benefits of a low-carb diet.',\n isComplete: false,\n userId: 5,\n user: {\n id: 5,\n name: 'Marshall',\n username: 'marshallswain'\n email: 'marshall@ilovehealthy.com'\n }\n}\n```\n\nCan you see the problem that will occur with this response? When this record is put into the `/todos` store, it will contain a copy of the user record. But we already have the user record in the `/users` store. And what happens when the user data changes? Now it's out of sync. To keep it in sync, you might have to manually listen for `users updated` & `users patched` events. Then you might have to write a custom mutation to update the user record attached to every applicable `todo` record. This gets messy, fast!\n\nThere's an easier way to solve this problem. Use the new [`setupInstance` method on Model classes](/model-classes.html#setupinstance).\n\n```js\nimport feathersClient, { makeServicePlugin, BaseModel } from '../feathers-client'\n\nclass Todo extends BaseModel {\n // Required for $FeathersVuex plugin to work after production transpile.\n static modelName = 'Todo'\n // Define default properties here\n static instanceDefaults() {\n return {\n email: '',\n password: ''\n }\n }\n // Updates `data.user` to be an instance of the `User` class.\n static setupInstance(data, { models }) {\n if (data.user) {\n data.user = new models.api.User(data.user)\n }\n return data\n }\n}\n\nconst servicePath = 'todos'\nconst servicePlugin = makeServicePlugin({\n Model: Todo,\n service: feathersClient.service(servicePath),\n servicePath\n})\n```\n\nWhen this record is instantiated, the `user` attribute will first be turned into a User [model instance](./model-classes.html), stored properly in the `/users` store. The `todo.user` attribute will be a reference to that user. No more duplicate data! Here's an example of how to set this up.\n\nThere's another amazing benefit from these relationships. Because `feathers-vuex` listens to real-time events and keeps data up to date, when the user record changes, the `todo.user` automatically updates!\n\n### Handling Sequelize Joins\n\nSee [this issue](https://github.com/feathersjs-ecosystem/feathers-vuex/issues/404) for a discussion on how to handle joins with Sequelize. It's important to specify `raw: false`, as shown in [this comment](https://github.com/feathersjs-ecosystem/feathers-vuex/issues/404#issuecomment-571774598).\n\n### Workflow for Saving Model Associations\n\nA great issue was opened on GitHub about the [Workflow for clone and save Model with associations](https://github.com/feathersjs-ecosystem/feathers-vuex/issues/278). That's a great issue to read to get familiar with the workflow.\n\n## Form Binding\n\nUse the Model classes to reduce the boilerplate required to work with forms and Vuex, even in strict mode! Every model instance has a `.clone()` method which can be used to get a fully-reactive copy of the record in the store. Here is a very simple version of how you could bind to a form and submit new data to the server.\n\n```vue\n\n
\n
Create Todo
\n\n \n
\n\n\n\n\n\n```\n\n## Multiple Copies\n\nThe previous version of `feathers-vuex` was hard-coded to allow for a single `current` record and one copy. It was pretty easy to hit that limit. This new release allows for keeping many more copies, one copy per stored record. To make it easier to comply with Vuex's `strict` mode, copies are not kept in the store by default, but are instead kept on `Model.copiesById`. You can make changes to the copies without having to make custom mutations, then you can commit them back into the store:\n\n```js\nconst { Todo } = this.$FeathersVuex\n\n// Create two records in the store (since they have ids, they get stored)\nconst todo = new Todo({ id: 1, description: 'Become more aware of others.'})\nconst todo2 = new Todo({ id: 2, description: 'Heal one ailments through healthy eating.'})\n\n// Create a deep-cloned copies in Todo.copiesById\nconst todoCopy = todo.clone()\nconst todoCopy2 = todo2.clone()\n\n// Try to clone a copy, and fail.\ntodoCopy.clone() // --> Error: You cannot clone a copy.\ntodoCopy2.clone() // --> Error: You cannot clone a copy.\n\n// Modify the copies.\ntodoCopy.description.replace('others', 'self')\ntodoCopy2.description.replace('one', 'all')\n\n// and update the original records\ntodoCopy.commit()\ntodoCopy2.commit()\n```\n\nYou 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.\n\n```js\nimport Vue from 'vue'\nimport Vuex from 'vuex'\nimport feathersVuex from 'feathers-vuex'\nimport feathersClient from './feathers-client'\n\nconst { service, auth, FeathersVuex } = feathersVuex(feathersClient, { idField: '_id' })\n\nVue.use(FeathersVuex)\nVue.use(Vuex)\n\nexport default new Vuex.Store({\n plugins: [\n service('todos', {\n keepCopiesInStore: true,\n instanceDefaults: {\n description: '',\n complete: false\n }\n })\n ]\n})\n```\n\n## Enable Debug Logging\n\nIf items aren't not getting added to the store properly, try setting the `debug` option on the `makeServicePlugin` to `true`. It enables some additional logging that may be useful for troubleshooting.\n\n## Full nuxt example\n\nIn this example we will create a nuxt configuration with all the features discribed in the [Nuxt Section](./nuxt.md).\n\nOur application is hosted in 2 different endpoints, one for the feathers api and another with our nuxt SSR, and we will also implement a permission system that will prevent users without an `admin` permission to get into some pages. For that you will need to [customize your payload](https://docs.feathersjs.com/cookbook/authentication/stateless.html#customizing-the-payload) in your feathers api.\n\n```js\n// nuxt.config.js\nexport default {\n env: {\n API_URL: process.env.API_URL || 'http://localhost:3030'\n },\n router: {\n middleware: [\n 'feathers'\n ]\n },\n plugins: [\n { src: '~/plugins/feathers-vuex.js' }\n ],\n modules: [\n 'nuxt-client-init-module'\n ],\n build: {\n transpile: [\n 'feathers-vuex'\n ]\n }\n}\n```\n\nThe `feathers` middleware will redirect any user in a non public page to the login, but will also redirect a loged user away from any public pages.\n\n```js\n// ~/middleware/feathers.js\nexport default function ({ store, redirect, route }) {\n const { auth } = store.state\n if (auth.publicPages.length > 0 && !auth.publicPages.includes(route.name) && !auth.payload) {\n return redirect('/login')\n } else if (auth.publicPages.length > 0 && auth.publicPages.includes(route.name) && auth.payload) {\n return redirect('/feed')\n }\n}\n```\n\nThe `admin` middleware will redirect any user that is not loged in or do not have the `admin` permission to a `not-permited` page.\n\n```js\n// ~/middleware/admin.js\nexport default function ({ store, redirect }) {\n const { auth } = store.state\n const permissions = auth.payload.permissions\n if (\n !auth.payload ||\n !permissions.includes('admin')\n ) {\n return redirect('/not-permited')\n }\n}\n```\nAdd the `admin` middleware to the administrative pages\n\n```js\n// ~/pages/**\nexport default {\n\n ...\n\n middleware: ['admin']\n\n ...\n\n}\n```\n\nIn the feathers client configuration we will use a different transport for the nuxt-server > api comunication and the nuxt-client > api. When we are making request on the server we do not need the socket io realtime messaging system so we can use an rest configuration for better performance.\n\n```js\n// ~/plugins/feathers.js\nimport feathers from '@feathersjs/feathers'\nimport rest from '@feathersjs/rest-client'\nimport axios from 'axios'\nimport socketio from '@feathersjs/socketio-client'\nimport auth from '@feathersjs/authentication-client'\nimport io from 'socket.io-client'\nimport { CookieStorage } from 'cookie-storage'\nimport { iff, discard } from 'feathers-hooks-common'\nimport feathersVuex, { initAuth, hydrateApi } from 'feathers-vuex'\n// Get the api url from the environment variable\nconst apiUrl = process.env.API_URL\nlet socket\nlet restClient\n// We won't use socket to comunicate from server to server\nif (process.client) {\n socket = io(apiUrl, { transports: ['websocket'] })\n} else {\n restClient = rest(apiUrl)\n}\nconst transport = process.client ? socketio(socket) : restClient.axios(axios)\nconst storage = new CookieStorage()\n\nconst feathersClient = feathers()\n .configure(transport)\n .configure(auth({ storage }))\n .hooks({\n before: {\n all: [\n iff(\n context => ['create', 'update', 'patch'].includes(context.method),\n discard('__id', '__isTemp')\n )\n ]\n }\n })\n\nexport default feathersClient\n\n// Setting up feathers-vuex\nconst { makeServicePlugin, makeAuthPlugin, BaseModel, models, FeathersVuex } = feathersVuex(\n feathersClient,\n {\n serverAlias: 'api', // optional for working with multiple APIs (this is the default value)\n idField: '_id', // Must match the id field in your database table/collection\n whitelist: ['$regex', '$options'],\n enableEvents: process.client // Prevent memory leak\n }\n)\n\nexport { makeAuthPlugin, makeServicePlugin, BaseModel, models, FeathersVuex, initAuth, hydrateApi }\n```\n\nI prefere install the `FeathersVuex` plugin in a separate file, it's more consistent with nuxt patterns.\n\n```js\n// ~/plugins/feathers-vuex.js\nimport Vue from 'vue'\nimport { FeathersVuex } from './feathers'\n\nVue.use(FeathersVuex)\n```\n\nConfigure any service you want on `~/store/services/*.js`.\n\n```js\n// ~/store/services/users.js\nimport feathersClient, { makeServicePlugin, BaseModel } from '~/plugins/feathers'\n\nclass User extends BaseModel {\n constructor(data, options) {\n super(data, options)\n }\n // Required for $FeathersVuex plugin to work after production transpile.\n static modelName = 'User'\n // Define default properties here\n static instanceDefaults() {\n return {\n email: '',\n password: '',\n permissions: []\n }\n }\n}\nconst servicePath = 'users'\nconst servicePlugin = makeServicePlugin({\n Model: User,\n service: feathersClient.service(servicePath),\n servicePath\n})\n\n// Setup the client-side Feathers hooks.\nfeathersClient.service(servicePath).hooks({\n before: {\n all: [],\n find: [],\n get: [],\n create: [],\n update: [],\n patch: [],\n remove: []\n },\n after: {\n all: [],\n find: [],\n get: [],\n create: [],\n update: [],\n patch: [],\n remove: []\n },\n error: {\n all: [],\n find: [],\n get: [],\n create: [],\n update: [],\n patch: [],\n remove: []\n }\n})\n\nexport default servicePlugin\n```\n\nCreate your nuxt store with the right nuxt pattern, exporting an Vuex store will be deprecated on nuxt 3.\n\n```js\n// ~/store/index.js\nimport { makeAuthPlugin, initAuth, hydrateApi, models } from '~/plugins/feathers'\nconst auth = makeAuthPlugin({\n userService: 'users',\n state: {\n publicPages: [\n 'login',\n 'signup'\n ]\n },\n actions: {\n onInitAuth ({ state, dispatch }, payload) {\n if (payload) {\n dispatch('authenticate', { strategy: 'jwt', accessToken: state.accessToken })\n .then((result) => {\n // handle success like a boss\n console.log('loged in')\n })\n .catch((error) => {\n // handle error like a boss\n console.log(error)\n })\n }\n }\n }\n})\n\nconst requireModule = require.context(\n // The path where the service modules live\n './services',\n // Whether to look in subfolders\n false,\n // Only include .js files (prevents duplicate imports`)\n /.js$/\n)\nconst servicePlugins = requireModule\n .keys()\n .map(modulePath => requireModule(modulePath).default)\n\nexport const modules = {\n // Custom modules\n}\n\nexport const state = () => ({\n // Custom state\n})\n\nexport const mutations = {\n // Custom mutations\n}\n\nexport const actions = {\n // Custom actions\n nuxtServerInit ({ commit, dispatch }, { req }) {\n return initAuth({\n commit,\n dispatch,\n req,\n moduleName: 'auth',\n cookieName: 'feathers-jwt'\n })\n },\n nuxtClientInit ({ state, dispatch, commit }, context) {\n\n hydrateApi({ api: models.api })\n\n if (state.auth.accessToken) {\n return dispatch('auth/onInitAuth', state.auth.payload)\n }\n }\n}\n\nexport const getters = {\n // Custom getters\n}\n\nexport const plugins = [ ...servicePlugins, auth ]\n```\n"
},
{
"path": "docs/composition-api.md",
"content": "---\ntitle: Composition API\nsidebarDepth: 3\n---\n\n# Feathers-Vuex Composition API \n\nIn addition to the Renderless Components and the Mixins, Feathers-Vuex includes utilities that let you take advantage of the [Vue Composition API](https://github.com/vuejs/composition-api).\n\nIt's important to note that the `@vue/composition-api` plugin must be registered BEFORE you import `App.vue`. This means that you need to modify your `main.js` file to look like this:\n\n```js\nimport Vue from 'vue'\nimport VueCompositionApi from '@vue/composition-api'\n\n// Register the Composition API plugin BEFORE you import App.vue\nVue.use(VueCompositionApi)\n\nimport App from './App.vue'\nimport router from './router'\nimport store from './store/store'\nimport './plugins/plugins'\nVue.config.productionTip = true\nnew Vue({\n router,\n store,\n render: h => h(App)\n}).$mount('#app')\n```\n\nIf you forget to register the plugin, first, you will see a console warning from Vue stating `[Vue warn]: Error in data(): \"Error: [vue-composition-api] must call Vue.use(plugin) before using any function.\". To fix this, make sure to register the plugin BEFORE you call any Composition utility functions, as shown above.\n\n## Setup\n\nBefore you can use the `useFind` and `useGet` composition functions, you'll need to [install the Vue Composition API](https://github.com/vuejs/composition-api#Installation) plugin.\n\n## Detour: Reading a TypeScript interface\n\nThe next few sections show various TypeScript interfaces, which are basically shorthand descriptions of the types of data that make up a variable. In this case, they're used to show the `options` object which can be passed to each of the composition api utilities. If this is your first time with interfaces, here's a quick primer as an alternative to reading the [TypeScript interface docs](https://www.typescriptlang.org/docs/handbook/interfaces.html):\n\n- In the [first interface example](#options), below, `UseFindOptions` is the name of the interface, similar to naming any other variable. When using TypeScript, you can import and pass interfaces around like variables.\n- Each line of the interface describes a property.\n- The part before the `:` is the name of the property.\n- The part after the `:` describes what type of variable it can be.\n- You can look at any `|` after the `:` as a conditional \"or\"\n- Any property followed by a `?` is optional.\n- Any property not followed by a `?` is required.\n\n## useFind \n\nThe `useFind` utility reduces boilerplate for querying with fall-through cache and realtime updates. To get started with it you provide a `model` class and a computed `params` object.\n\nLet's use the example of creating a User Guide, where we need to pull in the various `Tutorial` records from our `tutorials` service. We'll keep it simple in the template and just show a list of the names.\n\n```html\n\n
\n
\n {{ tutorial.name }}\n
\n
\n\n\n\n```\n\nLet's review each of the numbered comments, above:\n\n1. Get a reference to the model class. With the Vue Composition API, there's no `this` object. It has been replaced by the context object. So, only when using the composition API, the `$FeathersVuex` object is found at `context.root.$FeathersVuex`\n2. Create a computed property for the params. Return an object with a nested `query` object.\n\n### Options\n\nSince we learned earlier [how to read a TypeScript interface](#detour-reading-a-typescript-interface), let's look at the TypeScript definition for the `UseFindOptions` interface.\n\n```ts\ninterface UseFindOptions {\n model: Function\n params: Params | Ref\n fetchParams?: Params | Ref\n queryWhen?: Ref\n qid?: string\n immediate?: boolean\n}\n```\n\nAnd here's a look at each individual property:\n\n- `model` must be a Feathers-Vuex Model class. The Model's `find` and `findInStore` methods are used to query data.\n- `params` is a FeathersJS Params object OR a Composition API `ref` (or `computed`, since they return a `ref` instance) which returns a Params object.\n - When provided alone (without the optional `fetchParams`), this same query is used for both the local data store and the API requests.\n - Explicitly returning `null` will prevent an API request from being made.\n - 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.\n - 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).\n - 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.\n - 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.\n - Set `params.copies` to `true` to include cloned items in the results. The queried items get replaced with the corresponding copies from `copiesById`\n- `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.\n - Explicitly returning `null` will prevent an API request from being made.\n- `queryWhen` must be a `computed` property which returns a `boolean`. It provides a logical separation for preventing API requests *outside* of the `params`.\n- `qid` allows you to specify a query identifier (used in the pagination data in the store). This can also be set dynamically by returning a `qid` in the params.\n- `immediate`, which is `true` by default, determines if the internal `watch` should fire immediately. Set `immediate: false` and the query will not fire immediately. It will only fire on subsequent changes to the params.\n\n### Returned Attributes\n\nNotice the `tutorialsData` in the previous example. You can see that there's an `tutorialsData.items` property, which is returned at the bottom of the `setup` method as `tutorials`. There are many more attributes available in the object returned from `useFind`. We can learn more about the return values by looking at its TypeScript interface, below.\n\n```ts\ninterface UseFindData {\n items: Ref\n paginationData: Ref\n```\n\n### Props\n\n- `service {String}` - **required** the service path. This must match a service that has already been registered with FeathersVuex.\n- `query {Object}` **use `params` instead** - the query object. If only the `query` attribute is provided, the same query will be used for both the `find` getter and the `find` action. See the `fetchQuery` attribute for more information. When using server-side pagination, use the `fetchQuery` prop and the `query` prop for querying data from the local store. If the query is `null` or `undefined`, the query against both the API and store will be skipped. The find getter will return an empty array.\n- `watch {String|Array}` - specify the attributes of the `params` or `fetchParams` to watch. Pass 'params' to watch the entire params object. Pass 'params.query.name' to watch the 'name' property of the query. Watch is turned off by default, so the API server will only be queried once, by default. **Default: []**\n- `fetchQuery {Object}` **use `fetchParams` instead** - when provided, the `fetchQuery` serves as the query for the API server. The `query` param will be used against the service's local Vuex store. **Default: undefined**\n- `params {Object}` - the params object. If only the `params` attribute is provided, te same params will be used for both the `find` getter and the `find` action. See the `fetchParams` attribute for more information. \n- `fetchParams {Object}` - when provided, the `fetchParams` servers as the params for the API server. The `params` will be used against the service's local Vuex store. \n- `queryWhen {Boolean|Function}` - the query to the server will only be made when this evaluates to true. **Default: true**\n- `local {Boolean}` - when set to true, will only use the `query` prop to get data from the local Vuex store. It will disable queries to the API server. **Default:false**\n- `editScope {Function}` - a utility function that allows you to modify the scope data, and even add attributes to it, before providing it to the default slot. You can also use it to pull data into the current component's data (though that may be less recommended, it can come in handy). See the \"Scope Data\" section to learn more about what props are available in the scope object. **Default: scope => scope**\n- `temps {Boolean}` **use `params: { query: {}, temps: true }` instead** - Enable `temps` to include temporary records (from `state.tempsById`) in the find getter results. **Default: false**\n- `qid {String}` - The query identifier used for storing pagination data in the Vuex store. See the service module docs to see what you'll find inside. The default value is a random 10-character string. This means that by default, in theory, no two components will share the same pagination data, nor will they overwrite each other's pagination data. You can, of course, force them to use the same pagination data by giving them both the same `qid`, if there's a use case for that. **Default: randomString(10)**\n\n### Scope Data\n\n- `items {Array}` - The resulting array of records for find operations.\n- `isFindPending {Boolean}` - When there's an active request to the API server, this will be `true`. This is not the same as the `isFindPending` from the Vuex state. The value in the Vuex state is `true` whenever **any** component is querying data from that same service. This `isFindPending` attribute is specific to each component instance.\n- `pagination {Object}` - pagination data from the Vuex store, keyed by the `qid` attribute. By default, this will be specific to this component instance. (If you find a use case for sharing pagination between component instances, you can give both components the same `qid` string as a prop.)\n- `queryInfo {Object}` - the queryInfo for the `pagination` object. Includes the `total` prop for server side pagination\n- `pageInfo {Object}` - the pageInfo includes the queried ids and is necessary for server side pagination\n\n## FeathersVuexGet\n\nThe `FeathersVuexGet` component allows fetching data from directly inside a template. It makes the slot scope available to the child components. Note that in `feathers-vuex@3.3.0` the component now includes support for `params` and `fetchParams` props. These are meant to replace the `query` and `fetchQuery` props. The `params` allow you, for example, to configure a project to pass custom params to the server. This would require use of custom hooks.\n\n### Example\n\n```html\n\n \n {{ user }}\n \n\n\n\n```\n\n### Props\n\n- `service {String}` - **required** the service path. This must match a service that has already been registered with FeathersVuex.\n- `id {Number|String}` - when performing a `get` request, serves as the id for the request. This is automatically watched, so if the `id` changes, an API request will be made and the data will be updated. **Default: undefined**\n- `query {Object}` **use `params` instead** - the query object. If only the `query` attribute is provided, the same query will be used for both the `get` getter and the `get` action. See the `fetchQuery` attribute for more information. When using server-side pagination, use the `fetchQuery` prop and the `query` prop for querying data from the local store. If the query is `null` or `undefined`, the query against both the API and store will be skipped. The find getter will return an empty array.\n- `watch {String|Array}` - specify the attributes of the `params` or `fetchParams` to watch. Pass 'params' to watch the entire params object. Pass 'params.query.name' to watch the 'name' property of the query. Watch is turned off by default, so the API server will only be queried once, by default. The only exception is for the `id` prop. The `id` prop in the `FeathersVuexGet` component is always watched. **Default: []**\n- `fetchQuery {Object}` **use `fetchParams` instead** - when provided, the `fetchQuery` serves as the query for the API server. The `query` param will be used against the service's local Vuex store. **Default: undefined**\n- `params {Object}` - the params object. If only the `params` attribute is provided, te same params will be used for both the `get` getter and the `get` action. See the `fetchParams` attribute for more information.\n- `fetchParams {Object}` - when provided, the `fetchParams` servers as the params for the API server. The `params` will be used against the service's local Vuex store.\n- `queryWhen {Boolean|Function}` - the query to the server will only be made when this evaluates to true. **Default: true**\n- `local {Boolean}`: when set to true, will only use the `params` prop to get data from the local Vuex store. It will disable queries to the API server. **Default:false**\n- `editScope {Function}` - a utility function that allows you to modify the scope data, and even add attributes to it, before providing it to the default slot. You can also use it to pull data into the current component's data (though that may be less recommended, it can come in handy). See the \"Scope Data\" section to learn more about what props are available in the scope object. **Default: scope => scope**\n\n### Scope Data\n\n- `item {Object}` - The resulting record for the get operation.\n- `isGetPending {Boolean}` - When there's an active request to the API server, this will be `true`. This is not the same as the `isGetPending` from the Vuex state. The value in the Vuex state is `true` whenever **any** component is querying data from that same service. This `isGetPending` attribute is specific to each component instance.\n\n## FeathersVuexCount \n\nThe `FeathersVuexCount` component allows displaying a count of records. It makes the slot scope available to the child components. It adds `$limit: 0` to the passed params in the background. This will only run a (fast) counting query against the database.\n\n> **Note:** it only works for services with enabled pagination!\n\n```vue\n\n \n {{ total }}\n \n\n```\n\n### Props\n\n- `service {String}` - The path of the service\n- `params {Object}` - The params object passed to the `count` getter/action.\n- `fetchParams {Object}` - A seperate params object for the `count` action\n- `queryWhen {Boolean|Function(params)}` - the query to the server will only be made when this evaluates to true. **Default: true**\n- `watch {String|Array}` - specify the attributes of the `params` or `fetchParams` to watch. Pass 'params' to watch the entire params object. Pass 'params.query.name' to watch the 'name' property of the query. Watch is turned off by default, so the API server will only be queried once, by default. **Default: []**\n- `local {Boolean}`: when set to true, will only use the `params` prop to get data from the local Vuex store. It will disable queries to the API server. **Default:false**\n\n### Scope Data\n\n- `total {Number}` - The number of found records.\n- `isCountPending {Boolean}` - When there's an active request to the API server, this will be `true`.\n\n## A note about the internal architecture\n\nThese components use Vuex getters (to query data from the local store) and actions (to query data from the API server). When a `params` or `id` is provided, the components pull data from the API server and put it into the store. That same `params` or `id` is then used to pull data from the local Vuex store. Keep this in mind, especially when attempting to use server-side pagination. To use server-side pagination, use the `params` prop for pulling data from the local vuex store, then use the `fetchParams` prop to retrieve data from the API server.\n\n## Registering the components\n\nThese components are automatically registered globally when using the Feathers-Vuex Vue plugin.\n\nIf you prefer to manually register the component, pass `{ components: false }` as options when using the FeathersVuex Vue plugin, then do the following:\n\n```js\nimport { FeathersVuexFind, FeathersVuexGet, FeathersVuexCount } from 'feathers-vuex'\n\n// in your component\ncomponents: {\n FeathersVuexFind,\n FeathersVuexGet,\n FeathersVuexCount\n}\n\n// or globally registered\nVue.component('FeathersVuexFind', FeathersVuexFind)\nVue.component('FeathersVuexGet', FeathersVuexGet)\nVue.component('FeathersVuexCount', FeathersVuexCount)\n```\n\n## Scope Data\n\nWhen using these components, the scope data will become available to the `FeathersVuexFind`, `FeathersVuexGet` and `FeathersVuexCount` tags. It's accessible using the `v-slot=\"props\"` attribute:\n\n```html\n\n
\n {{props.items}}\n
\n\n```\n\nIt's also possible to modify the scope data by passing a function as the `edit-scope` prop. See the example for [modifying scope data](#Modify-the-scope-data)\n\n### Destructuring props\n\nUse the object destructuring syntax to pull specific variables out of the `v-slot` object. In the following example, instead of using `v-slot=\"props\"`, it directly accesses the `items` prop through destructuring:\n\n```html\n\n
\n {{items}}\n
\n\n```\n\n### Renaming props with destructuring\n\nYou can also rename scope props through the Object destructuring syntax. The `v-slot` in the next example shows how to give the items a more-descriptive name:\n\n```html\n\n
\n {{categories}}\n
\n\n```\n\n## Usage Examples\n\n#### A basic find all\n\nIn this example, only the `service` attribute is provided. There is no `query` nor `id` provided, so no queries are made. So `props.items` in this example returns an empty array.\n\n```html\n\n
\n {{props.items}}\n
\n\n```\n\n#### Fetch data from the API and the same data from the Vuex store\n\nThis example fetches data from the API server because a query was provided. Internally, this same `query` is used for both the `find` action and the `find` getter. Read other examples to see how to use distinct queries. Be aware that if you use pagination directives like `$skip` or `$limit`, you must use two queries to get the records you desire.\n\n```html\n\n
\n {{props.items}}\n
\n\n```\n\n#### Only get data from the local Vuex store\n\nIf you've already pulled a bunch of data from the server, you can use the `local` prop to only query the local data:\n\n```html\n\n
\n {{props.items}}\n
\n\n```\n\n#### Watch the query and re-fetch from the API\n\nSometimes you want to query new data from the server whenever the query changes. Pass an array of attribute names to the `watch` attribute re-query whenever upon change. This example watches the entire query object:\n\n```html\n\n
\n {{props.items}}\n
\n\n```\n\nThis next example watches a single prop from the query:\n\n```html\n\n
\n {{props.items}}\n
\n\n```\n\nYou can also provide an array of strings to watch multiple properties:\n\n```html\n\n
\n {{props.items}}\n
\n\n```\n\n#### Use a distinct `params` and `fetchParams`\n\nIn this scenario, the `fetchParams` is be used to grab a larger dataset from the API server (all todos with a matching `userId`). The `params` is used by the `find` getter to display a subset of this data from the store. If the `isComplete` attribute gets set to `true`, only completed todos will be displayed. Since a `fetchParams` is provided, the `watch` strings will be modified internally to watch the `fetchParams` object. This means if you are watching `params.query.userId` and you add a `fetchParams`, the component is smart enough to know you meant `fetchParams.query.userId`. You don't have to rewrite your `watch` attribute after adding a `fetchParams` prop.\n\n```html\n\n \n
\n {{todos}}\n
\n \n\n\n\n```\n\n#### Modify the scope data\n\nThe `edit-scope` function allows you to modify the scope before passing it down to the default slot. This feature can be super useful for preparing the data for the template. The `prepareCategories` method in this next example adds two properties to the scope data, which are used to create a nested category structure:\n\n```html\n\n \n
\n
\n
{{parent.name}}
\n
\n
\n {{child.name}}\n
\n
\n
\n
\n \n\n\n\n```\n\n#### server-side pagination\n\nWhen you want to use server-side pagination you need to pass the ids from the server to vuex. It can be done by a combination of `params`, `fetchParams` and `editScope` as described below. The `fetchParams`-prop is only computed after items from the server arrived. The ids for the `find` getter as well as the total amount of available values `total` are extracted by the `edit-scope` function and stored in `data`:\n\n```html\n\n \n
\n {{todos}}\n
\n \n\n\n\n```\n\n#### Query when certain conditions are met\n\nSometimes you only want to query the API server when certain conditions are met. This example shows how to query the API server when the `userSearch` has as least three characters. This property does not affect the internal `find` getter, so the `items` will still update when the `userSearch` property has fewer than three characters, just no API request will be made. The `isFindPending` attribute is used to indicate when data is being loaded from the server.\n\n```html\n\n
\n \n\n 2\"\n >\n
\n
\n {{user.email}}\n
\n
\n \n
\n\n\n\n```\n\n#### Use a get request\n\nYou can perform `get` requests with the `FeathersVuexGet` component and its `id` property. In the next example, when the `selectedUserId` changes, a get request will automatically fetch and display the matching user record. It also shows how to use the `isGetPending` prop to update the UI\n\n```html\n\n
\n
loading...
\n {{currentUser}}\n
\n\n```\n"
},
{
"path": "docs/example-applications.md",
"content": "---\ntitle: Example Applications\nsidebarDepth: 3\n---\n\n# Example Applications\n\nOn this page you will find any example applications using Feathers-Vuex that have been shared by the community. If there's something you would like to see here, feel free to make a PR to add it to the [Community Examples list](#community-examples).\n\n## Feathers Chat\n\nThe [Feathers Chat Example for Feathers Vuex](https://github.com/feathersjs-ecosystem/feathers-chat-vuex) has been updated to `feathers-vuex@3.x` and everything has been rewritten with the Vue composition API. The old repo is now available at [https://github.com/feathersjs-ecosystem/feathers-chat-vuex-0.7](https://github.com/feathersjs-ecosystem/feathers-chat-vuex-0.7). The following information will assist you in seeing the \"before\" and \"after\" of the refactor to feathers-vuex@3.x.\n\n\n\n### Before and After Comparisons\n\n- The folder structure is similar, since this is a VueCLI application. Some of the components in the old version have been moved into the `views` folder.\n - `/components/Home.vue` is now `/views/Home.vue`\n - `/components/Signup.vue` is now `/views/Signup.vue`\n - `/components/Login.vue` is now `/views/Login.vue`\n - `/components/Chat/Chat.vue` is now `/views/Chat.vue`\n- The `/components` folder has been flattened. There are no more subfolders.\n- Component refactors:\n - [Login.vue](https://github.com/feathersjs-ecosystem/feathers-chat-vuex/commit/eb9ba377c5705c1378bee72661a13dd0db48be05)\n - [Signup.vue](https://github.com/feathersjs-ecosystem/feathers-chat-vuex/commit/478710ed84869d33a9286078496c1e5974a95067)\n - [Users.vue](https://github.com/feathersjs-ecosystem/feathers-chat-vuex/commit/02b47149c80c27cdeb611c2f4438b4c62159c644)\n - [Messages.vue](https://github.com/feathersjs-ecosystem/feathers-chat-vuex/commit/930743c1679cc4ed9d691532a7dff1d6a34398e6)\n - [Compuser.vue](https://github.com/feathersjs-ecosystem/feathers-chat-vuex/commit/cd5c8898ede270d5e22f9c6ef1450d3f3c6278c9)\n - [Chat.vue](https://github.com/feathersjs-ecosystem/feathers-chat-vuex/commit/39eb3e13f6921b0d0524ae4ac7942b9ce78b222c)\n - [Messages.vue](https://github.com/feathersjs-ecosystem/feathers-chat-vuex/commit/e5cf7fb0cc8eab80ee3dc441afafb1399d69059e)\n\n### More to Come\n\nThe Feathers Chat example is a pretty simple application. Its primary purpose is to show off how easy it is to do realtime with FeathersJS. (FeathersJS continues to be the only framework that treats real-time communication as a first-class citizen with the same API across multiple transports.) But it doesn't properly showcase all of the great features in Feathers-Vuex 3.0. This requires a solution that:\n\n1. Still allows comparison of Feathers Chat applications made with other frameworks.\n2. Allows the version of Feathers Chat built with Feathers-Vuex to add features and showcase things you might actually use in production.\n\nIf there are features which you would like to see implemented, please open an issue in the [feathers-chat-vuex Repo](https://github.com/feathersjs-ecosystem/feathers-chat-vuex) for your idea to be considered.\n\n## Community Examples\n\nIf you have created or know of an example application, please add it, here.\n\n- [Feathers-Chat-Vuex](https://github.com/feathersjs-ecosystem/feathers-chat-vuex)\n"
},
{
"path": "docs/feathers-vuex-forms.md",
"content": "---\ntitle: Working with Forms\nsidebarDepth: 4\n---\n\n# Working with Forms\n\nThe `FeathersVuexFormWrapper` and `FeathersVuexInputWrapper` are renderless components which assist in connecting your feathers-vuex data to a form. The next two sections review why they exist by looking at a couple of common patterns. Proceed to the [FeathersVuexFormWrapper](#feathersvuexformwrapper) or [FeathersVuexInputWrapper](#feathersvuexinputwrapper) sections to learn how to implement.\n\n## The Mutation Multiplicity (anti) Pattern\n\nWhen working with Vuex, it's considered an anti-pattern to modify store data directly. Turn on Vuex strict mode, and it will throw an error every time you modify store data outside of a mutation. In my experience, the most common (anti)pattern that beginners use to work around this \"limitation\" is to\n\n1. Read data from the store and use it for display in the UI.\n2. Create custom mutations intended to modify the data in specific ways.\n3. Use the mutations wherever they apply (usually implemented as one mutation per form).\n\nThere are times when defining custom mutations is the most supportive pattern for the task, but I consider them to be more rare. The above pattern can result in a huge number of mutations, extra lines of code, and increased long-term maintenance costs.\n\n## The Clone and Commit Pattern\n\nThe \"Clone and Commit\" pattern provides an alternative to using a lot of mutations. This patterns looks more like this:\n\n1. Read data from the store and use it for display in the UI. (Same as above)\n2. Create and modify a clone of the data.\n3. Use a single mutation to commit the changes back to the original record in the store.\n\nSending most edits through a single mutation can really simplify the way you work with Vuex data. The Feathers-Vuex `BaseModel` class has `clone` and `commit` instance methods. These methods provide a clean API for working with items in the Vuex store and supporting Vuex strict mode:\n\n```js\nimport { models } from 'feathers-vuex'\n\nexport default {\n name: 'MyComponent',\n created() {\n const { Todo } = models.api\n\n const todo = new Todo({\n description: 'Plant the garden',\n isComplete: false\n })\n\n const todoClone = todo.clone()\n todoClone.description = 'Plant half of the garden.\"\n todoClone.commit()\n }\n}\n```\n\nIn the example above, modifying the `todo` variable would directly modify part of the Vuex store outside of a mutation (also known as a reducer in Redux), which is a generally unsupportive practice. Calling `todo.clone()` returns a reactive clone of the instance and keeps it outside the Vuex store. This means you can make changes to it all you want without causing any trouble with Vuex. You can then call `todoClone.commit()` to update the original record in the store.\n\nThe `clone` and `commit` methods are used inside the FeathersVuexFormWrapper component.\n\n## FeathersVuexFormWrapper\n\nThe `FeathersVuexFormWrapper` component uses the \"clone and commit\" pattern to connect a single record to a child form within its default slot.\n\n```vue\n\n \n \n \n \n \n\n\n\n```\n\nHere's another example of how you could use the form wrapper to both save the form and close a modal at the same time. (The modal is not shown in the template markup.) Notice how the `@save` handler is an inline function that sets `isModalVisible` to false, then on a new line it calls save. This is handled perfectly by Vue.\n\n```vue\n\n \n \n {\n isModalVisible = false\n save({ populateParams: {} })\n }\n \"\n @reset=\"reset\"\n @remove=\"remove\"\n >\n \n \n\n\n\n```\n### Props\n\n- `item`: {Object} a model instance from the Vuex store.\n- `watch`: {Boolean|Array} when enabled, if the original record is updated, the data will be re-cloned. The newly-cloned data will overwrite the `clone` data (in the slot scope). Default: `false`.\n- `eager`: {Boolean} While this is enabled, using the `save` method will first commit the result to the store then it will send a network request. The UI display will update immediately, without waiting for any response from the API server. Default: `true`.\n\n### Slot Scope\n\nThe default slot contains only four attributes. The `clone` data can be passed to the child component. The `save`, `reset`, and `remove` are meant to be bound to events emitted from the child component.\n\n- `clone`: {Object} The cloned record. Each record in the store can have a single clone. The clones are stored on the service's model class, by default.\n- `save`: {Function} When called, it commits the data and saves the record (with eager updating, by default. See the `eager` prop.) The save method calls `instance.save()`, internally, so you can pass a params object, if needed.\n- `reset`: {Function} When called, the clone data will be reset back to the data that is currently found in the store for the same record.\n- `remove`: {Function} When called, it removes the record from the API server and the Vuex store.\n\n### Usage with `diffOnPatch`\n\nIf you plan to use the `diffOnPatch` static Model method together with the `FeathersVuexFormWrapper`, be sure to set the `eager` prop to `false`. See [this GitHub issue](https://github.com/feathersjs-ecosystem/feathers-vuex/issues/520) for more details.\n\n## FormWrapper Example: CRUD Form\n\n### TodoView\n\nIt's a pretty common scenario to have the same form handle editing and creating data. Below is a basic example of how you could use the FeathersVuexFormWrapper for this. A few things to notice about the example:\n\n1. It uses a `Todo` Model class to create and edit todos. The `$FeathersVuex` object is available on `this` only when the [Feathers-Vuex Vue plugin](./vue-plugin.md) is used.\n2. It assumes that you have a route setup with an `:id` parameter.\n3. It assumes that the data has a MongoDB-style `_id` property, where an SQL-based service would probably use `id`.\n\n```vue\n\n \n \n \n \n \n\n\n\n```\n\n\n### TodoEditor\n\nNext let's look at a minimal example of a 'TodoEditor' component which is a child of the `FeathersVuexFormWrapper` in the above example. A few things to notice about the below `TodoEditor` component:\n\n1. It's minimal on purpose to show you the important parts of working with the `FeathersVuexFormWrapper`.\n1. It emits the `save`, `reset`, and `remove` events, which are connected to the `FeathersVuexFormWrapper` in the above code snippet.\n1. It's not styled to keep it simple. You'll probably want to add some styles. ;)\n1. The Delete button immediately emits remove, so the instance will be deleted immediately. You probably want, instead, to show a prompt or confirmation dialog to ask the user to confirm deletion.\n1. This is HTML, so the button `type` is important. If you forget to add `type=\"button\"` to a button, it will default to `type=\"submit\"`. Clicking the button would submit the form and call the `@submit.prevent` handler on the `