strapi-plugin-meilisearch 0.9.2 → 0.10.0

package/README.md

@@ -6,11 +6,12 @@
 
 <h4 align="center">
   <a href="https://github.com/meilisearch/meilisearch">Meilisearch</a> |
-  <a href="https://docs.meilisearch.com">Documentation</a> |
+  <a href="https://www.meilisearch.com/cloud?utm_campaign=oss&utm_source=github&utm_medium=strapi-plugin-meilisearch">Meilisearch Cloud</a> |
+  <a href="https://www.meilisearch.com/docs">Documentation</a> |
   <a href="https://discord.meilisearch.com">Discord</a> |
   <a href="https://roadmap.meilisearch.com/tabs/1-under-consideration">Roadmap</a> |
   <a href="https://www.meilisearch.com">Website</a> |
-  <a href="https://docs.meilisearch.com/faq">FAQ</a>
+  <a href="https://www.meilisearch.com/docs/faq">FAQ</a>
 </h4>
 
 <p align="center">
@@ -30,6 +31,7 @@ Add your Strapi content-types into a Meilisearch instance. The plugin listens to
 ## Table of Contents <!-- omit in toc -->
 
 - [📖 Documentation](#-documentation)
+- [⚡ Supercharge your Meilisearch experience](#-supercharge-your-meilisearch-experience)
 - [🔧 Installation](#-installation)
 - [🎬 Getting Started](#-getting-started)
 - [💅 Customization](#-customization)
@@ -41,10 +43,14 @@ Add your Strapi content-types into a Meilisearch instance. The plugin listens to
 
 ## 📖 Documentation
 
-To understand Meilisearch and how it works, see the [Meilisearch's documentation](https://docs.meilisearch.com/learn/getting_started/quick_start.html).
+To understand Meilisearch and how it works, see the [Meilisearch's documentation](https://www.meilisearch.com/docs/learn/getting_started/installation).
 
 To understand Strapi and how to create an app, see [Strapi's documentation](https://strapi.io/documentation/developer-docs/latest/getting-started/introduction.html).
 
+## ⚡ Supercharge your Meilisearch experience
+
+Say goodbye to server deployment and manual updates with [Meilisearch Cloud](https://www.meilisearch.com/cloud?utm_campaign=oss&utm_source=github&utm_medium=strapi-plugin-meilisearch). Get started with a 14-day free trial! No credit card required.
+
 ## 🔧 Installation
 
 This package version works with the [v4 of Strapi](https://docs.strapi.io/developer-docs/latest/getting-started/introduction.html). If you are using [Strapi v3](https://docs-v3.strapi.io/developer-docs/latest/getting-started/introduction.html), please refer to [this README](https://github.com/meilisearch/strapi-plugin-meilisearch/tree/v3_main).
@@ -71,7 +77,7 @@ You will need both a running Strapi app and a running Meilisearch instance. For
 
 ### 🏃‍♀️ Run Meilisearch <!-- omit in toc -->
 
-There are many easy ways to [download and run a Meilisearch instance](https://docs.meilisearch.com/reference/features/installation.html#download-and-launch).
+There are many easy ways to [download and run a Meilisearch instance](https://www.meilisearch.com/docs/reference/features/installation.html#download-and-launch).
 
 For example, if you use Docker:
 
@@ -109,9 +115,9 @@ On the left-navbar, `Meilisearch` appears under the `PLUGINS` category. If it do
 First, you need to configure credentials via the Strapi config, or on the plugin page.
 The credentials are composed of:
 - The `host`: The url to your running Meilisearch instance.
-- The `api_key`: The `master` or `private` key as the plugin requires administration permission on Meilisearch.[More about permissions here](https://docs.meilisearch.com/reference/features/authentication.html).
+- The `api_key`: The `master` or `private` key as the plugin requires administration permission on Meilisearch.[More about permissions here](https://www.meilisearch.com/docs/reference/features/authentication.html).
 
-⚠️ The `master` or `private` key should never be used to `search` on your front end. For searching, use the `public` key available on [the `key` route](https://docs.meilisearch.com/reference/api/keys.html#get-keys).
+⚠️ The `master` or `private` key should never be used to `search` on your front end. For searching, use the `public` key available on [the `key` route](https://www.meilisearch.com/docs/reference/api/keys.html#get-keys).
 
 #### Using the plugin page
 
@@ -184,7 +190,7 @@ The reload is only possible in develop mode; click on the `Reload Server` button
 
 ## 💅 Customization
 
-It is possible to add settings for every collection. Start by creating a sub-object with the name of the collection inside your `plugin.json` file.
+It is possible to add settings for every collection. Start by creating a sub-object with the name of the collection inside your `plugins.js` file.
 
 ```js
 // config/plugins.js
@@ -192,7 +198,9 @@ It is possible to add settings for every collection. Start by creating a sub-obj
 module.exports = () => ({
   //...
   meilisearch: {
-    restaurant: {}
+    config: {
+      restaurant: {}
+    }
   }
 })
 ```
@@ -202,7 +210,7 @@ Settings:
 - [🪄 Transform entries](#-transform-entries)
 - [🤚 Filter entries](#-filter-entries)
 - [🏗 Add Meilisearch settings](#-add-meilisearch-settings)
-- [🔎 Entries query](#🔎-entries-query)
+- [🔎 Entries query](#-entries-query)
 
 ### 🏷 Custom index name
 
@@ -319,7 +327,7 @@ Result:
   }
 ```
 
-By transforming the `categories` into an array of names, it is now compatible with the [`filtering` feature](https://docs.meilisearch.com/reference/features/filtering_and_faceted_search.html#configuring-filters) in Meilisearch.
+By transforming the `categories` into an array of names, it is now compatible with the [`filtering` feature](https://www.meilisearch.com/docs/reference/features/filtering_and_faceted_search.html#configuring-filters) in Meilisearch.
 
 **Important**: You should always return the id of the entry without any transformation to [allow sync](https://github.com/meilisearch/strapi-plugin-meilisearch/issues/487) when unpublished or deleting some entries in Strapi.
 
@@ -349,7 +357,7 @@ module.exports = {
 
 ### 🏗 Add Meilisearch settings
 
-Each index in Meilisearch can be customized with specific settings. It is possible to add your [Meilisearch settings](https://docs.meilisearch.com/reference/features/settings.html#settings) configuration to the indexes you create using the `settings` field in the plugin configuration file.
+Each index in Meilisearch can be customized with specific settings. It is possible to add your [Meilisearch settings](https://www.meilisearch.com/docs/reference/api/settings#settings_parameters#settings) configuration to the indexes you create using the `settings` field in the plugin configuration file.
 
 The settings are added when either: adding a content-type to Meilisearch or when updating a content-type in Meilisearch. The settings are not updated when documents are added through the [`listeners`](-apply-hooks).
 
@@ -375,14 +383,18 @@ module.exports = {
 
 ### 🔎 Entries query
 
-When indexing a content type to Meilisearch, the plugin has to fetch the documents from your database. With `entriesQuery` it is possible to specify some options that should be applied during the fetching of the entries.
+When indexing a content type to Meilisearch, the plugin has to fetch the documents from your database. With `entriesQuery` it is possible to specify some options are applied during the fetching of the entries.
 The options you can set are described in the [`findMany` documentation](https://docs.strapi.io/developer-docs/latest/developer-resources/database-apis-reference/entity-service/crud.html#findmany) of Strapi. However, we do not accept any changes on the `start` parameter.
 
+**Common use cases**
+
 If you are using the [🌍 Internationalization (i18n)](https://docs.strapi.io/developer-docs/latest/plugins/i18n.html) plugin, an additional field `locale` can also be added in `entriesQuery`.
 
-**For example**
+If you want to add a collection with a relation to the collection being included, you have to configure the `populate` parameter in `entriesQuery`. See [the docs](https://docs.strapi.io/dev-docs/api/entity-service/populate) on how it works, and [an example](./resources/entries-query/populate.js) in our resources.
+
+**Example**
 
-For example, if you want your documents to be fetched in batches of `1000` you specify it in the `entriesQuery` option.
+If you want your documents to be fetched in batches of `1000` you specify it in the `entriesQuery` option.
 
 ```js
 module.exports = {
@@ -400,16 +412,15 @@ module.exports = {
 
 [See resources](./resources/entries-query) for more entriesQuery examples.
 
-
 ### 🕵️‍♀️ Start Searching <!-- omit in toc -->
 
-Once you have a content-type indexed in Meilisearch, you can [start searching](https://docs.meilisearch.com/learn/getting_started/quick_start.html#search).
+Once you have a content-type indexed in Meilisearch, you can [start searching](https://www.meilisearch.com/docs/learn/getting_started/quick_start.html#search).
 
-To search in Meilisearch, you can use the [instant-meilisearch](https://github.com/meilisearch/instant-meilisearch) library that integrates a whole search interface, or our [meilisearch-js](https://github.com/meilisearch/meilisearch-js) SDK.
+To search in Meilisearch, you can use the [instant-meilisearch](https://github.com/meilisearch/meilisearch-js-plugins/tree/main/packages/instant-meilisearch) library that integrates a whole search interface, or our [meilisearch-js](https://github.com/meilisearch/meilisearch-js) SDK.
 
 #### ⚡️ Using Instant meiliSearch <!-- omit in toc -->
 
-You can have a front up and running in record time with [instant-meilisearch](https://github.com/meilisearch/instant-meilisearch).
+You can have a front up and running in record time with [instant-meilisearch](https://github.com/meilisearch/meilisearch-js-plugins/tree/main/packages/instant-meilisearch).
 
 <p align="center">
 <img src="./assets/obrigado.gif" alt="Restaurant demo" width="600"/>
@@ -547,14 +558,14 @@ If you want to know more about the development workflow or want to contribute, p
 
 ## 🌎 Community support
 
-- For general help using **Meilisearch**, please refer to [the official Meilisearch documentation](https://docs.meilisearch.com).
-- Contact the [Meilisearch support](https://docs.meilisearch.com/learn/what_is_meilisearch/contact.html)
+- For general help using **Meilisearch**, please refer to [the official Meilisearch documentation](https://www.meilisearch.com/docs).
+- Contact the [Meilisearch support](https://www.meilisearch.com/docs/learn/what_is_meilisearch/contact.html)
 - Strapi [community Slack](https://slack.strapi.io/)
 - For general help using **Strapi**, please refer to [the official Strapi documentation](https://strapi.io/documentation/).
 
 ## 🤩 Just for the pleasure of the eyes
 
-Using the [foodadvisor](https://github.com/strapi/foodadvisor) restaurant demo Strapi provided. We added a searchbar to it using [instant-meilisearch](https://github.com/meilisearch/instant-meilisearch).
+Using the [foodadvisor](https://github.com/strapi/foodadvisor) restaurant demo Strapi provided. We added a searchbar to it using [instant-meilisearch](https://github.com/meilisearch/meilisearch-js-plugins/tree/main/packages/instant-meilisearch).
 
 <p align="center">
 <img src="./assets/restaurant.gif" alt="Fooradvisor demo" width="600"/>

package/admin/src/containers/Settings/Credentials.js

@@ -45,7 +45,7 @@ const Credentials = () => {
         <Typography variant="pi" style={{ color: 'red' }}>
           Do not use this API key on your front-end as it has too much rights.
           Instead, use the public key available using{' '}
-          <a href="https://docs.meilisearch.com/reference/api/keys.html#get-keys">
+          <a href="https://www.meilisearch.com/docs/reference/api/keys#get-keys">
             the key route
           </a>
           .

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "strapi-plugin-meilisearch",
-  "version": "0.9.2",
+  "version": "0.10.0",
   "description": "Synchronise and search in your Strapi content-types with Meilisearch",
   "scripts": {
     "playground:dev": "yarn --cwd ./playground && yarn --cwd ./playground dev",
@@ -25,10 +25,12 @@
     "README.md"
   ],
   "dependencies": {
-    "@strapi/utils": "^4.5.4",
-    "meilisearch": "^0.30.0"
+    "@strapi/utils": "^4.13.7",
+    "meilisearch": "^0.34.2"
+  },
+  "peerDependencies": {
+     "@strapi/strapi": "^4.0.0"
   },
-  "peerDependencies": {},
   "author": {
     "name": "Charlotte Vermandel <charlotte@meilisearch.com>"
   },

package/server/__mocks__/meilisearch.js

@@ -4,8 +4,23 @@ const updateSettingsMock = jest.fn(() => 10)
 const deleteDocuments = jest.fn(() => {
   return [{ taskUid: 1 }, { taskUid: 2 }]
 })
-const getIndexes = jest.fn(() => {
-  return { results: [{ uid: 'my_restaurant' }, { uid: 'restaurant' }] }
+const getStats = jest.fn(() => {
+  return {
+    databaseSize: 447819776,
+    lastUpdate: '2019-11-15T11:15:22.092896Z',
+    indexes: {
+      my_restaurant: {
+        numberOfDocuments: 1,
+        isIndexing: false,
+        fieldDistribution: {},
+      },
+      restaurant: {
+        numberOfDocuments: 1,
+        isIndexing: false,
+        fieldDistribution: {},
+      },
+    },
+  }
 })
 
 const getTasks = jest.fn(() => {
@@ -18,7 +33,7 @@ const getTasks = jest.fn(() => {
   }
 })
 
-const getStats = jest.fn(() => {
+const getIndexStats = jest.fn(() => {
   return { numberOfDocuments: 1, isIndexing: false, fieldDistribution: {} }
 })
 
@@ -27,13 +42,13 @@ const mockIndex = jest.fn(() => ({
   updateDocuments: updateDocumentsMock,
   updateSettings: updateSettingsMock,
   deleteDocuments,
-  getStats,
+  getStats: getIndexStats,
 }))
 
 // @ts-ignore
 const mock = jest.fn().mockImplementation(() => {
   return {
-    getIndexes,
+    getStats,
     index: mockIndex,
     getTasks,
   }

package/server/__tests__/meilisearch.test.js

@@ -23,9 +23,9 @@ describe('Tests content types', () => {
       strapi: customStrapi,
     })
 
-    const indexes = await meilisearchService.getIndexes()
+    const indexes = await meilisearchService.getIndexUids()
 
-    expect(indexes).toEqual([{ uid: 'my_restaurant' }, { uid: 'restaurant' }])
+    expect(indexes).toEqual(['my_restaurant', 'restaurant'])
   })
 
   test('Test to delete entries from Meilisearch', async () => {

package/server/bootstrap.js

@@ -31,8 +31,7 @@ async function syncIndexedCollections({
   contentTypeService,
   meilisearch,
 }) {
-  const indexes = await meilisearch.getIndexes()
-  const indexUids = indexes.map(index => index.uid)
+  const indexUids = await meilisearch.getIndexUids()
   // All indexed contentTypes
   const indexedContentTypes = await store.getIndexedContentTypes()
   const contentTypes = contentTypeService.getContentTypesUid()

package/server/services/error/error.js

@@ -9,7 +9,7 @@ module.exports = ({ strapi }) => {
           error: {
             message: e.message,
             link: {
-              url: e.link || 'https://docs.meilisearch.com/',
+              url: e.link || 'https://www.meilisearch.com/docs',
               label: {
                 id: 'notification.meilisearch',
                 defaultMessage: 'See more',

package/server/services/meilisearch/connector.js

@@ -65,16 +65,16 @@ module.exports = ({ strapi, adapter, config }) => {
 
   return {
     /**
-     * Get indexes with a safe guard in case of error.
+     * Get index uids with a safe guard in case of error.
      *
      * @returns { Promise<import("meilisearch").Index[]> }
      */
-    getIndexes: async function () {
+    getIndexUids: async function () {
       try {
         const { apiKey, host } = await store.getCredentials()
         const client = Meilisearch({ apiKey, host })
-        const { results: indexes } = await client.getIndexes()
-        return indexes
+        const { indexes } = await client.getStats()
+        return Object.keys(indexes)
       } catch (e) {
         strapi.log.error(`meilisearch: ${e.message}`)
         return []
@@ -176,8 +176,7 @@ module.exports = ({ strapi, adapter, config }) => {
      * }>}>} - List of contentTypes reports.
      */
     getContentTypesReport: async function () {
-      const indexes = await this.getIndexes()
-      const indexUids = indexes.map(index => index.uid)
+      const indexUids = await this.getIndexUids()
 
       // All listened contentTypes
       const listenedContentTypes = await store.getListenedContentTypes()