Add resources with settings examples

Author: bidoubiwa

README.md

@@ -291,7 +291,7 @@ By transforming the `categories` into an array of names, it is now compatible wi
 
 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 `settings` field in your model's config.
 
-The settings are added when either adding a whole collection to MeiliSearch or when updating a collection in MeiliSearch. The settings are not updated when documents are added through the [`listeners`](-apply-hooks).
+The settings are added when either: adding a collection to MeiliSearch or when updating a collection in MeiliSearch. The settings are not updated when documents are added through the [`listeners`](-apply-hooks).
 
 **For example**
 ```js
@@ -310,6 +310,8 @@ module.exports = {
 }
 ```
 
+[See resources](./resources/meilisearch-settings) for more settings examples.
+
 ### 🕵️‍♀️ Start Searching <!-- omit in toc -->
 
 Once you have a collection containing documents indexed in MeiliSearch, you can [start searching](https://docs.meilisearch.com/learn/getting_started/quick_start.html#search).

resources/meilisearch-settings/basic-example.js

@@ -0,0 +1,17 @@
+/**
+ * Adds the settings specific to this collection in MeiliSearch.
+ */
+
+module.exports = {
+  meilisearch: {
+    settings: {
+      filterableAttributes: ['genres'],
+      distinctAttribute: null,
+      searchableAttributes: ['title', 'description', 'genres'],
+      synonyms: {
+        wolverine: ['xmen', 'logan'],
+        logan: ['wolverine', 'xmen'],
+      },
+    },
+  },
+}

resources/meilisearch-settings/make-relationship-filterable.js

@@ -0,0 +1,37 @@
+/**
+ * Imagine if you have a collection restaurant with a category field.
+ * Category is a collection of its own. They have a many-to-many relationship.
+ *
+ * In MeiliSearch you can use filters to for example in our case, only find italian restaurants.
+ * To be able to do that, you need to provide a list of values and add in the settings the field in `filterableAttributes`.
+ * See guide: https://docs.meilisearch.com/reference/features/filtering_and_faceted_search.html#configuring-filters
+ *
+ * In Strapi, when fetching an entry the many-to-many relationships are inside an object:
+ *
+ * {
+ *   id: 1,
+ *   restaurant_name: "The squared pizza",
+ *   category: [
+ *      { id: 1, name: "italian" },
+ * *    { id: 2, name: "French" }
+ *   ]
+ * }
+ *
+ * Since MeiliSearch is expecting `category: ["Italian", "french"]` and
+ * also `category` to be in `filterableAttributes` we can use the model configuration file to provide all these informations.
+ */
+
+module.exports = {
+  meilisearch: {
+    settings: {
+      filterableAttributes: ['categories'], // add categories to filterable attributes.
+    },
+    transformEntry({ entry }) {
+      const transformedEntry = {
+        ...entry,
+        categories: entry.categories.map(cat => cat.name), // map categories to only have categories name.
+      }
+      return transformedEntry
+    },
+  },
+}