Merge branch 'main' into expose-meilisearch-package

brunoocasali · web-flow · commit ad3c63bcc7cf · 2024-02-27T17:17:24.000-03:00
diff --git a/.github/workflows/meilisearch-prototype-tests.yml b/.github/workflows/meilisearch-prototype-tests.yml
@@ -123,7 +123,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node: ['14', '16', '18']
+        node: ['18', '20']
     name: integration-tests (Node.js ${{ matrix.node }})
     steps:
       - uses: actions/checkout@v4
diff --git a/.github/workflows/pre-release-tests.yml b/.github/workflows/pre-release-tests.yml
@@ -123,7 +123,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node: ['14', '16', '18']
+        node: ['18', '20']
     name: integration-tests (Node.js ${{ matrix.node }})
     steps:
       - uses: actions/checkout@v4
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -134,7 +134,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node: ['14', '16', '18']
+        node: ['18', '20']
     name: integration-tests (Node.js ${{ matrix.node }})
     steps:
       - uses: actions/checkout@v4
diff --git a/README.md b/README.md
@@ -17,7 +17,6 @@
 <p align="center">
   <a href="https://github.com/meilisearch/meilisearch-js-plugins/actions"><img src="https://github.com/meilisearch/meilisearch-js-plugins/workflows/Tests/badge.svg?branch=main" alt="Tests"></a>
   <a href="https://github.com/meilisearch/meilisearch-js-plugins/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-informational" alt="License"></a>
-  <a href="https://github.com/meilisearch/meilisearch/discussions" alt="Discussions"><img src="https://img.shields.io/badge/github-discussions-red" /></a>
   <a href="https://ms-bors.herokuapp.com/repositories/48"><img src="https://bors.tech/images/badge_small.svg" alt="Bors enabled"></a>
 </p>
 
diff --git a/bors.toml b/bors.toml
@@ -1,9 +1,8 @@
 status = [
   'style-check',
   'types-check',
-  'integration-tests (Node.js 14)',
-  'integration-tests (Node.js 16)',
   'integration-tests (Node.js 18)',
+  'integration-tests (Node.js 20)',
   'autocomplete-client end-to-end-tests',
   'instant-meilisearch end-to-end-tests',
 ]
diff --git a/packages/autocomplete-client/CHANGELOG.md b/packages/autocomplete-client/CHANGELOG.md
@@ -1,5 +1,11 @@
 # @meilisearch/autocomplete-client
 
+## 0.3.0
+
+### Minor Changes
+
+- 00f30c9: Remove node 14 and 16 from workflow
+
 ## 0.2.2
 
 ### Patch Changes
diff --git a/packages/autocomplete-client/README.md b/packages/autocomplete-client/README.md
@@ -255,7 +255,7 @@ This package guarantees compatibility with [version v1.x of Meilisearch](https:/
 
 **Node / NPM versions**:
 
-- NodeJS >= 14 <= 18
+- NodeJS >= 18
 
 ## ⚙️ Development Workflow and Contributing
 
diff --git a/packages/autocomplete-client/package.json b/packages/autocomplete-client/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@meilisearch/autocomplete-client",
-  "version": "0.2.2",
+  "version": "0.3.0",
   "private": false,
   "description": "The search client to use Meilisearch with autocomplete.js.",
   "homepage": "https://github.com/meilisearch/meilisearch-js-plugins/tree/main/packages/autocomplete-client",
diff --git a/packages/autocomplete-client/src/package-version.ts b/packages/autocomplete-client/src/package-version.ts
@@ -1 +1 @@
-export const PACKAGE_VERSION = '0.2.2'
+export const PACKAGE_VERSION = '0.3.0'
diff --git a/packages/instant-meilisearch/CHANGELOG.md b/packages/instant-meilisearch/CHANGELOG.md
@@ -1,5 +1,18 @@
 # @meilisearch/instant-meilisearch
 
+## 0.16.0
+
+### Minor Changes
+
+- b1343c1: Enable experimental hybrid search
+
+## 0.15.0
+
+### Minor Changes
+
+- 72726ac: Update meilisearch-js version
+- 36b5a62: Fixed RegExp in filter-adapter.ts and sort-context.ts to work in Safari
+
 ## 0.14.0
 
 ### Minor Changes
diff --git a/packages/instant-meilisearch/README.md b/packages/instant-meilisearch/README.md
@@ -222,7 +222,8 @@ The following options can be overridden:
 [`showMatchesPosition`](https://www.meilisearch.com/docs/reference/api/search#show-matches-position),
 [`matchingStrategy`](https://www.meilisearch.com/docs/reference/api/search#matching-strategy),
 [`showRankingScore`](https://www.meilisearch.com/docs/reference/api/search#ranking-score),
-[`attributesToSearchOn`](https://www.meilisearch.com/docs/reference/api/search#customize-attributes-to-search-on-at-search-time).
+[`attributesToSearchOn`](https://www.meilisearch.com/docs/reference/api/search#customize-attributes-to-search-on-at-search-time),
+[`hybrid`](https://www.meilisearch.com/docs/learn/experimental/vector_search)
 
 ```js
 instantMeiliSearch(
diff --git a/packages/instant-meilisearch/__tests__/sort.test.ts b/packages/instant-meilisearch/__tests__/sort.test.ts
@@ -63,6 +63,18 @@ describe('Sort browser test', () => {
     ])
   })
 
+  test('split multiple sorting rules in different order', () => {
+    const sortRules = splitSortString(
+      'title:asc,_geoPoint(37.8153, -122.4784):asc,description:desc'
+    )
+
+    expect(sortRules).toEqual([
+      'title:asc',
+      '_geoPoint(37.8153, -122.4784):asc',
+      'description:desc',
+    ])
+  })
+
   test('split one sorting rule', () => {
     const sortRules = splitSortString('_geoPoint(37.8153, -122.4784):asc')
 
diff --git a/packages/instant-meilisearch/package.json b/packages/instant-meilisearch/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@meilisearch/instant-meilisearch",
-  "version": "0.14.0",
+  "version": "0.16.0",
   "private": false,
   "description": "The search client to use Meilisearch with InstantSearch.",
   "homepage": "https://github.com/meilisearch/meilisearch-js-plugins/tree/main/packages/instant-meilisearch",
@@ -50,7 +50,7 @@
     "templates"
   ],
   "dependencies": {
-    "meilisearch": "^0.36.0"
+    "meilisearch": "^0.37.0"
   },
   "devDependencies": {
     "@babel/cli": "^7.22.9",
diff --git a/packages/instant-meilisearch/src/adapter/search-request-adapter/__tests__/search-params.test.ts b/packages/instant-meilisearch/src/adapter/search-request-adapter/__tests__/search-params.test.ts
@@ -78,6 +78,22 @@ describe('Parameters adapter', () => {
       meiliSearchParams.matchingStrategy
     )
   })
+
+  test('hybrid search configuration can be set via search parameters', () => {
+    const hybridSearchConfig = {
+      semanticRatio: 0,
+      embedder: 'default',
+    }
+
+    const searchParams = adaptSearchParams({
+      ...DEFAULT_CONTEXT,
+      meiliSearchParams: {
+        hybrid: hybridSearchConfig,
+      },
+    })
+
+    expect(searchParams.hybrid).toBe(hybridSearchConfig)
+  })
 })
 
 describe('Geo filter adapter', () => {
diff --git a/packages/instant-meilisearch/src/adapter/search-request-adapter/filter-adapter.ts b/packages/instant-meilisearch/src/adapter/search-request-adapter/filter-adapter.ts
@@ -29,9 +29,6 @@ function transformFacetFilter(filter: string): string {
   return `"${attribute}"="${value}"`
 }
 
-// Matches first occurrence of an operator
-const numericSplitRegExp = /(?<!(?:[<!>]?=|<|>|:).*)([<!>]?=|<|>|:)/
-
 /**
  * Transform InstantSearch [numeric filter](https://www.algolia.com/doc/api-reference/api-parameters/numericFilters/)
  * to Meilisearch compatible filter format.
@@ -47,9 +44,25 @@ const numericSplitRegExp = /(?<!(?:[<!>]?=|<|>|:).*)([<!>]?=|<|>|:)/
  * @returns {string}
  */
 function transformNumericFilter(filter: string): string {
-  // TODO: Warn users to not enable facet values escape for negative numbers.
-  //       https://github.com/algolia/instantsearch/blob/da701529ed325bb7a1d782e80cb994711e20d94a/packages/instantsearch.js/src/lib/utils/escapeFacetValue.ts#L13-L21
-  const [attribute, operator, value] = filter.split(numericSplitRegExp)
+  const splitNumericFilter = (): [string, string, string] => {
+    const attributeMatch = filter.match(/^([^<!>:=]*)([<!>:=]+)(.*)$/)
+
+    if (attributeMatch) {
+      const [attribute, dirtyOperator, valueEnd] = attributeMatch.slice(1)
+      const operatorMatch = dirtyOperator.match(/^([<!>]?=|<|>|:){1}(.*)/) || [
+        '',
+        '',
+      ]
+      const [operator, valueStart] = operatorMatch.slice(1)
+      const cleanedValue = valueStart + valueEnd
+
+      return [attribute, operator, cleanedValue]
+    }
+
+    return [filter, '', '']
+  }
+
+  const [attribute, operator, value] = splitNumericFilter()
   const escapedAttribute = getValueWithEscapedBackslashesAndQuotes(attribute)
   return `"${escapedAttribute.trim()}"${
     operator === ':' ? ' ' : operator
diff --git a/packages/instant-meilisearch/src/adapter/search-request-adapter/search-params-adapter.ts b/packages/instant-meilisearch/src/adapter/search-request-adapter/search-params-adapter.ts
@@ -232,6 +232,12 @@ export function MeiliParamsCreator(searchContext: SearchContext) {
         meiliSearchParams.attributesToSearchOn = value
       }
     },
+    addHybridSearch() {
+      const value = overrideParams?.hybrid
+      if (value !== undefined) {
+        meiliSearchParams.hybrid = value
+      }
+    },
   }
 }
 
@@ -263,6 +269,7 @@ export function adaptSearchParams(
   meilisearchParams.addMatchingStrategy()
   meilisearchParams.addShowRankingScore()
   meilisearchParams.addAttributesToSearchOn()
+  meilisearchParams.addHybridSearch()
 
   return meilisearchParams.getParams()
 }
diff --git a/packages/instant-meilisearch/src/client/instant-meilisearch-client.ts b/packages/instant-meilisearch/src/client/instant-meilisearch-client.ts
@@ -84,6 +84,7 @@ export function instantMeiliSearch(
     meiliSearchInstance: meilisearchClient,
     setMeiliSearchParams: (params): void => {
       const { meiliSearchParams } = instantMeiliSearchOptions
+
       instantMeiliSearchOptions.meiliSearchParams =
         meiliSearchParams === undefined
           ? params
diff --git a/packages/instant-meilisearch/src/contexts/sort-context.ts b/packages/instant-meilisearch/src/contexts/sort-context.ts
@@ -16,7 +16,13 @@
  */
 export function splitSortString(sortStr: string): string[] {
   if (!sortStr) return []
-  const sortRules = sortStr.split(/,(?=\w+:(?:asc|desc))/)
+  const regex = /[^:]+:(?:asc|desc)/g
+  const sortRules: string[] = []
 
-  return sortRules
+  let match
+  while ((match = regex.exec(sortStr)) !== null) {
+    sortRules.push(match[0])
+  }
+
+  return sortRules.map((str) => str.replace(/^,+|,+$/, ''))
 }
diff --git a/packages/instant-meilisearch/src/package-version.ts b/packages/instant-meilisearch/src/package-version.ts
@@ -1 +1 @@
-export const PACKAGE_VERSION = '0.14.0'
+export const PACKAGE_VERSION = '0.16.0'
diff --git a/packages/instant-meilisearch/src/types/types.ts b/packages/instant-meilisearch/src/types/types.ts
@@ -54,6 +54,7 @@ export type OverridableMeiliSearchSearchParameters = Pick<
   | 'matchingStrategy'
   | 'showRankingScore'
   | 'attributesToSearchOn'
+  | 'hybrid'
 >
 
 type BaseInstantMeiliSearchOptions = {
diff --git a/playgrounds/angular/package.json b/playgrounds/angular/package.json
@@ -19,7 +19,7 @@
     "@angular/platform-browser": "~15.1.0",
     "@angular/platform-browser-dynamic": "~15.1.0",
     "@angular/router": "~15.1.0",
-    "@meilisearch/instant-meilisearch": "0.14.0",
+    "@meilisearch/instant-meilisearch": "0.16.0",
     "algoliasearch": "^4.17.2",
     "angular-instantsearch": "^4.4.1",
     "instantsearch.js": "^4.56.2",
diff --git a/playgrounds/geo-javascript/package.json b/playgrounds/geo-javascript/package.json
@@ -12,7 +12,7 @@
   },
   "devDependencies": {
     "@babel/core": "^7.20.12",
-    "@meilisearch/instant-meilisearch": "0.14.0",
+    "@meilisearch/instant-meilisearch": "0.16.0",
     "eslint-config-meilisearch": "*"
   },
   "browserslist": [
diff --git a/playgrounds/javascript/package.json b/playgrounds/javascript/package.json
@@ -18,6 +18,6 @@
   ],
   "license": "MIT",
   "dependencies": {
-    "@meilisearch/instant-meilisearch": "0.14.0"
+    "@meilisearch/instant-meilisearch": "0.16.0"
   }
 }
diff --git a/playgrounds/local-react/package.json b/playgrounds/local-react/package.json
@@ -24,7 +24,7 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "@meilisearch/instant-meilisearch": "0.14.0",
+    "@meilisearch/instant-meilisearch": "0.16.0",
     "instantsearch.css": "^8.0.0",
     "react": "^17.0.1",
     "react-dom": "^17.0.1",
diff --git a/playgrounds/react/package.json b/playgrounds/react/package.json
@@ -23,7 +23,7 @@
     "react": "^17.0.1",
     "react-dom": "^17.0.1",
     "react-instantsearch": "^7.1.0",
-    "@meilisearch/instant-meilisearch": "0.14.0"
+    "@meilisearch/instant-meilisearch": "0.16.0"
   },
   "devDependencies": {
     "@babel/core": "^7.13.1",
diff --git a/playgrounds/vue3-ts/package.json b/playgrounds/vue3-ts/package.json
@@ -12,7 +12,7 @@
     "test:types": "yarn tsc"
   },
   "dependencies": {
-    "@meilisearch/instant-meilisearch": "0.14.0",
+    "@meilisearch/instant-meilisearch": "0.16.0",
     "vue": "^3.2.45",
     "vue-instantsearch": "^4.10.8"
   },
diff --git a/yarn.lock b/yarn.lock
@@ -10223,10 +10223,10 @@ media-typer@0.3.0:
   resolved "https://registry.yarnpkg.com/media-typer/-/media-typer-0.3.0.tgz#8710d7af0aa626f8fffa1ce00168545263255748"
   integrity sha512-dq+qelQ9akHpcOl/gUVRTxVIOkAJ1wR3QAvb4RsVjS8oVoFjDGTc679wJYmUmknUF5HwMLOgb5O+a3KxfWapPQ==
 
-meilisearch@^0.36.0:
-  version "0.36.0"
-  resolved "https://registry.yarnpkg.com/meilisearch/-/meilisearch-0.36.0.tgz#b2d1f6b342aabc89557832638a6ce2a6a7c6bf64"
-  integrity sha512-swcvEYrct0/zsGj3jlbPm1OYxbH14IURnlysKlXywNicIQ5EMkSYLYCLCwOuBKAaGcdISWdgdylH9TXVLegmOQ==
+meilisearch@^0.37.0:
+  version "0.37.0"
+  resolved "https://registry.yarnpkg.com/meilisearch/-/meilisearch-0.37.0.tgz#b4cafd434d1a854a77b92d17d6977ed6c47fd485"
+  integrity sha512-LdbK6JmRghCawrmWKJSEQF0OiE82md+YqJGE/U2JcCD8ROwlhTx0KM6NX4rQt0u0VpV0QZVG9umYiu3CSSIJAQ==
   dependencies:
     cross-fetch "^3.1.6"
 

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@meilisearch/autocomplete-client",`
`3`		`- "version": "0.2.2",`
	`3`	`+ "version": "0.3.0",`
`4`	`4`	`"private": false,`
`5`	`5`	`"description": "The search client to use Meilisearch with autocomplete.js.",`
`6`	`6`	`"homepage": "https://github.com/meilisearch/meilisearch-js-plugins/tree/main/packages/autocomplete-client",`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-export const PACKAGE_VERSION = '0.2.2'`
	`1`	`+export const PACKAGE_VERSION = '0.3.0'`