vuex-orm/plugin-search

Vuex ORM plugin for adding fuzzy search feature through model entities.

Vuex ORM Plugin: Search

Vuex ORM Search plugin adds a search() query chain modifier to easily filter matched records using fuzzy search logic from the Fuse.js library.

A simple example to search for 'john' within your query:

const users = User.query().search('john').get()

Sponsors

Vuex ORM is sponsored by awesome folks. Big love to all of them from whole Vuex ORM community 💕

Super Love Sponsors

Big Love Sponsors

A Love Sponsors

Installation

Install @vuex-orm/plugin-search alongside Vuex ORM.

npm install @vuex-orm/core @vuex-orm/plugin-search --save
# OR
yarn add @vuex-orm/core @vuex-orm/plugin-search

Then install the plugin using Vuex ORM use() method.

import VuexORM from '@vuex-orm/core'
import VuexORMSearch from '@vuex-orm/plugin-search'

VuexORM.use(VuexORMSearch, {
  // Configure default fuse.js options here (see "Configuration" section below).
})

API

The search plugin method accepts two parameters.

search(terms: string | string[], options: Object): Query

• terms – any string or an array of strings.
• options – see the Configurations section below.

NOTE: If passing an array of search terms, the results assume some element in the array to be matched.

Configurations

The plugin provides opinionated default Fuse.js options for token-based matching for optimum performance. These options can be 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 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	Keys from 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 Examples

Here are 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).

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.

const users = User.query().search('john', {
  caseSensitive: false,
  threshold: 0.3,
  keys: ['firstName', 'lastName']
}).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.

const data = User.query().search(['pat', 'male'], {
  keys: ['firstName', 'gender']
}).get()

Questions & Discussions

Join us on our Slack Channel for any questions and discussions.

Although there is the Slack Channel, do not hesitate to open an issue for any question you might have. We're always more than happy to hear any feedback, and we don't care what kind of form they are.

Plugins

Vuex ORM can be extended via plugins to add additional features. Here is a list of available plugins.

• Vuex ORM Axios – The plugin to sync the store against a RESTful API.
• Vuex ORM GraphQL – The plugin to sync the store against a GraphQL API.
• Vuex ORM Change Flags - Vuex ORM plugin for adding IsDirty / IsNew flags to model entities.
• Vuex ORM Soft Delete – Vuex ORM plugin for adding soft delete feature to model entities.

Contribution

We are excited that you are interested in contributing to Vuex ORM Plugin: Search! Anything from raising an issue, submitting an idea of a new feature, or making a pull request is welcome! Before submitting your contribution though, please make sure to take a moment and read through the following guidelines.

Pull Request Guidelines

When submitting a new pull request, please make sure to follow these guidelines:

• For feature requests: Checkout a topic branch from dev branch, and merge back against dev branch.
• For bug fixes: Checkout a topic branch from master branch, and merge back against master branch.

These rules also apply to the documentation. If you're submitting documentation about a new feature that isn't released yet, you must checkout the dev branch, but for non-functional updates, such as fixing a typo, you may checkout and commit to the master branch.

Scripts

There are several scripts to help with development.

yarn build

Compile files and generate bundles in dist directory.

yarn lint

Lint files using Prettier.

yarn test

Run the test using Jest.

yarn test:watch

Run the test in watch mode.

yarn coverage

Generate test coverage in coverage directory.

License

Vuex ORM Plugin: Search is open-sourced software licensed under the MIT license.

plugin-search's Issues

Support for Vuex ORM Next

Hi guys,

I was wondering if there are any plans to rewrite this plugin to support the Next branch of Vuex ORM in the near future?

I have written a quick implementation for using fuse.js with Vuex ORM Next and am wondering if I should publish it. If you have plans to support the upcoming version though it would probably not make much sense to publish a package with basically the same functionality.

weird behaviour when trying to search inside fields that contain special characters

I have a field that contains values such as "$12 per hour" and "55% equity"

No matter what I've tried, I cannot match those fields when searching for words like "hour" or "equity", and if I search for "55" it does match the "55% equity" but if I search for "12" it does not match the "$12 per hour"

I tried many options but it still won't work

Typescript error with new version of vuex-orm

Hi, there is a typescript error with version 0.33.0 of vuex-orm/core like that

Property 'search' does not exist on type 'Query<BaseModel>'.

Can you fix this?

Empty string should return whole collection

Hey,

I updated from 0.23 to 0.24 and empty search param now returns nothing with an error:
Error in render: "TypeError: t is null"

I need to start typing something to see results.

It's maybe a regression, I could open a PR if needed unless with know how to fix it quickly.

Thanks in advance

Composite primary key support

Vuex ORM 0.16.0 introduced the composite primary key feature. So now this.entity.primaryKey could be a string or an array.

I think we should fix this line but not sure how composite key should work with the plugin.

Maybe it's better not to remove primary keys if it's composite? Since primary key could be ['post_id', 'username'].

Does this work with nested fields and related models?

Hi there. I have a model which includes relationships. I include relationship data with the .with() function.
Even though fuse says it supports search of nested fields using the dot notation (https://fusejs.io/examples.html#nested-search), the neste fields of my model do not seem to be picked up.

const inquiries = computed(() => {
  const query = Inquiry.query()
    .has('shipment')
    .with('shipment.origin|destination')
    .with('user')
    .orderBy('created_at', 'desc')
  if (searchterm.value?.length > 2) {
    query.search(searchterm.value, {
      keys: ['status', 'shipment.hubspot_deal_id', 'user.first_name', 'user.last_name']
    })
  }
  return query.get()
})

If I search the status field. It appears to be working correctly. But if I try to search a user by first name or last name, the search result turns up empty.

So I guess my questions are:

• Does this plugin support the situation above, in which one wants to search nested fields, that consist of related models included using with()?
• When is the search executed? Is this before the .with() functions have successfully executed, or after?

Able to search many-to-many fields?

I have a model with several many-to-many relationship fields, which require an intermediate pivot model.

It doesn't appear that the search is working for them. Is this a limitation or is there a way to include these as well.

Make the default threshold bigger

Issue #4