Next v0.4.0 release

[bidoubiwa]

Important

• Only works with the newest v0.24.0 version of MeiliSearch
• Introduces a new way to index your data in MeiliSearch. You will need to re-index your content ⚠️

Important

• ⚠️ Introduces a new way to index your data in MeiliSearch. You will need to re-index your content ⚠️
• Only works with the newest v0.24.0 version of MeiliSearch

Features

• Custom configuration file
• Custom index name
• Multiple collections in one index
• Transform entries before indexation
• Permission system
• Error notification on failed entries indexation

Small changes

• Checkbox to index instead of row
• Clarity on different api keys

Custom Configuration

Inside the api/[collection]/model folder of all existing collections, there is an associated [collection_name].js file. In this condiguration file it is now possible to add information about how your collection should act with MeiliSearch.

All possible configurations are explained in the next sections.

Example

// api/restaurant/models/restaurant.js

module.exports = {
  meilisearch: {
    // parameters
  }
}

Custom Index Name

Previously, when adding a collection to MeiliSearch you had no choice on the index naming, it was the same as the collection name.

For example, when adding the restaurant collection to MeiliSearch, the indexUid inside MeiliSearch would also be called restaurant.

With this new version, it is now possible to define a custom index name in your collections model options.

// api/restaurant/models/restaurant.js

module.exports = {
  meilisearch: {
    indexName: "my_restaurants"
  }
}

Multiple collections in the same index

You can point multiple collections to the same index.
For example if you want both entries from shoes and shirts to go to the same index, they need to share the same indexName, for example clothes.

// api/shoes/models/shoes.js

module.exports = {
  meilisearch: {
    indexName: "clothes"
  }
}

// api/shirts/models/shirts.js

module.exports = {
  meilisearch: {
    indexName: "clothes"
  }
}

Transform sent data

Before, the whole entry of a collection was sent to MeiliSearch. Including all the sensitive fields about the authors for example. There was no way to decide which field to send to MeiliSearch.

It is now possible by setting a transformEntry function in the configuration file of the collection's model (lots of examples here)

Example to sanitize your field, and thus removing all sensitive data:

// api/restaurant/models/restaurant.js
const { sanitizeEntity } = require('strapi-utils')

module.exports = {
  meilisearch: {
    transformEntry({ entry, model }) {
      return sanitizeEntity(entry, { model })
    },
  },
}

For example, you can now:

• Remove specific rows,
• Sanitize the content of private fields
• Change the content of a field

⚠️ Avoid playing around with the id fields as it is possible your collections may be duplicated in an index.

Error notification on failed entries indexation

When indexing a collection by clicking on the un-checked you receive a notification when the index has been created successfully in MeiliSearch.
Nonetheless, if the entries addition fails, you receive no explanation as to why. The only information you see is that the counter stays at 0.

This release tracks the entries addition process and raises error notifications as to why documents were not able to be added.

Better permission system

Since strapi-plugin-users-permissions is not a mandatory plugin, the new permission system is very basic. Now, You need to be an admin in the admin panel to access or use any of the API routes of the MeiliSearch plugin.

Use the checkbox to add collection instead of row

Previously, when clicking on the row of a collection, indexation or removal was triggered. This was non-intuitive and has been removed. Now to add or remove a collection from MeiliSearch you need to click on the checkbox

Clarity on different API keys

It was not clear that the plugin required either the master key or the private key to be able to use the plugin. This leads to users using the same key in their front end to make search requests.

You need to use the public key in your front-end app and the private or master-key in Strapi. See keys documentation

fixes: #42
fixes: #112
fixes: #193
fixes: #218
fixes: #249
fixes: #284
fixes: #279
fixes: #191
fixes: #117
fixes: #126

TODO

• Show addDocuments error when they happen on the dashboard #126
• The screenshotw in README are outdated #117
• Create a permission system #191
• API Key Label in Strapi Admin should be improved to avoid confusion #279
• Add possibility to chose the name of the index  #284
• Handle many to many to avoid indexing a whole object #42
• Make it possible to chose which sub-fields of the related collection we should keep #112
• Multi index search with Strapi and Meilisearch #193
• Timestamps in search #218
• Sanitize the field to remove html tags before saving for search. #249
• Check for published state before indexing a row #270

[ghost]

When are you planning on releasing this PR?

[bidoubiwa]

@haye-webbio Today or tomorrow. I think today but just in case it might be tomorrow

[ghost]

@haye-webbio Today or tomorrow. I think today but just in case it might be tomorrow

Looking forward to it! Thanks :)

[bidoubiwa]

bors merge

[bidoubiwa]

bors -r

[meili-bors]

Did you mean "r-"?

[bidoubiwa]

bors r-

[meili-bors]

Canceled.

[alallema]

LGTM! 🌮

[bidoubiwa]

bors merge

[meili-bors]

Build succeeded:

• style-check
• playground-build (Node.js 12)
• integration-tests (Node.js 14)
• integration-tests (Node.js 12)
• cypress-run
• playground-build (Node.js 14)