init

Author: cjcrawford

.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+node_modules
+*.log
+coverage
+.vscode
+.idea

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Conan Crawford
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,137 @@
+# Vuex Orm Plugin: Search
+
+This plugin adds a **search()** method to the vuex-orm query methods to easily filter matched records using fuzzy search logic from the [Fuse.js](http://fusejs.io/) library.
+
+A simple example to search for '_john_' within your query:
+
+```javascript
+const data = this.$store.getters['entities/users/query']()
+  .search('john')
+  .orderBy('name', 'asc')
+  .offset(0)
+  .limit(10)
+  .get()
+```
+
+### API
+The search plugin method accepts two parameters
+
+- **term** : any string or an array of strings
+- **options** : see the _Fuse.js Default Options_ below
+
+**Note:** If passing an array of search terms, the results assume every element in the array must be matched.
+
+```typescript
+search(term: string | Array<string>, options: Object<any>): Array<Records>
+```
+
+## Requirements:
+
+The search plugin requires **@vuex-orm/core** package version **0.23.2**
+
+To upgrade the **vuex-orm package** simply run
+```bash
+npm install @vuex-orm/core
+```
+
+## Installation
+```bash
+npm install @vuex-orm/plugin-search --save
+```
+
+## Plugin Import Directions
+
+Import the search plugin in the Vuex Store entry file.
+
+```javascript
+// ex: store/index.js
+import VuexORM from '@vuex-orm/core'
+import VuexORMSearch from '@vuex-orm/plugin-search'
+````
+
+Tell VuexORM to install the plugin
+
+```javascript
+VuexORM.use(VuexORMSearch, {
+  // configure default fuse.js options here (see below)
+})
+```
+
+## Fuse.js Default Options
+
+The plugin provides opinionated default fuse.js options for token based matching for optimum performance. These options are easily changed at two stages of the plugin lifecycle:
+
+- Plugin installation (sets the global default options)
+- Runtime within the **search()** query chain
+
+see: [Fuse.js](http://fusejs.io/) for demo
+
+| Property | Description | Default |
+| --- | --- | --- |
+| searchPrimaryKey | Also search the primary key | false |
+| location | Approximately where in the text is the pattern expected to be found | 0 |
+| distance | Determines how close the match must be to the fuzzy location | 100 |
+| threshold | **0.0** requires a perfect match, and a threshold of **1.0** would match anything | 0.3 |
+| maxPatternLength | Machine word size | 32 |
+| caseSensitive | Indicates whether comparisons should be case sensitive | false |
+| tokenSeparator | Regex used to separate words when searching. Only applicable when **tokenize** is **true** | / +/g |
+| findAllMatches | When true, the algorithm continues searching to even if a perfect match is found | false |
+| minMatchCharLength | Minimum number of characters that must be matched before a result is considered a match | 1 |
+| keys | An array of fields (columns) to be included in the search | Model.$fields() |
+| shouldSort | Whether to sort the result list, by score | false |
+| tokenize | When true, the search algorithm will search individual words **and** the full string, computing the final score as a function of both. **Note**: that when _tokenize_ is _true_, the **threshold**, **distance**, and **location** are inconsequential for individual tokens | false |
+| matchAllTokens | When true, the result set will only include records that match all tokens. Will only work if **tokenize** is also true. **Note**: It is better to use multiple **.search()** query chains if you have multiple terms that need to match. | false |
+| verbose | Will print to the console. Useful for debugging. | false |
+
+## Option Use Examples
+
+Some examples on how to use the search plugin with case specific options
+
+### During Plugin Install
+
+For example, if we want to match based on case sensitive and no fuzzy search logic (perfect match)
+```javascript
+VuexORM.use(VuexORMSearch, {
+  caseSensitive: true,
+  threshold: 0
+})
+```
+
+### During Query Chain
+
+The global install options will now default to case sensitive and no fuzzy logic, but for example we have a run-time case we need to ignore case and implement a slightly more strict fuzzy search threshold.
+
+Let's also specify the need to only search the **firstName** and **lastName** fields.
+
+```javascript
+const options = {
+  caseSensitive: false,
+  threshold: 0.3,
+  keys: ['firstName', 'lastName']
+}
+const data = this.$store.getters['entities/users/query']()
+  .search('john', options)
+  .orderBy('firstName', 'asc')
+  .offset(0)
+  .limit(10)
+  .get()
+```
+
+### Finding Results Matching Multiple Terms
+
+Let's find all matches where both **pat** and **male** exist in our records, and sort by the date added.
+
+```javascript
+const terms = ['pat', 'male']
+const options = {
+  keys: ['firstName', 'gender']
+}
+const data = this.$store.getters['entities/users/query']()
+  .search(terms, options)
+  .orderBy('createdAt', 'desc')
+  .get()
+```
+
+## License
+
+The Vuex ORM Plugin Search is open-sourced software licensed under the [MIT license](LICENSE.md).

dist/index.js

@@ -0,0 +1,5 @@
+// Used for passing in buildable environment variables
+// Webpack will find and replace object keys with there respective values
+module.exports = {
+  // ENVIRONMENT: process.env.ENVIRONMENT
+}