algoliasearch 5.0.0-alpha.53 → 5.0.0-alpha.55

package/dist/client-search/model/index.d.ts

@@ -1,155 +1,155 @@
-export * from './acl';
-export * from './action';
-export * from './addApiKeyResponse';
-export * from './advancedSyntaxFeatures';
-export * from './alternativesAsExact';
-export * from './anchoring';
-export * from './apiKey';
-export * from './aroundRadius';
-export * from './aroundRadiusAll';
-export * from './assignUserIdParams';
-export * from './attributeToUpdate';
-export * from './automaticFacetFilter';
-export * from './automaticFacetFilters';
-export * from './baseGetApiKeyResponse';
-export * from './baseIndexSettings';
-export * from './baseSearchParams';
-export * from './baseSearchParamsWithoutQuery';
-export * from './baseSearchResponse';
-export * from './batchAssignUserIdsParams';
-export * from './batchDictionaryEntriesParams';
-export * from './batchDictionaryEntriesRequest';
-export * from './batchParams';
-export * from './batchRequest';
-export * from './batchResponse';
-export * from './batchWriteParams';
-export * from './browseParams';
-export * from './browseParamsObject';
-export * from './browseResponse';
-export * from './builtInOperation';
-export * from './builtInOperationType';
-export * from './condition';
-export * from './consequence';
-export * from './consequenceHide';
-export * from './consequenceParams';
-export * from './consequenceQuery';
-export * from './consequenceQueryObject';
-export * from './createdAtResponse';
-export * from './cursor';
-export * from './deleteApiKeyResponse';
-export * from './deleteByParams';
-export * from './deleteSourceResponse';
-export * from './deletedAtResponse';
-export * from './dictionaryAction';
-export * from './dictionaryEntry';
-export * from './dictionaryEntryState';
-export * from './dictionaryLanguage';
-export * from './dictionarySettingsParams';
-export * from './dictionaryType';
-export * from './distinct';
-export * from './edit';
-export * from './editType';
-export * from './errorBase';
-export * from './exactOnSingleWordQuery';
-export * from './facetFilters';
-export * from './facetHits';
-export * from './facetOrdering';
-export * from './facets';
-export * from './facetsStats';
-export * from './fetchedIndex';
-export * from './getApiKeyResponse';
-export * from './getDictionarySettingsResponse';
-export * from './getLogsResponse';
-export * from './getObjectsParams';
-export * from './getObjectsRequest';
-export * from './getObjectsResponse';
-export * from './getTaskResponse';
-export * from './getTopUserIdsResponse';
-export * from './hasPendingMappingsResponse';
-export * from './highlightResult';
-export * from './highlightResultOption';
-export * from './hit';
-export * from './ignorePlurals';
-export * from './indexSettings';
-export * from './indexSettingsAsSearchParams';
-export * from './languages';
-export * from './listApiKeysResponse';
-export * from './listClustersResponse';
-export * from './listIndicesResponse';
-export * from './listUserIdsResponse';
-export * from './log';
-export * from './logQuery';
-export * from './logType';
-export * from './matchLevel';
-export * from './matchedGeoLocation';
-export * from './mixedSearchFilters';
-export * from './multipleBatchRequest';
-export * from './multipleBatchResponse';
-export * from './numericFilters';
-export * from './operationIndexParams';
-export * from './operationType';
-export * from './optionalFilters';
-export * from './params';
-export * from './personalization';
-export * from './promote';
-export * from './promoteObjectID';
-export * from './promoteObjectIDs';
-export * from './queryType';
-export * from './rankingInfo';
-export * from './reRankingApplyFilter';
-export * from './removeStopWords';
-export * from './removeUserIdResponse';
-export * from './removeWordsIfNoResults';
-export * from './renderingContent';
-export * from './replaceSourceResponse';
-export * from './rule';
-export * from './saveObjectResponse';
-export * from './saveSynonymResponse';
-export * from './scopeType';
-export * from './searchDictionaryEntriesParams';
-export * from './searchForFacetValuesRequest';
-export * from './searchForFacetValuesResponse';
-export * from './searchForFacets';
-export * from './searchForFacetsOptions';
-export * from './searchForHits';
-export * from './searchForHitsOptions';
-export * from './searchHits';
-export * from './searchMethodParams';
-export * from './searchParams';
-export * from './searchParamsObject';
-export * from './searchParamsQuery';
-export * from './searchParamsString';
-export * from './searchQuery';
-export * from './searchResponse';
-export * from './searchResponses';
-export * from './searchRulesParams';
-export * from './searchRulesResponse';
-export * from './searchStrategy';
-export * from './searchSynonymsParams';
-export * from './searchSynonymsResponse';
-export * from './searchTypeDefault';
-export * from './searchTypeFacet';
-export * from './searchUserIdsParams';
-export * from './searchUserIdsResponse';
-export * from './snippetResult';
-export * from './snippetResultOption';
-export * from './sortRemainingBy';
-export * from './source';
-export * from './standardEntries';
-export * from './synonymHit';
-export * from './synonymType';
-export * from './tagFilters';
-export * from './taskStatus';
-export * from './timeRange';
-export * from './typoTolerance';
-export * from './typoToleranceEnum';
-export * from './updateApiKeyResponse';
-export * from './updatedAtResponse';
-export * from './updatedAtWithObjectIdResponse';
-export * from './updatedRuleResponse';
-export * from './userHighlightResult';
-export * from './userHit';
-export * from './userId';
-export * from './value';
-export * from './clientMethodProps';
+export * from './acl';
+export * from './action';
+export * from './addApiKeyResponse';
+export * from './advancedSyntaxFeatures';
+export * from './alternativesAsExact';
+export * from './anchoring';
+export * from './apiKey';
+export * from './aroundRadius';
+export * from './aroundRadiusAll';
+export * from './assignUserIdParams';
+export * from './attributeToUpdate';
+export * from './automaticFacetFilter';
+export * from './automaticFacetFilters';
+export * from './baseGetApiKeyResponse';
+export * from './baseIndexSettings';
+export * from './baseSearchParams';
+export * from './baseSearchParamsWithoutQuery';
+export * from './baseSearchResponse';
+export * from './batchAssignUserIdsParams';
+export * from './batchDictionaryEntriesParams';
+export * from './batchDictionaryEntriesRequest';
+export * from './batchParams';
+export * from './batchRequest';
+export * from './batchResponse';
+export * from './batchWriteParams';
+export * from './browseParams';
+export * from './browseParamsObject';
+export * from './browseResponse';
+export * from './builtInOperation';
+export * from './builtInOperationType';
+export * from './condition';
+export * from './consequence';
+export * from './consequenceHide';
+export * from './consequenceParams';
+export * from './consequenceQuery';
+export * from './consequenceQueryObject';
+export * from './createdAtResponse';
+export * from './cursor';
+export * from './deleteApiKeyResponse';
+export * from './deleteByParams';
+export * from './deleteSourceResponse';
+export * from './deletedAtResponse';
+export * from './dictionaryAction';
+export * from './dictionaryEntry';
+export * from './dictionaryEntryState';
+export * from './dictionaryLanguage';
+export * from './dictionarySettingsParams';
+export * from './dictionaryType';
+export * from './distinct';
+export * from './edit';
+export * from './editType';
+export * from './errorBase';
+export * from './exactOnSingleWordQuery';
+export * from './facetFilters';
+export * from './facetHits';
+export * from './facetOrdering';
+export * from './facets';
+export * from './facetsStats';
+export * from './fetchedIndex';
+export * from './getApiKeyResponse';
+export * from './getDictionarySettingsResponse';
+export * from './getLogsResponse';
+export * from './getObjectsParams';
+export * from './getObjectsRequest';
+export * from './getObjectsResponse';
+export * from './getTaskResponse';
+export * from './getTopUserIdsResponse';
+export * from './hasPendingMappingsResponse';
+export * from './highlightResult';
+export * from './highlightResultOption';
+export * from './hit';
+export * from './ignorePlurals';
+export * from './indexSettings';
+export * from './indexSettingsAsSearchParams';
+export * from './languages';
+export * from './listApiKeysResponse';
+export * from './listClustersResponse';
+export * from './listIndicesResponse';
+export * from './listUserIdsResponse';
+export * from './log';
+export * from './logQuery';
+export * from './logType';
+export * from './matchLevel';
+export * from './matchedGeoLocation';
+export * from './mixedSearchFilters';
+export * from './multipleBatchRequest';
+export * from './multipleBatchResponse';
+export * from './numericFilters';
+export * from './operationIndexParams';
+export * from './operationType';
+export * from './optionalFilters';
+export * from './params';
+export * from './personalization';
+export * from './promote';
+export * from './promoteObjectID';
+export * from './promoteObjectIDs';
+export * from './queryType';
+export * from './rankingInfo';
+export * from './reRankingApplyFilter';
+export * from './removeStopWords';
+export * from './removeUserIdResponse';
+export * from './removeWordsIfNoResults';
+export * from './renderingContent';
+export * from './replaceSourceResponse';
+export * from './rule';
+export * from './saveObjectResponse';
+export * from './saveSynonymResponse';
+export * from './scopeType';
+export * from './searchDictionaryEntriesParams';
+export * from './searchForFacetValuesRequest';
+export * from './searchForFacetValuesResponse';
+export * from './searchForFacets';
+export * from './searchForFacetsOptions';
+export * from './searchForHits';
+export * from './searchForHitsOptions';
+export * from './searchHits';
+export * from './searchMethodParams';
+export * from './searchParams';
+export * from './searchParamsObject';
+export * from './searchParamsQuery';
+export * from './searchParamsString';
+export * from './searchQuery';
+export * from './searchResponse';
+export * from './searchResponses';
+export * from './searchRulesParams';
+export * from './searchRulesResponse';
+export * from './searchStrategy';
+export * from './searchSynonymsParams';
+export * from './searchSynonymsResponse';
+export * from './searchTypeDefault';
+export * from './searchTypeFacet';
+export * from './searchUserIdsParams';
+export * from './searchUserIdsResponse';
+export * from './snippetResult';
+export * from './snippetResultOption';
+export * from './sortRemainingBy';
+export * from './source';
+export * from './standardEntries';
+export * from './synonymHit';
+export * from './synonymType';
+export * from './tagFilters';
+export * from './taskStatus';
+export * from './timeRange';
+export * from './typoTolerance';
+export * from './typoToleranceEnum';
+export * from './updateApiKeyResponse';
+export * from './updatedAtResponse';
+export * from './updatedAtWithObjectIdResponse';
+export * from './updatedRuleResponse';
+export * from './userHighlightResult';
+export * from './userHit';
+export * from './userId';
+export * from './value';
+export * from './clientMethodProps';
 //# sourceMappingURL=index.d.ts.map

package/dist/client-search/model/indexSettings.d.ts

@@ -1,7 +1,7 @@
-import type { BaseIndexSettings } from './baseIndexSettings';
-import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';
-/**
- * The Algolia index settings.
- */
-export type IndexSettings = BaseIndexSettings & IndexSettingsAsSearchParams;
+import type { BaseIndexSettings } from './baseIndexSettings';
+import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';
+/**
+ * The Algolia index settings.
+ */
+export type IndexSettings = BaseIndexSettings & IndexSettingsAsSearchParams;
 //# sourceMappingURL=indexSettings.d.ts.map

package/dist/client-search/model/indexSettingsAsSearchParams.d.ts

@@ -1,157 +1,157 @@
-import type { AdvancedSyntaxFeatures } from './advancedSyntaxFeatures';
-import type { AlternativesAsExact } from './alternativesAsExact';
-import type { Distinct } from './distinct';
-import type { ExactOnSingleWordQuery } from './exactOnSingleWordQuery';
-import type { IgnorePlurals } from './ignorePlurals';
-import type { QueryType } from './queryType';
-import type { RemoveStopWords } from './removeStopWords';
-import type { RemoveWordsIfNoResults } from './removeWordsIfNoResults';
-import type { RenderingContent } from './renderingContent';
-import type { TypoTolerance } from './typoTolerance';
-export type IndexSettingsAsSearchParams = {
-    /**
-     * The complete list of attributes that will be used for faceting.
-     */
-    attributesForFaceting?: string[];
-    /**
-     * This parameter controls which attributes to retrieve and which not to retrieve.
-     */
-    attributesToRetrieve?: string[];
-    /**
-     * Restricts a given query to look in only a subset of your searchable attributes.
-     */
-    restrictSearchableAttributes?: string[];
-    /**
-     * Controls how Algolia should sort your results.
-     */
-    ranking?: string[];
-    /**
-     * Specifies the custom ranking criterion.
-     */
-    customRanking?: string[];
-    /**
-     * Controls the relevancy threshold below which less relevant results aren\'t included in the results.
-     */
-    relevancyStrictness?: number;
-    /**
-     * List of attributes to highlight.
-     */
-    attributesToHighlight?: string[];
-    /**
-     * List of attributes to snippet, with an optional maximum number of words to snippet.
-     */
-    attributesToSnippet?: string[];
-    /**
-     * The HTML string to insert before the highlighted parts in all highlight and snippet results.
-     */
-    highlightPreTag?: string;
-    /**
-     * The HTML string to insert after the highlighted parts in all highlight and snippet results.
-     */
-    highlightPostTag?: string;
-    /**
-     * String used as an ellipsis indicator when a snippet is truncated.
-     */
-    snippetEllipsisText?: string;
-    /**
-     * Restrict highlighting and snippeting to items that matched the query.
-     */
-    restrictHighlightAndSnippetArrays?: boolean;
-    /**
-     * Set the number of hits per page.
-     */
-    hitsPerPage?: number;
-    /**
-     * Minimum number of characters a word in the query string must contain to accept matches with 1 typo.
-     */
-    minWordSizefor1Typo?: number;
-    /**
-     * Minimum number of characters a word in the query string must contain to accept matches with 2 typos.
-     */
-    minWordSizefor2Typos?: number;
-    typoTolerance?: TypoTolerance;
-    /**
-     * Whether to allow typos on numbers (\"numeric tokens\") in the query string.
-     */
-    allowTyposOnNumericTokens?: boolean;
-    /**
-     * List of attributes on which you want to disable typo tolerance.
-     */
-    disableTypoToleranceOnAttributes?: string[];
-    ignorePlurals?: IgnorePlurals;
-    removeStopWords?: RemoveStopWords;
-    /**
-     * List of characters that the engine shouldn\'t automatically normalize.
-     */
-    keepDiacriticsOnCharacters?: string;
-    /**
-     * Sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection.
-     */
-    queryLanguages?: string[];
-    /**
-     * Splits compound words into their composing atoms in the query.
-     */
-    decompoundQuery?: boolean;
-    /**
-     * Whether Rules should be globally enabled.
-     */
-    enableRules?: boolean;
-    /**
-     * Enable the Personalization feature.
-     */
-    enablePersonalization?: boolean;
-    queryType?: QueryType;
-    removeWordsIfNoResults?: RemoveWordsIfNoResults;
-    /**
-     * Enables the advanced query syntax.
-     */
-    advancedSyntax?: boolean;
-    /**
-     * A list of words that should be considered as optional when found in the query.
-     */
-    optionalWords?: string[];
-    /**
-     * List of attributes on which you want to disable the exact ranking criterion.
-     */
-    disableExactOnAttributes?: string[];
-    exactOnSingleWordQuery?: ExactOnSingleWordQuery;
-    /**
-     * List of alternatives that should be considered an exact match by the exact ranking criterion.
-     */
-    alternativesAsExact?: AlternativesAsExact[];
-    /**
-     * Allows you to specify which advanced syntax features are active when ‘advancedSyntax\' is enabled.
-     */
-    advancedSyntaxFeatures?: AdvancedSyntaxFeatures[];
-    distinct?: Distinct;
-    /**
-     * Name of the de-duplication attribute to be used with the distinct feature.
-     */
-    attributeForDistinct?: string;
-    /**
-     * Whether to take into account an index\'s synonyms for a particular search.
-     */
-    synonyms?: boolean;
-    /**
-     * Whether to highlight and snippet the original word that matches the synonym or the synonym itself.
-     */
-    replaceSynonymsInHighlight?: boolean;
-    /**
-     * Precision of the proximity ranking criterion.
-     */
-    minProximity?: number;
-    /**
-     * Choose which fields to return in the API response. This parameters applies to search and browse queries.
-     */
-    responseFields?: string[];
-    /**
-     * Maximum number of facet hits to return during a search for facet values. For performance reasons, the maximum allowed number of returned values is 100.
-     */
-    maxFacetHits?: number;
-    /**
-     * When attribute is ranked above proximity in your ranking formula, proximity is used to select which searchable attribute is matched in the attribute ranking stage.
-     */
-    attributeCriteriaComputedByMinProximity?: boolean;
-    renderingContent?: RenderingContent;
-};
+import type { AdvancedSyntaxFeatures } from './advancedSyntaxFeatures';
+import type { AlternativesAsExact } from './alternativesAsExact';
+import type { Distinct } from './distinct';
+import type { ExactOnSingleWordQuery } from './exactOnSingleWordQuery';
+import type { IgnorePlurals } from './ignorePlurals';
+import type { QueryType } from './queryType';
+import type { RemoveStopWords } from './removeStopWords';
+import type { RemoveWordsIfNoResults } from './removeWordsIfNoResults';
+import type { RenderingContent } from './renderingContent';
+import type { TypoTolerance } from './typoTolerance';
+export type IndexSettingsAsSearchParams = {
+    /**
+     * The complete list of attributes that will be used for faceting.
+     */
+    attributesForFaceting?: string[];
+    /**
+     * This parameter controls which attributes to retrieve and which not to retrieve.
+     */
+    attributesToRetrieve?: string[];
+    /**
+     * Restricts a given query to look in only a subset of your searchable attributes.
+     */
+    restrictSearchableAttributes?: string[];
+    /**
+     * Controls how Algolia should sort your results.
+     */
+    ranking?: string[];
+    /**
+     * Specifies the custom ranking criterion.
+     */
+    customRanking?: string[];
+    /**
+     * Controls the relevancy threshold below which less relevant results aren\'t included in the results.
+     */
+    relevancyStrictness?: number;
+    /**
+     * List of attributes to highlight.
+     */
+    attributesToHighlight?: string[];
+    /**
+     * List of attributes to snippet, with an optional maximum number of words to snippet.
+     */
+    attributesToSnippet?: string[];
+    /**
+     * The HTML string to insert before the highlighted parts in all highlight and snippet results.
+     */
+    highlightPreTag?: string;
+    /**
+     * The HTML string to insert after the highlighted parts in all highlight and snippet results.
+     */
+    highlightPostTag?: string;
+    /**
+     * String used as an ellipsis indicator when a snippet is truncated.
+     */
+    snippetEllipsisText?: string;
+    /**
+     * Restrict highlighting and snippeting to items that matched the query.
+     */
+    restrictHighlightAndSnippetArrays?: boolean;
+    /**
+     * Set the number of hits per page.
+     */
+    hitsPerPage?: number;
+    /**
+     * Minimum number of characters a word in the query string must contain to accept matches with 1 typo.
+     */
+    minWordSizefor1Typo?: number;
+    /**
+     * Minimum number of characters a word in the query string must contain to accept matches with 2 typos.
+     */
+    minWordSizefor2Typos?: number;
+    typoTolerance?: TypoTolerance;
+    /**
+     * Whether to allow typos on numbers (\"numeric tokens\") in the query string.
+     */
+    allowTyposOnNumericTokens?: boolean;
+    /**
+     * List of attributes on which you want to disable typo tolerance.
+     */
+    disableTypoToleranceOnAttributes?: string[];
+    ignorePlurals?: IgnorePlurals;
+    removeStopWords?: RemoveStopWords;
+    /**
+     * List of characters that the engine shouldn\'t automatically normalize.
+     */
+    keepDiacriticsOnCharacters?: string;
+    /**
+     * Sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection.
+     */
+    queryLanguages?: string[];
+    /**
+     * Splits compound words into their composing atoms in the query.
+     */
+    decompoundQuery?: boolean;
+    /**
+     * Whether Rules should be globally enabled.
+     */
+    enableRules?: boolean;
+    /**
+     * Enable the Personalization feature.
+     */
+    enablePersonalization?: boolean;
+    queryType?: QueryType;
+    removeWordsIfNoResults?: RemoveWordsIfNoResults;
+    /**
+     * Enables the advanced query syntax.
+     */
+    advancedSyntax?: boolean;
+    /**
+     * A list of words that should be considered as optional when found in the query.
+     */
+    optionalWords?: string[];
+    /**
+     * List of attributes on which you want to disable the exact ranking criterion.
+     */
+    disableExactOnAttributes?: string[];
+    exactOnSingleWordQuery?: ExactOnSingleWordQuery;
+    /**
+     * List of alternatives that should be considered an exact match by the exact ranking criterion.
+     */
+    alternativesAsExact?: AlternativesAsExact[];
+    /**
+     * Allows you to specify which advanced syntax features are active when ‘advancedSyntax\' is enabled.
+     */
+    advancedSyntaxFeatures?: AdvancedSyntaxFeatures[];
+    distinct?: Distinct;
+    /**
+     * Name of the de-duplication attribute to be used with the distinct feature.
+     */
+    attributeForDistinct?: string;
+    /**
+     * Whether to take into account an index\'s synonyms for a particular search.
+     */
+    synonyms?: boolean;
+    /**
+     * Whether to highlight and snippet the original word that matches the synonym or the synonym itself.
+     */
+    replaceSynonymsInHighlight?: boolean;
+    /**
+     * Precision of the proximity ranking criterion.
+     */
+    minProximity?: number;
+    /**
+     * Choose which fields to return in the API response. This parameters applies to search and browse queries.
+     */
+    responseFields?: string[];
+    /**
+     * Maximum number of facet hits to return during a search for facet values. For performance reasons, the maximum allowed number of returned values is 100.
+     */
+    maxFacetHits?: number;
+    /**
+     * When attribute is ranked above proximity in your ranking formula, proximity is used to select which searchable attribute is matched in the attribute ranking stage.
+     */
+    attributeCriteriaComputedByMinProximity?: boolean;
+    renderingContent?: RenderingContent;
+};
 //# sourceMappingURL=indexSettingsAsSearchParams.d.ts.map

package/dist/client-search/model/languages.d.ts

@@ -1,10 +1,10 @@
-import type { DictionaryLanguage } from './dictionaryLanguage';
-/**
- * A dictionary language.
- */
-export type Languages = {
-    plurals: DictionaryLanguage | null;
-    stopwords: DictionaryLanguage | null;
-    compounds: DictionaryLanguage | null;
-};
+import type { DictionaryLanguage } from './dictionaryLanguage';
+/**
+ * A dictionary language.
+ */
+export type Languages = {
+    plurals: DictionaryLanguage | null;
+    stopwords: DictionaryLanguage | null;
+    compounds: DictionaryLanguage | null;
+};
 //# sourceMappingURL=languages.d.ts.map