Skip to content

Commit

Permalink
Merge branch 'main' into fix/1308-dont-overwrite-objectid-in-geosearc…
Browse files Browse the repository at this point in the history
…h-if-exists
  • Loading branch information
flevi29 authored Aug 27, 2024
2 parents 58c3aa7 + 8b757e8 commit 44dc980
Show file tree
Hide file tree
Showing 17 changed files with 100 additions and 47 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -124,3 +124,5 @@ data.ms
.turbo

.angular

.idea
1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
v18.20.2
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -43,5 +43,6 @@
"dependencies": {
"@changesets/cli": "^2.26.1",
"instantsearch.css": "^8.0.0"
}
},
"packageManager": "[email protected]"
}
18 changes: 18 additions & 0 deletions packages/instant-meilisearch/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,23 @@
# @meilisearch/instant-meilisearch

## 0.20.0

### Minor Changes

- 1885691: Update meilisearch version to v0.42.0

## 0.19.3

### Patch Changes

- d167b70: Add support for [ranking score threshold](https://www.meilisearch.com/docs/reference/api/search#ranking-score-threshold?utm_campaign=oss&utm_source=github&utm_medium=instant-meilisearch)

## 0.19.2

### Patch Changes

- f2bb298: Add support for distinct attribute

## 0.19.1

### Patch Changes
Expand Down
24 changes: 13 additions & 11 deletions packages/instant-meilisearch/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -213,17 +213,19 @@ You can use your own HTTP client, for example, with [`axios`](https://github.com

`meiliSearchParams` lets you override a set of search parameters that are sent off to Meilisearch.
The following options can be overridden:
[`attributesToRetrieve`](https://www.meilisearch.com/docs/reference/api/search#attributes-to-retrieve),
[`attributesToCrop`](https://www.meilisearch.com/docs/reference/api/search#attributes-to-crop),
[`cropLength`](https://www.meilisearch.com/docs/reference/api/search#crop-length),
[`cropMarker`](https://www.meilisearch.com/docs/reference/api/search#crop-marker),
[`attributesToHighlight`](https://www.meilisearch.com/docs/reference/api/search#attributes-to-highlight),
[`highlightPreTag`, `highlightPostTag`](https://www.meilisearch.com/docs/reference/api/search#highlight-tags),
[`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),
[`hybrid`](https://www.meilisearch.com/docs/learn/experimental/vector_search)
- [`attributesToCrop`](https://www.meilisearch.com/docs/reference/api/search?utm_campaign=oss&utm_source=github&utm_medium=instant-meilisearch#attributes-to-crop)
- [`attributesToHighlight`](https://www.meilisearch.com/docs/reference/api/search?utm_campaign=oss&utm_source=github&utm_medium=instant-meilisearch#attributes-to-highlight)
- [`attributesToRetrieve`](https://www.meilisearch.com/docs/reference/api/search?utm_campaign=oss&utm_source=github&utm_medium=instant-meilisearch#attributes-to-retrieve)
- [`attributesToSearchOn`](https://www.meilisearch.com/docs/reference/api/search?utm_campaign=oss&utm_source=github&utm_medium=instant-meilisearch#customize-attributes-to-search-on-at-search-time)
- [`cropLength`](https://www.meilisearch.com/docs/reference/api/search?utm_campaign=oss&utm_source=github&utm_medium=instant-meilisearch#crop-length)
- [`cropMarker`](https://www.meilisearch.com/docs/reference/api/search?utm_campaign=oss&utm_source=github&utm_medium=instant-meilisearch#crop-marker)
- [`distinct`](https://www.meilisearch.com/docs/learn/relevancy/distinct_attribute)
- [`highlightPreTag`, `highlightPostTag`](https://www.meilisearch.com/docs/reference/api/search?utm_campaign=oss&utm_source=github&utm_medium=instant-meilisearch#highlight-tags)
- [`hybrid`](https://www.meilisearch.com/docs/learn/experimental/vector_search)
- [`matchingStrategy`](https://www.meilisearch.com/docs/reference/api/search?utm_campaign=oss&utm_source=github&utm_medium=instant-meilisearch#matching-strategy)
- [`showMatchesPosition`](https://www.meilisearch.com/docs/reference/api/search?utm_campaign=oss&utm_source=github&utm_medium=instant-meilisearch#show-matches-position)
- [`showRankingScore`](https://www.meilisearch.com/docs/reference/api/search?utm_campaign=oss&utm_source=github&utm_medium=instant-meilisearch#ranking-score)
- [`rankingScoreThreshold`](https://www.meilisearch.com/docs/reference/api/search?utm_campaign=oss&utm_source=github&utm_medium=instant-meilisearch#ranking-score-threshold)

```js
instantMeiliSearch(
Expand Down
6 changes: 3 additions & 3 deletions packages/instant-meilisearch/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@meilisearch/instant-meilisearch",
"version": "0.19.1",
"version": "0.20.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",
Expand Down Expand Up @@ -50,7 +50,7 @@
"templates"
],
"dependencies": {
"meilisearch": "^0.41.0"
"meilisearch": "^0.42.0"
},
"devDependencies": {
"@babel/cli": "^7.22.9",
Expand Down Expand Up @@ -78,4 +78,4 @@
"tslib": "^2.6.1",
"typescript": "^4.9.5"
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,32 @@ describe('Parameters adapter', () => {

expect(searchParams.hybrid).toBe(hybridSearchConfig)
})

test('ranking score threshold can be set via search parameters', () => {
const rankingScoreThreshold = 0.974

const searchParams = adaptSearchParams({
...DEFAULT_CONTEXT,
meiliSearchParams: {
rankingScoreThreshold,
},
})

expect(searchParams.rankingScoreThreshold).toBe(rankingScoreThreshold)
})

test('distinct search configuration can be set via search parameters', () => {
const distinctSearchConfig = 'title'

const searchParams = adaptSearchParams({
...DEFAULT_CONTEXT,
meiliSearchParams: {
distinct: distinctSearchConfig,
},
})

expect(searchParams.distinct).toBe(distinctSearchConfig)
})
})

describe('Geo filter adapter', () => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -238,6 +238,18 @@ export function MeiliParamsCreator(searchContext: SearchContext) {
meiliSearchParams.hybrid = value
}
},
addDistinct() {
const value = overrideParams?.distinct
if (value !== undefined) {
meiliSearchParams.distinct = value
}
},
addRankingScoreThreshold() {
const value = overrideParams?.rankingScoreThreshold
if (value !== undefined) {
meiliSearchParams.rankingScoreThreshold = value
}
},
}
}

Expand Down Expand Up @@ -270,6 +282,8 @@ export function adaptSearchParams(
meilisearchParams.addShowRankingScore()
meilisearchParams.addAttributesToSearchOn()
meilisearchParams.addHybridSearch()
meilisearchParams.addDistinct()
meilisearchParams.addRankingScoreThreshold()

return meilisearchParams.getParams()
}
2 changes: 1 addition & 1 deletion packages/instant-meilisearch/src/package-version.ts
Original file line number Diff line number Diff line change
@@ -1 +1 @@
export const PACKAGE_VERSION = '0.19.1'
export const PACKAGE_VERSION = '0.20.0'
10 changes: 6 additions & 4 deletions packages/instant-meilisearch/src/types/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,18 +43,20 @@ export type InstantSearchParams = NonNullable<

export type OverridableMeiliSearchSearchParameters = Pick<
MeiliSearchMultiSearchParams,
| 'attributesToRetrieve'
| 'attributesToCrop'
| 'attributesToRetrieve'
| 'attributesToSearchOn'
| 'cropLength'
| 'cropMarker'
| 'attributesToHighlight'
| 'distinct'
| 'highlightPreTag'
| 'highlightPostTag'
| 'showMatchesPosition'
| 'hybrid'
| 'matchingStrategy'
| 'rankingScoreThreshold'
| 'showMatchesPosition'
| 'showRankingScore'
| 'attributesToSearchOn'
| 'hybrid'
>

type BaseInstantMeiliSearchOptions = {
Expand Down
2 changes: 1 addition & 1 deletion playgrounds/angular/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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.19.1",
"@meilisearch/instant-meilisearch": "0.20.0",
"algoliasearch": "^4.17.2",
"angular-instantsearch": "^4.4.1",
"instantsearch.js": "^4.56.2",
Expand Down
2 changes: 1 addition & 1 deletion playgrounds/geo-javascript/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
},
"devDependencies": {
"@babel/core": "^7.20.12",
"@meilisearch/instant-meilisearch": "0.19.1",
"@meilisearch/instant-meilisearch": "0.20.0",
"eslint-config-meilisearch": "*"
},
"browserslist": [
Expand Down
2 changes: 1 addition & 1 deletion playgrounds/javascript/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,6 @@
],
"license": "MIT",
"dependencies": {
"@meilisearch/instant-meilisearch": "0.19.1"
"@meilisearch/instant-meilisearch": "0.20.0"
}
}
2 changes: 1 addition & 1 deletion playgrounds/local-react/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
"author": "",
"license": "ISC",
"dependencies": {
"@meilisearch/instant-meilisearch": "0.19.1",
"@meilisearch/instant-meilisearch": "0.20.0",
"instantsearch.css": "^8.0.0",
"react": "^17.0.1",
"react-dom": "^17.0.1",
Expand Down
2 changes: 1 addition & 1 deletion playgrounds/react/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
"react": "^17.0.1",
"react-dom": "^17.0.1",
"react-instantsearch": "^7.1.0",
"@meilisearch/instant-meilisearch": "0.19.1"
"@meilisearch/instant-meilisearch": "0.20.0"
},
"devDependencies": {
"@babel/core": "^7.13.1",
Expand Down
2 changes: 1 addition & 1 deletion playgrounds/vue3-ts/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"test:types": "yarn tsc"
},
"dependencies": {
"@meilisearch/instant-meilisearch": "0.19.1",
"@meilisearch/instant-meilisearch": "0.20.0",
"vue": "^3.2.45",
"vue-instantsearch": "^4.10.8"
},
Expand Down
29 changes: 8 additions & 21 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -6500,23 +6500,10 @@ electron-to-chromium@^1.4.428:
resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.4.428.tgz#c31fc88e854f49d8305cdabf6ec934ff1588a902"
integrity sha512-L7uUknyY286of0AYC8CKfgWstD0Smk2DvHDi9F0GWQhSH90Bzi7iDrmCbZKz75tYJxeGSAc7TYeKpmbjMDoh1w==

elliptic@^6.5.3:
version "6.5.4"
resolved "https://registry.yarnpkg.com/elliptic/-/elliptic-6.5.4.tgz#da37cebd31e79a1367e941b592ed1fbebd58abbb"
integrity sha512-iLhC6ULemrljPZb+QutR5TQGB+pdW6KGD5RSegS+8sorOZT+rdQFbsQFJgvN3eRqNALqJer4oQ16YvJHlU8hzQ==
dependencies:
bn.js "^4.11.9"
brorand "^1.1.0"
hash.js "^1.0.0"
hmac-drbg "^1.0.1"
inherits "^2.0.4"
minimalistic-assert "^1.0.1"
minimalistic-crypto-utils "^1.0.1"

elliptic@^6.5.5:
version "6.5.5"
resolved "https://registry.yarnpkg.com/elliptic/-/elliptic-6.5.5.tgz#c715e09f78b6923977610d4c2346d6ce22e6dded"
integrity sha512-7EjbcmUm17NQFu4Pmgmq2olYMj8nwMnpcddByChSUjArp8F5DQWcIcpriwO4ZToLNAJig0yiyjswfyGNje/ixw==
elliptic@^6.5.3, elliptic@^6.5.5:
version "6.5.7"
resolved "https://registry.yarnpkg.com/elliptic/-/elliptic-6.5.7.tgz#8ec4da2cb2939926a1b9a73619d768207e647c8b"
integrity sha512-ESVCtTwiA+XhY3wyh24QqRGBoP3rEdDUl3EDUUo9tft074fi19IrdpH7hLCMMP3CIj7jb3W96rn8lt/BqIlt5Q==
dependencies:
bn.js "^4.11.9"
brorand "^1.1.0"
Expand Down Expand Up @@ -10429,10 +10416,10 @@ [email protected]:
resolved "https://registry.yarnpkg.com/media-typer/-/media-typer-0.3.0.tgz#8710d7af0aa626f8fffa1ce00168545263255748"
integrity sha512-dq+qelQ9akHpcOl/gUVRTxVIOkAJ1wR3QAvb4RsVjS8oVoFjDGTc679wJYmUmknUF5HwMLOgb5O+a3KxfWapPQ==

meilisearch@^0.41.0:
version "0.41.0"
resolved "https://registry.yarnpkg.com/meilisearch/-/meilisearch-0.41.0.tgz#98fc50dd8ce4f2446aa4445e3cecd47e3c9afde5"
integrity sha512-5KcGLxEXD7E+uNO7R68rCbGSHgCqeM3Q3RFFLSsN7ZrIgr8HPDXVAIlP4LHggAZfk0FkSzo8VSXifHCwa2k80g==
meilisearch@^0.42.0:
version "0.42.0"
resolved "https://registry.yarnpkg.com/meilisearch/-/meilisearch-0.42.0.tgz#af52091456baf48b7244ac5a55b2f279a948df38"
integrity sha512-pXaOPx/uhVGYVpejNuOcXifQVJlRVSxtvpgrGKb7ygmYo4qSNXkQXPxq1p0Tv+4/RsPJug3W04pcNnYXiqungA==
dependencies:
cross-fetch "^3.1.6"

Expand Down

0 comments on commit 44dc980

Please sign in to comment.