Pass client agents to meilisearch (#244)

* Update docs-searchbar.js to v2.2.0

* Pass Vuepress client agent to meilisearch-js

* Add client agents as global in jest tests

Author: bidoubiwa

.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,

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: []
   }
 }