Merge #1323

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

Related to this issue: meilisearch/integration-guides#211

This PR:
- gathers the changes related to the next Meilisearch release (v0.29.0) so that this package is ready when the official release is out.
- should pass the tests against the [latest pre-release of Meilisearch](https://github.com/meilisearch/meilisearch/releases).
- might eventually contain test failures until the Meilisearch v0.29.0 is out.

⚠️ This PR should NOT be merged until the next release of Meilisearch (v0.29.0) is out.

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


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

README.md

@@ -338,7 +338,7 @@ controller.abort()
 
 ## 🤖 Compatibility with Meilisearch
 
-This package only guarantees the compatibility with the [version v0.28.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.28.0).
+This package only guarantees the compatibility with the [version v0.29.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.29.0).
 
 ## 💡 Learn more
 

src/types/types.ts

@@ -50,6 +50,11 @@ export type IndexesResults<T> = ResourceResults<T> & {}
  * SEARCH PARAMETERS
  */
 
+export const enum MatchingStrategies {
+  ALL = 'all',
+  LAST = 'last',
+}
+
 export type Filter = string | Array<string | string[]>
 
 export type Query = {
@@ -77,6 +82,7 @@ export type SearchParams = Query &
     facets?: string[]
     attributesToRetrieve?: string[]
     showMatchesPosition?: boolean
+    matchingStrategy?: MatchingStrategies
   }
 
 // Search parameters for searches made with the GET method

tests/keys.test.ts

@@ -1,9 +1,11 @@
+import MeiliSearch from '../src/browser'
 import { ErrorStatusCode } from '../src/types'
 import {
   clearAllIndexes,
   config,
   getClient,
   getKey,
+  HOST,
 } from './utils/meilisearch-test-utils'
 
 beforeEach(async () => {
@@ -116,6 +118,32 @@ describe.each([{ permission: 'Master' }, { permission: 'Private' }])(
       expect(key).toHaveProperty('expiresAt', null)
     })
 
+    test(`${permission} key: create key with actions using wildcards to provide rights`, async () => {
+      const client = await getClient(permission)
+      const uid = '3db051e0-423d-4b5c-a63a-f82a7043dce6'
+
+      const key = await client.createKey({
+        uid,
+        description: 'Indexing Products API key',
+        actions: ['indexes.*', 'tasks.*', 'documents.*'],
+        indexes: ['wildcard_keys_permission'],
+        expiresAt: null,
+      })
+
+      const newClient = new MeiliSearch({ host: HOST, apiKey: key.key })
+      await newClient.createIndex('wildcard_keys_permission') // test index creation
+      const taskInfo = await newClient
+        .index('wildcard_keys_permission')
+        .addDocuments([{ id: 1 }]) // test document addition
+      const task = await newClient.waitForTask(taskInfo.taskUid) // test fetching of tasks
+
+      expect(key).toBeDefined()
+      expect(task.status).toBe('succeeded')
+      expect(key).toHaveProperty('description', 'Indexing Products API key')
+      expect(key).toHaveProperty('uid', uid)
+      expect(key).toHaveProperty('expiresAt', null)
+    })
+
     test(`${permission} key: create key with an expiresAt`, async () => {
       const client = await getClient(permission)
 

tests/search.test.ts

@@ -1,5 +1,5 @@
 import AbortController from 'abort-controller'
-import { ErrorStatusCode, EnqueuedTask } from '../src/types'
+import { ErrorStatusCode, EnqueuedTask, MatchingStrategies } from '../src/types'
 import {
   clearAllIndexes,
   config,
@@ -95,6 +95,32 @@ describe.each([
     expect(response.hits.length).toEqual(2)
   })
 
+  test(`${permission} key: Basic phrase search with matchingStrategy at ALL`, async () => {
+    const client = await getClient(permission)
+    const response = await client
+      .index(index.uid)
+      .search('"french book" about', {
+        matchingStrategy: MatchingStrategies.ALL,
+      })
+
+    expect(response).toHaveProperty('hits', expect.any(Array))
+    expect(response).toHaveProperty('offset', 0)
+    expect(response).toHaveProperty('limit', 20)
+    expect(response.hits.length).toEqual(1)
+  })
+
+  test(`${permission} key: Basic phrase search with matchingStrategy at LAST`, async () => {
+    const client = await getClient(permission)
+    const response = await client
+      .index(index.uid)
+      .search('french book', { matchingStrategy: MatchingStrategies.LAST })
+
+    expect(response).toHaveProperty('hits', expect.any(Array))
+    expect(response).toHaveProperty('offset', 0)
+    expect(response).toHaveProperty('limit', 20)
+    expect(response.hits.length).toEqual(2)
+  })
+
   test(`${permission} key: Search with query in searchParams overwriting query`, async () => {
     const client = await getClient(permission)
     const response = await client
@@ -121,7 +147,8 @@ describe.each([
     expect(response.hits.length).toEqual(2)
   })
 
-  test(`${permission} key: Basic phrase search`, async () => {
+  // TODO: remove skip when bug is fixed by core
+  test.skip(`${permission} key: Basic phrase search`, async () => {
     const client = await getClient(permission)
     const response = await client
       .index(index.uid)
@@ -131,6 +158,7 @@ describe.each([
     expect(response).toHaveProperty('limit', 20)
     expect(response).toHaveProperty('processingTimeMs', expect.any(Number))
     expect(response).toHaveProperty('query', '"french book" about')
+
     expect(response.hits.length).toEqual(2)
   })