algoliasearch 5.9.1 → 5.10.0
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/README.md +5 -5
- package/dist/algoliasearch.umd.js +7 -7
- package/dist/browser.d.ts +5 -5
- package/dist/browser.js +3 -3
- package/dist/browser.js.map +1 -1
- package/dist/browser.min.js +1 -1
- package/dist/browser.min.js.map +1 -1
- package/dist/fetch.d.ts +5 -5
- package/dist/fetch.js +3 -3
- package/dist/fetch.js.map +1 -1
- package/dist/lite/browser.d.ts +7 -7
- package/dist/lite/builds/browser.js +1 -1
- package/dist/lite/builds/browser.js.map +1 -1
- package/dist/lite/builds/browser.min.js +1 -1
- package/dist/lite/builds/browser.min.js.map +1 -1
- package/dist/lite/builds/browser.umd.js +1 -1
- package/dist/lite/builds/node.cjs +1 -1
- package/dist/lite/builds/node.cjs.map +1 -1
- package/dist/lite/builds/node.js +1 -1
- package/dist/lite/builds/node.js.map +1 -1
- package/dist/lite/node.d.cts +7 -7
- package/dist/lite/node.d.ts +7 -7
- package/dist/lite/src/liteClient.cjs +1 -1
- package/dist/lite/src/liteClient.cjs.map +1 -1
- package/dist/lite/src/liteClient.js +1 -1
- package/dist/lite/src/liteClient.js.map +1 -1
- package/dist/node.cjs +3 -3
- package/dist/node.cjs.map +1 -1
- package/dist/node.d.cts +5 -5
- package/dist/node.d.ts +5 -5
- package/dist/node.js +3 -3
- package/dist/node.js.map +1 -1
- package/package.json +17 -19
- package/builds/browser.ts +0 -130
- package/builds/fetch.ts +0 -130
- package/builds/models.ts +0 -250
- package/builds/node.ts +0 -130
- package/lite/builds/browser.ts +0 -51
- package/lite/builds/node.ts +0 -47
- package/lite/model/acl.ts +0 -21
- package/lite/model/advancedSyntaxFeatures.ts +0 -3
- package/lite/model/alternativesAsExact.ts +0 -3
- package/lite/model/apiKey.ts +0 -48
- package/lite/model/aroundPrecision.ts +0 -8
- package/lite/model/aroundRadius.ts +0 -8
- package/lite/model/aroundRadiusAll.ts +0 -6
- package/lite/model/automaticFacetFilter.ts +0 -21
- package/lite/model/automaticFacetFilters.ts +0 -8
- package/lite/model/banner.ts +0 -13
- package/lite/model/bannerImage.ts +0 -12
- package/lite/model/bannerImageUrl.ts +0 -8
- package/lite/model/bannerLink.ts +0 -8
- package/lite/model/baseGetApiKeyResponse.ts +0 -13
- package/lite/model/baseIndexSettings.ts +0 -90
- package/lite/model/baseRecommendIndexSettings.ts +0 -184
- package/lite/model/baseRecommendRequest.ts +0 -22
- package/lite/model/baseRecommendSearchParams.ts +0 -133
- package/lite/model/baseSearchParams.ts +0 -6
- package/lite/model/baseSearchParamsWithoutQuery.ts +0 -148
- package/lite/model/baseSearchResponse.ts +0 -129
- package/lite/model/booleanString.ts +0 -3
- package/lite/model/boughtTogetherQuery.ts +0 -6
- package/lite/model/browsePagination.ts +0 -23
- package/lite/model/browseParamsObject.ts +0 -6
- package/lite/model/browseResponse.ts +0 -8
- package/lite/model/clientMethodProps.ts +0 -63
- package/lite/model/consequenceParams.ts +0 -7
- package/lite/model/consequenceQuery.ts +0 -8
- package/lite/model/consequenceQueryObject.ts +0 -15
- package/lite/model/cursor.ts +0 -8
- package/lite/model/distinct.ts +0 -6
- package/lite/model/edit.ts +0 -17
- package/lite/model/editType.ts +0 -6
- package/lite/model/errorBase.ts +0 -8
- package/lite/model/exactOnSingleWordQuery.ts +0 -6
- package/lite/model/exhaustive.ts +0 -31
- package/lite/model/facetFilters.ts +0 -6
- package/lite/model/facetHits.ts +0 -18
- package/lite/model/facetOrdering.ts +0 -16
- package/lite/model/facetStats.ts +0 -23
- package/lite/model/fallbackParams.ts +0 -5
- package/lite/model/fbtModel.ts +0 -6
- package/lite/model/frequentlyBoughtTogether.ts +0 -12
- package/lite/model/getApiKeyResponse.ts +0 -6
- package/lite/model/getRecommendationsParams.ts +0 -13
- package/lite/model/getRecommendationsResponse.ts +0 -7
- package/lite/model/highlightResult.ts +0 -5
- package/lite/model/highlightResultOption.ts +0 -25
- package/lite/model/hit.ts +0 -29
- package/lite/model/ignorePlurals.ts +0 -9
- package/lite/model/index.ts +0 -128
- package/lite/model/indexSettings.ts +0 -9
- package/lite/model/indexSettingsAsSearchParams.ts +0 -205
- package/lite/model/indexSettingsFacets.ts +0 -11
- package/lite/model/lookingSimilar.ts +0 -15
- package/lite/model/lookingSimilarModel.ts +0 -6
- package/lite/model/lookingSimilarQuery.ts +0 -6
- package/lite/model/matchLevel.ts +0 -6
- package/lite/model/matchedGeoLocation.ts +0 -18
- package/lite/model/mode.ts +0 -6
- package/lite/model/numericFilters.ts +0 -6
- package/lite/model/optionalFilters.ts +0 -6
- package/lite/model/params.ts +0 -18
- package/lite/model/personalization.ts +0 -18
- package/lite/model/queryType.ts +0 -6
- package/lite/model/range.ts +0 -16
- package/lite/model/rankingInfo.ts +0 -68
- package/lite/model/reRankingApplyFilter.ts +0 -6
- package/lite/model/recommendHit.ts +0 -34
- package/lite/model/recommendIndexSettings.ts +0 -9
- package/lite/model/recommendSearchParams.ts +0 -10
- package/lite/model/recommendationsHit.ts +0 -7
- package/lite/model/recommendationsHits.ts +0 -7
- package/lite/model/recommendationsRequest.ts +0 -18
- package/lite/model/recommendationsResults.ts +0 -7
- package/lite/model/recommendedForYou.ts +0 -10
- package/lite/model/recommendedForYouModel.ts +0 -6
- package/lite/model/recommendedForYouQuery.ts +0 -6
- package/lite/model/redirect.ts +0 -10
- package/lite/model/redirectRuleIndexData.ts +0 -8
- package/lite/model/redirectRuleIndexMetadata.ts +0 -27
- package/lite/model/redirectURL.ts +0 -8
- package/lite/model/relatedModel.ts +0 -6
- package/lite/model/relatedProducts.ts +0 -15
- package/lite/model/relatedQuery.ts +0 -6
- package/lite/model/removeStopWords.ts +0 -8
- package/lite/model/removeWordsIfNoResults.ts +0 -6
- package/lite/model/renderingContent.ts +0 -16
- package/lite/model/searchForFacetValuesResponse.ts +0 -20
- package/lite/model/searchForFacets.ts +0 -6
- package/lite/model/searchForFacetsOptions.ts +0 -27
- package/lite/model/searchForHits.ts +0 -6
- package/lite/model/searchForHitsOptions.ts +0 -12
- package/lite/model/searchHits.ts +0 -20
- package/lite/model/searchMethodParams.ts +0 -10
- package/lite/model/searchPagination.ts +0 -23
- package/lite/model/searchParams.ts +0 -6
- package/lite/model/searchParamsObject.ts +0 -9
- package/lite/model/searchParamsQuery.ts +0 -8
- package/lite/model/searchParamsString.ts +0 -11
- package/lite/model/searchQuery.ts +0 -6
- package/lite/model/searchResponse.ts +0 -7
- package/lite/model/searchResponses.ts +0 -7
- package/lite/model/searchResult.ts +0 -6
- package/lite/model/searchStrategy.ts +0 -6
- package/lite/model/searchTypeDefault.ts +0 -6
- package/lite/model/searchTypeFacet.ts +0 -6
- package/lite/model/semanticSearch.ts +0 -11
- package/lite/model/settingsResponse.ts +0 -6
- package/lite/model/snippetResult.ts +0 -5
- package/lite/model/snippetResultOption.ts +0 -15
- package/lite/model/sortRemainingBy.ts +0 -6
- package/lite/model/supportedLanguage.ts +0 -74
- package/lite/model/tagFilters.ts +0 -6
- package/lite/model/trendingFacetHit.ts +0 -21
- package/lite/model/trendingFacets.ts +0 -15
- package/lite/model/trendingFacetsModel.ts +0 -6
- package/lite/model/trendingFacetsQuery.ts +0 -6
- package/lite/model/trendingItems.ts +0 -20
- package/lite/model/trendingItemsModel.ts +0 -6
- package/lite/model/trendingItemsQuery.ts +0 -6
- package/lite/model/typoTolerance.ts +0 -8
- package/lite/model/typoToleranceEnum.ts +0 -6
- package/lite/model/value.ts +0 -17
- package/lite/model/widgets.ts +0 -13
- package/lite/model/withPrimary.ts +0 -8
- package/lite/src/liteClient.ts +0 -305
- package/lite/tsconfig.json +0 -9
|
@@ -1,18 +0,0 @@
|
|
|
1
|
-
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
-
|
|
3
|
-
export type MatchedGeoLocation = {
|
|
4
|
-
/**
|
|
5
|
-
* Latitude of the matched location.
|
|
6
|
-
*/
|
|
7
|
-
lat?: number;
|
|
8
|
-
|
|
9
|
-
/**
|
|
10
|
-
* Longitude of the matched location.
|
|
11
|
-
*/
|
|
12
|
-
lng?: number;
|
|
13
|
-
|
|
14
|
-
/**
|
|
15
|
-
* Distance between the matched location and the search location (in meters).
|
|
16
|
-
*/
|
|
17
|
-
distance?: number;
|
|
18
|
-
};
|
package/lite/model/mode.ts
DELETED
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
-
|
|
3
|
-
/**
|
|
4
|
-
* Search mode the index will use to query for results. This setting only applies to indices, for which Algolia enabled NeuralSearch for you.
|
|
5
|
-
*/
|
|
6
|
-
export type Mode = 'neuralSearch' | 'keywordSearch';
|
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
-
|
|
3
|
-
/**
|
|
4
|
-
* Filter by numeric facets. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** You can use numeric comparison operators: `<`, `<=`, `=`, `!=`, `>`, `>=`. Comparisons are precise up to 3 decimals. You can also provide ranges: `facet:<lower> TO <upper>`. The range includes the lower and upper boundaries. The same combination rules apply as for `facetFilters`.
|
|
5
|
-
*/
|
|
6
|
-
export type NumericFilters = Array<NumericFilters> | string;
|
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
-
|
|
3
|
-
/**
|
|
4
|
-
* Filters to promote or demote records in the search results. Optional filters work like facet filters, but they don\'t exclude records from the search results. Records that match the optional filter rank before records that don\'t match. If you\'re using a negative filter `facet:-value`, matching records rank after records that don\'t match. - Optional filters don\'t work on virtual replicas. - Optional filters are applied _after_ sort-by attributes. - Optional filters don\'t work with numeric attributes.
|
|
5
|
-
*/
|
|
6
|
-
export type OptionalFilters = Array<OptionalFilters> | string;
|
package/lite/model/params.ts
DELETED
|
@@ -1,18 +0,0 @@
|
|
|
1
|
-
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
-
|
|
3
|
-
import type { AutomaticFacetFilters } from './automaticFacetFilters';
|
|
4
|
-
import type { ConsequenceQuery } from './consequenceQuery';
|
|
5
|
-
import type { RenderingContent } from './renderingContent';
|
|
6
|
-
|
|
7
|
-
/**
|
|
8
|
-
* Parameters to apply to this search. You can use all search parameters, plus special `automaticFacetFilters`, `automaticOptionalFacetFilters`, and `query`.
|
|
9
|
-
*/
|
|
10
|
-
export type Params = {
|
|
11
|
-
query?: ConsequenceQuery;
|
|
12
|
-
|
|
13
|
-
automaticFacetFilters?: AutomaticFacetFilters;
|
|
14
|
-
|
|
15
|
-
automaticOptionalFacetFilters?: AutomaticFacetFilters;
|
|
16
|
-
|
|
17
|
-
renderingContent?: RenderingContent;
|
|
18
|
-
};
|
|
@@ -1,18 +0,0 @@
|
|
|
1
|
-
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
-
|
|
3
|
-
export type Personalization = {
|
|
4
|
-
/**
|
|
5
|
-
* The score of the filters.
|
|
6
|
-
*/
|
|
7
|
-
filtersScore?: number;
|
|
8
|
-
|
|
9
|
-
/**
|
|
10
|
-
* The score of the ranking.
|
|
11
|
-
*/
|
|
12
|
-
rankingScore?: number;
|
|
13
|
-
|
|
14
|
-
/**
|
|
15
|
-
* The score of the event.
|
|
16
|
-
*/
|
|
17
|
-
score?: number;
|
|
18
|
-
};
|
package/lite/model/queryType.ts
DELETED
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
-
|
|
3
|
-
/**
|
|
4
|
-
* Determines if and how query words are interpreted as prefixes. By default, only the last query word is treated as a prefix (`prefixLast`). To turn off prefix search, use `prefixNone`. Avoid `prefixAll`, which treats all query words as prefixes. This might lead to counterintuitive results and makes your search slower. For more information, see [Prefix searching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/prefix-searching/).
|
|
5
|
-
*/
|
|
6
|
-
export type QueryType = 'prefixLast' | 'prefixAll' | 'prefixNone';
|
package/lite/model/range.ts
DELETED
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
-
|
|
3
|
-
/**
|
|
4
|
-
* Range object with lower and upper values in meters to define custom ranges.
|
|
5
|
-
*/
|
|
6
|
-
export type Range = {
|
|
7
|
-
/**
|
|
8
|
-
* Lower boundary of a range in meters. The Geo ranking criterion considers all records within the range to be equal.
|
|
9
|
-
*/
|
|
10
|
-
from?: number;
|
|
11
|
-
|
|
12
|
-
/**
|
|
13
|
-
* Upper boundary of a range in meters. The Geo ranking criterion considers all records within the range to be equal.
|
|
14
|
-
*/
|
|
15
|
-
value?: number;
|
|
16
|
-
};
|
|
@@ -1,68 +0,0 @@
|
|
|
1
|
-
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
-
|
|
3
|
-
import type { MatchedGeoLocation } from './matchedGeoLocation';
|
|
4
|
-
import type { Personalization } from './personalization';
|
|
5
|
-
|
|
6
|
-
/**
|
|
7
|
-
* Object with detailed information about the record\'s ranking.
|
|
8
|
-
*/
|
|
9
|
-
export type RankingInfo = {
|
|
10
|
-
/**
|
|
11
|
-
* Whether a filter matched the query.
|
|
12
|
-
*/
|
|
13
|
-
filters?: number;
|
|
14
|
-
|
|
15
|
-
/**
|
|
16
|
-
* Position of the first matched word in the best matching attribute of the record.
|
|
17
|
-
*/
|
|
18
|
-
firstMatchedWord: number;
|
|
19
|
-
|
|
20
|
-
/**
|
|
21
|
-
* Distance between the geo location in the search query and the best matching geo location in the record, divided by the geo precision (in meters).
|
|
22
|
-
*/
|
|
23
|
-
geoDistance: number;
|
|
24
|
-
|
|
25
|
-
/**
|
|
26
|
-
* Precision used when computing the geo distance, in meters.
|
|
27
|
-
*/
|
|
28
|
-
geoPrecision?: number;
|
|
29
|
-
|
|
30
|
-
matchedGeoLocation?: MatchedGeoLocation;
|
|
31
|
-
|
|
32
|
-
personalization?: Personalization;
|
|
33
|
-
|
|
34
|
-
/**
|
|
35
|
-
* Number of exactly matched words.
|
|
36
|
-
*/
|
|
37
|
-
nbExactWords: number;
|
|
38
|
-
|
|
39
|
-
/**
|
|
40
|
-
* Number of typos encountered when matching the record.
|
|
41
|
-
*/
|
|
42
|
-
nbTypos: number;
|
|
43
|
-
|
|
44
|
-
/**
|
|
45
|
-
* Whether the record was promoted by a rule.
|
|
46
|
-
*/
|
|
47
|
-
promoted?: boolean;
|
|
48
|
-
|
|
49
|
-
/**
|
|
50
|
-
* Number of words between multiple matches in the query plus 1. For single word queries, `proximityDistance` is 0.
|
|
51
|
-
*/
|
|
52
|
-
proximityDistance?: number;
|
|
53
|
-
|
|
54
|
-
/**
|
|
55
|
-
* Overall ranking of the record, expressed as a single integer. This attribute is internal.
|
|
56
|
-
*/
|
|
57
|
-
userScore: number;
|
|
58
|
-
|
|
59
|
-
/**
|
|
60
|
-
* Number of matched words.
|
|
61
|
-
*/
|
|
62
|
-
words?: number;
|
|
63
|
-
|
|
64
|
-
/**
|
|
65
|
-
* Whether the record is re-ranked.
|
|
66
|
-
*/
|
|
67
|
-
promotedByReRanking?: boolean;
|
|
68
|
-
};
|
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
-
|
|
3
|
-
/**
|
|
4
|
-
* Restrict [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) to records that match these filters.
|
|
5
|
-
*/
|
|
6
|
-
export type ReRankingApplyFilter = Array<ReRankingApplyFilter> | string;
|
|
@@ -1,34 +0,0 @@
|
|
|
1
|
-
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
-
|
|
3
|
-
import type { HighlightResult } from './highlightResult';
|
|
4
|
-
import type { RankingInfo } from './rankingInfo';
|
|
5
|
-
import type { SnippetResult } from './snippetResult';
|
|
6
|
-
|
|
7
|
-
/**
|
|
8
|
-
* Recommend hit.
|
|
9
|
-
*/
|
|
10
|
-
export type RecommendHit = Record<string, any> & {
|
|
11
|
-
/**
|
|
12
|
-
* Unique record identifier.
|
|
13
|
-
*/
|
|
14
|
-
objectID: string;
|
|
15
|
-
|
|
16
|
-
/**
|
|
17
|
-
* Surround words that match the query with HTML tags for highlighting.
|
|
18
|
-
*/
|
|
19
|
-
_highlightResult?: { [key: string]: HighlightResult };
|
|
20
|
-
|
|
21
|
-
/**
|
|
22
|
-
* Snippets that show the context around a matching search query.
|
|
23
|
-
*/
|
|
24
|
-
_snippetResult?: { [key: string]: SnippetResult };
|
|
25
|
-
|
|
26
|
-
_rankingInfo?: RankingInfo;
|
|
27
|
-
|
|
28
|
-
_distinctSeqID?: number;
|
|
29
|
-
|
|
30
|
-
/**
|
|
31
|
-
* Recommendation score.
|
|
32
|
-
*/
|
|
33
|
-
_score?: number;
|
|
34
|
-
};
|
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
-
|
|
3
|
-
import type { BaseIndexSettings } from './baseIndexSettings';
|
|
4
|
-
import type { BaseRecommendIndexSettings } from './baseRecommendIndexSettings';
|
|
5
|
-
|
|
6
|
-
/**
|
|
7
|
-
* Index settings.
|
|
8
|
-
*/
|
|
9
|
-
export type RecommendIndexSettings = BaseIndexSettings & BaseRecommendIndexSettings;
|
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
-
|
|
3
|
-
import type { BaseRecommendSearchParams } from './baseRecommendSearchParams';
|
|
4
|
-
import type { RecommendIndexSettings } from './recommendIndexSettings';
|
|
5
|
-
import type { SearchParamsQuery } from './searchParamsQuery';
|
|
6
|
-
|
|
7
|
-
/**
|
|
8
|
-
* Search parameters for filtering the recommendations.
|
|
9
|
-
*/
|
|
10
|
-
export type RecommendSearchParams = BaseRecommendSearchParams & SearchParamsQuery & RecommendIndexSettings;
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
-
|
|
3
|
-
import type { RecommendHit } from './recommendHit';
|
|
4
|
-
|
|
5
|
-
import type { TrendingFacetHit } from './trendingFacetHit';
|
|
6
|
-
|
|
7
|
-
export type RecommendationsHit = RecommendHit | TrendingFacetHit;
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
-
|
|
3
|
-
import type { RecommendationsHit } from './recommendationsHit';
|
|
4
|
-
|
|
5
|
-
export type RecommendationsHits = {
|
|
6
|
-
hits: Array<RecommendationsHit>;
|
|
7
|
-
};
|
|
@@ -1,18 +0,0 @@
|
|
|
1
|
-
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
-
|
|
3
|
-
import type { BoughtTogetherQuery } from './boughtTogetherQuery';
|
|
4
|
-
|
|
5
|
-
import type { LookingSimilarQuery } from './lookingSimilarQuery';
|
|
6
|
-
|
|
7
|
-
import type { RecommendedForYouQuery } from './recommendedForYouQuery';
|
|
8
|
-
import type { RelatedQuery } from './relatedQuery';
|
|
9
|
-
import type { TrendingFacetsQuery } from './trendingFacetsQuery';
|
|
10
|
-
import type { TrendingItemsQuery } from './trendingItemsQuery';
|
|
11
|
-
|
|
12
|
-
export type RecommendationsRequest =
|
|
13
|
-
| BoughtTogetherQuery
|
|
14
|
-
| RelatedQuery
|
|
15
|
-
| TrendingItemsQuery
|
|
16
|
-
| TrendingFacetsQuery
|
|
17
|
-
| LookingSimilarQuery
|
|
18
|
-
| RecommendedForYouQuery;
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
-
|
|
3
|
-
import type { BaseSearchResponse } from './baseSearchResponse';
|
|
4
|
-
import type { RecommendationsHits } from './recommendationsHits';
|
|
5
|
-
import type { SearchPagination } from './searchPagination';
|
|
6
|
-
|
|
7
|
-
export type RecommendationsResults = BaseSearchResponse & SearchPagination & RecommendationsHits;
|
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
-
|
|
3
|
-
import type { FallbackParams } from './fallbackParams';
|
|
4
|
-
import type { RecommendedForYouModel } from './recommendedForYouModel';
|
|
5
|
-
|
|
6
|
-
export type RecommendedForYou = {
|
|
7
|
-
model: RecommendedForYouModel;
|
|
8
|
-
|
|
9
|
-
fallbackParameters?: FallbackParams;
|
|
10
|
-
};
|
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
-
|
|
3
|
-
/**
|
|
4
|
-
* \"Recommened for you\" model.
|
|
5
|
-
*/
|
|
6
|
-
export type RecommendedForYouModel = 'recommended-for-you';
|
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
-
|
|
3
|
-
import type { BaseRecommendRequest } from './baseRecommendRequest';
|
|
4
|
-
import type { RecommendedForYou } from './recommendedForYou';
|
|
5
|
-
|
|
6
|
-
export type RecommendedForYouQuery = BaseRecommendRequest & RecommendedForYou;
|
package/lite/model/redirect.ts
DELETED
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
-
|
|
3
|
-
import type { RedirectRuleIndexMetadata } from './redirectRuleIndexMetadata';
|
|
4
|
-
|
|
5
|
-
/**
|
|
6
|
-
* [Redirect results to a URL](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/redirects/), this this parameter is for internal use only.
|
|
7
|
-
*/
|
|
8
|
-
export type Redirect = {
|
|
9
|
-
index?: Array<RedirectRuleIndexMetadata>;
|
|
10
|
-
};
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
-
|
|
3
|
-
/**
|
|
4
|
-
* Redirect rule data.
|
|
5
|
-
*/
|
|
6
|
-
export type RedirectRuleIndexData = {
|
|
7
|
-
ruleObjectID: string;
|
|
8
|
-
};
|
|
@@ -1,27 +0,0 @@
|
|
|
1
|
-
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
-
|
|
3
|
-
import type { RedirectRuleIndexData } from './redirectRuleIndexData';
|
|
4
|
-
|
|
5
|
-
export type RedirectRuleIndexMetadata = {
|
|
6
|
-
/**
|
|
7
|
-
* Source index for the redirect rule.
|
|
8
|
-
*/
|
|
9
|
-
source: string;
|
|
10
|
-
|
|
11
|
-
/**
|
|
12
|
-
* Destination index for the redirect rule.
|
|
13
|
-
*/
|
|
14
|
-
dest: string;
|
|
15
|
-
|
|
16
|
-
/**
|
|
17
|
-
* Reason for the redirect rule.
|
|
18
|
-
*/
|
|
19
|
-
reason: string;
|
|
20
|
-
|
|
21
|
-
/**
|
|
22
|
-
* Redirect rule status.
|
|
23
|
-
*/
|
|
24
|
-
succeed: boolean;
|
|
25
|
-
|
|
26
|
-
data: RedirectRuleIndexData;
|
|
27
|
-
};
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
-
|
|
3
|
-
/**
|
|
4
|
-
* The redirect rule container.
|
|
5
|
-
*/
|
|
6
|
-
export type RedirectURL = {
|
|
7
|
-
url?: string;
|
|
8
|
-
};
|
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
-
|
|
3
|
-
/**
|
|
4
|
-
* Related products or similar content model. This model recommends items that are similar to the item with the ID `objectID`. Similarity is determined from the user interactions and attributes.
|
|
5
|
-
*/
|
|
6
|
-
export type RelatedModel = 'related-products';
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
-
|
|
3
|
-
import type { FallbackParams } from './fallbackParams';
|
|
4
|
-
import type { RelatedModel } from './relatedModel';
|
|
5
|
-
|
|
6
|
-
export type RelatedProducts = {
|
|
7
|
-
model: RelatedModel;
|
|
8
|
-
|
|
9
|
-
/**
|
|
10
|
-
* Unique record identifier.
|
|
11
|
-
*/
|
|
12
|
-
objectID: string;
|
|
13
|
-
|
|
14
|
-
fallbackParameters?: FallbackParams;
|
|
15
|
-
};
|
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
-
|
|
3
|
-
import type { BaseRecommendRequest } from './baseRecommendRequest';
|
|
4
|
-
import type { RelatedProducts } from './relatedProducts';
|
|
5
|
-
|
|
6
|
-
export type RelatedQuery = BaseRecommendRequest & RelatedProducts;
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
-
|
|
3
|
-
import type { SupportedLanguage } from './supportedLanguage';
|
|
4
|
-
|
|
5
|
-
/**
|
|
6
|
-
* Removes stop words from the search query. Stop words are common words like articles, conjunctions, prepositions, or pronouns that have little or no meaning on their own. In English, \"the\", \"a\", or \"and\" are stop words. You should only use this feature for the languages used in your index.
|
|
7
|
-
*/
|
|
8
|
-
export type RemoveStopWords = Array<SupportedLanguage> | boolean;
|
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
-
|
|
3
|
-
/**
|
|
4
|
-
* Strategy for removing words from the query when it doesn\'t return any results. This helps to avoid returning empty search results. - `none`. No words are removed when a query doesn\'t return results. - `lastWords`. Treat the last (then second to last, then third to last) word as optional, until there are results or at most 5 words have been removed. - `firstWords`. Treat the first (then second, then third) word as optional, until there are results or at most 5 words have been removed. - `allOptional`. Treat all words as optional. For more information, see [Remove words to improve results](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/in-depth/why-use-remove-words-if-no-results/).
|
|
5
|
-
*/
|
|
6
|
-
export type RemoveWordsIfNoResults = 'none' | 'lastWords' | 'firstWords' | 'allOptional';
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
-
|
|
3
|
-
import type { FacetOrdering } from './facetOrdering';
|
|
4
|
-
import type { RedirectURL } from './redirectURL';
|
|
5
|
-
import type { Widgets } from './widgets';
|
|
6
|
-
|
|
7
|
-
/**
|
|
8
|
-
* Extra data that can be used in the search UI. You can use this to control aspects of your search UI, such as the order of facet names and values without changing your frontend code.
|
|
9
|
-
*/
|
|
10
|
-
export type RenderingContent = {
|
|
11
|
-
facetOrdering?: FacetOrdering;
|
|
12
|
-
|
|
13
|
-
redirect?: RedirectURL;
|
|
14
|
-
|
|
15
|
-
widgets?: Widgets;
|
|
16
|
-
};
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
-
|
|
3
|
-
import type { FacetHits } from './facetHits';
|
|
4
|
-
|
|
5
|
-
export type SearchForFacetValuesResponse = {
|
|
6
|
-
/**
|
|
7
|
-
* Matching facet values.
|
|
8
|
-
*/
|
|
9
|
-
facetHits: Array<FacetHits>;
|
|
10
|
-
|
|
11
|
-
/**
|
|
12
|
-
* Whether the facet count is exhaustive (true) or approximate (false). For more information, see [Why are my facet and hit counts not accurate](https://support.algolia.com/hc/en-us/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate-).
|
|
13
|
-
*/
|
|
14
|
-
exhaustiveFacetsCount: boolean;
|
|
15
|
-
|
|
16
|
-
/**
|
|
17
|
-
* Time the server took to process the request, in milliseconds.
|
|
18
|
-
*/
|
|
19
|
-
processingTimeMS?: number;
|
|
20
|
-
};
|
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
-
|
|
3
|
-
import type { SearchForFacetsOptions } from './searchForFacetsOptions';
|
|
4
|
-
import type { SearchParams } from './searchParams';
|
|
5
|
-
|
|
6
|
-
export type SearchForFacets = SearchParams & SearchForFacetsOptions;
|
|
@@ -1,27 +0,0 @@
|
|
|
1
|
-
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
-
|
|
3
|
-
import type { SearchTypeFacet } from './searchTypeFacet';
|
|
4
|
-
|
|
5
|
-
export type SearchForFacetsOptions = {
|
|
6
|
-
/**
|
|
7
|
-
* Facet name.
|
|
8
|
-
*/
|
|
9
|
-
facet: string;
|
|
10
|
-
|
|
11
|
-
/**
|
|
12
|
-
* Index name (case-sensitive).
|
|
13
|
-
*/
|
|
14
|
-
indexName: string;
|
|
15
|
-
|
|
16
|
-
/**
|
|
17
|
-
* Text to search inside the facet\'s values.
|
|
18
|
-
*/
|
|
19
|
-
facetQuery?: string;
|
|
20
|
-
|
|
21
|
-
/**
|
|
22
|
-
* Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
|
|
23
|
-
*/
|
|
24
|
-
maxFacetHits?: number;
|
|
25
|
-
|
|
26
|
-
type: SearchTypeFacet;
|
|
27
|
-
};
|
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
-
|
|
3
|
-
import type { SearchForHitsOptions } from './searchForHitsOptions';
|
|
4
|
-
import type { SearchParams } from './searchParams';
|
|
5
|
-
|
|
6
|
-
export type SearchForHits = SearchParams & SearchForHitsOptions;
|
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
-
|
|
3
|
-
import type { SearchTypeDefault } from './searchTypeDefault';
|
|
4
|
-
|
|
5
|
-
export type SearchForHitsOptions = {
|
|
6
|
-
/**
|
|
7
|
-
* Index name (case-sensitive).
|
|
8
|
-
*/
|
|
9
|
-
indexName: string;
|
|
10
|
-
|
|
11
|
-
type?: SearchTypeDefault;
|
|
12
|
-
} & { facet?: never; maxFacetHits?: never; facetQuery?: never };
|
package/lite/model/searchHits.ts
DELETED
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
-
|
|
3
|
-
import type { Hit } from './hit';
|
|
4
|
-
|
|
5
|
-
export type SearchHits<T = Record<string, any>> = Record<string, any> & {
|
|
6
|
-
/**
|
|
7
|
-
* Search results (hits). Hits are records from your index that match the search criteria, augmented with additional attributes, such as, for highlighting.
|
|
8
|
-
*/
|
|
9
|
-
hits: Hit<T>[];
|
|
10
|
-
|
|
11
|
-
/**
|
|
12
|
-
* Search query.
|
|
13
|
-
*/
|
|
14
|
-
query: string;
|
|
15
|
-
|
|
16
|
-
/**
|
|
17
|
-
* URL-encoded string of all search parameters.
|
|
18
|
-
*/
|
|
19
|
-
params: string;
|
|
20
|
-
};
|
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
-
|
|
3
|
-
import type { SearchQuery } from './searchQuery';
|
|
4
|
-
import type { SearchStrategy } from './searchStrategy';
|
|
5
|
-
|
|
6
|
-
export type SearchMethodParams = {
|
|
7
|
-
requests: Array<SearchQuery>;
|
|
8
|
-
|
|
9
|
-
strategy?: SearchStrategy;
|
|
10
|
-
};
|
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
-
|
|
3
|
-
export type SearchPagination = {
|
|
4
|
-
/**
|
|
5
|
-
* Page of search results to retrieve.
|
|
6
|
-
*/
|
|
7
|
-
page?: number;
|
|
8
|
-
|
|
9
|
-
/**
|
|
10
|
-
* Number of results (hits).
|
|
11
|
-
*/
|
|
12
|
-
nbHits?: number;
|
|
13
|
-
|
|
14
|
-
/**
|
|
15
|
-
* Number of pages of results.
|
|
16
|
-
*/
|
|
17
|
-
nbPages?: number;
|
|
18
|
-
|
|
19
|
-
/**
|
|
20
|
-
* Number of hits per page.
|
|
21
|
-
*/
|
|
22
|
-
hitsPerPage?: number;
|
|
23
|
-
};
|
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
-
|
|
3
|
-
import type { SearchParamsObject } from './searchParamsObject';
|
|
4
|
-
import type { SearchParamsString } from './searchParamsString';
|
|
5
|
-
|
|
6
|
-
export type SearchParams = SearchParamsString | SearchParamsObject;
|
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
-
|
|
3
|
-
import type { BaseSearchParams } from './baseSearchParams';
|
|
4
|
-
import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';
|
|
5
|
-
|
|
6
|
-
/**
|
|
7
|
-
* Each parameter value, including the `query` must not be larger than 512 bytes.
|
|
8
|
-
*/
|
|
9
|
-
export type SearchParamsObject = BaseSearchParams & IndexSettingsAsSearchParams;
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
-
|
|
3
|
-
export type SearchParamsQuery = {
|
|
4
|
-
/**
|
|
5
|
-
* Search query.
|
|
6
|
-
*/
|
|
7
|
-
query?: string;
|
|
8
|
-
};
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
-
|
|
3
|
-
/**
|
|
4
|
-
* Search parameters as query string.
|
|
5
|
-
*/
|
|
6
|
-
export type SearchParamsString = {
|
|
7
|
-
/**
|
|
8
|
-
* Search parameters as a URL-encoded query string.
|
|
9
|
-
*/
|
|
10
|
-
params?: string;
|
|
11
|
-
};
|
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
-
|
|
3
|
-
import type { SearchForFacets } from './searchForFacets';
|
|
4
|
-
import type { SearchForHits } from './searchForHits';
|
|
5
|
-
|
|
6
|
-
export type SearchQuery = SearchForHits | SearchForFacets;
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
-
|
|
3
|
-
import type { BaseSearchResponse } from './baseSearchResponse';
|
|
4
|
-
import type { SearchHits } from './searchHits';
|
|
5
|
-
import type { SearchPagination } from './searchPagination';
|
|
6
|
-
|
|
7
|
-
export type SearchResponse<T = Record<string, any>> = BaseSearchResponse & SearchPagination & SearchHits<T>;
|