algoliasearch 5.2.5 → 5.3.0

package/dist/lite/browser.d.ts

@@ -1,52 +1,5 @@
 import * as _algolia_client_common from '@algolia/client-common';
-import { ClientOptions } from '@algolia/client-common';
-
-/**
- * Access control list permissions.
- */
-type Acl = 'addObject' | 'analytics' | 'browse' | 'deleteIndex' | 'deleteObject' | 'editSettings' | 'inference' | 'listIndexes' | 'logs' | 'personalization' | 'recommendation' | 'search' | 'seeUnretrievableAttributes' | 'settings' | 'usage';
-
-type AdvancedSyntaxFeatures = 'exactPhrase' | 'excludeWords';
-
-type AlternativesAsExact = 'ignorePlurals' | 'multiWordsSynonym' | 'singleWordSynonym';
-
-/**
- * API key object.
- */
-type ApiKey = {
-    /**
-     * Permissions that determine the type of API requests this key can make. The required ACL is listed in each endpoint\'s reference. For more information, see [access control list](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl).
-     */
-    acl: Acl[];
-    /**
-     * Description of an API key to help you identify this API key.
-     */
-    description?: string;
-    /**
-     * Index names or patterns that this API key can access. By default, an API key can access all indices in the same application.  You can use leading and trailing wildcard characters (`*`):  - `dev_*` matches all indices starting with \"dev_\". - `*_dev` matches all indices ending with \"_dev\". - `*_products_*` matches all indices containing \"_products_\".
-     */
-    indexes?: string[];
-    /**
-     * Maximum number of results this API key can retrieve in one query. By default, there\'s no limit.
-     */
-    maxHitsPerQuery?: number;
-    /**
-     * Maximum number of API requests allowed per IP address or [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/) per hour.  If this limit is reached, the API returns an error with status code `429`. By default, there\'s no limit.
-     */
-    maxQueriesPerIPPerHour?: number;
-    /**
-     * Query parameters to add when making API requests with this API key.  To restrict this API key to specific IP addresses, add the `restrictSources` parameter. You can only add a single source, but you can provide a range of IP addresses.  Creating an API key fails if the request is made from an IP address that\'s outside the restricted range.
-     */
-    queryParameters?: string;
-    /**
-     * Allowed HTTP referrers for this API key.  By default, all referrers are allowed. You can use leading and trailing wildcard characters (`*`):  - `https://algolia.com/_*` allows all referrers starting with \"https://algolia.com/\" - `*.algolia.com` allows all referrers ending with \".algolia.com\" - `*algolia.com*` allows all referrers in the domain \"algolia.com\".  Like all HTTP headers, referrers can be spoofed. Don\'t rely on them to secure your data. For more information, see [HTTP referrer restrictions](https://www.algolia.com/doc/guides/security/security-best-practices/#http-referrers-restrictions).
-     */
-    referers?: string[];
-    /**
-     * Duration (in seconds) after which the API key expires. By default, API keys don\'t expire.
-     */
-    validity?: number;
-};
+import { CreateClientOptions, RequestOptions, ClientOptions } from '@algolia/client-common';
 
 /**
  * Range object with lower and upper values in meters to define custom ranges.
@@ -77,116 +30,6 @@ type AroundRadiusAll = 'all';
  */
 type AroundRadius = AroundRadiusAll | number;
 
-/**
- * Filter or optional filter to be applied to the search.
- */
-type AutomaticFacetFilter = {
-    /**
-     * Facet name to be applied as filter. The name must match placeholders in the `pattern` parameter. For example, with `pattern: {facet:genre}`, `automaticFacetFilters` must be `genre`.
-     */
-    facet: string;
-    /**
-     * Filter scores to give different weights to individual filters.
-     */
-    score?: number;
-    /**
-     * Whether the filter is disjunctive or conjunctive.  If true the filter has multiple matches, multiple occurences are combined with the logical `OR` operation. If false, multiple occurences are combined with the logical `AND` operation.
-     */
-    disjunctive?: boolean;
-};
-
-/**
- * Filter to be applied to the search.  You can use this to respond to search queries that match a facet value. For example, if users search for \"comedy\", which matches a facet value of the \"genre\" facet, you can filter the results to show the top-ranked comedy movies.
- */
-type AutomaticFacetFilters = AutomaticFacetFilter[] | string[];
-
-type BaseGetApiKeyResponse = {
-    /**
-     * API key.
-     */
-    value?: string;
-    /**
-     * Timestamp when the object was created, in milliseconds since the Unix epoch.
-     */
-    createdAt: number;
-};
-
-/**
- * ISO code for a supported language.
- */
-type SupportedLanguage = 'af' | 'ar' | 'az' | 'bg' | 'bn' | 'ca' | 'cs' | 'cy' | 'da' | 'de' | 'el' | 'en' | 'eo' | 'es' | 'et' | 'eu' | 'fa' | 'fi' | 'fo' | 'fr' | 'ga' | 'gl' | 'he' | 'hi' | 'hu' | 'hy' | 'id' | 'is' | 'it' | 'ja' | 'ka' | 'kk' | 'ko' | 'ku' | 'ky' | 'lt' | 'lv' | 'mi' | 'mn' | 'mr' | 'ms' | 'mt' | 'nb' | 'nl' | 'no' | 'ns' | 'pl' | 'ps' | 'pt-br' | 'pt' | 'qu' | 'ro' | 'ru' | 'sk' | 'sq' | 'sv' | 'sw' | 'ta' | 'te' | 'th' | 'tl' | 'tn' | 'tr' | 'tt' | 'uk' | 'ur' | 'uz' | 'zh';
-
-type BaseIndexSettings = {
-    /**
-     * Attributes used for [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/).  Facets are attributes that let you categorize search results. They can be used for filtering search results. By default, no attribute is used for faceting. Attribute names are case-sensitive.  **Modifiers**  - `filterOnly(\"ATTRIBUTE\")`.   Allows using this attribute as a filter, but doesn\'t evalue the facet values.  - `searchable(\"ATTRIBUTE\")`.   Allows searching for facet values.  - `afterDistinct(\"ATTRIBUTE\")`.   Evaluates the facet count _after_ deduplication with `distinct`.   This ensures accurate facet counts.   You can apply this modifier to searchable facets: `afterDistinct(searchable(ATTRIBUTE))`.
-     */
-    attributesForFaceting?: string[];
-    /**
-     * Creates [replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/).  Replicas are copies of a primary index with the same records but different settings, synonyms, or rules. If you want to offer a different ranking or sorting of your search results, you\'ll use replica indices. All index operations on a primary index are automatically forwarded to its replicas. To add a replica index, you must provide the complete set of replicas to this parameter. If you omit a replica from this list, the replica turns into a regular, standalone index that will no longer by synced with the primary index.  **Modifier**  - `virtual(\"REPLICA\")`.   Create a virtual replica,   Virtual replicas don\'t increase the number of records and are optimized for [Relevant sorting](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/relevant-sort/).
-     */
-    replicas?: string[];
-    /**
-     * Maximum number of search results that can be obtained through pagination.  Higher pagination limits might slow down your search. For pagination limits above 1,000, the sorting of results beyond the 1,000th hit can\'t be guaranteed.
-     */
-    paginationLimitedTo?: number;
-    /**
-     * Attributes that can\'t be retrieved at query time.  This can be useful if you want to use an attribute for ranking or to [restrict access](https://www.algolia.com/doc/guides/security/api-keys/how-to/user-restricted-access-to-data/), but don\'t want to include it in the search results. Attribute names are case-sensitive.
-     */
-    unretrievableAttributes?: string[];
-    /**
-     * Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
-     */
-    disableTypoToleranceOnWords?: string[];
-    /**
-     * Attributes, for which you want to support [Japanese transliteration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#japanese-transliteration-and-type-ahead).  Transliteration supports searching in any of the Japanese writing systems. To support transliteration, you must set the indexing language to Japanese. Attribute names are case-sensitive.
-     */
-    attributesToTransliterate?: string[];
-    /**
-     * Attributes for which to split [camel case](https://wikipedia.org/wiki/Camel_case) words. Attribute names are case-sensitive.
-     */
-    camelCaseAttributes?: string[];
-    /**
-     * Searchable attributes to which Algolia should apply [word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) (decompounding). Attribute names are case-sensitive.  Compound words are formed by combining two or more individual words, and are particularly prevalent in Germanic languages—for example, \"firefighter\". With decompounding, the individual components are indexed separately.  You can specify different lists for different languages. Decompounding is supported for these languages: Dutch (`nl`), German (`de`), Finnish (`fi`), Danish (`da`), Swedish (`sv`), and Norwegian (`no`). Decompounding doesn\'t work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, `Gartenstühle` won\'t be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308).
-     */
-    decompoundedAttributes?: Record<string, unknown>;
-    /**
-     * Languages for language-specific processing steps, such as word detection and dictionary settings.  **You should always specify an indexing language.** If you don\'t specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/).
-     */
-    indexLanguages?: SupportedLanguage[];
-    /**
-     * Searchable attributes for which you want to turn off [prefix matching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/#adjusting-prefix-search). Attribute names are case-sensitive.
-     */
-    disablePrefixOnAttributes?: string[];
-    /**
-     * Whether arrays with exclusively non-negative integers should be compressed for better performance. If true, the compressed arrays may be reordered.
-     */
-    allowCompressionOfIntegerArray?: boolean;
-    /**
-     * Numeric attributes that can be used as [numerical filters](https://www.algolia.com/doc/guides/managing-results/rules/detecting-intent/how-to/applying-a-custom-filter-for-a-specific-query/#numerical-filters). Attribute names are case-sensitive.  By default, all numeric attributes are available as numerical filters. For faster indexing, reduce the number of numeric attributes.  If you want to turn off filtering for all numeric attributes, specifiy an attribute that doesn\'t exist in your index, such as `NO_NUMERIC_FILTERING`.  **Modifier**  - `equalOnly(\"ATTRIBUTE\")`.   Support only filtering based on equality comparisons `=` and `!=`.
-     */
-    numericAttributesForFiltering?: string[];
-    /**
-     * Controls which separators are indexed.  Separators are all non-letter characters except spaces and currency characters, such as $€£¥. By default, separator characters aren\'t indexed. With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, a search for `C#` would report two matches.
-     */
-    separatorsToIndex?: string;
-    /**
-     * Attributes used for searching. Attribute names are case-sensitive.  By default, all attributes are searchable and the [Attribute](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#attribute) ranking criterion is turned off. With a non-empty list, Algolia only returns results with matches in the selected attributes. In addition, the Attribute ranking criterion is turned on: matches in attributes that are higher in the list of `searchableAttributes` rank first. To make matches in two attributes rank equally, include them in a comma-separated string, such as `\"title,alternate_title\"`. Attributes with the same priority are always unordered.  For more information, see [Searchable attributes](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/setting-searchable-attributes/).  **Modifier**  - `unordered(\"ATTRIBUTE\")`.   Ignore the position of a match within the attribute.  Without modifier, matches at the beginning of an attribute rank higer than matches at the end.
-     */
-    searchableAttributes?: string[];
-    /**
-     * An object with custom data.  You can store up to 32kB as custom data.
-     */
-    userData?: Record<string, unknown>;
-    /**
-     * Characters and their normalized replacements. This overrides Algolia\'s default [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/).
-     */
-    customNormalization?: Record<string, Record<string, string>>;
-    /**
-     * Attribute that should be used to establish groups of results. Attribute names are case-sensitive.  All records with the same value for this attribute are considered a group. You can combine `attributeForDistinct` with the `distinct` search parameter to control how many items per group are included in the search results.  If you want to use the same attribute also for faceting, use the `afterDistinct` modifier of the `attributesForFaceting` setting. This applies faceting _after_ deduplication, which will result in accurate facet counts.
-     */
-    attributeForDistinct?: string;
-};
-
 /**
  * Filter the search by facet values, so that only records with the same facet values are retrieved.  **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.**  - `[filter1, filter2]` is interpreted as `filter1 AND filter2`. - `[[filter1, filter2], filter3]` is interpreted as `filter1 OR filter2 AND filter3`. - `facet:-value` is interpreted as `NOT facet:value`.  While it\'s best to avoid attributes that start with a `-`, you can still filter them by escaping with a backslash: `facet:\\-value`.
  */
@@ -202,6 +45,11 @@ type NumericFilters = NumericFilters[] | string;
  */
 type OptionalFilters = OptionalFilters[] | string;
 
+/**
+ * ISO code for a supported language.
+ */
+type SupportedLanguage = 'af' | 'ar' | 'az' | 'bg' | 'bn' | 'ca' | 'cs' | 'cy' | 'da' | 'de' | 'el' | 'en' | 'eo' | 'es' | 'et' | 'eu' | 'fa' | 'fi' | 'fo' | 'fr' | 'ga' | 'gl' | 'he' | 'hi' | 'hu' | 'hy' | 'id' | 'is' | 'it' | 'ja' | 'ka' | 'kk' | 'ko' | 'ku' | 'ky' | 'lt' | 'lv' | 'mi' | 'mn' | 'mr' | 'ms' | 'mt' | 'nb' | 'nl' | 'no' | 'ns' | 'pl' | 'ps' | 'pt-br' | 'pt' | 'qu' | 'ro' | 'ru' | 'sk' | 'sq' | 'sv' | 'sw' | 'ta' | 'te' | 'th' | 'tl' | 'tn' | 'tr' | 'tt' | 'uk' | 'ur' | 'uz' | 'zh';
+
 /**
  * Filter the search by values of the special `_tags` attribute.  **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.**  Different from regular facets, `_tags` can only be used for filtering (including or excluding records). You won\'t get a facet count. The same combination and escaping rules apply as for `facetFilters`.
  */
@@ -325,6 +173,10 @@ type SearchParamsQuery = {
 
 type BaseSearchParams = BaseSearchParamsWithoutQuery & SearchParamsQuery;
 
+type AdvancedSyntaxFeatures = 'exactPhrase' | 'excludeWords';
+
+type AlternativesAsExact = 'ignorePlurals' | 'multiWordsSynonym' | 'singleWordSynonym';
+
 /**
  * Determines how many records of a group are included in the search results.  Records with the same value for the `attributeForDistinct` attribute are considered a group. The `distinct` setting controls how many members of the group are returned. This is useful for [deduplication and grouping](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature).  The `distinct` setting is ignored if `attributeForDistinct` is not set.
  */
@@ -610,88 +462,290 @@ type BaseRecommendRequest = {
 };
 
 /**
- * Whether certain properties of the search response are calculated exhaustive (exact) or approximated.
+ * Frequently bought together model.  This model recommends items that have been purchased within 1 day with the item with the ID `objectID`.
  */
-type Exhaustive = {
-    /**
-     * Whether the facet count is exhaustive (`true`) or approximate (`false`). See the [related discussion](https://support.algolia.com/hc/en-us/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate-).
-     */
-    facetsCount?: boolean;
-    /**
-     * The value is `false` if not all facet values are retrieved.
-     */
-    facetValues?: boolean;
-    /**
-     * Whether the `nbHits` is exhaustive (`true`) or approximate (`false`). When the query takes more than 50ms to be processed, the engine makes an approximation. This can happen when using complex filters on millions of records, when typo-tolerance was not exhaustive, or when enough hits have been retrieved (for example, after the engine finds 10,000 exact matches). `nbHits` is reported as non-exhaustive whenever an approximation is made, even if the approximation didn’t, in the end, impact the exhaustivity of the query.
-     */
-    nbHits?: boolean;
-    /**
-     * Rules matching exhaustivity. The value is `false` if rules were enable for this query, and could not be fully processed due a timeout. This is generally caused by the number of alternatives (such as typos) which is too large.
-     */
-    rulesMatch?: boolean;
-    /**
-     * Whether the typo search was exhaustive (`true`) or approximate (`false`). An approximation is done when the typo search query part takes more than 10% of the query budget (ie. 5ms by default) to be processed (this can happen when a lot of typo alternatives exist for the query). This field will not be included when typo-tolerance is entirely disabled.
-     */
-    typo?: boolean;
-};
+type FbtModel = 'bought-together';
 
-type FacetStats = {
-    /**
-     * Minimum value in the results.
-     */
-    min?: number;
-    /**
-     * Maximum value in the results.
-     */
-    max?: number;
-    /**
-     * Average facet value in the results.
-     */
-    avg?: number;
+type FrequentlyBoughtTogether = {
+    model: FbtModel;
     /**
-     * Sum of all values in the results.
+     * Unique record identifier.
      */
-    sum?: number;
+    objectID: string;
 };
 
+type BoughtTogetherQuery = BaseRecommendRequest & FrequentlyBoughtTogether;
+
+type FallbackParams = Record<string, unknown> & SearchParamsObject;
+
 /**
- * Redirect rule data.
+ * Looking similar model.  This model recommends items that look similar to the item with the ID `objectID` based on image attributes in your index.
  */
-type RedirectRuleIndexData = {
-    ruleObjectID: string;
-};
+type LookingSimilarModel = 'looking-similar';
 
-type RedirectRuleIndexMetadata = {
-    /**
-     * Source index for the redirect rule.
-     */
-    source: string;
-    /**
-     * Destination index for the redirect rule.
-     */
-    dest: string;
-    /**
-     * Reason for the redirect rule.
-     */
-    reason: string;
+type LookingSimilar = {
+    model: LookingSimilarModel;
     /**
-     * Redirect rule status.
+     * Unique record identifier.
      */
-    succeed: boolean;
-    data: RedirectRuleIndexData;
+    objectID: string;
+    fallbackParameters?: FallbackParams;
 };
 
+type LookingSimilarQuery = BaseRecommendRequest & LookingSimilar;
+
 /**
- * [Redirect results to a URL](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/redirects/), this this parameter is for internal use only.
+ * \"Recommened for you\" model.
  */
-type Redirect = {
-    index?: RedirectRuleIndexMetadata[];
+type RecommendedForYouModel = 'recommended-for-you';
+
+type RecommendedForYou = {
+    model: RecommendedForYouModel;
+    fallbackParameters?: FallbackParams;
 };
 
-type BaseSearchResponse = Record<string, any> & {
-    /**
-     * A/B test ID. This is only included in the response for indices that are part of an A/B test.
-     */
+type RecommendedForYouQuery = BaseRecommendRequest & RecommendedForYou;
+
+/**
+ * Related products or similar content model.  This model recommends items that are similar to the item with the ID `objectID`. Similarity is determined from the user interactions and attributes.
+ */
+type RelatedModel = 'related-products';
+
+type RelatedProducts = {
+    model: RelatedModel;
+    /**
+     * Unique record identifier.
+     */
+    objectID: string;
+    fallbackParameters?: FallbackParams;
+};
+
+type RelatedQuery = BaseRecommendRequest & RelatedProducts;
+
+/**
+ * Trending facet values model.  This model recommends trending facet values for the specified facet attribute.
+ */
+type TrendingFacetsModel = 'trending-facets';
+
+type TrendingFacets = {
+    /**
+     * Facet attribute for which to retrieve trending facet values.
+     */
+    facetName: any | null;
+    model: TrendingFacetsModel;
+    fallbackParameters?: FallbackParams;
+};
+
+type TrendingFacetsQuery = BaseRecommendRequest & TrendingFacets;
+
+/**
+ * Trending items model.  Trending items are determined from the number of conversion events collected on them.
+ */
+type TrendingItemsModel = 'trending-items';
+
+type TrendingItems = {
+    /**
+     * Facet attribute. To be used in combination with `facetValue`. If specified, only recommendations matching the facet filter will be returned.
+     */
+    facetName?: string;
+    /**
+     * Facet value. To be used in combination with `facetName`. If specified, only recommendations matching the facet filter will be returned.
+     */
+    facetValue?: string;
+    model: TrendingItemsModel;
+    fallbackParameters?: SearchParamsObject;
+};
+
+type TrendingItemsQuery = BaseRecommendRequest & TrendingItems;
+
+type RecommendationsRequest = BoughtTogetherQuery | LookingSimilarQuery | RecommendedForYouQuery | RelatedQuery | TrendingFacetsQuery | TrendingItemsQuery;
+
+/**
+ * - `default`: perform a search query - `facet` [searches for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
+ */
+type SearchTypeFacet = 'facet';
+
+type SearchForFacetsOptions = {
+    /**
+     * Facet name.
+     */
+    facet: string;
+    /**
+     * Index name (case-sensitive).
+     */
+    indexName: string;
+    /**
+     * Text to search inside the facet\'s values.
+     */
+    facetQuery?: string;
+    /**
+     * Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
+     */
+    maxFacetHits?: number;
+    type: SearchTypeFacet;
+};
+
+/**
+ * - `default`: perform a search query - `facet` [searches for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
+ */
+type SearchTypeDefault = 'default';
+
+type SearchForHitsOptions = {
+    /**
+     * Index name (case-sensitive).
+     */
+    indexName: string;
+    type?: SearchTypeDefault;
+} & {
+    facet?: never;
+    maxFacetHits?: never;
+    facetQuery?: never;
+};
+
+/**
+ * Properties for the `customPost` method.
+ */
+type CustomPostProps = {
+    /**
+     * Path of the endpoint, anything after \"/1\" must be specified.
+     */
+    path: string;
+    /**
+     * Query parameters to apply to the current query.
+     */
+    parameters?: Record<string, any>;
+    /**
+     * Parameters to send with the custom request.
+     */
+    body?: Record<string, unknown>;
+};
+/**
+ * Recommend method signature compatible with the `algoliasearch` v4 package. When using this signature, extra computation will be required to make it match the new signature.
+ *
+ * @deprecated This signature will be removed from the next major version, we recommend using the `GetRecommendationsParams` type for performances and future proof reasons.
+ */
+type LegacyGetRecommendationsParams = RecommendationsRequest[];
+/**
+ * In v4, the search parameters are wrapped in a `params` parameter.
+ *
+ * @deprecated The `search` method now accepts flat `searchParams` at the root of the method.
+ */
+type LegacySearchParams = {
+    params?: SearchParamsObject;
+};
+/**
+ * In v4, the search parameters are wrapped in a `params` parameter.
+ *
+ * @deprecated The `search` method now accepts flat `searchParams` at the root of the method.
+ */
+type LegacySearchForFacets = LegacySearchParams & SearchForFacetsOptions;
+/**
+ * In v4, the search parameters are wrapped in a `params` parameter.
+ *
+ * @deprecated The `search` method now accepts flat `searchParams` at the root of the method.
+ */
+type LegacySearchForHits = LegacySearchParams & SearchForHitsOptions;
+type LegacySearchQuery = LegacySearchForFacets | LegacySearchForHits;
+/**
+ * Search method signature compatible with the `algoliasearch` v4 package. When using this signature, extra computation will be required to make it match the new signature.
+ *
+ * @deprecated This signature will be removed from the next major version, we recommend using the `SearchMethodParams` type for performances and future proof reasons.
+ */
+type LegacySearchMethodProps = LegacySearchQuery[];
+
+/**
+ * Recommend request body.
+ */
+type GetRecommendationsParams = {
+    /**
+     * Recommendation request with parameters depending on the requested model.
+     */
+    requests: RecommendationsRequest[];
+};
+
+/**
+ * Whether certain properties of the search response are calculated exhaustive (exact) or approximated.
+ */
+type Exhaustive = {
+    /**
+     * Whether the facet count is exhaustive (`true`) or approximate (`false`). See the [related discussion](https://support.algolia.com/hc/en-us/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate-).
+     */
+    facetsCount?: boolean;
+    /**
+     * The value is `false` if not all facet values are retrieved.
+     */
+    facetValues?: boolean;
+    /**
+     * Whether the `nbHits` is exhaustive (`true`) or approximate (`false`). When the query takes more than 50ms to be processed, the engine makes an approximation. This can happen when using complex filters on millions of records, when typo-tolerance was not exhaustive, or when enough hits have been retrieved (for example, after the engine finds 10,000 exact matches). `nbHits` is reported as non-exhaustive whenever an approximation is made, even if the approximation didn’t, in the end, impact the exhaustivity of the query.
+     */
+    nbHits?: boolean;
+    /**
+     * Rules matching exhaustivity. The value is `false` if rules were enable for this query, and could not be fully processed due a timeout. This is generally caused by the number of alternatives (such as typos) which is too large.
+     */
+    rulesMatch?: boolean;
+    /**
+     * Whether the typo search was exhaustive (`true`) or approximate (`false`). An approximation is done when the typo search query part takes more than 10% of the query budget (ie. 5ms by default) to be processed (this can happen when a lot of typo alternatives exist for the query). This field will not be included when typo-tolerance is entirely disabled.
+     */
+    typo?: boolean;
+};
+
+type FacetStats = {
+    /**
+     * Minimum value in the results.
+     */
+    min?: number;
+    /**
+     * Maximum value in the results.
+     */
+    max?: number;
+    /**
+     * Average facet value in the results.
+     */
+    avg?: number;
+    /**
+     * Sum of all values in the results.
+     */
+    sum?: number;
+};
+
+/**
+ * Redirect rule data.
+ */
+type RedirectRuleIndexData = {
+    ruleObjectID: string;
+};
+
+type RedirectRuleIndexMetadata = {
+    /**
+     * Source index for the redirect rule.
+     */
+    source: string;
+    /**
+     * Destination index for the redirect rule.
+     */
+    dest: string;
+    /**
+     * Reason for the redirect rule.
+     */
+    reason: string;
+    /**
+     * Redirect rule status.
+     */
+    succeed: boolean;
+    data: RedirectRuleIndexData;
+};
+
+/**
+ * [Redirect results to a URL](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/redirects/), this this parameter is for internal use only.
+ */
+type Redirect = {
+    index?: RedirectRuleIndexMetadata[];
+};
+
+type BaseSearchResponse = Record<string, any> & {
+    /**
+     * A/B test ID. This is only included in the response for indices that are part of an A/B test.
+     */
     abTestID?: number;
     /**
      * Variant ID. This is only included in the response for indices that are part of an A/B test.
@@ -779,59 +833,16 @@ type BaseSearchResponse = Record<string, any> & {
 };
 
 /**
- * Frequently bought together model.  This model recommends items that have been purchased within 1 day with the item with the ID `objectID`.
+ * Whether the whole query string matches or only a part.
  */
-type FbtModel = 'bought-together';
+type MatchLevel = 'full' | 'none' | 'partial';
 
-type FrequentlyBoughtTogether = {
-    model: FbtModel;
+/**
+ * Surround words that match the query with HTML tags for highlighting.
+ */
+type HighlightResultOption = {
     /**
-     * Unique record identifier.
-     */
-    objectID: string;
-};
-
-type BoughtTogetherQuery = BaseRecommendRequest & FrequentlyBoughtTogether;
-
-type BrowsePagination = {
-    /**
-     * Page of search results to retrieve.
-     */
-    page?: number;
-    /**
-     * Number of results (hits).
-     */
-    nbHits?: number;
-    /**
-     * Number of pages of results.
-     */
-    nbPages?: number;
-    /**
-     * Number of hits per page.
-     */
-    hitsPerPage?: number;
-};
-
-type Cursor = {
-    /**
-     * Cursor to get the next page of the response.  The parameter must match the value returned in the response of a previous request. The last page of the response does not return a `cursor` attribute.
-     */
-    cursor?: string;
-};
-
-type BrowseParamsObject = Cursor & SearchParamsObject;
-
-/**
- * Whether the whole query string matches or only a part.
- */
-type MatchLevel = 'full' | 'none' | 'partial';
-
-/**
- * Surround words that match the query with HTML tags for highlighting.
- */
-type HighlightResultOption = {
-    /**
-     * Highlighted attribute value, including HTML tags.
+     * Highlighted attribute value, including HTML tags.
      */
     value: string;
     matchLevel: MatchLevel;
@@ -947,9 +958,9 @@ type SnippetResult = Record<string, SnippetResultOption> | SnippetResultOption |
 };
 
 /**
- * Search result.  A hit is a record from your index, augmented with special attributes for highlighting, snippeting, and ranking.
+ * Recommend hit.
  */
-type Hit<T = Record<string, any>> = T & {
+type RecommendHit = Record<string, any> & {
     /**
      * Unique record identifier.
      */
@@ -964,75 +975,59 @@ type Hit<T = Record<string, any>> = T & {
     _snippetResult?: Record<string, SnippetResult>;
     _rankingInfo?: RankingInfo;
     _distinctSeqID?: number;
+    /**
+     * Recommendation score.
+     */
+    _score: number;
 };
 
-type SearchHits<T = Record<string, any>> = Record<string, any> & {
+/**
+ * Trending facet hit.
+ */
+type TrendingFacetHit = {
     /**
-     * Search results (hits).  Hits are records from your index that match the search criteria, augmented with additional attributes, such as, for highlighting.
+     * Recommendation score.
      */
-    hits: Array<Hit<T>>;
+    _score: number;
     /**
-     * Search query.
+     * Facet attribute. To be used in combination with `facetValue`. If specified, only recommendations matching the facet filter will be returned.
      */
-    query: string;
+    facetName: string;
     /**
-     * URL-encoded string of all search parameters.
+     * Facet value. To be used in combination with `facetName`. If specified, only recommendations matching the facet filter will be returned.
      */
-    params: string;
+    facetValue: string;
 };
 
-type BrowseResponse<T = Record<string, any>> = BaseSearchResponse & BrowsePagination & Cursor & SearchHits<T>;
+type RecommendationsHit = RecommendHit | TrendingFacetHit;
 
-/**
- * Type of edit.
- */
-type EditType = 'remove' | 'replace';
+type RecommendationsHits = {
+    hits: RecommendationsHit[];
+};
 
-type Edit = {
-    type?: EditType;
+type SearchPagination = {
     /**
-     * Text or patterns to remove from the query string.
+     * Page of search results to retrieve.
      */
-    delete?: string;
+    page: number;
     /**
-     * Text to be added in place of the deleted text inside the query string.
+     * Number of results (hits).
      */
-    insert?: string;
-};
-
-type ConsequenceQueryObject = {
+    nbHits: number;
     /**
-     * Words to remove from the search query.
+     * Number of pages of results.
      */
-    remove?: string[];
+    nbPages: number;
     /**
-     * Changes to make to the search query.
+     * Number of hits per page.
      */
-    edits?: Edit[];
-};
-
-/**
- * Replace or edit the search query.  If `consequenceQuery` is a string, the entire search query is replaced with that string. If `consequenceQuery` is an object, it describes incremental edits made to the query.
- */
-type ConsequenceQuery = ConsequenceQueryObject | string;
-
-/**
- * Parameters to apply to this search.  You can use all search parameters, plus special `automaticFacetFilters`, `automaticOptionalFacetFilters`, and `query`.
- */
-type Params = {
-    query?: ConsequenceQuery;
-    automaticFacetFilters?: AutomaticFacetFilters;
-    automaticOptionalFacetFilters?: AutomaticFacetFilters;
-    renderingContent?: RenderingContent;
+    hitsPerPage: number;
 };
 
-type ConsequenceParams = BaseSearchParamsWithoutQuery & IndexSettingsAsSearchParams & Params;
+type RecommendationsResults = BaseSearchResponse & RecommendationsHits & SearchPagination;
 
-/**
- * Error.
- */
-type ErrorBase = Record<string, any> & {
-    message?: string;
+type GetRecommendationsResponse = {
+    results: RecommendationsResults[];
 };
 
 type FacetHits = {
@@ -1050,106 +1045,41 @@ type FacetHits = {
     count: number;
 };
 
-type FallbackParams = Record<string, unknown> & SearchParamsObject;
-
-type GetApiKeyResponse = ApiKey & BaseGetApiKeyResponse;
-
-/**
- * Looking similar model.  This model recommends items that look similar to the item with the ID `objectID` based on image attributes in your index.
- */
-type LookingSimilarModel = 'looking-similar';
-
-type LookingSimilar = {
-    model: LookingSimilarModel;
+type SearchForFacetValuesResponse = {
     /**
-     * Unique record identifier.
+     * Matching facet values.
      */
-    objectID: string;
-    fallbackParameters?: FallbackParams;
-};
-
-type LookingSimilarQuery = BaseRecommendRequest & LookingSimilar;
-
-/**
- * \"Recommened for you\" model.
- */
-type RecommendedForYouModel = 'recommended-for-you';
-
-type RecommendedForYou = {
-    model: RecommendedForYouModel;
-    fallbackParameters?: FallbackParams;
-};
-
-type RecommendedForYouQuery = BaseRecommendRequest & RecommendedForYou;
-
-/**
- * Related products or similar content model.  This model recommends items that are similar to the item with the ID `objectID`. Similarity is determined from the user interactions and attributes.
- */
-type RelatedModel = 'related-products';
-
-type RelatedProducts = {
-    model: RelatedModel;
+    facetHits: FacetHits[];
     /**
-     * Unique record identifier.
+     * Whether the facet count is exhaustive (true) or approximate (false). For more information, see [Why are my facet and hit counts not accurate](https://support.algolia.com/hc/en-us/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate-).
      */
-    objectID: string;
-    fallbackParameters?: FallbackParams;
-};
-
-type RelatedQuery = BaseRecommendRequest & RelatedProducts;
-
-/**
- * Trending facet values model.  This model recommends trending facet values for the specified facet attribute.
- */
-type TrendingFacetsModel = 'trending-facets';
-
-type TrendingFacets = {
+    exhaustiveFacetsCount: boolean;
     /**
-     * Facet attribute for which to retrieve trending facet values.
+     * Time the server took to process the request, in milliseconds.
      */
-    facetName: any | null;
-    model: TrendingFacetsModel;
-    fallbackParameters?: FallbackParams;
+    processingTimeMS?: number;
 };
 
-type TrendingFacetsQuery = BaseRecommendRequest & TrendingFacets;
-
-/**
- * Trending items model.  Trending items are determined from the number of conversion events collected on them.
- */
-type TrendingItemsModel = 'trending-items';
-
-type TrendingItems = {
-    /**
-     * Facet attribute. To be used in combination with `facetValue`. If specified, only recommendations matching the facet filter will be returned.
-     */
-    facetName?: string;
-    /**
-     * Facet value. To be used in combination with `facetName`. If specified, only recommendations matching the facet filter will be returned.
-     */
-    facetValue?: string;
-    model: TrendingItemsModel;
-    fallbackParameters?: SearchParamsObject;
-};
+type SearchForFacets = SearchForFacetsOptions & SearchParams;
 
-type TrendingItemsQuery = BaseRecommendRequest & TrendingItems;
+type SearchForHits = SearchForHitsOptions & SearchParams;
 
-type RecommendationsRequest = BoughtTogetherQuery | LookingSimilarQuery | RecommendedForYouQuery | RelatedQuery | TrendingFacetsQuery | TrendingItemsQuery;
+type SearchQuery = SearchForFacets | SearchForHits;
 
 /**
- * Recommend request body.
+ * Strategy for multiple search queries:  - `none`. Run all queries. - `stopIfEnoughMatches`. Run the queries one by one, stopping as soon as a query matches at least the `hitsPerPage` number of results.
  */
-type GetRecommendationsParams = {
-    /**
-     * Recommendation request with parameters depending on the requested model.
-     */
-    requests: RecommendationsRequest[];
+type SearchStrategy = 'none' | 'stopIfEnoughMatches';
+
+type SearchMethodParams = {
+    requests: SearchQuery[];
+    strategy?: SearchStrategy;
 };
 
 /**
- * Recommend hit.
+ * Search result.  A hit is a record from your index, augmented with special attributes for highlighting, snippeting, and ranking.
  */
-type RecommendHit = Record<string, any> & {
+type Hit<T = Record<string, any>> = T & {
     /**
      * Unique record identifier.
      */
@@ -1164,228 +1094,364 @@ type RecommendHit = Record<string, any> & {
     _snippetResult?: Record<string, SnippetResult>;
     _rankingInfo?: RankingInfo;
     _distinctSeqID?: number;
-    /**
-     * Recommendation score.
-     */
-    _score: number;
 };
 
-/**
- * Trending facet hit.
- */
-type TrendingFacetHit = {
+type SearchHits<T = Record<string, any>> = Record<string, any> & {
     /**
-     * Recommendation score.
+     * Search results (hits).  Hits are records from your index that match the search criteria, augmented with additional attributes, such as, for highlighting.
      */
-    _score: number;
+    hits: Array<Hit<T>>;
     /**
-     * Facet attribute. To be used in combination with `facetValue`. If specified, only recommendations matching the facet filter will be returned.
+     * Search query.
      */
-    facetName: string;
+    query: string;
     /**
-     * Facet value. To be used in combination with `facetName`. If specified, only recommendations matching the facet filter will be returned.
+     * URL-encoded string of all search parameters.
      */
-    facetValue: string;
+    params: string;
 };
 
-type RecommendationsHit = RecommendHit | TrendingFacetHit;
+type SearchResponse<T = Record<string, any>> = BaseSearchResponse & SearchHits<T> & SearchPagination;
 
-type RecommendationsHits = {
-    hits: RecommendationsHit[];
+type SearchResult<T = Record<string, any>> = SearchForFacetValuesResponse | SearchResponse<T>;
+
+type SearchResponses<T = Record<string, any>> = {
+    results: Array<SearchResult<T>>;
 };
 
-type SearchPagination = {
+declare const apiClientVersion = "5.3.0";
+declare function createLiteClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
+    transporter: _algolia_client_common.Transporter;
     /**
-     * Page of search results to retrieve.
+     * The `appId` currently in use.
      */
-    page: number;
+    appId: string;
     /**
-     * Number of results (hits).
+     * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
      */
-    nbHits: number;
+    clearCache(): Promise<void>;
     /**
-     * Number of pages of results.
+     * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
      */
-    nbPages: number;
+    readonly _ua: string;
     /**
-     * Number of hits per page.
+     * Adds a `segment` to the `x-algolia-agent` sent with every requests.
+     *
+     * @param segment - The algolia agent (user-agent) segment to add.
+     * @param version - The version of the agent.
      */
-    hitsPerPage: number;
-};
-
-type RecommendationsResults = BaseSearchResponse & RecommendationsHits & SearchPagination;
-
-type GetRecommendationsResponse = {
-    results: RecommendationsResults[];
-};
-
-/**
- * Index settings.
- */
-type IndexSettings = BaseIndexSettings & IndexSettingsAsSearchParams;
-
-type SearchForFacetValuesResponse = {
+    addAlgoliaAgent(segment: string, version?: string): void;
     /**
-     * Matching facet values.
+     * Helper method to switch the API key used to authenticate the requests.
+     *
+     * @param params - Method params.
+     * @param params.apiKey - The new API Key to use.
      */
-    facetHits: FacetHits[];
+    setClientApiKey({ apiKey }: {
+        apiKey: string;
+    }): void;
     /**
-     * Whether the facet count is exhaustive (true) or approximate (false). For more information, see [Why are my facet and hit counts not accurate](https://support.algolia.com/hc/en-us/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate-).
+     * Helper: calls the `search` method but with certainty that we will only request Algolia records (hits) and not facets.
+     * Disclaimer: We don't assert that the parameters you pass to this method only contains `hits` requests to prevent impacting search performances, this helper is purely for typing purposes.
+     *
+     * @summary Search multiple indices for `hits`.
+     * @param searchMethodParams - Query requests and strategies. Results will be received in the same order as the queries.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    exhaustiveFacetsCount: boolean;
+    searchForHits<T>(searchMethodParams: LegacySearchMethodProps | SearchMethodParams, requestOptions?: RequestOptions): Promise<{
+        results: Array<SearchResponse<T>>;
+    }>;
     /**
-     * Time the server took to process the request, in milliseconds.
+     * Helper: calls the `search` method but with certainty that we will only request Algolia facets and not records (hits).
+     * Disclaimer: We don't assert that the parameters you pass to this method only contains `facets` requests to prevent impacting search performances, this helper is purely for typing purposes.
+     *
+     * @summary Search multiple indices for `facets`.
+     * @param searchMethodParams - Query requests and strategies. Results will be received in the same order as the queries.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    processingTimeMS?: number;
+    searchForFacets(searchMethodParams: LegacySearchMethodProps | SearchMethodParams, requestOptions?: RequestOptions): Promise<{
+        results: SearchForFacetValuesResponse[];
+    }>;
+    /**
+     * This method allow you to send requests to the Algolia REST API.
+     *
+     * @param customPost - The customPost object.
+     * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param customPost.parameters - Query parameters to apply to the current query.
+     * @param customPost.body - Parameters to send with the custom request.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    customPost({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
+    /**
+     * Retrieves recommendations from selected AI models.
+     *
+     * Required API Key ACLs:
+     * - search.
+     *
+     * @param getRecommendationsParams - The getRecommendationsParams object.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    getRecommendations(getRecommendationsParams: GetRecommendationsParams | LegacyGetRecommendationsParams, requestOptions?: RequestOptions): Promise<GetRecommendationsResponse>;
+    /**
+     * Sends multiple search request to one or more indices.  This can be useful in these cases:  - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters.
+     *
+     * Required API Key ACLs:
+     * - search.
+     *
+     * @param searchMethodParams - Muli-search request body. Results are returned in the same order as the requests.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    search<T>(searchMethodParams: LegacySearchMethodProps | SearchMethodParams, requestOptions?: RequestOptions): Promise<SearchResponses<T>>;
 };
 
 /**
- * - `default`: perform a search query - `facet` [searches for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
+ * Access control list permissions.
  */
-type SearchTypeFacet = 'facet';
+type Acl = 'addObject' | 'analytics' | 'browse' | 'deleteIndex' | 'deleteObject' | 'editSettings' | 'inference' | 'listIndexes' | 'logs' | 'personalization' | 'recommendation' | 'search' | 'seeUnretrievableAttributes' | 'settings' | 'usage';
 
-type SearchForFacetsOptions = {
+/**
+ * API key object.
+ */
+type ApiKey = {
     /**
-     * Facet name.
+     * Permissions that determine the type of API requests this key can make. The required ACL is listed in each endpoint\'s reference. For more information, see [access control list](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl).
      */
-    facet: string;
+    acl: Acl[];
     /**
-     * Index name (case-sensitive).
+     * Description of an API key to help you identify this API key.
      */
-    indexName: string;
+    description?: string;
     /**
-     * Text to search inside the facet\'s values.
+     * Index names or patterns that this API key can access. By default, an API key can access all indices in the same application.  You can use leading and trailing wildcard characters (`*`):  - `dev_*` matches all indices starting with \"dev_\". - `*_dev` matches all indices ending with \"_dev\". - `*_products_*` matches all indices containing \"_products_\".
      */
-    facetQuery?: string;
+    indexes?: string[];
     /**
-     * Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
+     * Maximum number of results this API key can retrieve in one query. By default, there\'s no limit.
      */
-    maxFacetHits?: number;
-    type: SearchTypeFacet;
+    maxHitsPerQuery?: number;
+    /**
+     * Maximum number of API requests allowed per IP address or [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/) per hour.  If this limit is reached, the API returns an error with status code `429`. By default, there\'s no limit.
+     */
+    maxQueriesPerIPPerHour?: number;
+    /**
+     * Query parameters to add when making API requests with this API key.  To restrict this API key to specific IP addresses, add the `restrictSources` parameter. You can only add a single source, but you can provide a range of IP addresses.  Creating an API key fails if the request is made from an IP address that\'s outside the restricted range.
+     */
+    queryParameters?: string;
+    /**
+     * Allowed HTTP referrers for this API key.  By default, all referrers are allowed. You can use leading and trailing wildcard characters (`*`):  - `https://algolia.com/_*` allows all referrers starting with \"https://algolia.com/\" - `*.algolia.com` allows all referrers ending with \".algolia.com\" - `*algolia.com*` allows all referrers in the domain \"algolia.com\".  Like all HTTP headers, referrers can be spoofed. Don\'t rely on them to secure your data. For more information, see [HTTP referrer restrictions](https://www.algolia.com/doc/guides/security/security-best-practices/#http-referrers-restrictions).
+     */
+    referers?: string[];
+    /**
+     * Duration (in seconds) after which the API key expires. By default, API keys don\'t expire.
+     */
+    validity?: number;
 };
 
-type SearchForFacets = SearchForFacetsOptions & SearchParams;
-
 /**
- * - `default`: perform a search query - `facet` [searches for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
+ * Filter or optional filter to be applied to the search.
  */
-type SearchTypeDefault = 'default';
-
-type SearchForHitsOptions = {
+type AutomaticFacetFilter = {
     /**
-     * Index name (case-sensitive).
+     * Facet name to be applied as filter. The name must match placeholders in the `pattern` parameter. For example, with `pattern: {facet:genre}`, `automaticFacetFilters` must be `genre`.
      */
-    indexName: string;
-    type?: SearchTypeDefault;
-} & {
-    facet?: never;
-    maxFacetHits?: never;
-    facetQuery?: never;
+    facet: string;
+    /**
+     * Filter scores to give different weights to individual filters.
+     */
+    score?: number;
+    /**
+     * Whether the filter is disjunctive or conjunctive.  If true the filter has multiple matches, multiple occurences are combined with the logical `OR` operation. If false, multiple occurences are combined with the logical `AND` operation.
+     */
+    disjunctive?: boolean;
 };
 
-type SearchForHits = SearchForHitsOptions & SearchParams;
-
-type SearchQuery = SearchForFacets | SearchForHits;
-
 /**
- * Strategy for multiple search queries:  - `none`. Run all queries. - `stopIfEnoughMatches`. Run the queries one by one, stopping as soon as a query matches at least the `hitsPerPage` number of results.
+ * Filter to be applied to the search.  You can use this to respond to search queries that match a facet value. For example, if users search for \"comedy\", which matches a facet value of the \"genre\" facet, you can filter the results to show the top-ranked comedy movies.
  */
-type SearchStrategy = 'none' | 'stopIfEnoughMatches';
+type AutomaticFacetFilters = AutomaticFacetFilter[] | string[];
 
-type SearchMethodParams = {
-    requests: SearchQuery[];
-    strategy?: SearchStrategy;
+type BaseGetApiKeyResponse = {
+    /**
+     * API key.
+     */
+    value?: string;
+    /**
+     * Timestamp when the object was created, in milliseconds since the Unix epoch.
+     */
+    createdAt: number;
 };
 
-type SearchResponse<T = Record<string, any>> = BaseSearchResponse & SearchHits<T> & SearchPagination;
-
-type SearchResult<T = Record<string, any>> = SearchForFacetValuesResponse | SearchResponse<T>;
+type BaseIndexSettings = {
+    /**
+     * Attributes used for [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/).  Facets are attributes that let you categorize search results. They can be used for filtering search results. By default, no attribute is used for faceting. Attribute names are case-sensitive.  **Modifiers**  - `filterOnly(\"ATTRIBUTE\")`.   Allows using this attribute as a filter, but doesn\'t evalue the facet values.  - `searchable(\"ATTRIBUTE\")`.   Allows searching for facet values.  - `afterDistinct(\"ATTRIBUTE\")`.   Evaluates the facet count _after_ deduplication with `distinct`.   This ensures accurate facet counts.   You can apply this modifier to searchable facets: `afterDistinct(searchable(ATTRIBUTE))`.
+     */
+    attributesForFaceting?: string[];
+    /**
+     * Creates [replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/).  Replicas are copies of a primary index with the same records but different settings, synonyms, or rules. If you want to offer a different ranking or sorting of your search results, you\'ll use replica indices. All index operations on a primary index are automatically forwarded to its replicas. To add a replica index, you must provide the complete set of replicas to this parameter. If you omit a replica from this list, the replica turns into a regular, standalone index that will no longer by synced with the primary index.  **Modifier**  - `virtual(\"REPLICA\")`.   Create a virtual replica,   Virtual replicas don\'t increase the number of records and are optimized for [Relevant sorting](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/relevant-sort/).
+     */
+    replicas?: string[];
+    /**
+     * Maximum number of search results that can be obtained through pagination.  Higher pagination limits might slow down your search. For pagination limits above 1,000, the sorting of results beyond the 1,000th hit can\'t be guaranteed.
+     */
+    paginationLimitedTo?: number;
+    /**
+     * Attributes that can\'t be retrieved at query time.  This can be useful if you want to use an attribute for ranking or to [restrict access](https://www.algolia.com/doc/guides/security/api-keys/how-to/user-restricted-access-to-data/), but don\'t want to include it in the search results. Attribute names are case-sensitive.
+     */
+    unretrievableAttributes?: string[];
+    /**
+     * Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
+     */
+    disableTypoToleranceOnWords?: string[];
+    /**
+     * Attributes, for which you want to support [Japanese transliteration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#japanese-transliteration-and-type-ahead).  Transliteration supports searching in any of the Japanese writing systems. To support transliteration, you must set the indexing language to Japanese. Attribute names are case-sensitive.
+     */
+    attributesToTransliterate?: string[];
+    /**
+     * Attributes for which to split [camel case](https://wikipedia.org/wiki/Camel_case) words. Attribute names are case-sensitive.
+     */
+    camelCaseAttributes?: string[];
+    /**
+     * Searchable attributes to which Algolia should apply [word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) (decompounding). Attribute names are case-sensitive.  Compound words are formed by combining two or more individual words, and are particularly prevalent in Germanic languages—for example, \"firefighter\". With decompounding, the individual components are indexed separately.  You can specify different lists for different languages. Decompounding is supported for these languages: Dutch (`nl`), German (`de`), Finnish (`fi`), Danish (`da`), Swedish (`sv`), and Norwegian (`no`). Decompounding doesn\'t work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, `Gartenstühle` won\'t be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308).
+     */
+    decompoundedAttributes?: Record<string, unknown>;
+    /**
+     * Languages for language-specific processing steps, such as word detection and dictionary settings.  **You should always specify an indexing language.** If you don\'t specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/).
+     */
+    indexLanguages?: SupportedLanguage[];
+    /**
+     * Searchable attributes for which you want to turn off [prefix matching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/#adjusting-prefix-search). Attribute names are case-sensitive.
+     */
+    disablePrefixOnAttributes?: string[];
+    /**
+     * Whether arrays with exclusively non-negative integers should be compressed for better performance. If true, the compressed arrays may be reordered.
+     */
+    allowCompressionOfIntegerArray?: boolean;
+    /**
+     * Numeric attributes that can be used as [numerical filters](https://www.algolia.com/doc/guides/managing-results/rules/detecting-intent/how-to/applying-a-custom-filter-for-a-specific-query/#numerical-filters). Attribute names are case-sensitive.  By default, all numeric attributes are available as numerical filters. For faster indexing, reduce the number of numeric attributes.  If you want to turn off filtering for all numeric attributes, specifiy an attribute that doesn\'t exist in your index, such as `NO_NUMERIC_FILTERING`.  **Modifier**  - `equalOnly(\"ATTRIBUTE\")`.   Support only filtering based on equality comparisons `=` and `!=`.
+     */
+    numericAttributesForFiltering?: string[];
+    /**
+     * Controls which separators are indexed.  Separators are all non-letter characters except spaces and currency characters, such as $€£¥. By default, separator characters aren\'t indexed. With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, a search for `C#` would report two matches.
+     */
+    separatorsToIndex?: string;
+    /**
+     * Attributes used for searching. Attribute names are case-sensitive.  By default, all attributes are searchable and the [Attribute](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#attribute) ranking criterion is turned off. With a non-empty list, Algolia only returns results with matches in the selected attributes. In addition, the Attribute ranking criterion is turned on: matches in attributes that are higher in the list of `searchableAttributes` rank first. To make matches in two attributes rank equally, include them in a comma-separated string, such as `\"title,alternate_title\"`. Attributes with the same priority are always unordered.  For more information, see [Searchable attributes](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/setting-searchable-attributes/).  **Modifier**  - `unordered(\"ATTRIBUTE\")`.   Ignore the position of a match within the attribute.  Without modifier, matches at the beginning of an attribute rank higer than matches at the end.
+     */
+    searchableAttributes?: string[];
+    /**
+     * An object with custom data.  You can store up to 32kB as custom data.
+     */
+    userData?: Record<string, unknown>;
+    /**
+     * Characters and their normalized replacements. This overrides Algolia\'s default [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/).
+     */
+    customNormalization?: Record<string, Record<string, string>>;
+    /**
+     * Attribute that should be used to establish groups of results. Attribute names are case-sensitive.  All records with the same value for this attribute are considered a group. You can combine `attributeForDistinct` with the `distinct` search parameter to control how many items per group are included in the search results.  If you want to use the same attribute also for faceting, use the `afterDistinct` modifier of the `attributesForFaceting` setting. This applies faceting _after_ deduplication, which will result in accurate facet counts.
+     */
+    attributeForDistinct?: string;
+};
 
-type SearchResponses<T = Record<string, any>> = {
-    results: Array<SearchResult<T>>;
+type BrowsePagination = {
+    /**
+     * Page of search results to retrieve.
+     */
+    page?: number;
+    /**
+     * Number of results (hits).
+     */
+    nbHits?: number;
+    /**
+     * Number of pages of results.
+     */
+    nbPages?: number;
+    /**
+     * Number of hits per page.
+     */
+    hitsPerPage?: number;
 };
 
-type WithPrimary = {
+type Cursor = {
     /**
-     * Replica indices only: the name of the primary index for this replica.
+     * Cursor to get the next page of the response.  The parameter must match the value returned in the response of a previous request. The last page of the response does not return a `cursor` attribute.
      */
-    primary?: string;
+    cursor?: string;
 };
 
-type SettingsResponse = IndexSettings & WithPrimary;
+type BrowseParamsObject = Cursor & SearchParamsObject;
+
+type BrowseResponse<T = Record<string, any>> = BaseSearchResponse & BrowsePagination & Cursor & SearchHits<T>;
 
 /**
- * Properties for the `customPost` method.
+ * Type of edit.
  */
-type CustomPostProps = {
+type EditType = 'remove' | 'replace';
+
+type Edit = {
+    type?: EditType;
     /**
-     * Path of the endpoint, anything after \"/1\" must be specified.
+     * Text or patterns to remove from the query string.
      */
-    path: string;
+    delete?: string;
     /**
-     * Query parameters to apply to the current query.
+     * Text to be added in place of the deleted text inside the query string.
      */
-    parameters?: Record<string, any>;
+    insert?: string;
+};
+
+type ConsequenceQueryObject = {
     /**
-     * Parameters to send with the custom request.
+     * Words to remove from the search query.
      */
-    body?: Record<string, unknown>;
+    remove?: string[];
+    /**
+     * Changes to make to the search query.
+     */
+    edits?: Edit[];
 };
+
 /**
- * Recommend method signature compatible with the `algoliasearch` v4 package. When using this signature, extra computation will be required to make it match the new signature.
- *
- * @deprecated This signature will be removed from the next major version, we recommend using the `GetRecommendationsParams` type for performances and future proof reasons.
+ * Replace or edit the search query.  If `consequenceQuery` is a string, the entire search query is replaced with that string. If `consequenceQuery` is an object, it describes incremental edits made to the query.
  */
-type LegacyGetRecommendationsParams = RecommendationsRequest[];
+type ConsequenceQuery = ConsequenceQueryObject | string;
+
 /**
- * In v4, the search parameters are wrapped in a `params` parameter.
- *
- * @deprecated The `search` method now accepts flat `searchParams` at the root of the method.
+ * Parameters to apply to this search.  You can use all search parameters, plus special `automaticFacetFilters`, `automaticOptionalFacetFilters`, and `query`.
  */
-type LegacySearchParams = {
-    params?: SearchParamsObject;
+type Params = {
+    query?: ConsequenceQuery;
+    automaticFacetFilters?: AutomaticFacetFilters;
+    automaticOptionalFacetFilters?: AutomaticFacetFilters;
+    renderingContent?: RenderingContent;
 };
+
+type ConsequenceParams = BaseSearchParamsWithoutQuery & IndexSettingsAsSearchParams & Params;
+
 /**
- * In v4, the search parameters are wrapped in a `params` parameter.
- *
- * @deprecated The `search` method now accepts flat `searchParams` at the root of the method.
- */
-type LegacySearchForFacets = LegacySearchParams & SearchForFacetsOptions;
-/**
- * In v4, the search parameters are wrapped in a `params` parameter.
- *
- * @deprecated The `search` method now accepts flat `searchParams` at the root of the method.
- */
-type LegacySearchForHits = LegacySearchParams & SearchForHitsOptions;
-type LegacySearchQuery = LegacySearchForFacets | LegacySearchForHits;
-/**
- * Search method signature compatible with the `algoliasearch` v4 package. When using this signature, extra computation will be required to make it match the new signature.
- *
- * @deprecated This signature will be removed from the next major version, we recommend using the `SearchMethodParams` type for performances and future proof reasons.
+ * Error.
  */
-type LegacySearchMethodProps = LegacySearchQuery[];
+type ErrorBase = Record<string, any> & {
+    message?: string;
+};
 
-declare const apiClientVersion = "5.2.5";
+type GetApiKeyResponse = ApiKey & BaseGetApiKeyResponse;
 
 /**
- * The client type.
+ * Index settings.
  */
-type LiteClient = ReturnType<typeof liteClient>;
-declare function liteClient(appId: string, apiKey: string, options?: ClientOptions): {
-    transporter: _algolia_client_common.Transporter;
-    appId: string;
-    clearCache(): Promise<void>;
-    readonly _ua: string;
-    addAlgoliaAgent(segment: string, version?: string): void;
-    searchForHits<T>(searchMethodParams: LegacySearchMethodProps | SearchMethodParams, requestOptions?: _algolia_client_common.RequestOptions): Promise<{
-        results: Array<SearchResponse<T>>;
-    }>;
-    searchForFacets(searchMethodParams: LegacySearchMethodProps | SearchMethodParams, requestOptions?: _algolia_client_common.RequestOptions): Promise<{
-        results: SearchForFacetValuesResponse[];
-    }>;
-    customPost({ path, parameters, body }: CustomPostProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
-    getRecommendations(getRecommendationsParams: GetRecommendationsParams | LegacyGetRecommendationsParams, requestOptions?: _algolia_client_common.RequestOptions): Promise<GetRecommendationsResponse>;
-    search<T>(searchMethodParams: LegacySearchMethodProps | SearchMethodParams, requestOptions?: _algolia_client_common.RequestOptions): Promise<SearchResponses<T>>;
+type IndexSettings = BaseIndexSettings & IndexSettingsAsSearchParams;
+
+type WithPrimary = {
+    /**
+     * Replica indices only: the name of the primary index for this replica.
+     */
+    primary?: string;
 };
 
+type SettingsResponse = IndexSettings & WithPrimary;
+
+type LiteClient = ReturnType<typeof createLiteClient>;
+
+declare function liteClient(appId: string, apiKey: string, options?: ClientOptions): LiteClient;
+
 export { type Acl, type AdvancedSyntaxFeatures, type AlternativesAsExact, type ApiKey, type AroundPrecision, type AroundRadius, type AroundRadiusAll, type AutomaticFacetFilter, type AutomaticFacetFilters, type BaseGetApiKeyResponse, type BaseIndexSettings, type BaseRecommendRequest, type BaseSearchParams, type BaseSearchParamsWithoutQuery, type BaseSearchResponse, type BooleanString, type BoughtTogetherQuery, type BrowsePagination, type BrowseParamsObject, type BrowseResponse, type ConsequenceParams, type ConsequenceQuery, type ConsequenceQueryObject, type Cursor, type CustomPostProps, type Distinct, type Edit, type EditType, type ErrorBase, type ExactOnSingleWordQuery, type Exhaustive, type FacetFilters, type FacetHits, type FacetOrdering, type FacetStats, type Facets, type FallbackParams, type FbtModel, type FrequentlyBoughtTogether, type GetApiKeyResponse, type GetRecommendationsParams, type GetRecommendationsResponse, type HighlightResult, type HighlightResultOption, type Hit, type IgnorePlurals, type IndexSettings, type IndexSettingsAsSearchParams, type LegacyGetRecommendationsParams, type LegacySearchMethodProps, type LiteClient, type LookingSimilar, type LookingSimilarModel, type LookingSimilarQuery, type MatchLevel, type MatchedGeoLocation, type Mode, type NumericFilters, type OptionalFilters, type Params, type Personalization, type QueryType, type Range, type RankingInfo, type ReRankingApplyFilter, type RecommendHit, type RecommendationsHit, type RecommendationsHits, type RecommendationsRequest, type RecommendationsResults, type RecommendedForYou, type RecommendedForYouModel, type RecommendedForYouQuery, type Redirect, type RedirectRuleIndexData, type RedirectRuleIndexMetadata, type RedirectURL, type RelatedModel, type RelatedProducts, type RelatedQuery, type RemoveStopWords, type RemoveWordsIfNoResults, type RenderingContent, type SearchForFacetValuesResponse, type SearchForFacets, type SearchForFacetsOptions, type SearchForHits, type SearchForHitsOptions, type SearchHits, type SearchMethodParams, type SearchPagination, type SearchParams, type SearchParamsObject, type SearchParamsQuery, type SearchQuery, type SearchResponse, type SearchResponses, type SearchResult, type SearchStrategy, type SearchTypeDefault, type SearchTypeFacet, type SemanticSearch, type SettingsResponse, type SnippetResult, type SnippetResultOption, type SortRemainingBy, type SupportedLanguage, type TagFilters, type TrendingFacetHit, type TrendingFacets, type TrendingFacetsModel, type TrendingFacetsQuery, type TrendingItems, type TrendingItemsModel, type TrendingItemsQuery, type TypoTolerance, type TypoToleranceEnum, type Value, type WithPrimary, apiClientVersion, liteClient };