Strapi-plugin-fuzzy-search
Register a weighted fuzzy search endpoint for Strapi Headless CMS you can add your content types to in no time.
Uses fuzzysort under the hood: Simple, quick and easy. No need to worry about setting up an instance for a complex search engine.
Table of Contents
- Options/Config- [General Options](#general-options)
- [Fuzzysort Options](#fuzzysort-options)
- [Full Example config](#full-example-config)- [Example Requests](#example-requests)
- [REST](#rest)
- [GraphQl](#graphql)
- [Example Responses](#example-responses)
- [REST](#rest-1)
- [GraphQl](#graphql-1)- [REST](#rest-2)
- [GraphQL](#graphql-2)Roadmap 🏗️
- Return indices/highlights of matches
- Pass configuration as query params/args
- Support Population
Requirements
Strapi Version v4.x.xInstallation
Enable the fuzzy-search plugin in the ./config/plugins.js of your Strapi project.Make sure to set the appropriate permissions for the
search route in the Permissions tab of the Users & Permission Plugin for the role to be able to access the search route.Options/Config
Mandatory settings are marked with*.General Options
The plugin requires several configurations to be set in the.config/plugins.js file of your Strapi project to work.| Key | Type | Notes | | ---------------- | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | contentTypes\* | Array of Objects | List the content types you want to register for fuzzysort. Each object requires the
uid: string and modelName: string to be set for a content type |
| transliterate | boolean | If this is set to true the search will additionally run against transliterated versions of the content for the keys specified in the keys array for a given content type. E.g. 你好 will match for ni hao. Note that activating this feature for a content type comes at a performance cost and may increase the response time. |
| queryConstraints | Object | Manipulate the db query that queries for the entries of a model, e.g. as to only select articles that have been published. These constraints to the underlying findMany() query are built with the logical operators of Strapis Query Engine API |Fuzzysort Options
ThefuzzysortOptions allow for some finetuning of fuzzysorts searching algorithm to your needs.| Key | Type | Notes | | -------------- | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | characterLimit | int (positive) | Limits the length of characters the algorithm is searching through for any string of the content type | | threshold | int (negative) | Sets the threshold for the score of the entries that will be returned. The lower, the "fuzzier" the results. | | limit | int (positive) | Limits the amount of entries returned from the search | | keys\* | array of objects | Lists the fields of the models the algorithm should search
(name: string) and a factor to weight them by weight: int. The higher the weight, the higher a match for a given field will be evaluated for a content type. |Full Example config
module.exports = ({ env }) => ({
// ...
"fuzzy-search": {
enabled: true,
config: {
contentTypes: [
{
uid: "api::author.author",
modelName: "author",
transliterate: true,
queryConstraints: {
where: {
$and: [
{
publishedAt: { $notNull: true },
},
],
},
},
fuzzysortOptions: {
characterLimit: 300,
threshold: -600,
limit: 10,
keys: [
{
name: "name",
weight: 100,
},
{
name: "description",
weight: -100,
},
],
},
},
{
uid: "api::book.book",
modelName: "book",
fuzzysortOptions: {
characterLimit: 500,
keys: [
{
name: "title",
weight: 200,
},
{
name: "description",
weight: -200,
},
],
},
},
],
},
},
// ...
});A note on performance:
A highcharacterLimit, limit, a low threshold (the lower the value the more matches) as well as setting transliterate: true all hamper the performance of the search algorithm. We recommend that you start out with a characterLimit: 500, threshold: -1000, limit: 15 and work your way from there. The characterLimit especially can be quite delicate, so make sure to test every scenario when dialing in it's value.Usage
Basic Search
Hitting the/api/fuzzy-search/search?query=<your-query-string> will return an array of matched entries for each content type registered in the config. If no match could be found an empty array will be returned. The endpoint accepts an optional locale=<your-locale> query as well.Alternatively (and if the graphql plugin is installed), a search query is registered that accepts
query: String! and locale: String (optional) as arguments.IMPORTANT: Please not that in order to query for the locale of a content type, localization must be enabled for the content type.
Example Requests
REST
await fetch(`${API_URL}/api/fuzzy-search/search?query=deresh&locale=en`);
// GET /api/fuzzy-search/search?query=deresh&locale=enGraphQl
query {
search(query: "deresh", locale: "en") {
authors {
data {
attributes {
name
}
}
}
books {
data {
attributes {
title
description
}
}
}
}
}Example Responses
IMPORTANT: Please note that as of now published as well as unpublished entries will be returned by default. Modify this behavior by setting up aqueryConstraint in your config.REST
{
"authors": [
{
"id": 1,
"name": "Любко Дереш",
"description": "As an author, Lyubko has had somewhat of a cult-like following among the younger generation in Ukraine since the appearance of his novel Cult at age eighteen, which was followed almost immediately by the publication of another novel, written in early high school.",
"createdAt": "2022-05-05T13:08:19.312Z",
"updatedAt": "2022-05-05T13:34:46.488Z",
"publishedAt": "2022-05-05T13:22:17.310Z"
}
],
"books": [
{
"id": 1,
"title": "Jacob's Head",
"description": "Jacob’s Head by Lyubko Deresh is scheduled to be adapted into a movie in Ukraine in the near future.",
"createdAt": "2022-05-05T13:08:43.816Z",
"updatedAt": "2022-05-05T13:24:07.107Z",
"publishedAt": "2022-05-05T13:22:23.764Z"
}
]
}GraphQl
{
"data": {
"search": {
"authors": {
"data": [
{
"attributes": {
"name": "Любко Дереш"
}
}
]
},
"books": {
"data": [
{
"attributes": {
"title": "Jacob's Head",
"description": "Jacob’s Head by Lyubko Deresh is scheduled to be adapted into a movie in Ukraine in the near future."
}
}
]
}
}
}
}Pagination
REST
The endpoint accepts query parameters in line with Strapis pagination by page parameters. The difference being that the pagination is scoped for the content types individually.Important: Please note that if pagination parameters are passed for a content type, it's data will now be available under the key
data, whereas the pagination meta data can be found under the key meta.| Parameter | Type | Description | Default | | ------------------------------------ | ------- | ------------------------------------------------------------------------- | ------- | | paginationmyContentTypepage | Integer | Page number | 1 | | paginationmyContentTypepagesize | Integer | Page size | 25 | | paginationmyContentTypewithcount | Boolean | Adds the total numbers of entries and the number of pages to the response | True |
Request:
await fetch(`${API_URL}/api/fuzzy-search/search?query=deresh&pagination[authors][pageSize]=2&pagination[authors][page]=3`);
// GET /api/fuzzy-search/search?query=deresh&pagination[authors][pageSize]=2&pagination[authors][page]=3Response:
{
"authors": [
// ...
],
"books": {
"data": [
// ...
],
"meta": {
"pagination": {
"page": 3,
"pageSize": 2,
"total": 6,
"pageCount": 3
}
}
}
}GraphQL
The endpoint accepts pagination arguments in line with Strapis pagination by page and pagination by offset parameters.| Parameter | Description | Default | | -------------------- | ---------------------------- | ------- | | paginationpage | Page number | 1 | | paginationpageSize | Page size | 10 | | paginationstart | Start value | 0 | | paginationlimit | Number of entities to return | 10 |
IMPORTANT: Please note that in line with Strapis defaults, pagination methods can not be mixed. Always use either page with pageSize or start with limit.
Request:
search(query: "deresh") {
books(pagination: { page: 3, pageSize: 2 }) {
data {
attributes {
title
}
}
meta {
pagination {
page
pageSize
pageCount
total
}
}
}
}Response:
{
"data": {
"search": {
"books": {
"data": [
// ...
],
"meta": {
"pagination": {
"page": 3,
"pageSize": 2,
"pageCount": 3,
"total": 6
}
}
}
}
}
}Filter by Content Type (REST)
The REST-endpoint accepts an optional parameter to select only some content types the fuzzy search should run for.| Parameter | Type | Description | | --------------------- | ------ | --------------------------------------------------------------- | | filterscontentTypes | string | Comma seperated list of the content types to run the search for |
Request:
await fetch(`${API_URL}/api/fuzzy-search/search?query=deresh&filters[contentTypes]=books,authors`);
// GET /api/fuzzy-search/search?query=deresh&filters[contentTypes]=booksResponse:
{
"authors": [
// ...
],
"books": [
// ...
]
}Why use fuzzysort and not something like Fuse.js?
While Fuse.js proofs to be an amazing library, it can yield unexpected results and what is to be perceived as "false positives" (by a human) when searching through longer strings. Fuzzysort aims to solve this problem by introducing the evaluation and scoring of exact matches. Since we had issues with Fuse.js and it's underlying algorithm, we opted for fuzzysearch to do the heavy lifting instead.Found a bug?
If you found a bug or have any questions please submit an issue. If you think you found a way how to fix it, please feel free to create a pull request!Contributors ✨
Thanks goes to these wonderful people (emoji key):This project follows the all-contributors specification. Contributions of any kind welcome!
