Merge branch 'main' into improve-eslint-prettier-tsconfig

Author: brunoocasali

.code-samples.meilisearch.yaml

@@ -741,3 +741,5 @@ facet_search_3: |-
     facetQuery: 'c',
     facetName: 'genres'
   })
+search_parameter_guide_show_ranking_score_details_1: |-
+  client.index('movies').search('dragon', { showRankingScoreDetails: true })

.github/workflows/release-drafter.yml

@@ -9,7 +9,7 @@ jobs:
   update_release_draft:
     runs-on: ubuntu-latest
     steps:
-      - uses: release-drafter/release-drafter@v5
+      - uses: release-drafter/release-drafter@v6
         with:
           config-name: release-draft-template.yml
         env:

.github/workflows/tests.yml

@@ -58,7 +58,7 @@ jobs:
       - name: Run Browser env
         run: yarn test:env:browser
       - name: Upload coverage reports to Codecov
-        uses: codecov/codecov-action@v3
+        uses: codecov/codecov-action@v4
         env:
           CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
   style_tests:

README.md

@@ -17,7 +17,7 @@
 <p align="center">
   <a href="https://www.npmjs.com/package/meilisearch"><img src="https://img.shields.io/npm/v/meilisearch.svg" alt="npm version"></a>
   <a href="https://github.com/meilisearch/meilisearch-js/actions"><img src="https://github.com/meilisearch/meilisearch-js/workflows/Tests/badge.svg" alt="Tests"></a>
-  <a href="https://codecov.io/gh/meilisearch/meilisearch-python">
+  <a href="https://codecov.io/gh/meilisearch/meilisearch-js">
     <img src="https://codecov.io/github/meilisearch/meilisearch-js/coverage.svg?branch=main" alt="Codecov">
   </a>
   <a href="https://github.com/prettier/prettier"><img src="https://img.shields.io/badge/styled_with-prettier-ff69b4.svg" alt="Prettier"></a>
@@ -983,7 +983,7 @@ client.index('myIndex').resetProximityPrecision(): Promise<EnqueuedTask>
 
 ### Embedders <!-- omit in toc -->
 
-⚠️ This feature is experimental. Activate the `vectorStore` experimental feature to use it](https://www.meilisearch.com/docs/reference/api/experimental_features#configure-experimental-features) 
+⚠️ This feature is experimental. Activate the [`vectorStore` experimental feature to use it](https://www.meilisearch.com/docs/reference/api/experimental_features#configure-experimental-features) 
 
 #### [Get embedders](https://www.meilisearch.com/docs/reference/api/settings#get-embedders)
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "meilisearch",
-  "version": "0.37.0",
+  "version": "0.38.0",
   "description": "The Meilisearch JS client for Node.js and the browser.",
   "keywords": [
     "meilisearch",

src/package-version.ts

@@ -1 +1 @@
-export const PACKAGE_VERSION = '0.37.0'
+export const PACKAGE_VERSION = '0.38.0'

src/types/types.ts

@@ -292,6 +292,8 @@ export type RawDocumentAdditionOptions = DocumentOptions & {
 export type DocumentsQuery<T = Record<string, any>> = ResourceQuery & {
   fields?: Fields<T>
   filter?: Filter
+  limit?: number
+  offset?: number
 }
 
 export type DocumentQuery<T = Record<string, any>> = {
@@ -337,6 +339,7 @@ export type OpenAiEmbedder = {
   model?: string
   apiKey?: string
   documentTemplate?: string
+  dimensions?: number
 }
 
 export type HuggingFaceEmbedder = {
@@ -350,6 +353,7 @@ export type UserProvidedEmbedder = {
   source: 'userProvided'
   dimensions: number
 }
+
 export type Embedder =
   | OpenAiEmbedder
   | HuggingFaceEmbedder

tests/embedders.test.ts

@@ -73,9 +73,10 @@ describe.each([{ permission: 'Master' }, { permission: 'Admin' }])(
         default: {
           source: 'openAi',
           apiKey: '<your-OpenAI-API-key>',
-          model: 'text-embedding-ada-002',
+          model: 'text-embedding-3-small',
           documentTemplate:
             "A movie titled '{{doc.title}}' whose description starts with {{doc.overview|truncatewords: 20}}",
+          dimensions: 1536,
         },
       }
       const task: EnqueuedTask = await client

tests/search.test.ts

@@ -271,18 +271,8 @@ describe.each([
     expect(hit).toHaveProperty('_rankingScore')
   })
 
-  test(`${permission} key: search with showRankingScoreDetails enabled`, async () => {
+  test(`${permission} key: search with showRankingScoreDetails`, async () => {
     const client = await getClient(permission)
-    const key = await getKey(permission)
-
-    await fetch(`${HOST}/experimental-features`, {
-      body: JSON.stringify({ scoreDetails: true }),
-      headers: {
-        Authorization: `Bearer ${key}`,
-        'Content-Type': 'application/json',
-      },
-      method: 'PATCH',
-    })
 
     const response = await client.index(index.uid).search('prince', {
       showRankingScoreDetails: true,