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

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

@@ -1,39 +1,39 @@
-import type { Acl } from './acl';
-/**
- * Api Key object.
- */
-export type ApiKey = {
-    /**
-     * Set of permissions associated with the key.
-     */
-    acl: Acl[];
-    /**
-     * A comment used to identify a key more easily in the dashboard. It is not interpreted by the API.
-     */
-    description?: string;
-    /**
-     * Restrict this new API key to a list of indices or index patterns. If the list is empty, all indices are allowed.
-     */
-    indexes?: string[];
-    /**
-     * Maximum number of hits this API key can retrieve in one query. If zero, no limit is enforced.
-     */
-    maxHitsPerQuery?: number;
-    /**
-     * Maximum number of API calls per hour allowed from a given IP address or a user token.
-     */
-    maxQueriesPerIPPerHour?: number;
-    /**
-     * URL-encoded query string. Force some query parameters to be applied for each query made with this API key.
-     */
-    queryParameters?: string;
-    /**
-     * Restrict this new API key to specific referers. If empty or blank, defaults to all referers.
-     */
-    referers?: string[];
-    /**
-     * Validity limit for this key in seconds. The key will automatically be removed after this period of time.
-     */
-    validity?: number;
-};
+import type { Acl } from './acl';
+/**
+ * Api Key object.
+ */
+export type ApiKey = {
+    /**
+     * Set of permissions associated with the key.
+     */
+    acl: Acl[];
+    /**
+     * A comment used to identify a key more easily in the dashboard. It is not interpreted by the API.
+     */
+    description?: string;
+    /**
+     * Restrict this new API key to a list of indices or index patterns. If the list is empty, all indices are allowed.
+     */
+    indexes?: string[];
+    /**
+     * Maximum number of hits this API key can retrieve in one query. If zero, no limit is enforced.
+     */
+    maxHitsPerQuery?: number;
+    /**
+     * Maximum number of API calls per hour allowed from a given IP address or a user token.
+     */
+    maxQueriesPerIPPerHour?: number;
+    /**
+     * URL-encoded query string. Force some query parameters to be applied for each query made with this API key.
+     */
+    queryParameters?: string;
+    /**
+     * Restrict this new API key to specific referers. If empty or blank, defaults to all referers.
+     */
+    referers?: string[];
+    /**
+     * Validity limit for this key in seconds. The key will automatically be removed after this period of time.
+     */
+    validity?: number;
+};
 //# sourceMappingURL=apiKey.d.ts.map

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

@@ -1,6 +1,6 @@
-import type { AroundRadiusAll } from './aroundRadiusAll';
-/**
- * Define the maximum radius for a geo search (in meters).
- */
-export type AroundRadius = AroundRadiusAll | number;
+import type { AroundRadiusAll } from './aroundRadiusAll';
+/**
+ * Define the maximum radius for a geo search (in meters).
+ */
+export type AroundRadius = AroundRadiusAll | number;
 //# sourceMappingURL=aroundRadius.d.ts.map

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

@@ -1,2 +1,2 @@
-export type AroundRadiusAll = 'all';
+export type AroundRadiusAll = 'all';
 //# sourceMappingURL=aroundRadiusAll.d.ts.map

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

@@ -1,10 +1,10 @@
-/**
- * Assign userID parameters.
- */
-export type AssignUserIdParams = {
-    /**
-     * Name of the cluster.
-     */
-    cluster: string;
-};
+/**
+ * Assign userID parameters.
+ */
+export type AssignUserIdParams = {
+    /**
+     * Name of the cluster.
+     */
+    cluster: string;
+};
 //# sourceMappingURL=assignUserIdParams.d.ts.map

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

@@ -1,3 +1,3 @@
-import type { BuiltInOperation } from './builtInOperation';
-export type AttributeToUpdate = BuiltInOperation | string;
+import type { BuiltInOperation } from './builtInOperation';
+export type AttributeToUpdate = BuiltInOperation | string;
 //# sourceMappingURL=attributeToUpdate.d.ts.map

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

@@ -1,18 +1,18 @@
-/**
- * Automatic facet Filter.
- */
-export type AutomaticFacetFilter = {
-    /**
-     * Attribute to filter on. This must match a facet placeholder in the Rule\'s pattern.
-     */
-    facet: string;
-    /**
-     * Score for the filter. Typically used for optional or disjunctive filters.
-     */
-    score?: number;
-    /**
-     * Whether the filter is disjunctive (true) or conjunctive (false).
-     */
-    disjunctive?: boolean;
-};
+/**
+ * Automatic facet Filter.
+ */
+export type AutomaticFacetFilter = {
+    /**
+     * Attribute to filter on. This must match a facet placeholder in the Rule\'s pattern.
+     */
+    facet: string;
+    /**
+     * Score for the filter. Typically used for optional or disjunctive filters.
+     */
+    score?: number;
+    /**
+     * Whether the filter is disjunctive (true) or conjunctive (false).
+     */
+    disjunctive?: boolean;
+};
 //# sourceMappingURL=automaticFacetFilter.d.ts.map

package/dist/client-search/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/client-search/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/client-search/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/client-search/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/client-search/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