Changes related to the next Meilisearch release (v0.28.0)

README.md

@@ -119,7 +119,7 @@ firebase ext:install meilisearch/firestore-meilisearch --project=[your-project-i
 
 ## 🤖 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
 

functions/__tests__/functions.test.ts

@@ -5,6 +5,7 @@ import { mockConsoleLog, mockConsoleInfo } from './__mocks__/console'
 import { MeiliSearch } from 'meilisearch'
 import defaultEnvironment from './data/environment'
 import defaultDocument from './data/document'
+import { version } from '../src/version'
 
 jest.mock('meilisearch')
 
@@ -52,6 +53,7 @@ describe('extension', () => {
     expect(mockedMeilisearch).toHaveBeenCalledWith({
       apiKey: defaultEnvironment.MEILISEARCH_API_KEY,
       host: defaultEnvironment.MEILISEARCH_HOST,
+      clientAgents: [`Meilisearch Firebase (v${version})`],
     })
     expect(mockConsoleLog).toBeCalledWith(
       'Initializing extension with configuration',

functions/package.json

@@ -25,7 +25,7 @@
     "firebase-admin": "^9.8.0",
     "firebase-functions": "^3.16.0",
     "inquirer": "^8.2.2",
-    "meilisearch": "^0.25.1"
+    "meilisearch": "^0.27.0"
   },
   "devDependencies": {
     "@babel/preset-typescript": "^7.15.0",

functions/src/meilisearch/agents.ts

@@ -0,0 +1,9 @@
+import { version } from '../version'
+
+export const constructClientAgents = (
+  clientAgents: string[] = []
+): string[] => {
+  const firebaseAgent = `Meilisearch Firebase (v${version})`
+
+  return clientAgents.concat(firebaseAgent)
+}

functions/src/meilisearch/create-index.ts

@@ -1,5 +1,6 @@
 import { MeiliSearch, Index } from 'meilisearch'
 import { MeilisearchConfig } from '../types'
+import { constructClientAgents } from './agents'
 
 /**
  * initMeilisearchIndex
@@ -14,6 +15,7 @@ export function initMeilisearchIndex({
   const client = new MeiliSearch({
     host,
     apiKey,
+    clientAgents: constructClientAgents(),
   })
 
   return client.index(indexUid)

functions/yarn.lock

@@ -3773,10 +3773,10 @@ [email protected]:
   resolved "https://registry.npmjs.org/media-typer/-/media-typer-0.3.0.tgz"
   integrity sha1-hxDXrwqmJvj/+hzgAWhUUmMlV0g=
 
-meilisearch@^0.25.1:
-  version "0.25.1"
-  resolved "https://registry.yarnpkg.com/meilisearch/-/meilisearch-0.25.1.tgz#0dc25ffad64e6e50eb3da6c0691b0ff54f8578bf"
-  integrity sha512-20jO0pK9BhghxHSkOLbdoYn58h/Z0PNL3JQcRq7ipNIeqrxkAetCZZ6ttJC3uxcz0jVglmiFoSXu3Z/lEOLOLQ==
+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"