@algolia/client-search 5.8.0 → 5.9.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 +4 -4
- package/dist/browser.d.ts +20 -20
- package/dist/builds/browser.js +3 -2
- package/dist/builds/browser.js.map +1 -1
- package/dist/builds/browser.min.js +1 -1
- package/dist/builds/browser.min.js.map +1 -1
- package/dist/builds/browser.umd.js +2 -2
- package/dist/builds/fetch.js +3 -2
- package/dist/builds/fetch.js.map +1 -1
- package/dist/builds/node.cjs +3 -2
- package/dist/builds/node.cjs.map +1 -1
- package/dist/builds/node.js +3 -2
- package/dist/builds/node.js.map +1 -1
- package/dist/fetch.d.ts +20 -20
- package/dist/node.d.cts +20 -20
- package/dist/node.d.ts +20 -20
- package/dist/src/searchClient.cjs +3 -2
- package/dist/src/searchClient.cjs.map +1 -1
- package/dist/src/searchClient.js +3 -2
- package/dist/src/searchClient.js.map +1 -1
- package/index.d.ts +0 -1
- package/index.js +0 -1
- package/model/bannerImage.ts +1 -1
- package/model/baseGetApiKeyResponse.ts +1 -1
- package/model/baseIndexSettings.ts +2 -2
- package/model/baseSearchResponse.ts +5 -0
- package/model/getObjectsResponse.ts +1 -1
- package/model/index.ts +0 -1
- package/model/indexSettingsAsSearchParams.ts +1 -1
- package/model/searchDictionaryEntriesResponse.ts +1 -1
- package/model/searchRulesParams.ts +2 -2
- package/model/searchUserIdsResponse.ts +1 -1
- package/model/widgets.ts +5 -2
- package/package.json +7 -7
- package/model/banners.ts +0 -10
package/dist/fetch.d.ts
CHANGED
|
@@ -227,7 +227,7 @@ type BannerImageUrl = {
|
|
|
227
227
|
* image of a search banner.
|
|
228
228
|
*/
|
|
229
229
|
type BannerImage = {
|
|
230
|
-
urls?: BannerImageUrl
|
|
230
|
+
urls?: Array<BannerImageUrl>;
|
|
231
231
|
title?: string;
|
|
232
232
|
};
|
|
233
233
|
|
|
@@ -246,18 +246,14 @@ type Banner = {
|
|
|
246
246
|
link?: BannerLink;
|
|
247
247
|
};
|
|
248
248
|
|
|
249
|
-
/**
|
|
250
|
-
* banners defined in the merchandising studio for the given search.
|
|
251
|
-
*/
|
|
252
|
-
type Banners = {
|
|
253
|
-
banners?: Banner;
|
|
254
|
-
};
|
|
255
|
-
|
|
256
249
|
/**
|
|
257
250
|
* widgets returned from any rules that are applied to the current search.
|
|
258
251
|
*/
|
|
259
252
|
type Widgets = {
|
|
260
|
-
|
|
253
|
+
/**
|
|
254
|
+
* banners defined in the merchandising studio for the given search.
|
|
255
|
+
*/
|
|
256
|
+
banners?: Array<Banner>;
|
|
261
257
|
};
|
|
262
258
|
|
|
263
259
|
/**
|
|
@@ -287,6 +283,10 @@ type BaseSearchResponse = Record<string, any> & {
|
|
|
287
283
|
*/
|
|
288
284
|
automaticRadius?: string;
|
|
289
285
|
exhaustive?: Exhaustive;
|
|
286
|
+
/**
|
|
287
|
+
* Rules applied to the query.
|
|
288
|
+
*/
|
|
289
|
+
appliedRules?: Array<Record<string, unknown>>;
|
|
290
290
|
/**
|
|
291
291
|
* See the `facetsCount` field of the `exhaustive` object in the response.
|
|
292
292
|
*/
|
|
@@ -634,7 +634,7 @@ type BaseGetApiKeyResponse = {
|
|
|
634
634
|
/**
|
|
635
635
|
* API key.
|
|
636
636
|
*/
|
|
637
|
-
value
|
|
637
|
+
value: string;
|
|
638
638
|
/**
|
|
639
639
|
* Timestamp when the object was created, in milliseconds since the Unix epoch.
|
|
640
640
|
*/
|
|
@@ -758,7 +758,7 @@ type GetObjectsResponse<T = Record<string, any>> = {
|
|
|
758
758
|
/**
|
|
759
759
|
* Retrieved records.
|
|
760
760
|
*/
|
|
761
|
-
results
|
|
761
|
+
results?: T[];
|
|
762
762
|
};
|
|
763
763
|
|
|
764
764
|
/**
|
|
@@ -1341,7 +1341,7 @@ type IndexSettingsAsSearchParams = {
|
|
|
1341
1341
|
disableExactOnAttributes?: Array<string>;
|
|
1342
1342
|
exactOnSingleWordQuery?: ExactOnSingleWordQuery;
|
|
1343
1343
|
/**
|
|
1344
|
-
*
|
|
1344
|
+
* Determine which plurals and synonyms should be considered an exact matches. By default, Algolia treats singular and plural forms of a word, and single-word synonyms, as [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact) matches when searching. For example: - \"swimsuit\" and \"swimsuits\" are treated the same - \"swimsuit\" and \"swimwear\" are treated the same (if they are [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)). - `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY\" = \"NYC\", are considered exact matches. - `multiWordsSynonym`. Multi-word synonyms, such as \"NY\" = \"New York\", are considered exact matches.
|
|
1345
1345
|
*/
|
|
1346
1346
|
alternativesAsExact?: Array<AlternativesAsExact>;
|
|
1347
1347
|
/**
|
|
@@ -1615,7 +1615,7 @@ type SearchDictionaryEntriesResponse = {
|
|
|
1615
1615
|
*/
|
|
1616
1616
|
hits: Array<DictionaryEntry>;
|
|
1617
1617
|
/**
|
|
1618
|
-
* Requested page of the API response.
|
|
1618
|
+
* Requested page of the API response. Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)). - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on. For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.
|
|
1619
1619
|
*/
|
|
1620
1620
|
page: number;
|
|
1621
1621
|
/**
|
|
@@ -1907,7 +1907,7 @@ type SearchUserIdsResponse = {
|
|
|
1907
1907
|
*/
|
|
1908
1908
|
page: number;
|
|
1909
1909
|
/**
|
|
1910
|
-
* Maximum number of hits per page.
|
|
1910
|
+
* Maximum number of hits per page. Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)). - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on. For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.
|
|
1911
1911
|
*/
|
|
1912
1912
|
hitsPerPage: number;
|
|
1913
1913
|
/**
|
|
@@ -1934,7 +1934,7 @@ type BaseIndexSettings = {
|
|
|
1934
1934
|
*/
|
|
1935
1935
|
unretrievableAttributes?: Array<string>;
|
|
1936
1936
|
/**
|
|
1937
|
-
*
|
|
1937
|
+
* Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
|
|
1938
1938
|
*/
|
|
1939
1939
|
disableTypoToleranceOnWords?: Array<string>;
|
|
1940
1940
|
/**
|
|
@@ -1966,7 +1966,7 @@ type BaseIndexSettings = {
|
|
|
1966
1966
|
*/
|
|
1967
1967
|
numericAttributesForFiltering?: Array<string>;
|
|
1968
1968
|
/**
|
|
1969
|
-
*
|
|
1969
|
+
* Control which non-alphanumeric characters are indexed. By default, Algolia ignores [non-alphanumeric characters](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/#handling-non-alphanumeric-characters) like hyphen (`-`), plus (`+`), and parentheses (`(`,`)`). To include such characters, define them with `separatorsToIndex`. Separators are all non-letter characters except spaces and currency characters, such as $€£¥. With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, in a search for \"Disney+\", Algolia considers \"Disney\" and \"+\" as two separate words.
|
|
1970
1970
|
*/
|
|
1971
1971
|
separatorsToIndex?: string;
|
|
1972
1972
|
/**
|
|
@@ -2226,11 +2226,11 @@ type SearchRulesParams = {
|
|
|
2226
2226
|
*/
|
|
2227
2227
|
context?: string;
|
|
2228
2228
|
/**
|
|
2229
|
-
* Requested page of the API response.
|
|
2229
|
+
* Requested page of the API response. Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)). - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on. For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.
|
|
2230
2230
|
*/
|
|
2231
2231
|
page?: number;
|
|
2232
2232
|
/**
|
|
2233
|
-
* Maximum number of hits per page.
|
|
2233
|
+
* Maximum number of hits per page. Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)). - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on. For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.
|
|
2234
2234
|
*/
|
|
2235
2235
|
hitsPerPage?: number;
|
|
2236
2236
|
/**
|
|
@@ -3037,7 +3037,7 @@ type ReplaceAllObjectsOptions = {
|
|
|
3037
3037
|
batchSize?: number;
|
|
3038
3038
|
};
|
|
3039
3039
|
|
|
3040
|
-
declare const apiClientVersion = "5.
|
|
3040
|
+
declare const apiClientVersion = "5.9.0";
|
|
3041
3041
|
declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
|
|
3042
3042
|
transporter: _algolia_client_common.Transporter;
|
|
3043
3043
|
/**
|
|
@@ -3888,4 +3888,4 @@ type SearchClient = ReturnType<typeof createSearchClient> & SearchClientNodeHelp
|
|
|
3888
3888
|
|
|
3889
3889
|
declare function searchClient(appId: string, apiKey: string, options?: ClientOptions): SearchClient;
|
|
3890
3890
|
|
|
3891
|
-
export { type Acl, type Action, type AddApiKeyResponse, type AddOrUpdateObjectProps, type AdvancedSyntaxFeatures, type AlternativesAsExact, type Anchoring, type ApiKey, type ApiKeyOperation, type AroundPrecision, type AroundRadius, type AroundRadiusAll, type AssignUserIdParams, type AssignUserIdProps, type AttributeToUpdate, type AutomaticFacetFilter, type AutomaticFacetFilters, type Banner, type BannerImage, type BannerImageUrl, type BannerLink, type
|
|
3891
|
+
export { type Acl, type Action, type AddApiKeyResponse, type AddOrUpdateObjectProps, type AdvancedSyntaxFeatures, type AlternativesAsExact, type Anchoring, type ApiKey, type ApiKeyOperation, type AroundPrecision, type AroundRadius, type AroundRadiusAll, type AssignUserIdParams, type AssignUserIdProps, type AttributeToUpdate, type AutomaticFacetFilter, type AutomaticFacetFilters, type Banner, type BannerImage, type BannerImageUrl, type BannerLink, type BaseGetApiKeyResponse, type BaseIndexSettings, type BaseSearchParams, type BaseSearchParamsWithoutQuery, type BaseSearchResponse, type BatchAssignUserIdsParams, type BatchAssignUserIdsProps, type BatchDictionaryEntriesParams, type BatchDictionaryEntriesProps, type BatchDictionaryEntriesRequest, type BatchParams, type BatchProps, type BatchRequest, type BatchResponse, type BatchWriteParams, type BooleanString, type BrowseOptions, type BrowsePagination, type BrowseParams, type BrowseParamsObject, type BrowseProps, type BrowseResponse, type BuiltInOperation, type BuiltInOperationType, type BuiltInOperationValue, type ChunkedBatchOptions, type ClearObjectsProps, type ClearRulesProps, type ClearSynonymsProps, type Condition, type Consequence, type ConsequenceHide, type ConsequenceParams, type ConsequenceQuery, type ConsequenceQueryObject, type CreatedAtResponse, type Cursor, type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type DeleteApiKeyProps, type DeleteApiKeyResponse, type DeleteByParams, type DeleteByProps, type DeleteIndexProps, type DeleteObjectProps, type DeleteObjectsOptions, type DeleteRuleProps, type DeleteSourceProps, type DeleteSourceResponse, type DeleteSynonymProps, type DeletedAtResponse, type DictionaryAction, type DictionaryEntry, type DictionaryEntryState, type DictionaryEntryType, type DictionaryLanguage, type DictionarySettingsParams, type DictionaryType, type Distinct, type Edit, type EditType, type ErrorBase, type ExactOnSingleWordQuery, type Exhaustive, type FacetFilters, type FacetHits, type FacetOrdering, type FacetStats, type Facets, type FetchedIndex, type GenerateSecuredApiKeyOptions, type GetApiKeyProps, type GetApiKeyResponse, type GetAppTaskProps, type GetDictionarySettingsResponse, type GetLogsProps, type GetLogsResponse, type GetObjectProps, type GetObjectsParams, type GetObjectsRequest, type GetObjectsResponse, type GetRuleProps, type GetSecuredApiKeyRemainingValidityOptions, type GetSettingsProps, type GetSynonymProps, type GetTaskProps, type GetTaskResponse, type GetTopUserIdsResponse, type GetUserIdProps, type HasPendingMappingsProps, type HasPendingMappingsResponse, type HighlightResult, type HighlightResultOption, type Hit, type IgnorePlurals, type IndexSettings, type IndexSettingsAsSearchParams, type Languages, type LegacySearchMethodProps, type ListApiKeysResponse, type ListClustersResponse, type ListIndicesProps, type ListIndicesResponse, type ListUserIdsProps, type ListUserIdsResponse, type Log, type LogQuery, type LogType, type MatchLevel, type MatchedGeoLocation, type Mode, type MultipleBatchRequest, type MultipleBatchResponse, type NumericFilters, type OperationIndexParams, type OperationIndexProps, type OperationType, type OptionalFilters, type Params, type PartialUpdateObjectProps, type PartialUpdateObjectsOptions, type Personalization, type Promote, type PromoteObjectID, type PromoteObjectIDs, type QueryType, type Range, type RankingInfo, type ReRankingApplyFilter, type Redirect, type RedirectRuleIndexData, type RedirectRuleIndexMetadata, type RedirectURL, type RemoveStopWords, type RemoveUserIdProps, type RemoveUserIdResponse, type RemoveWordsIfNoResults, type RenderingContent, type ReplaceAllObjectsOptions, type ReplaceAllObjectsResponse, type ReplaceSourceResponse, type ReplaceSourcesProps, type RestoreApiKeyProps, type Rule, type SaveObjectProps, type SaveObjectResponse, type SaveObjectsOptions, type SaveRuleProps, type SaveRulesProps, type SaveSynonymProps, type SaveSynonymResponse, type SaveSynonymsProps, type ScopeType, type SearchClient, type SearchClientNodeHelpers, type SearchDictionaryEntriesParams, type SearchDictionaryEntriesProps, type SearchDictionaryEntriesResponse, type SearchForFacetValuesProps, type SearchForFacetValuesRequest, type SearchForFacetValuesResponse, type SearchForFacets, type SearchForFacetsOptions, type SearchForHits, type SearchForHitsOptions, type SearchHits, type SearchMethodParams, type SearchPagination, type SearchParams, type SearchParamsObject, type SearchParamsQuery, type SearchParamsString, type SearchQuery, type SearchResponse, type SearchResponses, type SearchResult, type SearchRulesParams, type SearchRulesProps, type SearchRulesResponse, type SearchSingleIndexProps, type SearchStrategy, type SearchSynonymsParams, type SearchSynonymsProps, type SearchSynonymsResponse, type SearchTypeDefault, type SearchTypeFacet, type SearchUserIdsParams, type SearchUserIdsResponse, type SecuredApiKeyRestrictions, type SemanticSearch, type SetSettingsProps, type SettingsResponse, type SnippetResult, type SnippetResultOption, type SortRemainingBy, type Source, type StandardEntries, type SupportedLanguage, type SynonymHit, type SynonymType, type TagFilters, type TaskStatus, type TimeRange, type TypoTolerance, type TypoToleranceEnum, type UpdateApiKeyProps, type UpdateApiKeyResponse, type UpdatedAtResponse, type UpdatedAtWithObjectIdResponse, type UpdatedRuleResponse, type UserHighlightResult, type UserHit, type UserId, type Value, type WaitForApiKeyOptions, type WaitForAppTaskOptions, type WaitForTaskOptions, type Widgets, type WithPrimary, apiClientVersion, searchClient };
|
package/dist/node.d.cts
CHANGED
|
@@ -227,7 +227,7 @@ type BannerImageUrl = {
|
|
|
227
227
|
* image of a search banner.
|
|
228
228
|
*/
|
|
229
229
|
type BannerImage = {
|
|
230
|
-
urls?: BannerImageUrl
|
|
230
|
+
urls?: Array<BannerImageUrl>;
|
|
231
231
|
title?: string;
|
|
232
232
|
};
|
|
233
233
|
|
|
@@ -246,18 +246,14 @@ type Banner = {
|
|
|
246
246
|
link?: BannerLink;
|
|
247
247
|
};
|
|
248
248
|
|
|
249
|
-
/**
|
|
250
|
-
* banners defined in the merchandising studio for the given search.
|
|
251
|
-
*/
|
|
252
|
-
type Banners = {
|
|
253
|
-
banners?: Banner;
|
|
254
|
-
};
|
|
255
|
-
|
|
256
249
|
/**
|
|
257
250
|
* widgets returned from any rules that are applied to the current search.
|
|
258
251
|
*/
|
|
259
252
|
type Widgets = {
|
|
260
|
-
|
|
253
|
+
/**
|
|
254
|
+
* banners defined in the merchandising studio for the given search.
|
|
255
|
+
*/
|
|
256
|
+
banners?: Array<Banner>;
|
|
261
257
|
};
|
|
262
258
|
|
|
263
259
|
/**
|
|
@@ -287,6 +283,10 @@ type BaseSearchResponse = Record<string, any> & {
|
|
|
287
283
|
*/
|
|
288
284
|
automaticRadius?: string;
|
|
289
285
|
exhaustive?: Exhaustive;
|
|
286
|
+
/**
|
|
287
|
+
* Rules applied to the query.
|
|
288
|
+
*/
|
|
289
|
+
appliedRules?: Array<Record<string, unknown>>;
|
|
290
290
|
/**
|
|
291
291
|
* See the `facetsCount` field of the `exhaustive` object in the response.
|
|
292
292
|
*/
|
|
@@ -634,7 +634,7 @@ type BaseGetApiKeyResponse = {
|
|
|
634
634
|
/**
|
|
635
635
|
* API key.
|
|
636
636
|
*/
|
|
637
|
-
value
|
|
637
|
+
value: string;
|
|
638
638
|
/**
|
|
639
639
|
* Timestamp when the object was created, in milliseconds since the Unix epoch.
|
|
640
640
|
*/
|
|
@@ -758,7 +758,7 @@ type GetObjectsResponse<T = Record<string, any>> = {
|
|
|
758
758
|
/**
|
|
759
759
|
* Retrieved records.
|
|
760
760
|
*/
|
|
761
|
-
results
|
|
761
|
+
results?: T[];
|
|
762
762
|
};
|
|
763
763
|
|
|
764
764
|
/**
|
|
@@ -1341,7 +1341,7 @@ type IndexSettingsAsSearchParams = {
|
|
|
1341
1341
|
disableExactOnAttributes?: Array<string>;
|
|
1342
1342
|
exactOnSingleWordQuery?: ExactOnSingleWordQuery;
|
|
1343
1343
|
/**
|
|
1344
|
-
*
|
|
1344
|
+
* Determine which plurals and synonyms should be considered an exact matches. By default, Algolia treats singular and plural forms of a word, and single-word synonyms, as [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact) matches when searching. For example: - \"swimsuit\" and \"swimsuits\" are treated the same - \"swimsuit\" and \"swimwear\" are treated the same (if they are [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)). - `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY\" = \"NYC\", are considered exact matches. - `multiWordsSynonym`. Multi-word synonyms, such as \"NY\" = \"New York\", are considered exact matches.
|
|
1345
1345
|
*/
|
|
1346
1346
|
alternativesAsExact?: Array<AlternativesAsExact>;
|
|
1347
1347
|
/**
|
|
@@ -1615,7 +1615,7 @@ type SearchDictionaryEntriesResponse = {
|
|
|
1615
1615
|
*/
|
|
1616
1616
|
hits: Array<DictionaryEntry>;
|
|
1617
1617
|
/**
|
|
1618
|
-
* Requested page of the API response.
|
|
1618
|
+
* Requested page of the API response. Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)). - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on. For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.
|
|
1619
1619
|
*/
|
|
1620
1620
|
page: number;
|
|
1621
1621
|
/**
|
|
@@ -1907,7 +1907,7 @@ type SearchUserIdsResponse = {
|
|
|
1907
1907
|
*/
|
|
1908
1908
|
page: number;
|
|
1909
1909
|
/**
|
|
1910
|
-
* Maximum number of hits per page.
|
|
1910
|
+
* Maximum number of hits per page. Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)). - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on. For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.
|
|
1911
1911
|
*/
|
|
1912
1912
|
hitsPerPage: number;
|
|
1913
1913
|
/**
|
|
@@ -1934,7 +1934,7 @@ type BaseIndexSettings = {
|
|
|
1934
1934
|
*/
|
|
1935
1935
|
unretrievableAttributes?: Array<string>;
|
|
1936
1936
|
/**
|
|
1937
|
-
*
|
|
1937
|
+
* Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
|
|
1938
1938
|
*/
|
|
1939
1939
|
disableTypoToleranceOnWords?: Array<string>;
|
|
1940
1940
|
/**
|
|
@@ -1966,7 +1966,7 @@ type BaseIndexSettings = {
|
|
|
1966
1966
|
*/
|
|
1967
1967
|
numericAttributesForFiltering?: Array<string>;
|
|
1968
1968
|
/**
|
|
1969
|
-
*
|
|
1969
|
+
* Control which non-alphanumeric characters are indexed. By default, Algolia ignores [non-alphanumeric characters](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/#handling-non-alphanumeric-characters) like hyphen (`-`), plus (`+`), and parentheses (`(`,`)`). To include such characters, define them with `separatorsToIndex`. Separators are all non-letter characters except spaces and currency characters, such as $€£¥. With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, in a search for \"Disney+\", Algolia considers \"Disney\" and \"+\" as two separate words.
|
|
1970
1970
|
*/
|
|
1971
1971
|
separatorsToIndex?: string;
|
|
1972
1972
|
/**
|
|
@@ -2226,11 +2226,11 @@ type SearchRulesParams = {
|
|
|
2226
2226
|
*/
|
|
2227
2227
|
context?: string;
|
|
2228
2228
|
/**
|
|
2229
|
-
* Requested page of the API response.
|
|
2229
|
+
* Requested page of the API response. Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)). - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on. For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.
|
|
2230
2230
|
*/
|
|
2231
2231
|
page?: number;
|
|
2232
2232
|
/**
|
|
2233
|
-
* Maximum number of hits per page.
|
|
2233
|
+
* Maximum number of hits per page. Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)). - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on. For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.
|
|
2234
2234
|
*/
|
|
2235
2235
|
hitsPerPage?: number;
|
|
2236
2236
|
/**
|
|
@@ -3037,7 +3037,7 @@ type ReplaceAllObjectsOptions = {
|
|
|
3037
3037
|
batchSize?: number;
|
|
3038
3038
|
};
|
|
3039
3039
|
|
|
3040
|
-
declare const apiClientVersion = "5.
|
|
3040
|
+
declare const apiClientVersion = "5.9.0";
|
|
3041
3041
|
declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
|
|
3042
3042
|
transporter: _algolia_client_common.Transporter;
|
|
3043
3043
|
/**
|
|
@@ -3888,4 +3888,4 @@ type SearchClient = ReturnType<typeof createSearchClient> & SearchClientNodeHelp
|
|
|
3888
3888
|
|
|
3889
3889
|
declare function searchClient(appId: string, apiKey: string, options?: ClientOptions): SearchClient;
|
|
3890
3890
|
|
|
3891
|
-
export { type Acl, type Action, type AddApiKeyResponse, type AddOrUpdateObjectProps, type AdvancedSyntaxFeatures, type AlternativesAsExact, type Anchoring, type ApiKey, type ApiKeyOperation, type AroundPrecision, type AroundRadius, type AroundRadiusAll, type AssignUserIdParams, type AssignUserIdProps, type AttributeToUpdate, type AutomaticFacetFilter, type AutomaticFacetFilters, type Banner, type BannerImage, type BannerImageUrl, type BannerLink, type
|
|
3891
|
+
export { type Acl, type Action, type AddApiKeyResponse, type AddOrUpdateObjectProps, type AdvancedSyntaxFeatures, type AlternativesAsExact, type Anchoring, type ApiKey, type ApiKeyOperation, type AroundPrecision, type AroundRadius, type AroundRadiusAll, type AssignUserIdParams, type AssignUserIdProps, type AttributeToUpdate, type AutomaticFacetFilter, type AutomaticFacetFilters, type Banner, type BannerImage, type BannerImageUrl, type BannerLink, type BaseGetApiKeyResponse, type BaseIndexSettings, type BaseSearchParams, type BaseSearchParamsWithoutQuery, type BaseSearchResponse, type BatchAssignUserIdsParams, type BatchAssignUserIdsProps, type BatchDictionaryEntriesParams, type BatchDictionaryEntriesProps, type BatchDictionaryEntriesRequest, type BatchParams, type BatchProps, type BatchRequest, type BatchResponse, type BatchWriteParams, type BooleanString, type BrowseOptions, type BrowsePagination, type BrowseParams, type BrowseParamsObject, type BrowseProps, type BrowseResponse, type BuiltInOperation, type BuiltInOperationType, type BuiltInOperationValue, type ChunkedBatchOptions, type ClearObjectsProps, type ClearRulesProps, type ClearSynonymsProps, type Condition, type Consequence, type ConsequenceHide, type ConsequenceParams, type ConsequenceQuery, type ConsequenceQueryObject, type CreatedAtResponse, type Cursor, type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type DeleteApiKeyProps, type DeleteApiKeyResponse, type DeleteByParams, type DeleteByProps, type DeleteIndexProps, type DeleteObjectProps, type DeleteObjectsOptions, type DeleteRuleProps, type DeleteSourceProps, type DeleteSourceResponse, type DeleteSynonymProps, type DeletedAtResponse, type DictionaryAction, type DictionaryEntry, type DictionaryEntryState, type DictionaryEntryType, type DictionaryLanguage, type DictionarySettingsParams, type DictionaryType, type Distinct, type Edit, type EditType, type ErrorBase, type ExactOnSingleWordQuery, type Exhaustive, type FacetFilters, type FacetHits, type FacetOrdering, type FacetStats, type Facets, type FetchedIndex, type GenerateSecuredApiKeyOptions, type GetApiKeyProps, type GetApiKeyResponse, type GetAppTaskProps, type GetDictionarySettingsResponse, type GetLogsProps, type GetLogsResponse, type GetObjectProps, type GetObjectsParams, type GetObjectsRequest, type GetObjectsResponse, type GetRuleProps, type GetSecuredApiKeyRemainingValidityOptions, type GetSettingsProps, type GetSynonymProps, type GetTaskProps, type GetTaskResponse, type GetTopUserIdsResponse, type GetUserIdProps, type HasPendingMappingsProps, type HasPendingMappingsResponse, type HighlightResult, type HighlightResultOption, type Hit, type IgnorePlurals, type IndexSettings, type IndexSettingsAsSearchParams, type Languages, type LegacySearchMethodProps, type ListApiKeysResponse, type ListClustersResponse, type ListIndicesProps, type ListIndicesResponse, type ListUserIdsProps, type ListUserIdsResponse, type Log, type LogQuery, type LogType, type MatchLevel, type MatchedGeoLocation, type Mode, type MultipleBatchRequest, type MultipleBatchResponse, type NumericFilters, type OperationIndexParams, type OperationIndexProps, type OperationType, type OptionalFilters, type Params, type PartialUpdateObjectProps, type PartialUpdateObjectsOptions, type Personalization, type Promote, type PromoteObjectID, type PromoteObjectIDs, type QueryType, type Range, type RankingInfo, type ReRankingApplyFilter, type Redirect, type RedirectRuleIndexData, type RedirectRuleIndexMetadata, type RedirectURL, type RemoveStopWords, type RemoveUserIdProps, type RemoveUserIdResponse, type RemoveWordsIfNoResults, type RenderingContent, type ReplaceAllObjectsOptions, type ReplaceAllObjectsResponse, type ReplaceSourceResponse, type ReplaceSourcesProps, type RestoreApiKeyProps, type Rule, type SaveObjectProps, type SaveObjectResponse, type SaveObjectsOptions, type SaveRuleProps, type SaveRulesProps, type SaveSynonymProps, type SaveSynonymResponse, type SaveSynonymsProps, type ScopeType, type SearchClient, type SearchClientNodeHelpers, type SearchDictionaryEntriesParams, type SearchDictionaryEntriesProps, type SearchDictionaryEntriesResponse, type SearchForFacetValuesProps, type SearchForFacetValuesRequest, type SearchForFacetValuesResponse, type SearchForFacets, type SearchForFacetsOptions, type SearchForHits, type SearchForHitsOptions, type SearchHits, type SearchMethodParams, type SearchPagination, type SearchParams, type SearchParamsObject, type SearchParamsQuery, type SearchParamsString, type SearchQuery, type SearchResponse, type SearchResponses, type SearchResult, type SearchRulesParams, type SearchRulesProps, type SearchRulesResponse, type SearchSingleIndexProps, type SearchStrategy, type SearchSynonymsParams, type SearchSynonymsProps, type SearchSynonymsResponse, type SearchTypeDefault, type SearchTypeFacet, type SearchUserIdsParams, type SearchUserIdsResponse, type SecuredApiKeyRestrictions, type SemanticSearch, type SetSettingsProps, type SettingsResponse, type SnippetResult, type SnippetResultOption, type SortRemainingBy, type Source, type StandardEntries, type SupportedLanguage, type SynonymHit, type SynonymType, type TagFilters, type TaskStatus, type TimeRange, type TypoTolerance, type TypoToleranceEnum, type UpdateApiKeyProps, type UpdateApiKeyResponse, type UpdatedAtResponse, type UpdatedAtWithObjectIdResponse, type UpdatedRuleResponse, type UserHighlightResult, type UserHit, type UserId, type Value, type WaitForApiKeyOptions, type WaitForAppTaskOptions, type WaitForTaskOptions, type Widgets, type WithPrimary, apiClientVersion, searchClient };
|
package/dist/node.d.ts
CHANGED
|
@@ -227,7 +227,7 @@ type BannerImageUrl = {
|
|
|
227
227
|
* image of a search banner.
|
|
228
228
|
*/
|
|
229
229
|
type BannerImage = {
|
|
230
|
-
urls?: BannerImageUrl
|
|
230
|
+
urls?: Array<BannerImageUrl>;
|
|
231
231
|
title?: string;
|
|
232
232
|
};
|
|
233
233
|
|
|
@@ -246,18 +246,14 @@ type Banner = {
|
|
|
246
246
|
link?: BannerLink;
|
|
247
247
|
};
|
|
248
248
|
|
|
249
|
-
/**
|
|
250
|
-
* banners defined in the merchandising studio for the given search.
|
|
251
|
-
*/
|
|
252
|
-
type Banners = {
|
|
253
|
-
banners?: Banner;
|
|
254
|
-
};
|
|
255
|
-
|
|
256
249
|
/**
|
|
257
250
|
* widgets returned from any rules that are applied to the current search.
|
|
258
251
|
*/
|
|
259
252
|
type Widgets = {
|
|
260
|
-
|
|
253
|
+
/**
|
|
254
|
+
* banners defined in the merchandising studio for the given search.
|
|
255
|
+
*/
|
|
256
|
+
banners?: Array<Banner>;
|
|
261
257
|
};
|
|
262
258
|
|
|
263
259
|
/**
|
|
@@ -287,6 +283,10 @@ type BaseSearchResponse = Record<string, any> & {
|
|
|
287
283
|
*/
|
|
288
284
|
automaticRadius?: string;
|
|
289
285
|
exhaustive?: Exhaustive;
|
|
286
|
+
/**
|
|
287
|
+
* Rules applied to the query.
|
|
288
|
+
*/
|
|
289
|
+
appliedRules?: Array<Record<string, unknown>>;
|
|
290
290
|
/**
|
|
291
291
|
* See the `facetsCount` field of the `exhaustive` object in the response.
|
|
292
292
|
*/
|
|
@@ -634,7 +634,7 @@ type BaseGetApiKeyResponse = {
|
|
|
634
634
|
/**
|
|
635
635
|
* API key.
|
|
636
636
|
*/
|
|
637
|
-
value
|
|
637
|
+
value: string;
|
|
638
638
|
/**
|
|
639
639
|
* Timestamp when the object was created, in milliseconds since the Unix epoch.
|
|
640
640
|
*/
|
|
@@ -758,7 +758,7 @@ type GetObjectsResponse<T = Record<string, any>> = {
|
|
|
758
758
|
/**
|
|
759
759
|
* Retrieved records.
|
|
760
760
|
*/
|
|
761
|
-
results
|
|
761
|
+
results?: T[];
|
|
762
762
|
};
|
|
763
763
|
|
|
764
764
|
/**
|
|
@@ -1341,7 +1341,7 @@ type IndexSettingsAsSearchParams = {
|
|
|
1341
1341
|
disableExactOnAttributes?: Array<string>;
|
|
1342
1342
|
exactOnSingleWordQuery?: ExactOnSingleWordQuery;
|
|
1343
1343
|
/**
|
|
1344
|
-
*
|
|
1344
|
+
* Determine which plurals and synonyms should be considered an exact matches. By default, Algolia treats singular and plural forms of a word, and single-word synonyms, as [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact) matches when searching. For example: - \"swimsuit\" and \"swimsuits\" are treated the same - \"swimsuit\" and \"swimwear\" are treated the same (if they are [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)). - `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY\" = \"NYC\", are considered exact matches. - `multiWordsSynonym`. Multi-word synonyms, such as \"NY\" = \"New York\", are considered exact matches.
|
|
1345
1345
|
*/
|
|
1346
1346
|
alternativesAsExact?: Array<AlternativesAsExact>;
|
|
1347
1347
|
/**
|
|
@@ -1615,7 +1615,7 @@ type SearchDictionaryEntriesResponse = {
|
|
|
1615
1615
|
*/
|
|
1616
1616
|
hits: Array<DictionaryEntry>;
|
|
1617
1617
|
/**
|
|
1618
|
-
* Requested page of the API response.
|
|
1618
|
+
* Requested page of the API response. Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)). - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on. For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.
|
|
1619
1619
|
*/
|
|
1620
1620
|
page: number;
|
|
1621
1621
|
/**
|
|
@@ -1907,7 +1907,7 @@ type SearchUserIdsResponse = {
|
|
|
1907
1907
|
*/
|
|
1908
1908
|
page: number;
|
|
1909
1909
|
/**
|
|
1910
|
-
* Maximum number of hits per page.
|
|
1910
|
+
* Maximum number of hits per page. Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)). - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on. For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.
|
|
1911
1911
|
*/
|
|
1912
1912
|
hitsPerPage: number;
|
|
1913
1913
|
/**
|
|
@@ -1934,7 +1934,7 @@ type BaseIndexSettings = {
|
|
|
1934
1934
|
*/
|
|
1935
1935
|
unretrievableAttributes?: Array<string>;
|
|
1936
1936
|
/**
|
|
1937
|
-
*
|
|
1937
|
+
* Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
|
|
1938
1938
|
*/
|
|
1939
1939
|
disableTypoToleranceOnWords?: Array<string>;
|
|
1940
1940
|
/**
|
|
@@ -1966,7 +1966,7 @@ type BaseIndexSettings = {
|
|
|
1966
1966
|
*/
|
|
1967
1967
|
numericAttributesForFiltering?: Array<string>;
|
|
1968
1968
|
/**
|
|
1969
|
-
*
|
|
1969
|
+
* Control which non-alphanumeric characters are indexed. By default, Algolia ignores [non-alphanumeric characters](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/#handling-non-alphanumeric-characters) like hyphen (`-`), plus (`+`), and parentheses (`(`,`)`). To include such characters, define them with `separatorsToIndex`. Separators are all non-letter characters except spaces and currency characters, such as $€£¥. With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, in a search for \"Disney+\", Algolia considers \"Disney\" and \"+\" as two separate words.
|
|
1970
1970
|
*/
|
|
1971
1971
|
separatorsToIndex?: string;
|
|
1972
1972
|
/**
|
|
@@ -2226,11 +2226,11 @@ type SearchRulesParams = {
|
|
|
2226
2226
|
*/
|
|
2227
2227
|
context?: string;
|
|
2228
2228
|
/**
|
|
2229
|
-
* Requested page of the API response.
|
|
2229
|
+
* Requested page of the API response. Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)). - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on. For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.
|
|
2230
2230
|
*/
|
|
2231
2231
|
page?: number;
|
|
2232
2232
|
/**
|
|
2233
|
-
* Maximum number of hits per page.
|
|
2233
|
+
* Maximum number of hits per page. Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)). - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on. For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.
|
|
2234
2234
|
*/
|
|
2235
2235
|
hitsPerPage?: number;
|
|
2236
2236
|
/**
|
|
@@ -3037,7 +3037,7 @@ type ReplaceAllObjectsOptions = {
|
|
|
3037
3037
|
batchSize?: number;
|
|
3038
3038
|
};
|
|
3039
3039
|
|
|
3040
|
-
declare const apiClientVersion = "5.
|
|
3040
|
+
declare const apiClientVersion = "5.9.0";
|
|
3041
3041
|
declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
|
|
3042
3042
|
transporter: _algolia_client_common.Transporter;
|
|
3043
3043
|
/**
|
|
@@ -3888,4 +3888,4 @@ type SearchClient = ReturnType<typeof createSearchClient> & SearchClientNodeHelp
|
|
|
3888
3888
|
|
|
3889
3889
|
declare function searchClient(appId: string, apiKey: string, options?: ClientOptions): SearchClient;
|
|
3890
3890
|
|
|
3891
|
-
export { type Acl, type Action, type AddApiKeyResponse, type AddOrUpdateObjectProps, type AdvancedSyntaxFeatures, type AlternativesAsExact, type Anchoring, type ApiKey, type ApiKeyOperation, type AroundPrecision, type AroundRadius, type AroundRadiusAll, type AssignUserIdParams, type AssignUserIdProps, type AttributeToUpdate, type AutomaticFacetFilter, type AutomaticFacetFilters, type Banner, type BannerImage, type BannerImageUrl, type BannerLink, type
|
|
3891
|
+
export { type Acl, type Action, type AddApiKeyResponse, type AddOrUpdateObjectProps, type AdvancedSyntaxFeatures, type AlternativesAsExact, type Anchoring, type ApiKey, type ApiKeyOperation, type AroundPrecision, type AroundRadius, type AroundRadiusAll, type AssignUserIdParams, type AssignUserIdProps, type AttributeToUpdate, type AutomaticFacetFilter, type AutomaticFacetFilters, type Banner, type BannerImage, type BannerImageUrl, type BannerLink, type BaseGetApiKeyResponse, type BaseIndexSettings, type BaseSearchParams, type BaseSearchParamsWithoutQuery, type BaseSearchResponse, type BatchAssignUserIdsParams, type BatchAssignUserIdsProps, type BatchDictionaryEntriesParams, type BatchDictionaryEntriesProps, type BatchDictionaryEntriesRequest, type BatchParams, type BatchProps, type BatchRequest, type BatchResponse, type BatchWriteParams, type BooleanString, type BrowseOptions, type BrowsePagination, type BrowseParams, type BrowseParamsObject, type BrowseProps, type BrowseResponse, type BuiltInOperation, type BuiltInOperationType, type BuiltInOperationValue, type ChunkedBatchOptions, type ClearObjectsProps, type ClearRulesProps, type ClearSynonymsProps, type Condition, type Consequence, type ConsequenceHide, type ConsequenceParams, type ConsequenceQuery, type ConsequenceQueryObject, type CreatedAtResponse, type Cursor, type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type DeleteApiKeyProps, type DeleteApiKeyResponse, type DeleteByParams, type DeleteByProps, type DeleteIndexProps, type DeleteObjectProps, type DeleteObjectsOptions, type DeleteRuleProps, type DeleteSourceProps, type DeleteSourceResponse, type DeleteSynonymProps, type DeletedAtResponse, type DictionaryAction, type DictionaryEntry, type DictionaryEntryState, type DictionaryEntryType, type DictionaryLanguage, type DictionarySettingsParams, type DictionaryType, type Distinct, type Edit, type EditType, type ErrorBase, type ExactOnSingleWordQuery, type Exhaustive, type FacetFilters, type FacetHits, type FacetOrdering, type FacetStats, type Facets, type FetchedIndex, type GenerateSecuredApiKeyOptions, type GetApiKeyProps, type GetApiKeyResponse, type GetAppTaskProps, type GetDictionarySettingsResponse, type GetLogsProps, type GetLogsResponse, type GetObjectProps, type GetObjectsParams, type GetObjectsRequest, type GetObjectsResponse, type GetRuleProps, type GetSecuredApiKeyRemainingValidityOptions, type GetSettingsProps, type GetSynonymProps, type GetTaskProps, type GetTaskResponse, type GetTopUserIdsResponse, type GetUserIdProps, type HasPendingMappingsProps, type HasPendingMappingsResponse, type HighlightResult, type HighlightResultOption, type Hit, type IgnorePlurals, type IndexSettings, type IndexSettingsAsSearchParams, type Languages, type LegacySearchMethodProps, type ListApiKeysResponse, type ListClustersResponse, type ListIndicesProps, type ListIndicesResponse, type ListUserIdsProps, type ListUserIdsResponse, type Log, type LogQuery, type LogType, type MatchLevel, type MatchedGeoLocation, type Mode, type MultipleBatchRequest, type MultipleBatchResponse, type NumericFilters, type OperationIndexParams, type OperationIndexProps, type OperationType, type OptionalFilters, type Params, type PartialUpdateObjectProps, type PartialUpdateObjectsOptions, type Personalization, type Promote, type PromoteObjectID, type PromoteObjectIDs, type QueryType, type Range, type RankingInfo, type ReRankingApplyFilter, type Redirect, type RedirectRuleIndexData, type RedirectRuleIndexMetadata, type RedirectURL, type RemoveStopWords, type RemoveUserIdProps, type RemoveUserIdResponse, type RemoveWordsIfNoResults, type RenderingContent, type ReplaceAllObjectsOptions, type ReplaceAllObjectsResponse, type ReplaceSourceResponse, type ReplaceSourcesProps, type RestoreApiKeyProps, type Rule, type SaveObjectProps, type SaveObjectResponse, type SaveObjectsOptions, type SaveRuleProps, type SaveRulesProps, type SaveSynonymProps, type SaveSynonymResponse, type SaveSynonymsProps, type ScopeType, type SearchClient, type SearchClientNodeHelpers, type SearchDictionaryEntriesParams, type SearchDictionaryEntriesProps, type SearchDictionaryEntriesResponse, type SearchForFacetValuesProps, type SearchForFacetValuesRequest, type SearchForFacetValuesResponse, type SearchForFacets, type SearchForFacetsOptions, type SearchForHits, type SearchForHitsOptions, type SearchHits, type SearchMethodParams, type SearchPagination, type SearchParams, type SearchParamsObject, type SearchParamsQuery, type SearchParamsString, type SearchQuery, type SearchResponse, type SearchResponses, type SearchResult, type SearchRulesParams, type SearchRulesProps, type SearchRulesResponse, type SearchSingleIndexProps, type SearchStrategy, type SearchSynonymsParams, type SearchSynonymsProps, type SearchSynonymsResponse, type SearchTypeDefault, type SearchTypeFacet, type SearchUserIdsParams, type SearchUserIdsResponse, type SecuredApiKeyRestrictions, type SemanticSearch, type SetSettingsProps, type SettingsResponse, type SnippetResult, type SnippetResultOption, type SortRemainingBy, type Source, type StandardEntries, type SupportedLanguage, type SynonymHit, type SynonymType, type TagFilters, type TaskStatus, type TimeRange, type TypoTolerance, type TypoToleranceEnum, type UpdateApiKeyProps, type UpdateApiKeyResponse, type UpdatedAtResponse, type UpdatedAtWithObjectIdResponse, type UpdatedRuleResponse, type UserHighlightResult, type UserHit, type UserId, type Value, type WaitForApiKeyOptions, type WaitForAppTaskOptions, type WaitForTaskOptions, type Widgets, type WithPrimary, apiClientVersion, searchClient };
|
|
@@ -25,7 +25,7 @@ __export(searchClient_exports, {
|
|
|
25
25
|
});
|
|
26
26
|
module.exports = __toCommonJS(searchClient_exports);
|
|
27
27
|
var import_client_common = require("@algolia/client-common");
|
|
28
|
-
var apiClientVersion = "5.
|
|
28
|
+
var apiClientVersion = "5.9.0";
|
|
29
29
|
function getDefaultHosts(appId) {
|
|
30
30
|
return [
|
|
31
31
|
{
|
|
@@ -767,7 +767,8 @@ function createSearchClient({
|
|
|
767
767
|
path: requestPath,
|
|
768
768
|
queryParameters,
|
|
769
769
|
headers,
|
|
770
|
-
data: browseParams ? browseParams : {}
|
|
770
|
+
data: browseParams ? browseParams : {},
|
|
771
|
+
useReadTransporter: true
|
|
771
772
|
};
|
|
772
773
|
return transporter.request(request, requestOptions);
|
|
773
774
|
},
|