@algolia/recommend 5.0.0-alpha.53 → 5.0.0-alpha.55
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/builds/browser.d.ts +5 -5
- package/dist/builds/node.d.ts +5 -5
- package/dist/model/advancedSyntaxFeatures.d.ts +1 -1
- package/dist/model/alternativesAsExact.d.ts +1 -1
- package/dist/model/aroundRadius.d.ts +5 -5
- package/dist/model/aroundRadiusAll.d.ts +1 -1
- package/dist/model/baseRecommendRequest.d.ts +17 -17
- package/dist/model/baseRecommendationRequest.d.ts +8 -8
- package/dist/model/baseSearchParams.d.ts +3 -3
- package/dist/model/baseSearchParamsWithoutQuery.d.ts +122 -122
- package/dist/model/baseSearchResponse.d.ts +101 -101
- package/dist/model/baseTrendingRequest.d.ts +12 -12
- package/dist/model/clientMethodProps.d.ts +60 -60
- package/dist/model/distinct.d.ts +4 -4
- package/dist/model/errorBase.d.ts +6 -6
- package/dist/model/exactOnSingleWordQuery.d.ts +4 -4
- package/dist/model/facetFilters.d.ts +5 -5
- package/dist/model/facetOrdering.d.ts +12 -12
- package/dist/model/facets.d.ts +9 -9
- package/dist/model/facetsStats.d.ts +18 -18
- package/dist/model/getRecommendationsParams.d.ts +10 -10
- package/dist/model/getRecommendationsResponse.d.ts +4 -4
- package/dist/model/highlightResult.d.ts +2 -2
- package/dist/model/highlightResultOption.d.ts +19 -19
- package/dist/model/ignorePlurals.d.ts +4 -4
- package/dist/model/index.d.ts +53 -53
- package/dist/model/indexSettingsAsSearchParams.d.ts +156 -156
- package/dist/model/matchLevel.d.ts +4 -4
- package/dist/model/matchedGeoLocation.d.ts +14 -14
- package/dist/model/mixedSearchFilters.d.ts +1 -1
- package/dist/model/numericFilters.d.ts +5 -5
- package/dist/model/optionalFilters.d.ts +5 -5
- package/dist/model/personalization.d.ts +14 -14
- package/dist/model/queryType.d.ts +4 -4
- package/dist/model/rankingInfo.d.ts +50 -50
- package/dist/model/reRankingApplyFilter.d.ts +5 -5
- package/dist/model/recommendHit.d.ts +26 -26
- package/dist/model/recommendHits.d.ts +4 -4
- package/dist/model/recommendationModels.d.ts +4 -4
- package/dist/model/recommendationRequest.d.ts +3 -3
- package/dist/model/recommendationsRequest.d.ts +3 -3
- package/dist/model/recommendationsResponse.d.ts +3 -3
- package/dist/model/removeStopWords.d.ts +4 -4
- package/dist/model/removeWordsIfNoResults.d.ts +4 -4
- package/dist/model/renderingContent.d.ts +7 -7
- package/dist/model/searchParamsObject.d.ts +3 -3
- package/dist/model/searchParamsQuery.d.ts +6 -6
- package/dist/model/snippetResult.d.ts +2 -2
- package/dist/model/snippetResultOption.d.ts +11 -11
- package/dist/model/sortRemainingBy.d.ts +4 -4
- package/dist/model/tagFilters.d.ts +5 -5
- package/dist/model/trendingModels.d.ts +4 -4
- package/dist/model/trendingRequest.d.ts +3 -3
- package/dist/model/typoTolerance.d.ts +5 -5
- package/dist/model/typoToleranceEnum.d.ts +1 -1
- package/dist/model/value.d.ts +8 -8
- package/dist/recommend.cjs.js +235 -235
- package/dist/recommend.esm.browser.js +359 -359
- package/dist/recommend.esm.node.js +235 -235
- package/dist/recommend.umd.js +2 -2
- package/dist/src/recommendClient.d.ts +81 -81
- package/model/advancedSyntaxFeatures.ts +1 -1
- package/model/alternativesAsExact.ts +1 -1
- package/model/aroundRadius.ts +1 -1
- package/model/aroundRadiusAll.ts +1 -1
- package/model/baseRecommendRequest.ts +1 -1
- package/model/baseRecommendationRequest.ts +1 -1
- package/model/baseSearchParams.ts +1 -1
- package/model/baseSearchParamsWithoutQuery.ts +1 -1
- package/model/baseSearchResponse.ts +1 -1
- package/model/baseTrendingRequest.ts +1 -1
- package/model/clientMethodProps.ts +1 -1
- package/model/distinct.ts +1 -1
- package/model/errorBase.ts +1 -1
- package/model/exactOnSingleWordQuery.ts +1 -1
- package/model/facetFilters.ts +1 -1
- package/model/facetOrdering.ts +1 -1
- package/model/facets.ts +1 -1
- package/model/facetsStats.ts +1 -1
- package/model/getRecommendationsParams.ts +1 -1
- package/model/getRecommendationsResponse.ts +1 -1
- package/model/highlightResult.ts +1 -1
- package/model/highlightResultOption.ts +1 -1
- package/model/ignorePlurals.ts +1 -1
- package/model/index.ts +1 -1
- package/model/indexSettingsAsSearchParams.ts +1 -1
- package/model/matchLevel.ts +1 -1
- package/model/matchedGeoLocation.ts +1 -1
- package/model/mixedSearchFilters.ts +1 -1
- package/model/numericFilters.ts +1 -1
- package/model/optionalFilters.ts +1 -1
- package/model/personalization.ts +1 -1
- package/model/queryType.ts +1 -1
- package/model/rankingInfo.ts +1 -1
- package/model/reRankingApplyFilter.ts +1 -1
- package/model/recommendHit.ts +1 -1
- package/model/recommendHits.ts +1 -1
- package/model/recommendationModels.ts +1 -1
- package/model/recommendationRequest.ts +1 -1
- package/model/recommendationsRequest.ts +1 -1
- package/model/recommendationsResponse.ts +1 -1
- package/model/removeStopWords.ts +1 -1
- package/model/removeWordsIfNoResults.ts +1 -1
- package/model/renderingContent.ts +1 -1
- package/model/searchParamsObject.ts +1 -1
- package/model/searchParamsQuery.ts +1 -1
- package/model/snippetResult.ts +1 -1
- package/model/snippetResultOption.ts +1 -1
- package/model/sortRemainingBy.ts +1 -1
- package/model/tagFilters.ts +1 -1
- package/model/trendingModels.ts +1 -1
- package/model/trendingRequest.ts +1 -1
- package/model/typoTolerance.ts +1 -1
- package/model/typoToleranceEnum.ts +1 -1
- package/model/value.ts +1 -1
- package/package.json +6 -6
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Removes stop (common) words from the query before executing it. RemoveStopWords is used in conjunction with the queryLanguages setting. List: language ISO codes for which ignoring plurals should be enabled. This list will override any values that you may have set in queryLanguages. True: enables the stop word functionality, ensuring that stop words are removed from consideration in a search. The languages supported here are either every language, or those set by queryLanguages. False: disables stop word functionality, allowing stop words to be taken into account in a search.
|
|
3
|
-
*/
|
|
4
|
-
export type RemoveStopWords = string[] | boolean;
|
|
1
|
+
/**
|
|
2
|
+
* Removes stop (common) words from the query before executing it. RemoveStopWords is used in conjunction with the queryLanguages setting. List: language ISO codes for which ignoring plurals should be enabled. This list will override any values that you may have set in queryLanguages. True: enables the stop word functionality, ensuring that stop words are removed from consideration in a search. The languages supported here are either every language, or those set by queryLanguages. False: disables stop word functionality, allowing stop words to be taken into account in a search.
|
|
3
|
+
*/
|
|
4
|
+
export type RemoveStopWords = string[] | boolean;
|
|
5
5
|
//# sourceMappingURL=removeStopWords.d.ts.map
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Selects a strategy to remove words from the query when it doesn\'t match any hits.
|
|
3
|
-
*/
|
|
4
|
-
export type RemoveWordsIfNoResults = 'allOptional' | 'firstWords' | 'lastWords' | 'none';
|
|
1
|
+
/**
|
|
2
|
+
* Selects a strategy to remove words from the query when it doesn\'t match any hits.
|
|
3
|
+
*/
|
|
4
|
+
export type RemoveWordsIfNoResults = 'allOptional' | 'firstWords' | 'lastWords' | 'none';
|
|
5
5
|
//# sourceMappingURL=removeWordsIfNoResults.d.ts.map
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
import type { FacetOrdering } from './facetOrdering';
|
|
2
|
-
/**
|
|
3
|
-
* Content defining how the search interface should be rendered. Can be set via the settings for a default value and can be overridden via rules.
|
|
4
|
-
*/
|
|
5
|
-
export type RenderingContent = {
|
|
6
|
-
facetOrdering?: FacetOrdering;
|
|
7
|
-
};
|
|
1
|
+
import type { FacetOrdering } from './facetOrdering';
|
|
2
|
+
/**
|
|
3
|
+
* Content defining how the search interface should be rendered. Can be set via the settings for a default value and can be overridden via rules.
|
|
4
|
+
*/
|
|
5
|
+
export type RenderingContent = {
|
|
6
|
+
facetOrdering?: FacetOrdering;
|
|
7
|
+
};
|
|
8
8
|
//# sourceMappingURL=renderingContent.d.ts.map
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { BaseSearchParams } from './baseSearchParams';
|
|
2
|
-
import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';
|
|
3
|
-
export type SearchParamsObject = BaseSearchParams & IndexSettingsAsSearchParams;
|
|
1
|
+
import type { BaseSearchParams } from './baseSearchParams';
|
|
2
|
+
import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';
|
|
3
|
+
export type SearchParamsObject = BaseSearchParams & IndexSettingsAsSearchParams;
|
|
4
4
|
//# sourceMappingURL=searchParamsObject.d.ts.map
|
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
export type SearchParamsQuery = {
|
|
2
|
-
/**
|
|
3
|
-
* The text to search in the index.
|
|
4
|
-
*/
|
|
5
|
-
query?: string;
|
|
6
|
-
};
|
|
1
|
+
export type SearchParamsQuery = {
|
|
2
|
+
/**
|
|
3
|
+
* The text to search in the index.
|
|
4
|
+
*/
|
|
5
|
+
query?: string;
|
|
6
|
+
};
|
|
7
7
|
//# sourceMappingURL=searchParamsQuery.d.ts.map
|
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
import type { SnippetResultOption } from './snippetResultOption';
|
|
2
|
-
export type SnippetResult = SnippetResultOption | SnippetResultOption[];
|
|
1
|
+
import type { SnippetResultOption } from './snippetResultOption';
|
|
2
|
+
export type SnippetResult = SnippetResultOption | SnippetResultOption[];
|
|
3
3
|
//# sourceMappingURL=snippetResult.d.ts.map
|
|
@@ -1,12 +1,12 @@
|
|
|
1
|
-
import type { MatchLevel } from './matchLevel';
|
|
2
|
-
/**
|
|
3
|
-
* Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.
|
|
4
|
-
*/
|
|
5
|
-
export type SnippetResultOption = {
|
|
6
|
-
/**
|
|
7
|
-
* Markup text with occurrences highlighted.
|
|
8
|
-
*/
|
|
9
|
-
value: string;
|
|
10
|
-
matchLevel: MatchLevel;
|
|
11
|
-
};
|
|
1
|
+
import type { MatchLevel } from './matchLevel';
|
|
2
|
+
/**
|
|
3
|
+
* Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.
|
|
4
|
+
*/
|
|
5
|
+
export type SnippetResultOption = {
|
|
6
|
+
/**
|
|
7
|
+
* Markup text with occurrences highlighted.
|
|
8
|
+
*/
|
|
9
|
+
value: string;
|
|
10
|
+
matchLevel: MatchLevel;
|
|
11
|
+
};
|
|
12
12
|
//# sourceMappingURL=snippetResultOption.d.ts.map
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* How to display the remaining items. - `count`: facet count (descending). - `alpha`: alphabetical (ascending). - `hidden`: show only pinned values.
|
|
3
|
-
*/
|
|
4
|
-
export type SortRemainingBy = 'alpha' | 'count' | 'hidden';
|
|
1
|
+
/**
|
|
2
|
+
* How to display the remaining items. - `count`: facet count (descending). - `alpha`: alphabetical (ascending). - `hidden`: show only pinned values.
|
|
3
|
+
*/
|
|
4
|
+
export type SortRemainingBy = 'alpha' | 'count' | 'hidden';
|
|
5
5
|
//# sourceMappingURL=sortRemainingBy.d.ts.map
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import type { MixedSearchFilters } from './mixedSearchFilters';
|
|
2
|
-
/**
|
|
3
|
-
* Filter hits by tags.
|
|
4
|
-
*/
|
|
5
|
-
export type TagFilters = MixedSearchFilters[] | string;
|
|
1
|
+
import type { MixedSearchFilters } from './mixedSearchFilters';
|
|
2
|
+
/**
|
|
3
|
+
* Filter hits by tags.
|
|
4
|
+
*/
|
|
5
|
+
export type TagFilters = MixedSearchFilters[] | string;
|
|
6
6
|
//# sourceMappingURL=tagFilters.d.ts.map
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* The trending model to use.
|
|
3
|
-
*/
|
|
4
|
-
export type TrendingModels = 'trending-facets' | 'trending-items';
|
|
1
|
+
/**
|
|
2
|
+
* The trending model to use.
|
|
3
|
+
*/
|
|
4
|
+
export type TrendingModels = 'trending-facets' | 'trending-items';
|
|
5
5
|
//# sourceMappingURL=trendingModels.d.ts.map
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { BaseRecommendRequest } from './baseRecommendRequest';
|
|
2
|
-
import type { BaseTrendingRequest } from './baseTrendingRequest';
|
|
3
|
-
export type TrendingRequest = BaseRecommendRequest & BaseTrendingRequest;
|
|
1
|
+
import type { BaseRecommendRequest } from './baseRecommendRequest';
|
|
2
|
+
import type { BaseTrendingRequest } from './baseTrendingRequest';
|
|
3
|
+
export type TrendingRequest = BaseRecommendRequest & BaseTrendingRequest;
|
|
4
4
|
//# sourceMappingURL=trendingRequest.d.ts.map
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import type { TypoToleranceEnum } from './typoToleranceEnum';
|
|
2
|
-
/**
|
|
3
|
-
* Controls whether typo tolerance is enabled and how it is applied.
|
|
4
|
-
*/
|
|
5
|
-
export type TypoTolerance = TypoToleranceEnum | boolean;
|
|
1
|
+
import type { TypoToleranceEnum } from './typoToleranceEnum';
|
|
2
|
+
/**
|
|
3
|
+
* Controls whether typo tolerance is enabled and how it is applied.
|
|
4
|
+
*/
|
|
5
|
+
export type TypoTolerance = TypoToleranceEnum | boolean;
|
|
6
6
|
//# sourceMappingURL=typoTolerance.d.ts.map
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export type TypoToleranceEnum = 'min' | 'strict';
|
|
1
|
+
export type TypoToleranceEnum = 'min' | 'strict';
|
|
2
2
|
//# sourceMappingURL=typoToleranceEnum.d.ts.map
|
package/dist/model/value.d.ts
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
import type { SortRemainingBy } from './sortRemainingBy';
|
|
2
|
-
export type Value = {
|
|
3
|
-
/**
|
|
4
|
-
* Pinned order of facet lists.
|
|
5
|
-
*/
|
|
6
|
-
order?: string[];
|
|
7
|
-
sortRemainingBy?: SortRemainingBy;
|
|
8
|
-
};
|
|
1
|
+
import type { SortRemainingBy } from './sortRemainingBy';
|
|
2
|
+
export type Value = {
|
|
3
|
+
/**
|
|
4
|
+
* Pinned order of facet lists.
|
|
5
|
+
*/
|
|
6
|
+
order?: string[];
|
|
7
|
+
sortRemainingBy?: SortRemainingBy;
|
|
8
|
+
};
|
|
9
9
|
//# sourceMappingURL=value.d.ts.map
|