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

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

@@ -1,6 +1,6 @@
-import type { AutomaticFacetFilter } from './automaticFacetFilter';
-/**
- * Names of facets to which automatic filtering must be applied; they must match the facet name of a facet value placeholder in the query pattern.
- */
-export type AutomaticFacetFilters = AutomaticFacetFilter[] | string[];
+import type { AutomaticFacetFilter } from './automaticFacetFilter';
+/**
+ * Names of facets to which automatic filtering must be applied; they must match the facet name of a facet value placeholder in the query pattern.
+ */
+export type AutomaticFacetFilters = AutomaticFacetFilter[] | string[];
 //# sourceMappingURL=automaticFacetFilters.d.ts.map

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

@@ -1,11 +1,11 @@
-export type BaseGetApiKeyResponse = {
-    /**
-     * The API key.
-     */
-    value?: string;
-    /**
-     * Time of the event expressed in milliseconds since the Unix epoch.
-     */
-    createdAt: number;
-};
+export type BaseGetApiKeyResponse = {
+    /**
+     * The API key.
+     */
+    value?: string;
+    /**
+     * Time of the event expressed in milliseconds since the Unix epoch.
+     */
+    createdAt: number;
+};
 //# sourceMappingURL=baseGetApiKeyResponse.d.ts.map

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

@@ -1,63 +1,63 @@
-export type BaseIndexSettings = {
-    /**
-     * Creates replicas, exact copies of an index.
-     */
-    replicas?: string[];
-    /**
-     * Set the maximum number of hits accessible via pagination.
-     */
-    paginationLimitedTo?: number;
-    /**
-     * List of attributes that can\'t be retrieved at query time.
-     */
-    unretrievableAttributes?: string[];
-    /**
-     * A list of words for which you want to turn off typo tolerance.
-     */
-    disableTypoToleranceOnWords?: string[];
-    /**
-     * Specify on which attributes in your index Algolia should apply Japanese transliteration to make words indexed in Katakana or Kanji searchable in Hiragana.
-     */
-    attributesToTransliterate?: string[];
-    /**
-     * List of attributes on which to do a decomposition of camel case words.
-     */
-    camelCaseAttributes?: string[];
-    /**
-     * Specify on which attributes in your index Algolia should apply word segmentation, also known as decompounding.
-     */
-    decompoundedAttributes?: Record<string, any>;
-    /**
-     * Sets the languages at the index level for language-specific processing such as tokenization and normalization.
-     */
-    indexLanguages?: string[];
-    /**
-     * List of attributes on which you want to disable prefix matching.
-     */
-    disablePrefixOnAttributes?: string[];
-    /**
-     * Enables compression of large integer arrays.
-     */
-    allowCompressionOfIntegerArray?: boolean;
-    /**
-     * List of numeric attributes that can be used as numerical filters.
-     */
-    numericAttributesForFiltering?: string[];
-    /**
-     * Control which separators are indexed.
-     */
-    separatorsToIndex?: string;
-    /**
-     * The complete list of attributes used for searching.
-     */
-    searchableAttributes?: string[];
-    /**
-     * Lets you store custom data in your indices.
-     */
-    userData?: Record<string, any>;
-    /**
-     * Overrides Algolia\'s default normalization.
-     */
-    customNormalization?: Record<string, Record<string, string>>;
-};
+export type BaseIndexSettings = {
+    /**
+     * Creates replicas, exact copies of an index.
+     */
+    replicas?: string[];
+    /**
+     * Set the maximum number of hits accessible via pagination.
+     */
+    paginationLimitedTo?: number;
+    /**
+     * List of attributes that can\'t be retrieved at query time.
+     */
+    unretrievableAttributes?: string[];
+    /**
+     * A list of words for which you want to turn off typo tolerance.
+     */
+    disableTypoToleranceOnWords?: string[];
+    /**
+     * Specify on which attributes in your index Algolia should apply Japanese transliteration to make words indexed in Katakana or Kanji searchable in Hiragana.
+     */
+    attributesToTransliterate?: string[];
+    /**
+     * List of attributes on which to do a decomposition of camel case words.
+     */
+    camelCaseAttributes?: string[];
+    /**
+     * Specify on which attributes in your index Algolia should apply word segmentation, also known as decompounding.
+     */
+    decompoundedAttributes?: Record<string, any>;
+    /**
+     * Sets the languages at the index level for language-specific processing such as tokenization and normalization.
+     */
+    indexLanguages?: string[];
+    /**
+     * List of attributes on which you want to disable prefix matching.
+     */
+    disablePrefixOnAttributes?: string[];
+    /**
+     * Enables compression of large integer arrays.
+     */
+    allowCompressionOfIntegerArray?: boolean;
+    /**
+     * List of numeric attributes that can be used as numerical filters.
+     */
+    numericAttributesForFiltering?: string[];
+    /**
+     * Control which separators are indexed.
+     */
+    separatorsToIndex?: string;
+    /**
+     * The complete list of attributes used for searching.
+     */
+    searchableAttributes?: string[];
+    /**
+     * Lets you store custom data in your indices.
+     */
+    userData?: Record<string, any>;
+    /**
+     * Overrides Algolia\'s default normalization.
+     */
+    customNormalization?: Record<string, Record<string, string>>;
+};
 //# sourceMappingURL=baseIndexSettings.d.ts.map

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

@@ -1,4 +1,4 @@
-import type { BaseSearchParamsWithoutQuery } from './baseSearchParamsWithoutQuery';
-import type { SearchParamsQuery } from './searchParamsQuery';
-export type BaseSearchParams = BaseSearchParamsWithoutQuery & SearchParamsQuery;
+import type { BaseSearchParamsWithoutQuery } from './baseSearchParamsWithoutQuery';
+import type { SearchParamsQuery } from './searchParamsQuery';
+export type BaseSearchParams = BaseSearchParamsWithoutQuery & SearchParamsQuery;
 //# sourceMappingURL=baseSearchParams.d.ts.map

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

@@ -1,123 +1,123 @@
-import type { AroundRadius } from './aroundRadius';
-import type { FacetFilters } from './facetFilters';
-import type { NumericFilters } from './numericFilters';
-import type { OptionalFilters } from './optionalFilters';
-import type { ReRankingApplyFilter } from './reRankingApplyFilter';
-import type { TagFilters } from './tagFilters';
-export type BaseSearchParamsWithoutQuery = {
-    /**
-     * Overrides the query parameter and performs a more generic search that can be used to find \"similar\" results.
-     */
-    similarQuery?: string;
-    /**
-     * Filter the query with numeric, facet and/or tag filters.
-     */
-    filters?: string;
-    facetFilters?: FacetFilters;
-    optionalFilters?: OptionalFilters;
-    numericFilters?: NumericFilters;
-    tagFilters?: TagFilters;
-    /**
-     * Determines how to calculate the total score for filtering.
-     */
-    sumOrFiltersScores?: boolean;
-    /**
-     * Retrieve facets and their facet values.
-     */
-    facets?: string[];
-    /**
-     * Maximum number of facet values to return for each facet during a regular search.
-     */
-    maxValuesPerFacet?: number;
-    /**
-     * Force faceting to be applied after de-duplication (via the Distinct setting).
-     */
-    facetingAfterDistinct?: boolean;
-    /**
-     * Controls how facet values are fetched.
-     */
-    sortFacetValuesBy?: string;
-    /**
-     * Specify the page to retrieve.
-     */
-    page?: number;
-    /**
-     * Specify the offset of the first hit to return.
-     */
-    offset?: number;
-    /**
-     * Set the number of hits to retrieve (used only with offset).
-     */
-    length?: number;
-    /**
-     * Search for entries around a central geolocation, enabling a geo search within a circular area.
-     */
-    aroundLatLng?: string;
-    /**
-     * Search for entries around a given location automatically computed from the requester\'s IP address.
-     */
-    aroundLatLngViaIP?: boolean;
-    aroundRadius?: AroundRadius;
-    /**
-     * Precision of geo search (in meters), to add grouping by geo location to the ranking formula.
-     */
-    aroundPrecision?: number;
-    /**
-     * Minimum radius (in meters) used for a geo search when aroundRadius is not set.
-     */
-    minimumAroundRadius?: number;
-    /**
-     * Search inside a rectangular area (in geo coordinates).
-     */
-    insideBoundingBox?: number[];
-    /**
-     * Search inside a polygon (in geo coordinates).
-     */
-    insidePolygon?: number[];
-    /**
-     * This parameter changes the default values of certain parameters and settings that work best for a natural language query, such as ignorePlurals, removeStopWords, removeWordsIfNoResults, analyticsTags and ruleContexts. These parameters and settings work well together when the query is formatted in natural language instead of keywords, for example when your user performs a voice search.
-     */
-    naturalLanguages?: string[];
-    /**
-     * Enables contextual rules.
-     */
-    ruleContexts?: string[];
-    /**
-     * Define the impact of the Personalization feature.
-     */
-    personalizationImpact?: number;
-    /**
-     * Associates a certain user token with the current search.
-     */
-    userToken?: string;
-    /**
-     * Retrieve detailed ranking information.
-     */
-    getRankingInfo?: boolean;
-    /**
-     * Enable the Click Analytics feature.
-     */
-    clickAnalytics?: boolean;
-    /**
-     * Whether the current query will be taken into account in the Analytics.
-     */
-    analytics?: boolean;
-    /**
-     * List of tags to apply to the query for analytics purposes.
-     */
-    analyticsTags?: string[];
-    /**
-     * Whether to include or exclude a query from the processing-time percentile computation.
-     */
-    percentileComputation?: boolean;
-    /**
-     * Whether this search should participate in running AB tests.
-     */
-    enableABTest?: boolean;
-    /**
-     * Whether this search should use AI Re-Ranking.
-     */
-    enableReRanking?: boolean;
-    reRankingApplyFilter?: ReRankingApplyFilter | null;
-};
+import type { AroundRadius } from './aroundRadius';
+import type { FacetFilters } from './facetFilters';
+import type { NumericFilters } from './numericFilters';
+import type { OptionalFilters } from './optionalFilters';
+import type { ReRankingApplyFilter } from './reRankingApplyFilter';
+import type { TagFilters } from './tagFilters';
+export type BaseSearchParamsWithoutQuery = {
+    /**
+     * Overrides the query parameter and performs a more generic search that can be used to find \"similar\" results.
+     */
+    similarQuery?: string;
+    /**
+     * Filter the query with numeric, facet and/or tag filters.
+     */
+    filters?: string;
+    facetFilters?: FacetFilters;
+    optionalFilters?: OptionalFilters;
+    numericFilters?: NumericFilters;
+    tagFilters?: TagFilters;
+    /**
+     * Determines how to calculate the total score for filtering.
+     */
+    sumOrFiltersScores?: boolean;
+    /**
+     * Retrieve facets and their facet values.
+     */
+    facets?: string[];
+    /**
+     * Maximum number of facet values to return for each facet during a regular search.
+     */
+    maxValuesPerFacet?: number;
+    /**
+     * Force faceting to be applied after de-duplication (via the Distinct setting).
+     */
+    facetingAfterDistinct?: boolean;
+    /**
+     * Controls how facet values are fetched.
+     */
+    sortFacetValuesBy?: string;
+    /**
+     * Specify the page to retrieve.
+     */
+    page?: number;
+    /**
+     * Specify the offset of the first hit to return.
+     */
+    offset?: number;
+    /**
+     * Set the number of hits to retrieve (used only with offset).
+     */
+    length?: number;
+    /**
+     * Search for entries around a central geolocation, enabling a geo search within a circular area.
+     */
+    aroundLatLng?: string;
+    /**
+     * Search for entries around a given location automatically computed from the requester\'s IP address.
+     */
+    aroundLatLngViaIP?: boolean;
+    aroundRadius?: AroundRadius;
+    /**
+     * Precision of geo search (in meters), to add grouping by geo location to the ranking formula.
+     */
+    aroundPrecision?: number;
+    /**
+     * Minimum radius (in meters) used for a geo search when aroundRadius is not set.
+     */
+    minimumAroundRadius?: number;
+    /**
+     * Search inside a rectangular area (in geo coordinates).
+     */
+    insideBoundingBox?: number[];
+    /**
+     * Search inside a polygon (in geo coordinates).
+     */
+    insidePolygon?: number[];
+    /**
+     * This parameter changes the default values of certain parameters and settings that work best for a natural language query, such as ignorePlurals, removeStopWords, removeWordsIfNoResults, analyticsTags and ruleContexts. These parameters and settings work well together when the query is formatted in natural language instead of keywords, for example when your user performs a voice search.
+     */
+    naturalLanguages?: string[];
+    /**
+     * Enables contextual rules.
+     */
+    ruleContexts?: string[];
+    /**
+     * Define the impact of the Personalization feature.
+     */
+    personalizationImpact?: number;
+    /**
+     * Associates a certain user token with the current search.
+     */
+    userToken?: string;
+    /**
+     * Retrieve detailed ranking information.
+     */
+    getRankingInfo?: boolean;
+    /**
+     * Enable the Click Analytics feature.
+     */
+    clickAnalytics?: boolean;
+    /**
+     * Whether the current query will be taken into account in the Analytics.
+     */
+    analytics?: boolean;
+    /**
+     * List of tags to apply to the query for analytics purposes.
+     */
+    analyticsTags?: string[];
+    /**
+     * Whether to include or exclude a query from the processing-time percentile computation.
+     */
+    percentileComputation?: boolean;
+    /**
+     * Whether this search should participate in running AB tests.
+     */
+    enableABTest?: boolean;
+    /**
+     * Whether this search should use AI Re-Ranking.
+     */
+    enableReRanking?: boolean;
+    reRankingApplyFilter?: ReRankingApplyFilter | null;
+};
 //# sourceMappingURL=baseSearchParamsWithoutQuery.d.ts.map

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

@@ -1,102 +1,102 @@
-import type { FacetsStats } from './facetsStats';
-import type { RenderingContent } from './renderingContent';
-export type BaseSearchResponse = {
-    /**
-     * If a search encounters an index that is being A/B tested, abTestID reports the ongoing A/B test ID.
-     */
-    abTestID?: number;
-    /**
-     * If a search encounters an index that is being A/B tested, abTestVariantID reports the variant ID of the index used (starting at 1).
-     */
-    abTestVariantID?: number;
-    /**
-     * The computed geo location.
-     */
-    aroundLatLng?: string;
-    /**
-     * The automatically computed radius. For legacy reasons, this parameter is a string and not an integer.
-     */
-    automaticRadius?: string;
-    /**
-     * Whether the facet count is exhaustive or approximate.
-     */
-    exhaustiveFacetsCount?: boolean;
-    /**
-     * Indicate if the nbHits count was exhaustive or approximate.
-     */
-    exhaustiveNbHits: boolean;
-    /**
-     * Indicate if the typo-tolerance search was exhaustive or approximate (only included when typo-tolerance is enabled).
-     */
-    exhaustiveTypo?: boolean;
-    /**
-     * A mapping of each facet name to the corresponding facet counts.
-     */
-    facets?: Record<string, Record<string, number>>;
-    /**
-     * Statistics for numerical facets.
-     */
-    facets_stats?: Record<string, FacetsStats>;
-    /**
-     * Set the number of hits per page.
-     */
-    hitsPerPage: number;
-    /**
-     * Index name used for the query.
-     */
-    index?: string;
-    /**
-     * Index name used for the query. In the case of an A/B test, the targeted index isn\'t always the index used by the query.
-     */
-    indexUsed?: string;
-    /**
-     * Used to return warnings about the query.
-     */
-    message?: string;
-    /**
-     * Number of hits that the search query matched.
-     */
-    nbHits: number;
-    /**
-     * Number of pages available for the current query.
-     */
-    nbPages: number;
-    /**
-     * The number of hits selected and sorted by the relevant sort algorithm.
-     */
-    nbSortedHits?: number;
-    /**
-     * Specify the page to retrieve.
-     */
-    page: number;
-    /**
-     * A url-encoded string of all search parameters.
-     */
-    params: string;
-    /**
-     * The query string that will be searched, after normalization.
-     */
-    parsedQuery?: string;
-    /**
-     * Time the server took to process the request, in milliseconds.
-     */
-    processingTimeMS: number;
-    /**
-     * The text to search in the index.
-     */
-    query: string;
-    /**
-     * A markup text indicating which parts of the original query have been removed in order to retrieve a non-empty result set.
-     */
-    queryAfterRemoval?: string;
-    /**
-     * Actual host name of the server that processed the request.
-     */
-    serverUsed?: string;
-    /**
-     * Lets you store custom data in your indices.
-     */
-    userData?: Record<string, any>;
-    renderingContent?: RenderingContent;
-};
+import type { FacetsStats } from './facetsStats';
+import type { RenderingContent } from './renderingContent';
+export type BaseSearchResponse = {
+    /**
+     * If a search encounters an index that is being A/B tested, abTestID reports the ongoing A/B test ID.
+     */
+    abTestID?: number;
+    /**
+     * If a search encounters an index that is being A/B tested, abTestVariantID reports the variant ID of the index used (starting at 1).
+     */
+    abTestVariantID?: number;
+    /**
+     * The computed geo location.
+     */
+    aroundLatLng?: string;
+    /**
+     * The automatically computed radius. For legacy reasons, this parameter is a string and not an integer.
+     */
+    automaticRadius?: string;
+    /**
+     * Whether the facet count is exhaustive or approximate.
+     */
+    exhaustiveFacetsCount?: boolean;
+    /**
+     * Indicate if the nbHits count was exhaustive or approximate.
+     */
+    exhaustiveNbHits: boolean;
+    /**
+     * Indicate if the typo-tolerance search was exhaustive or approximate (only included when typo-tolerance is enabled).
+     */
+    exhaustiveTypo?: boolean;
+    /**
+     * A mapping of each facet name to the corresponding facet counts.
+     */
+    facets?: Record<string, Record<string, number>>;
+    /**
+     * Statistics for numerical facets.
+     */
+    facets_stats?: Record<string, FacetsStats>;
+    /**
+     * Set the number of hits per page.
+     */
+    hitsPerPage: number;
+    /**
+     * Index name used for the query.
+     */
+    index?: string;
+    /**
+     * Index name used for the query. In the case of an A/B test, the targeted index isn\'t always the index used by the query.
+     */
+    indexUsed?: string;
+    /**
+     * Used to return warnings about the query.
+     */
+    message?: string;
+    /**
+     * Number of hits that the search query matched.
+     */
+    nbHits: number;
+    /**
+     * Number of pages available for the current query.
+     */
+    nbPages: number;
+    /**
+     * The number of hits selected and sorted by the relevant sort algorithm.
+     */
+    nbSortedHits?: number;
+    /**
+     * Specify the page to retrieve.
+     */
+    page: number;
+    /**
+     * A url-encoded string of all search parameters.
+     */
+    params: string;
+    /**
+     * The query string that will be searched, after normalization.
+     */
+    parsedQuery?: string;
+    /**
+     * Time the server took to process the request, in milliseconds.
+     */
+    processingTimeMS: number;
+    /**
+     * The text to search in the index.
+     */
+    query: string;
+    /**
+     * A markup text indicating which parts of the original query have been removed in order to retrieve a non-empty result set.
+     */
+    queryAfterRemoval?: string;
+    /**
+     * Actual host name of the server that processed the request.
+     */
+    serverUsed?: string;
+    /**
+     * Lets you store custom data in your indices.
+     */
+    userData?: Record<string, any>;
+    renderingContent?: RenderingContent;
+};
 //# sourceMappingURL=baseSearchResponse.d.ts.map

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

@@ -1,4 +1,4 @@
-import type { BrowseParamsObject } from './browseParamsObject';
-import type { SearchParamsString } from './searchParamsString';
-export type BrowseParams = BrowseParamsObject | SearchParamsString;
+import type { BrowseParamsObject } from './browseParamsObject';
+import type { SearchParamsString } from './searchParamsString';
+export type BrowseParams = BrowseParamsObject | SearchParamsString;
 //# sourceMappingURL=browseParams.d.ts.map

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

@@ -1,4 +1,4 @@
-import type { Cursor } from './cursor';
-import type { SearchParamsObject } from './searchParamsObject';
-export type BrowseParamsObject = Cursor & SearchParamsObject;
+import type { Cursor } from './cursor';
+import type { SearchParamsObject } from './searchParamsObject';
+export type BrowseParamsObject = Cursor & SearchParamsObject;
 //# sourceMappingURL=browseParamsObject.d.ts.map

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

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