Merge #236

236: Changes related to the next Meilisearch release (v0.28.0) r=bidoubiwa a=meili-bot

This PR gathers the changes related to the next Meilisearch release (v0.28.0) so that this package is ready when the official release is out.

⚠️ This PR should NOT be merged until:
  - the next release of Meilisearch (v0.28.0) is out.
  - the [`docs-searchbar.js`](https://github.com/meilisearch/docs-searchbar.js) dependency has been released to be compatible with Meilisearch v0.28.0.
  Once the release is out, the upgrade of the `docs-searchbar.js` dependency might be committed to this branch.

_This PR is auto-generated for the [pre-release week](https://github.com/meilisearch/integration-guides/blob/master/guides/pre-release-week.md) purpose._

_Related to this issue: https://github.com/meilisearch/integration-guides/issues/205_


Co-authored-by: meili-bot <74670311+meili-bot@users.noreply.github.com>
Co-authored-by: cvermand <33010418+bidoubiwa@users.noreply.github.com>

Author: 3 people

.eslintrc.js

@@ -16,7 +16,8 @@ module.exports = {
     PLACEHOLDER: 'readonly',
     LAYOUT: 'readonly',
     DEBUG: 'readonly',
-    ENABLE_DARK_MODE: 'readonly'
+    ENABLE_DARK_MODE: 'readonly',
+    CLIENT_AGENTS: 'readonly'
   },
   parserOptions: {
     parser: 'babel-eslint',

MeiliSearchBox.vue

@@ -30,6 +30,7 @@ export default {
       hostUrl: HOST_URL,
       apiKey: API_KEY,
       indexUid: INDEX_UID,
+      clientAgents: CLIENT_AGENTS,
       meilisearchOptions: {
         limit:
           MAX_SUGGESTIONS || this.$site.themeConfig.searchMaxSuggestions || 5,

README.md

@@ -139,7 +139,7 @@ You can also find an example in our [playground's `palette.styl` file](./playgro
 
 ## Compatibility with Meilisearch
 
-This package only guarantees the compatibility with the [version v0.27.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.27.0).
+This package only guarantees the compatibility with the [version v0.28.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.28.0).
 
 ## Development Workflow and Contributing
 

client_agents.js

@@ -0,0 +1,11 @@
+const { version } = require('./package.json')
+
+const constructClientAgents = (clientAgents = []) => {
+  const vuepressAgents = `Meilisearch Vuepress (v${version})`
+
+  return clientAgents.concat(vuepressAgents)
+}
+
+module.exports = {
+  constructClientAgents
+}

index.js

@@ -1,5 +1,7 @@
 const path = require('path')
 
+const { constructClientAgents } = require('./client_agents')
+
 module.exports = (options) => {
   return {
     alias: {
@@ -15,7 +17,8 @@ module.exports = (options) => {
       CROP_LENGTH: options.cropLength || 30,
       LAYOUT: options.layout || 'columns',
       DEBUG: options.debug || false,
-      ENABLE_DARK_MODE: options.enableDarkMode || false
+      ENABLE_DARK_MODE: options.enableDarkMode || false,
+      CLIENT_AGENTS: constructClientAgents(options.clientAgents) || []
     }
   }
 }

jest.config.js

@@ -16,6 +16,7 @@ module.exports = {
     CROP_LENGTH: 30,
     LAYOUT: 'columns',
     DEBUG: false,
-    ENABLE_DARK_MODE: false
+    ENABLE_DARK_MODE: false,
+    CLIENT_AGENTS: []
   }
 }

package.json

@@ -11,7 +11,7 @@
   },
   "main": "index.js",
   "dependencies": {
-    "docs-searchbar.js": "^2.1.1"
+    "docs-searchbar.js": "^2.2.0"
   },
   "resolutions": {
     "yargs-parser": "^13.1.2"

playground/package.json

@@ -9,7 +9,7 @@
     "setup": "node setup.js"
   },
   "dependencies": {
-    "meilisearch": "^0.25.0",
+    "meilisearch": "^0.27.0",
     "vuepress": "^1.4.1",
     "vuepress-theme-default-prefers-color-scheme": "^2.0.0"
   }

playground/setup.js

@@ -213,6 +213,6 @@ const { MeiliSearch } = require('meilisearch')
 
   const response = await index.addDocuments(dataset)
 
-  const task = await client.waitForTask(response.uid)
+  const task = await client.waitForTask(response.taskUid)
   console.log(task)
 })()

playground/yarn.lock

@@ -4837,10 +4837,10 @@ media-typer@0.3.0:
   resolved "https://registry.yarnpkg.com/media-typer/-/media-typer-0.3.0.tgz#8710d7af0aa626f8fffa1ce00168545263255748"
   integrity sha1-hxDXrwqmJvj/+hzgAWhUUmMlV0g=
 
-meilisearch@^0.25.0:
-  version "0.25.0"
-  resolved "https://registry.yarnpkg.com/meilisearch/-/meilisearch-0.25.0.tgz#8e980fbdd36b9fe6ed606205e262418f21e64d84"
-  integrity sha512-TSIJTh5lva7WHBaoG3arNYQXuIAQkcD3BY09h2nHhjHS/wzxWKJM45x5bEC67Grw8zXihVqqmWty4a4ps4S+tg==
+meilisearch@^0.27.0:
+  version "0.27.0"
+  resolved "https://registry.yarnpkg.com/meilisearch/-/meilisearch-0.27.0.tgz#8bd57ddb77b975f93e054cb977b951c488ece297"
+  integrity sha512-kZOZFIuSO7c6xRf+Y2/9/h6A9pl0sCl/G44X4KuaSwxGbruOZPhmxbeVEgLHBv4pUFvQ56rNVTA/2d/5GCU1YA==
   dependencies:
     cross-fetch "^3.1.5"