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

package/dist/lite/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/lite/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

package/dist/lite/model/listIndicesResponse.d.ts

@@ -1,12 +1,12 @@
-import type { FetchedIndex } from './fetchedIndex';
-export type ListIndicesResponse = {
-    /**
-     * List of the fetched indices.
-     */
-    items: FetchedIndex[];
-    /**
-     * Number of pages.
-     */
-    nbPages?: number;
-};
+import type { FetchedIndex } from './fetchedIndex';
+export type ListIndicesResponse = {
+    /**
+     * List of the fetched indices.
+     */
+    items: FetchedIndex[];
+    /**
+     * Number of pages.
+     */
+    nbPages?: number;
+};
 //# sourceMappingURL=listIndicesResponse.d.ts.map

package/dist/lite/model/logType.d.ts

@@ -1,2 +1,2 @@
-export type LogType = 'all' | 'build' | 'error' | 'query';
+export type LogType = 'all' | 'build' | 'error' | 'query';
 //# sourceMappingURL=logType.d.ts.map

package/dist/lite/model/matchLevel.d.ts

@@ -1,5 +1,5 @@
-/**
- * Indicates how well the attribute matched the search query.
- */
-export type MatchLevel = 'full' | 'none' | 'partial';
+/**
+ * Indicates how well the attribute matched the search query.
+ */
+export type MatchLevel = 'full' | 'none' | 'partial';
 //# sourceMappingURL=matchLevel.d.ts.map

package/dist/lite/model/matchedGeoLocation.d.ts

@@ -1,15 +1,15 @@
-export type MatchedGeoLocation = {
-    /**
-     * Latitude of the matched location.
-     */
-    lat?: number;
-    /**
-     * Longitude of the matched location.
-     */
-    lng?: number;
-    /**
-     * Distance between the matched location and the search location (in meters).
-     */
-    distance?: number;
-};
+export type MatchedGeoLocation = {
+    /**
+     * Latitude of the matched location.
+     */
+    lat?: number;
+    /**
+     * Longitude of the matched location.
+     */
+    lng?: number;
+    /**
+     * Distance between the matched location and the search location (in meters).
+     */
+    distance?: number;
+};
 //# sourceMappingURL=matchedGeoLocation.d.ts.map

package/dist/lite/model/mixedSearchFilters.d.ts

@@ -1,2 +1,2 @@
-export type MixedSearchFilters = string[] | string;
+export type MixedSearchFilters = string[] | string;
 //# sourceMappingURL=mixedSearchFilters.d.ts.map

package/dist/lite/model/numericFilters.d.ts

@@ -1,6 +1,6 @@
-import type { MixedSearchFilters } from './mixedSearchFilters';
-/**
- * Filter on numeric attributes.
- */
-export type NumericFilters = MixedSearchFilters[] | string;
+import type { MixedSearchFilters } from './mixedSearchFilters';
+/**
+ * Filter on numeric attributes.
+ */
+export type NumericFilters = MixedSearchFilters[] | string;
 //# sourceMappingURL=numericFilters.d.ts.map

package/dist/lite/model/operationType.d.ts

@@ -1,5 +1,5 @@
-/**
- * Type of operation to perform (move or copy).
- */
-export type OperationType = 'copy' | 'move';
+/**
+ * Type of operation to perform (move or copy).
+ */
+export type OperationType = 'copy' | 'move';
 //# sourceMappingURL=operationType.d.ts.map

package/dist/lite/model/optionalFilters.d.ts

@@ -1,6 +1,6 @@
-import type { MixedSearchFilters } from './mixedSearchFilters';
-/**
- * Create filters for ranking purposes, where records that match the filter are ranked higher, or lower in the case of a negative optional filter.
- */
-export type OptionalFilters = MixedSearchFilters[] | string;
+import type { MixedSearchFilters } from './mixedSearchFilters';
+/**
+ * Create filters for ranking purposes, where records that match the filter are ranked higher, or lower in the case of a negative optional filter.
+ */
+export type OptionalFilters = MixedSearchFilters[] | string;
 //# sourceMappingURL=optionalFilters.d.ts.map

package/dist/lite/model/params.d.ts

@@ -1,13 +1,13 @@
-import type { AutomaticFacetFilters } from './automaticFacetFilters';
-import type { ConsequenceQuery } from './consequenceQuery';
-import type { RenderingContent } from './renderingContent';
-/**
- * Additional search parameters. Any valid search parameter is allowed.
- */
-export type Params = {
-    query?: ConsequenceQuery;
-    automaticFacetFilters?: AutomaticFacetFilters;
-    automaticOptionalFacetFilters?: AutomaticFacetFilters;
-    renderingContent?: RenderingContent;
-};
+import type { AutomaticFacetFilters } from './automaticFacetFilters';
+import type { ConsequenceQuery } from './consequenceQuery';
+import type { RenderingContent } from './renderingContent';
+/**
+ * Additional search parameters. Any valid search parameter is allowed.
+ */
+export type Params = {
+    query?: ConsequenceQuery;
+    automaticFacetFilters?: AutomaticFacetFilters;
+    automaticOptionalFacetFilters?: AutomaticFacetFilters;
+    renderingContent?: RenderingContent;
+};
 //# sourceMappingURL=params.d.ts.map

package/dist/lite/model/personalization.d.ts

@@ -1,15 +1,15 @@
-export type Personalization = {
-    /**
-     * The score of the filters.
-     */
-    filtersScore?: number;
-    /**
-     * The score of the ranking.
-     */
-    rankingScore?: number;
-    /**
-     * The score of the event.
-     */
-    score?: number;
-};
+export type Personalization = {
+    /**
+     * The score of the filters.
+     */
+    filtersScore?: number;
+    /**
+     * The score of the ranking.
+     */
+    rankingScore?: number;
+    /**
+     * The score of the event.
+     */
+    score?: number;
+};
 //# sourceMappingURL=personalization.d.ts.map

package/dist/lite/model/promote.d.ts

@@ -1,4 +1,4 @@
-import type { PromoteObjectID } from './promoteObjectID';
-import type { PromoteObjectIDs } from './promoteObjectIDs';
-export type Promote = PromoteObjectID | PromoteObjectIDs;
+import type { PromoteObjectID } from './promoteObjectID';
+import type { PromoteObjectIDs } from './promoteObjectIDs';
+export type Promote = PromoteObjectID | PromoteObjectIDs;
 //# sourceMappingURL=promote.d.ts.map

package/dist/lite/model/promoteObjectID.d.ts

@@ -1,14 +1,14 @@
-/**
- * Single objectID to promote as hits.
- */
-export type PromoteObjectID = {
-    /**
-     * Unique identifier of the object to promote.
-     */
-    objectID: string;
-    /**
-     * The position to promote the objects to (zero-based). If you pass objectIDs, the objects are placed at this position as a group. For example, if you pass four objectIDs to position 0, the objects take the first four positions.
-     */
-    position: number;
-};
+/**
+ * Single objectID to promote as hits.
+ */
+export type PromoteObjectID = {
+    /**
+     * Unique identifier of the object to promote.
+     */
+    objectID: string;
+    /**
+     * The position to promote the objects to (zero-based). If you pass objectIDs, the objects are placed at this position as a group. For example, if you pass four objectIDs to position 0, the objects take the first four positions.
+     */
+    position: number;
+};
 //# sourceMappingURL=promoteObjectID.d.ts.map

package/dist/lite/model/promoteObjectIDs.d.ts

@@ -1,14 +1,14 @@
-/**
- * Multiple objectIDs to promote as hits.
- */
-export type PromoteObjectIDs = {
-    /**
-     * Array of unique identifiers of the objects to promote.
-     */
-    objectIDs: string[];
-    /**
-     * The position to promote the objects to (zero-based). If you pass objectIDs, the objects are placed at this position as a group. For example, if you pass four objectIDs to position 0, the objects take the first four positions.
-     */
-    position: number;
-};
+/**
+ * Multiple objectIDs to promote as hits.
+ */
+export type PromoteObjectIDs = {
+    /**
+     * Array of unique identifiers of the objects to promote.
+     */
+    objectIDs: string[];
+    /**
+     * The position to promote the objects to (zero-based). If you pass objectIDs, the objects are placed at this position as a group. For example, if you pass four objectIDs to position 0, the objects take the first four positions.
+     */
+    position: number;
+};
 //# sourceMappingURL=promoteObjectIDs.d.ts.map

package/dist/lite/model/queryType.d.ts

@@ -1,5 +1,5 @@
-/**
- * Controls if and how query words are interpreted as prefixes.
- */
-export type QueryType = 'prefixAll' | 'prefixLast' | 'prefixNone';
+/**
+ * Controls if and how query words are interpreted as prefixes.
+ */
+export type QueryType = 'prefixAll' | 'prefixLast' | 'prefixNone';
 //# sourceMappingURL=queryType.d.ts.map