-
Notifications
You must be signed in to change notification settings - Fork 223
fix(recommend): update trending facets query props (RECO-1184) #1434
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
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,21 @@ | ||
import { TrendingQuery } from './TrendingQuery'; | ||
export type TrendingFacetsQuery = { | ||
/** | ||
* The name of the target index. | ||
*/ | ||
readonly indexName: string; | ||
|
||
export type TrendingFacetsQuery = Omit< | ||
TrendingQuery, | ||
'model' | 'facetValue' | 'fallbackParameters' | 'queryParameters' | ||
>; | ||
/** | ||
* Threshold for the recommendations confidence score (between 0 and 100). Only recommendations with a greater score are returned. | ||
*/ | ||
readonly threshold?: number; | ||
|
||
/** | ||
* How many recommendations to retrieve. | ||
*/ | ||
readonly maxRecommendations?: number; | ||
|
||
/** | ||
* Used for trending model | ||
*/ | ||
readonly facetName: string; | ||
}; |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,40 @@ | ||
import { TrendingQuery } from './TrendingQuery'; | ||
import { RecommendSearchOptions } from '@algolia/recommend'; | ||
|
||
export type TrendingItemsQuery = Omit<TrendingQuery, 'model'>; | ||
export type TrendingItemsQuery = { | ||
/** | ||
* The name of the target index. | ||
*/ | ||
readonly indexName: string; | ||
|
||
/** | ||
* Threshold for the recommendations confidence score (between 0 and 100). Only recommendations with a greater score are returned. | ||
*/ | ||
readonly threshold?: number; | ||
|
||
/** | ||
* How many recommendations to retrieve. | ||
*/ | ||
readonly maxRecommendations?: number; | ||
|
||
/** | ||
* List of [search parameters](https://www.algolia.com/doc/api-reference/search-api-parameters/) to send. | ||
*/ | ||
readonly queryParameters?: RecommendSearchOptions; | ||
|
||
/** | ||
* List of [search parameters](https://www.algolia.com/doc/api-reference/search-api-parameters/) to send. | ||
* | ||
* Additional filters to use as fallback when there aren’t enough recommendations. | ||
*/ | ||
readonly fallbackParameters?: RecommendSearchOptions; | ||
|
||
/** | ||
* Used for trending model | ||
*/ | ||
readonly facetName?: string; | ||
|
||
/** | ||
* Used for trending model | ||
*/ | ||
readonly facetValue?: string; | ||
}; |
This file was deleted.
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -11,6 +11,5 @@ export * from './RecommendSearchOptions'; | |
export * from './RecommendationsQuery'; | ||
export * from './RelatedProductsQuery'; | ||
export * from './TrendingFacetsQuery'; | ||
export * from './TrendingQuery'; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Any reasons to remove this export? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. removed the file completely and separated the trending query in 2 independent ones There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes but the type still exists: https://github.com/algolia/algoliasearch-client-javascript/pull/1434/files#diff-c2f0ecb57e8ccf256bade6bed628a6494a8758ed3a4756877bcccf1b3db25d69R16-R18 I'm fine removing the export as long as it's a conscious decision. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. but here is only a local type as it's only used (and needed) in There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I was more hinting the fact that it could be a breaking change now that it's not exported anymore. I think it's OK, but we should acknowledge it. |
||
export * from './TrendingItemsQuery'; | ||
export * from './WithRecommendMethods'; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This doesn't describe what this param is? (Same for
facetName
andfacetValue
for trending items.)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
✅ : 41fe144