algoliasearch 5.0.0-alpha.52 → 5.0.0-alpha.54

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

@@ -1,51 +1,51 @@
-import type { MatchedGeoLocation } from './matchedGeoLocation';
-import type { Personalization } from './personalization';
-export type RankingInfo = {
-    /**
-     * This field is reserved for advanced usage.
-     */
-    filters: number;
-    /**
-     * Position of the most important matched attribute in the attributes to index list.
-     */
-    firstMatchedWord: number;
-    /**
-     * Distance between the geo location in the search query and the best matching geo location in the record, divided by the geo precision (in meters).
-     */
-    geoDistance: number;
-    /**
-     * Precision used when computing the geo distance, in meters.
-     */
-    geoPrecision?: number;
-    matchedGeoLocation?: MatchedGeoLocation;
-    personalization?: Personalization;
-    /**
-     * Number of exactly matched words.
-     */
-    nbExactWords: number;
-    /**
-     * Number of typos encountered when matching the record.
-     */
-    nbTypos: number;
-    /**
-     * Present and set to true if a Rule promoted the hit.
-     */
-    promoted: boolean;
-    /**
-     * When the query contains more than one word, the sum of the distances between matched words (in meters).
-     */
-    proximityDistance?: number;
-    /**
-     * Custom ranking for the object, expressed as a single integer value.
-     */
-    userScore: number;
-    /**
-     * Number of matched words, including prefixes and typos.
-     */
-    words: number;
-    /**
-     * Wether the record are promoted by the re-ranking strategy.
-     */
-    promotedByReRanking?: boolean;
-};
+import type { MatchedGeoLocation } from './matchedGeoLocation';
+import type { Personalization } from './personalization';
+export type RankingInfo = {
+    /**
+     * This field is reserved for advanced usage.
+     */
+    filters: number;
+    /**
+     * Position of the most important matched attribute in the attributes to index list.
+     */
+    firstMatchedWord: number;
+    /**
+     * Distance between the geo location in the search query and the best matching geo location in the record, divided by the geo precision (in meters).
+     */
+    geoDistance: number;
+    /**
+     * Precision used when computing the geo distance, in meters.
+     */
+    geoPrecision?: number;
+    matchedGeoLocation?: MatchedGeoLocation;
+    personalization?: Personalization;
+    /**
+     * Number of exactly matched words.
+     */
+    nbExactWords: number;
+    /**
+     * Number of typos encountered when matching the record.
+     */
+    nbTypos: number;
+    /**
+     * Present and set to true if a Rule promoted the hit.
+     */
+    promoted: boolean;
+    /**
+     * When the query contains more than one word, the sum of the distances between matched words (in meters).
+     */
+    proximityDistance?: number;
+    /**
+     * Custom ranking for the object, expressed as a single integer value.
+     */
+    userScore: number;
+    /**
+     * Number of matched words, including prefixes and typos.
+     */
+    words: number;
+    /**
+     * Wether the record are promoted by the re-ranking strategy.
+     */
+    promotedByReRanking?: boolean;
+};
 //# sourceMappingURL=rankingInfo.d.ts.map

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

@@ -1,6 +1,6 @@
-import type { MixedSearchFilters } from './mixedSearchFilters';
-/**
- * When Dynamic Re-Ranking is enabled, only records that match these filters will be impacted by Dynamic Re-Ranking.
- */
-export type ReRankingApplyFilter = MixedSearchFilters[] | string;
+import type { MixedSearchFilters } from './mixedSearchFilters';
+/**
+ * When Dynamic Re-Ranking is enabled, only records that match these filters will be impacted by Dynamic Re-Ranking.
+ */
+export type ReRankingApplyFilter = MixedSearchFilters[] | string;
 //# sourceMappingURL=reRankingApplyFilter.d.ts.map

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

@@ -1,5 +1,5 @@
-/**
- * Removes stop (common) words from the query before executing it. RemoveStopWords is used in conjunction with the queryLanguages setting. List: language ISO codes for which ignoring plurals should be enabled. This list will override any values that you may have set in queryLanguages. True: enables the stop word functionality, ensuring that stop words are removed from consideration in a search. The languages supported here are either every language, or those set by queryLanguages. False: disables stop word functionality, allowing stop words to be taken into account in a search.
- */
-export type RemoveStopWords = string[] | boolean;
+/**
+ * Removes stop (common) words from the query before executing it. RemoveStopWords is used in conjunction with the queryLanguages setting. List: language ISO codes for which ignoring plurals should be enabled. This list will override any values that you may have set in queryLanguages. True: enables the stop word functionality, ensuring that stop words are removed from consideration in a search. The languages supported here are either every language, or those set by queryLanguages. False: disables stop word functionality, allowing stop words to be taken into account in a search.
+ */
+export type RemoveStopWords = string[] | boolean;
 //# sourceMappingURL=removeStopWords.d.ts.map

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

@@ -1,5 +1,5 @@
-/**
- * Selects a strategy to remove words from the query when it doesn\'t match any hits.
- */
-export type RemoveWordsIfNoResults = 'allOptional' | 'firstWords' | 'lastWords' | 'none';
+/**
+ * Selects a strategy to remove words from the query when it doesn\'t match any hits.
+ */
+export type RemoveWordsIfNoResults = 'allOptional' | 'firstWords' | 'lastWords' | 'none';
 //# sourceMappingURL=removeWordsIfNoResults.d.ts.map

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

@@ -1,8 +1,8 @@
-import type { FacetOrdering } from './facetOrdering';
-/**
- * Content defining how the search interface should be rendered. Can be set via the settings for a default value and can be overridden via rules.
- */
-export type RenderingContent = {
-    facetOrdering?: FacetOrdering;
-};
+import type { FacetOrdering } from './facetOrdering';
+/**
+ * Content defining how the search interface should be rendered. Can be set via the settings for a default value and can be overridden via rules.
+ */
+export type RenderingContent = {
+    facetOrdering?: FacetOrdering;
+};
 //# sourceMappingURL=renderingContent.d.ts.map

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

@@ -1,30 +1,30 @@
-import type { Condition } from './condition';
-import type { Consequence } from './consequence';
-import type { TimeRange } from './timeRange';
-/**
- * Rule object.
- */
-export type Rule = {
-    /**
-     * Unique identifier of the object.
-     */
-    objectID: string;
-    /**
-     * A list of conditions that should apply to activate a Rule. You can use up to 25 conditions per Rule.
-     */
-    conditions?: Condition[];
-    consequence?: Consequence;
-    /**
-     * This field is intended for Rule management purposes, in particular to ease searching for Rules and presenting them to human readers. It\'s not interpreted by the API.
-     */
-    description?: string;
-    /**
-     * Whether the Rule is enabled. Disabled Rules remain in the index, but aren\'t applied at query time.
-     */
-    enabled?: boolean;
-    /**
-     * By default, Rules are permanently valid. When validity periods are specified, the Rule applies only during those periods; it\'s ignored the rest of the time. The list must not be empty.
-     */
-    validity?: TimeRange[];
-};
+import type { Condition } from './condition';
+import type { Consequence } from './consequence';
+import type { TimeRange } from './timeRange';
+/**
+ * Rule object.
+ */
+export type Rule = {
+    /**
+     * Unique identifier of the object.
+     */
+    objectID: string;
+    /**
+     * A list of conditions that should apply to activate a Rule. You can use up to 25 conditions per Rule.
+     */
+    conditions?: Condition[];
+    consequence?: Consequence;
+    /**
+     * This field is intended for Rule management purposes, in particular to ease searching for Rules and presenting them to human readers. It\'s not interpreted by the API.
+     */
+    description?: string;
+    /**
+     * Whether the Rule is enabled. Disabled Rules remain in the index, but aren\'t applied at query time.
+     */
+    enabled?: boolean;
+    /**
+     * By default, Rules are permanently valid. When validity periods are specified, the Rule applies only during those periods; it\'s ignored the rest of the time. The list must not be empty.
+     */
+    validity?: TimeRange[];
+};
 //# sourceMappingURL=rule.d.ts.map

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

@@ -1,2 +1,2 @@
-export type ScopeType = 'rules' | 'settings' | 'synonyms';
+export type ScopeType = 'rules' | 'settings' | 'synonyms';
 //# sourceMappingURL=scopeType.d.ts.map

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

@@ -1,4 +1,4 @@
-import type { SearchForFacetsOptions } from './searchForFacetsOptions';
-import type { SearchParams } from './searchParams';
-export type SearchForFacets = SearchForFacetsOptions & SearchParams;
+import type { SearchForFacetsOptions } from './searchForFacetsOptions';
+import type { SearchParams } from './searchParams';
+export type SearchForFacets = SearchForFacetsOptions & SearchParams;
 //# sourceMappingURL=searchForFacets.d.ts.map

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

@@ -1,21 +1,21 @@
-import type { SearchTypeFacet } from './searchTypeFacet';
-export type SearchForFacetsOptions = {
-    /**
-     * The `facet` name.
-     */
-    facet: string;
-    /**
-     * The Algolia index name.
-     */
-    indexName: string;
-    /**
-     * Text to search inside the facet\'s values.
-     */
-    facetQuery?: 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;
-    type: SearchTypeFacet;
-};
+import type { SearchTypeFacet } from './searchTypeFacet';
+export type SearchForFacetsOptions = {
+    /**
+     * The `facet` name.
+     */
+    facet: string;
+    /**
+     * The Algolia index name.
+     */
+    indexName: string;
+    /**
+     * Text to search inside the facet\'s values.
+     */
+    facetQuery?: 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;
+    type: SearchTypeFacet;
+};
 //# sourceMappingURL=searchForFacetsOptions.d.ts.map

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

@@ -1,4 +1,4 @@
-import type { SearchForHitsOptions } from './searchForHitsOptions';
-import type { SearchParams } from './searchParams';
-export type SearchForHits = SearchForHitsOptions & SearchParams;
+import type { SearchForHitsOptions } from './searchForHitsOptions';
+import type { SearchParams } from './searchParams';
+export type SearchForHits = SearchForHitsOptions & SearchParams;
 //# sourceMappingURL=searchForHits.d.ts.map

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

@@ -1,13 +1,13 @@
-import type { SearchTypeDefault } from './searchTypeDefault';
-export type SearchForHitsOptions = {
-    /**
-     * The Algolia index name.
-     */
-    indexName: string;
-    type?: SearchTypeDefault;
-} & {
-    facet?: never;
-    maxFacetHits?: never;
-    facetQuery?: never;
-};
+import type { SearchTypeDefault } from './searchTypeDefault';
+export type SearchForHitsOptions = {
+    /**
+     * The Algolia index name.
+     */
+    indexName: string;
+    type?: SearchTypeDefault;
+} & {
+    facet?: never;
+    maxFacetHits?: never;
+    facetQuery?: never;
+};
 //# sourceMappingURL=searchForHitsOptions.d.ts.map

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

@@ -1,5 +1,5 @@
-import type { Hit } from './hit';
-export type SearchHits<T = Record<string, any>> = {
-    hits: Array<Hit<T>>;
-};
+import type { Hit } from './hit';
+export type SearchHits<T = Record<string, any>> = {
+    hits: Array<Hit<T>>;
+};
 //# sourceMappingURL=searchHits.d.ts.map

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

@@ -1,7 +1,7 @@
-import type { SearchQuery } from './searchQuery';
-import type { SearchStrategy } from './searchStrategy';
-export type SearchMethodParams = {
-    requests: SearchQuery[];
-    strategy?: SearchStrategy;
-};
+import type { SearchQuery } from './searchQuery';
+import type { SearchStrategy } from './searchStrategy';
+export type SearchMethodParams = {
+    requests: SearchQuery[];
+    strategy?: SearchStrategy;
+};
 //# sourceMappingURL=searchMethodParams.d.ts.map

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

@@ -1,4 +1,4 @@
-import type { SearchParamsObject } from './searchParamsObject';
-import type { SearchParamsString } from './searchParamsString';
-export type SearchParams = SearchParamsObject | SearchParamsString;
+import type { SearchParamsObject } from './searchParamsObject';
+import type { SearchParamsString } from './searchParamsString';
+export type SearchParams = SearchParamsObject | SearchParamsString;
 //# sourceMappingURL=searchParams.d.ts.map

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

@@ -1,4 +1,4 @@
-import type { BaseSearchParams } from './baseSearchParams';
-import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';
-export type SearchParamsObject = BaseSearchParams & IndexSettingsAsSearchParams;
+import type { BaseSearchParams } from './baseSearchParams';
+import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';
+export type SearchParamsObject = BaseSearchParams & IndexSettingsAsSearchParams;
 //# sourceMappingURL=searchParamsObject.d.ts.map

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

@@ -1,7 +1,7 @@
-export type SearchParamsQuery = {
-    /**
-     * The text to search in the index.
-     */
-    query?: string;
-};
+export type SearchParamsQuery = {
+    /**
+     * The text to search in the index.
+     */
+    query?: string;
+};
 //# sourceMappingURL=searchParamsQuery.d.ts.map

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

@@ -1,7 +1,7 @@
-export type SearchParamsString = {
-    /**
-     * Search parameters as URL-encoded query string.
-     */
-    params?: string;
-};
+export type SearchParamsString = {
+    /**
+     * Search parameters as URL-encoded query string.
+     */
+    params?: string;
+};
 //# sourceMappingURL=searchParamsString.d.ts.map

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

@@ -1,4 +1,4 @@
-import type { SearchForFacets } from './searchForFacets';
-import type { SearchForHits } from './searchForHits';
-export type SearchQuery = SearchForFacets | SearchForHits;
+import type { SearchForFacets } from './searchForFacets';
+import type { SearchForHits } from './searchForHits';
+export type SearchQuery = SearchForFacets | SearchForHits;
 //# sourceMappingURL=searchQuery.d.ts.map

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

@@ -1,4 +1,4 @@
-import type { BaseSearchResponse } from './baseSearchResponse';
-import type { SearchHits } from './searchHits';
-export type SearchResponse<T = Record<string, any>> = BaseSearchResponse & SearchHits<T>;
+import type { BaseSearchResponse } from './baseSearchResponse';
+import type { SearchHits } from './searchHits';
+export type SearchResponse<T = Record<string, any>> = BaseSearchResponse & SearchHits<T>;
 //# sourceMappingURL=searchResponse.d.ts.map

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

@@ -1,5 +1,5 @@
-import type { SearchResponse } from './searchResponse';
-export type SearchResponses<T = Record<string, any>> = {
-    results: Array<SearchResponse<T>>;
-};
+import type { SearchResponse } from './searchResponse';
+export type SearchResponses<T = Record<string, any>> = {
+    results: Array<SearchResponse<T>>;
+};
 //# sourceMappingURL=searchResponses.d.ts.map

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

@@ -1,2 +1,2 @@
-export type SearchStrategy = 'none' | 'stopIfEnoughMatches';
+export type SearchStrategy = 'none' | 'stopIfEnoughMatches';
 //# sourceMappingURL=searchStrategy.d.ts.map

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

@@ -1,12 +1,12 @@
-import type { SynonymHit } from './synonymHit';
-export type SearchSynonymsResponse = Record<string, any> & {
-    /**
-     * Array of synonym objects.
-     */
-    hits: SynonymHit[];
-    /**
-     * Number of hits that the search query matched.
-     */
-    nbHits: number;
-};
+import type { SynonymHit } from './synonymHit';
+export type SearchSynonymsResponse = Record<string, any> & {
+    /**
+     * Array of synonym objects.
+     */
+    hits: SynonymHit[];
+    /**
+     * Number of hits that the search query matched.
+     */
+    nbHits: number;
+};
 //# sourceMappingURL=searchSynonymsResponse.d.ts.map

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

@@ -1,5 +1,5 @@
-/**
- * Perform a search query with `default`, will search for facet values if `facet` is given.
- */
-export type SearchTypeDefault = 'default';
+/**
+ * Perform a search query with `default`, will search for facet values if `facet` is given.
+ */
+export type SearchTypeDefault = 'default';
 //# sourceMappingURL=searchTypeDefault.d.ts.map

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

@@ -1,5 +1,5 @@
-/**
- * Perform a search query with `default`, will search for facet values if `facet` is given.
- */
-export type SearchTypeFacet = 'facet';
+/**
+ * Perform a search query with `default`, will search for facet values if `facet` is given.
+ */
+export type SearchTypeFacet = 'facet';
 //# sourceMappingURL=searchTypeFacet.d.ts.map

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

@@ -1,3 +1,3 @@
-import type { SnippetResultOption } from './snippetResultOption';
-export type SnippetResult = SnippetResultOption | SnippetResultOption[];
+import type { SnippetResultOption } from './snippetResultOption';
+export type SnippetResult = SnippetResultOption | SnippetResultOption[];
 //# sourceMappingURL=snippetResult.d.ts.map

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

@@ -1,12 +1,12 @@
-import type { MatchLevel } from './matchLevel';
-/**
- * Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.
- */
-export type SnippetResultOption = {
-    /**
-     * Markup text with occurrences highlighted.
-     */
-    value: string;
-    matchLevel: MatchLevel;
-};
+import type { MatchLevel } from './matchLevel';
+/**
+ * Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.
+ */
+export type SnippetResultOption = {
+    /**
+     * Markup text with occurrences highlighted.
+     */
+    value: string;
+    matchLevel: MatchLevel;
+};
 //# sourceMappingURL=snippetResultOption.d.ts.map

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

@@ -1,5 +1,5 @@
-/**
- * How to display the remaining items.   - `count`: facet count (descending).   - `alpha`: alphabetical (ascending).   - `hidden`: show only pinned values.
- */
-export type SortRemainingBy = 'alpha' | 'count' | 'hidden';
+/**
+ * How to display the remaining items.   - `count`: facet count (descending).   - `alpha`: alphabetical (ascending).   - `hidden`: show only pinned values.
+ */
+export type SortRemainingBy = 'alpha' | 'count' | 'hidden';
 //# sourceMappingURL=sortRemainingBy.d.ts.map

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

@@ -1,14 +1,14 @@
-/**
- * The source.
- */
-export type Source = {
-    /**
-     * The IP range of the source.
-     */
-    source: string;
-    /**
-     * The description of the source.
-     */
-    description?: string;
-};
+/**
+ * The source.
+ */
+export type Source = {
+    /**
+     * The IP range of the source.
+     */
+    source: string;
+    /**
+     * The description of the source.
+     */
+    description?: string;
+};
 //# sourceMappingURL=source.d.ts.map

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

@@ -1,18 +1,18 @@
-/**
- * Map of language ISO code supported by the dictionary (e.g., \"en\" for English) to a boolean value.
- */
-export type StandardEntries = {
-    /**
-     * Language ISO code.
-     */
-    plurals?: Record<string, boolean> | null;
-    /**
-     * Language ISO code.
-     */
-    stopwords?: Record<string, boolean> | null;
-    /**
-     * Language ISO code.
-     */
-    compounds?: Record<string, boolean> | null;
-};
+/**
+ * Map of language ISO code supported by the dictionary (e.g., \"en\" for English) to a boolean value.
+ */
+export type StandardEntries = {
+    /**
+     * Language ISO code.
+     */
+    plurals?: Record<string, boolean> | null;
+    /**
+     * Language ISO code.
+     */
+    stopwords?: Record<string, boolean> | null;
+    /**
+     * Language ISO code.
+     */
+    compounds?: Record<string, boolean> | null;
+};
 //# sourceMappingURL=standardEntries.d.ts.map

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

@@ -1,36 +1,36 @@
-import type { SynonymType } from './synonymType';
-/**
- * Synonym object.
- */
-export type SynonymHit = {
-    /**
-     * Unique identifier of the synonym object to be created or updated.
-     */
-    objectID: string;
-    type: SynonymType;
-    /**
-     * Words or phrases to be considered equivalent.
-     */
-    synonyms?: string[];
-    /**
-     * Word or phrase to appear in query strings (for onewaysynonym).
-     */
-    input?: string;
-    /**
-     * Word or phrase to appear in query strings (for altcorrection1 and altcorrection2).
-     */
-    word?: string;
-    /**
-     * Words to be matched in records.
-     */
-    corrections?: string[];
-    /**
-     * Token to be put inside records.
-     */
-    placeholder?: string;
-    /**
-     * List of query words that will match the token.
-     */
-    replacements?: string[];
-};
+import type { SynonymType } from './synonymType';
+/**
+ * Synonym object.
+ */
+export type SynonymHit = {
+    /**
+     * Unique identifier of the synonym object to be created or updated.
+     */
+    objectID: string;
+    type: SynonymType;
+    /**
+     * Words or phrases to be considered equivalent.
+     */
+    synonyms?: string[];
+    /**
+     * Word or phrase to appear in query strings (for onewaysynonym).
+     */
+    input?: string;
+    /**
+     * Word or phrase to appear in query strings (for altcorrection1 and altcorrection2).
+     */
+    word?: string;
+    /**
+     * Words to be matched in records.
+     */
+    corrections?: string[];
+    /**
+     * Token to be put inside records.
+     */
+    placeholder?: string;
+    /**
+     * List of query words that will match the token.
+     */
+    replacements?: string[];
+};
 //# sourceMappingURL=synonymHit.d.ts.map