Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for distinct attribute #1313

Merged
merged 3 commits into from
Aug 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/smart-llamas-draw.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@meilisearch/instant-meilisearch": patch
---

Add support for distinct attribute
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 packages/instant-meilisearch/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,7 @@ The following options can be overridden:
[`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)
[`distinct`](https://www.meilisearch.com/docs/learn/relevancy/distinct_attribute)

```js
instantMeiliSearch(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,19 @@ describe('Parameters adapter', () => {

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

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,12 @@ export function MeiliParamsCreator(searchContext: SearchContext) {
meiliSearchParams.hybrid = value
}
},
addDistinct() {
const value = overrideParams?.distinct
if (value !== undefined) {
meiliSearchParams.distinct = value
}
},
}
}

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

return meilisearchParams.getParams()
}
1 change: 1 addition & 0 deletions packages/instant-meilisearch/src/types/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ export type OverridableMeiliSearchSearchParameters = Pick<
| 'showRankingScore'
| 'attributesToSearchOn'
| 'hybrid'
| 'distinct'
>

type BaseInstantMeiliSearchOptions = {
Expand Down
Loading