@algolia/composition 0.0.1-beta.10

package/dist/node.d.cts

@@ -0,0 +1,826 @@
+import * as _algolia_client_common from '@algolia/client-common';
+import { CreateClientOptions, RequestOptions, ClientOptions } from '@algolia/client-common';
+
+type FacetHits = {
+    /**
+     * Facet value.
+     */
+    value: string;
+    /**
+     * Highlighted attribute value, including HTML tags.
+     */
+    highlighted: string;
+    /**
+     * Number of records with this facet value. [The count may be approximated](https://support.algolia.com/hc/en-us/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate-).
+     */
+    count: number;
+};
+
+type SearchForFacetValuesResults = {
+    indexName: string;
+    /**
+     * Matching facet values.
+     */
+    facetHits: Array<FacetHits>;
+    /**
+     * 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-).
+     */
+    exhaustiveFacetsCount: boolean;
+    /**
+     * Time the server took to process the request, in milliseconds.
+     */
+    processingTimeMS?: number;
+};
+
+type SearchForFacetValuesResponse = {
+    /**
+     * Search for facet values results.
+     */
+    results?: Array<SearchForFacetValuesResults>;
+};
+
+type CompositionRunAppliedRules = {
+    /**
+     * Unique record identifier.
+     */
+    objectID: string;
+};
+
+type CompositionRunSearchResponse = Record<string, any> & {
+    /**
+     * Unique record identifier.
+     */
+    objectID: string;
+    appliedRules?: Array<CompositionRunAppliedRules>;
+};
+
+type CompositionsSearchResponse = Record<string, any> & {
+    run: Array<CompositionRunSearchResponse>;
+};
+
+type CompositionBaseSearchResponse = Record<string, any> & {
+    compositions?: CompositionsSearchResponse;
+};
+
+/**
+ * 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?: Array<RedirectRuleIndexMetadata>;
+};
+
+/**
+ * Order of facet names.
+ */
+type Facets = {
+    /**
+     * Explicit order of facets or facet values.  This setting lets you always show specific facets or facet values at the top of the list.
+     */
+    order?: Array<string>;
+};
+
+/**
+ * Order of facet values that aren\'t explicitly positioned with the `order` setting.  - `count`.   Order remaining facet values by decreasing count.   The count is the number of matching records containing this facet value.  - `alpha`.   Sort facet values alphabetically.  - `hidden`.   Don\'t show facet values that aren\'t explicitly positioned.
+ */
+type SortRemainingBy = 'count' | 'alpha' | 'hidden';
+
+type Value = {
+    /**
+     * Explicit order of facets or facet values.  This setting lets you always show specific facets or facet values at the top of the list.
+     */
+    order?: Array<string>;
+    sortRemainingBy?: SortRemainingBy;
+    /**
+     * Hide facet values.
+     */
+    hide?: Array<string>;
+};
+
+/**
+ * Order of facet names and facet values in your UI.
+ */
+type FacetOrdering = {
+    facets?: Facets;
+    /**
+     * Order of facet values. One object for each facet.
+     */
+    values?: {
+        [key: string]: Value;
+    };
+};
+
+/**
+ * The redirect rule container.
+ */
+type RedirectURL = {
+    url?: string;
+};
+
+/**
+ * URL for an image to show inside a banner.
+ */
+type BannerImageUrl = {
+    url?: string;
+};
+
+/**
+ * Image to show inside a banner.
+ */
+type BannerImage = {
+    urls?: Array<BannerImageUrl>;
+    title?: string;
+};
+
+/**
+ * Link for a banner defined in the Merchandising Studio.
+ */
+type BannerLink = {
+    url?: string;
+};
+
+/**
+ * Banner with image and link to redirect users.
+ */
+type Banner = {
+    image?: BannerImage;
+    link?: BannerLink;
+};
+
+/**
+ * Widgets returned from any rules that are applied to the current search.
+ */
+type Widgets = {
+    /**
+     * Banners defined in the Merchandising Studio for a given search.
+     */
+    banners?: Array<Banner>;
+};
+
+/**
+ * Extra data that can be used in the search UI.  You can use this to control aspects of your search UI, such as the order of facet names and values without changing your frontend code.
+ */
+type RenderingContent = {
+    facetOrdering?: FacetOrdering;
+    redirect?: RedirectURL;
+    widgets?: Widgets;
+};
+
+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.
+     */
+    abTestVariantID?: number;
+    /**
+     * Computed geographical location.
+     */
+    aroundLatLng?: string;
+    /**
+     * Distance from a central coordinate provided by `aroundLatLng`.
+     */
+    automaticRadius?: string;
+    exhaustive?: Exhaustive;
+    /**
+     * Rules applied to the query.
+     */
+    appliedRules?: Array<Record<string, unknown>>;
+    /**
+     * See the `facetsCount` field of the `exhaustive` object in the response.
+     */
+    exhaustiveFacetsCount?: boolean;
+    /**
+     * See the `nbHits` field of the `exhaustive` object in the response.
+     */
+    exhaustiveNbHits?: boolean;
+    /**
+     * See the `typo` field of the `exhaustive` object in the response.
+     */
+    exhaustiveTypo?: boolean;
+    /**
+     * Facet counts.
+     */
+    facets?: {
+        [key: string]: {
+            [key: string]: number;
+        };
+    };
+    /**
+     * Statistics for numerical facets.
+     */
+    facets_stats?: {
+        [key: string]: FacetStats;
+    };
+    /**
+     * Index name used for the query.
+     */
+    index?: string;
+    /**
+     * Index name used for the query. During A/B testing, the targeted index isn\'t always the index used by the query.
+     */
+    indexUsed?: string;
+    /**
+     * Warnings about the query.
+     */
+    message?: string;
+    /**
+     * Number of hits selected and sorted by the relevant sort algorithm.
+     */
+    nbSortedHits?: number;
+    /**
+     * Post-[normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/#what-does-normalization-mean) query string that will be searched.
+     */
+    parsedQuery?: string;
+    /**
+     * Time the server took to process the request, in milliseconds.
+     */
+    processingTimeMS: number;
+    /**
+     * Experimental. List of processing steps and their times, in milliseconds. You can use this list to investigate performance issues.
+     */
+    processingTimingsMS?: Record<string, unknown>;
+    /**
+     * Markup text indicating which parts of the original query have been removed to retrieve a non-empty result set.
+     */
+    queryAfterRemoval?: string;
+    redirect?: Redirect;
+    renderingContent?: RenderingContent;
+    /**
+     * Time the server took to process the request, in milliseconds.
+     */
+    serverTimeMS?: number;
+    /**
+     * Host name of the server that processed the request.
+     */
+    serverUsed?: string;
+    /**
+     * An object with custom data.  You can store up to 32kB as custom data.
+     */
+    userData?: Record<string, unknown>;
+    /**
+     * Unique identifier for the query. This is used for [click analytics](https://www.algolia.com/doc/guides/analytics/click-analytics/).
+     */
+    queryID?: string;
+    /**
+     * Whether automatic events collection is enabled for the application.
+     */
+    _automaticInsights?: boolean;
+};
+
+type ResultsInjectedItemAppliedRulesInfoResponse = {
+    /**
+     * Unique record identifier.
+     */
+    objectID: string;
+};
+
+type ResultsInjectedItemInfoResponse = Record<string, any> & {
+    key: string;
+    appliedRules?: Array<ResultsInjectedItemAppliedRulesInfoResponse>;
+};
+
+type ResultsCompositionInfoResponse = {
+    injectedItems: Array<ResultsInjectedItemInfoResponse>;
+};
+
+type ResultsCompositionsResponse = Record<string, any> & {
+    compositions: {
+        [key: string]: ResultsCompositionInfoResponse;
+    };
+};
+
+/**
+ * Whether the whole query string matches or only a part.
+ */
+type MatchLevel = 'none' | 'partial' | 'full';
+
+/**
+ * Surround words that match the query with HTML tags for highlighting.
+ */
+type HighlightResultOption = {
+    /**
+     * Highlighted attribute value, including HTML tags.
+     */
+    value: string;
+    matchLevel: MatchLevel;
+    /**
+     * List of matched words from the search query.
+     */
+    matchedWords: Array<string>;
+    /**
+     * Whether the entire attribute value is highlighted.
+     */
+    fullyHighlighted?: boolean;
+};
+
+type HighlightResult = HighlightResultOption | {
+    [key: string]: HighlightResult;
+} | Array<HighlightResult>;
+
+type CompositionIdRankingInfo = {
+    index: string;
+    injectedItemKey: string;
+};
+
+type CompositionRankingInfo = {
+    composed?: {
+        [key: string]: CompositionIdRankingInfo;
+    };
+};
+
+type MatchedGeoLocation = {
+    /**
+     * Latitude of the matched location.
+     */
+    lat?: number;
+    /**
+     * Longitude of the matched location.
+     */
+    lng?: number;
+    /**
+     * Distance between the matched location and the search location (in meters).
+     */
+    distance?: number;
+};
+
+type Personalization = {
+    /**
+     * The score of the filters.
+     */
+    filtersScore?: number;
+    /**
+     * The score of the ranking.
+     */
+    rankingScore?: number;
+    /**
+     * The score of the event.
+     */
+    score?: number;
+};
+
+/**
+ * Object with detailed information about the record\'s ranking.
+ */
+type RankingInfo = {
+    /**
+     * Whether a filter matched the query.
+     */
+    filters?: number;
+    /**
+     * Position of the first matched word in the best matching attribute of the record.
+     */
+    firstMatchedWord: number;
+    /**
+     * Distance between the geo location in the search query and the best matching geo location in the record, divided by the geo precision (in meters).
+     */
+    geoDistance: number;
+    /**
+     * Precision used when computing the geo distance, in meters.
+     */
+    geoPrecision?: number;
+    matchedGeoLocation?: MatchedGeoLocation;
+    personalization?: Personalization;
+    /**
+     * Number of exactly matched words.
+     */
+    nbExactWords: number;
+    /**
+     * Number of typos encountered when matching the record.
+     */
+    nbTypos: number;
+    /**
+     * Whether the record was promoted by a rule.
+     */
+    promoted?: boolean;
+    /**
+     * Number of words between multiple matches in the query plus 1. For single word queries, `proximityDistance` is 0.
+     */
+    proximityDistance?: number;
+    /**
+     * Overall ranking of the record, expressed as a single integer. This attribute is internal.
+     */
+    userScore: number;
+    /**
+     * Number of matched words.
+     */
+    words?: number;
+    /**
+     * Whether the record is re-ranked.
+     */
+    promotedByReRanking?: boolean;
+};
+
+type HitRankingInfo = RankingInfo & CompositionRankingInfo;
+
+/**
+ * Snippets that show the context around a matching search query.
+ */
+type SnippetResultOption = {
+    /**
+     * Highlighted attribute value, including HTML tags.
+     */
+    value: string;
+    matchLevel: MatchLevel;
+};
+
+type SnippetResult = SnippetResultOption | {
+    [key: string]: SnippetResult;
+} | Array<SnippetResult>;
+
+/**
+ * Search result.  A hit is a record from your index, augmented with special attributes for highlighting, snippeting, and ranking.
+ */
+type Hit<T = Record<string, unknown>> = T & {
+    /**
+     * Unique record identifier.
+     */
+    objectID: string;
+    /**
+     * Surround words that match the query with HTML tags for highlighting.
+     */
+    _highlightResult?: {
+        [key: string]: HighlightResult;
+    };
+    /**
+     * Snippets that show the context around a matching search query.
+     */
+    _snippetResult?: {
+        [key: string]: SnippetResult;
+    };
+    _rankingInfo?: HitRankingInfo;
+    _distinctSeqID?: number;
+};
+
+type SearchHits<T = Record<string, unknown>> = Record<string, any> & {
+    /**
+     * Search results (hits).  Hits are records from your index that match the search criteria, augmented with additional attributes, such as, for highlighting.
+     */
+    hits: Hit<T>[];
+    /**
+     * Search query.
+     */
+    query: string;
+    /**
+     * URL-encoded string of all search parameters.
+     */
+    params: string;
+};
+
+type SearchPagination = {
+    /**
+     * 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 SearchResultsItem<T = Record<string, unknown>> = BaseSearchResponse & SearchPagination & SearchHits<T> & ResultsCompositionsResponse;
+
+type SearchResults<T = Record<string, unknown>> = {
+    /**
+     * Search results.
+     */
+    results: SearchResultsItem<T>[];
+};
+
+type SearchResponse<T = Record<string, unknown>> = CompositionBaseSearchResponse & SearchResults<T>;
+
+/**
+ * Range object with lower and upper values in meters to define custom ranges.
+ */
+type Range = {
+    /**
+     * Lower boundary of a range in meters. The Geo ranking criterion considers all records within the range to be equal.
+     */
+    from?: number;
+    /**
+     * Upper boundary of a range in meters. The Geo ranking criterion considers all records within the range to be equal.
+     */
+    value?: number;
+};
+
+/**
+ * Precision of a coordinate-based search in meters to group results with similar distances.  The Geo ranking criterion considers all matches within the same range of distances to be equal.
+ */
+type AroundPrecision = number | Array<Range>;
+
+/**
+ * Return all records with a valid `_geoloc` attribute. Don\'t filter by distance.
+ */
+type AroundRadiusAll = 'all';
+
+/**
+ * Maximum radius for a search around a central location.  This parameter works in combination with the `aroundLatLng` and `aroundLatLngViaIP` parameters. By default, the search radius is determined automatically from the density of hits around the central location. The search radius is small if there are many hits close to the central coordinates.
+ */
+type AroundRadius = number | AroundRadiusAll;
+
+/**
+ * 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`.
+ */
+type FacetFilters = Array<FacetFilters> | string;
+
+type InsideBoundingBox = string | Array<Array<number>>;
+
+/**
+ * Filter by numeric facets.  **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.**  You can use numeric comparison operators: `<`, `<=`, `=`, `!=`, `>`, `>=`. Comparisons are precise up to 3 decimals. You can also provide ranges: `facet:<lower> TO <upper>`. The range includes the lower and upper boundaries. The same combination rules apply as for `facetFilters`.
+ */
+type NumericFilters = Array<NumericFilters> | string;
+
+/**
+ * Filters to promote or demote records in the search results.  Optional filters work like facet filters, but they don\'t exclude records from the search results. Records that match the optional filter rank before records that don\'t match. If you\'re using a negative filter `facet:-value`, matching records rank after records that don\'t match.  - Optional filters don\'t work on virtual replicas. - Optional filters are applied _after_ sort-by attributes. - Optional filters are applied _before_ custom ranking attributes (in the default [ranking](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/)). - Optional filters don\'t work with numeric attributes.
+ */
+type OptionalFilters = Array<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' | 'pt-br' | 'qu' | 'ro' | 'ru' | 'sk' | 'sq' | 'sv' | 'sw' | 'ta' | 'te' | 'th' | 'tl' | 'tn' | 'tr' | 'tt' | 'uk' | 'ur' | 'uz' | 'zh';
+
+type Params = {
+    /**
+     * Search query.
+     */
+    query?: string;
+    /**
+     * Filter expression to only include items that match the filter criteria in the response.  You can use these filter expressions:  - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>` where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>` where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`.  You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions:  - You can only combine filters of the same type with `OR`.   **Not supported:** `facet:value OR num > 3`. - You can\'t use `NOT` with combinations of filters.   **Not supported:** `NOT(facet:value OR facet:value)` - You can\'t combine conjunctions (`AND`) with `OR`.   **Not supported:** `facet:value OR (facet:value AND facet:value)`  Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array.  For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/).
+     */
+    filters?: string;
+    /**
+     * Page of search results to retrieve.
+     */
+    page?: number;
+    /**
+     * Whether the search response should include detailed ranking information.
+     */
+    getRankingInfo?: boolean;
+    relevancyStrictness?: number;
+    facetFilters?: FacetFilters;
+    optionalFilters?: OptionalFilters;
+    numericFilters?: NumericFilters;
+    /**
+     * Number of hits per page.
+     */
+    hitsPerPage?: number;
+    /**
+     * Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude.  Only records included within a circle around this central location are included in the results. The radius of the circle is determined by the `aroundRadius` and `minimumAroundRadius` settings. This parameter is ignored if you also specify `insidePolygon` or `insideBoundingBox`.
+     */
+    aroundLatLng?: string;
+    /**
+     * Whether to obtain the coordinates from the request\'s IP address.
+     */
+    aroundLatLngViaIP?: boolean;
+    aroundRadius?: AroundRadius;
+    aroundPrecision?: AroundPrecision;
+    /**
+     * Minimum radius (in meters) for a search around a location when `aroundRadius` isn\'t set.
+     */
+    minimumAroundRadius?: number;
+    insideBoundingBox?: InsideBoundingBox | null;
+    /**
+     * Coordinates of a polygon in which to search.  Polygons are defined by 3 to 10,000 points. Each point is represented by its latitude and longitude. Provide multiple polygons as nested arrays. For more information, see [filtering inside polygons](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas). This parameter is ignored if you also specify `insideBoundingBox`.
+     */
+    insidePolygon?: Array<Array<number>>;
+    /**
+     * Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries.  This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` settings. This setting also sets a dictionary for word detection in the logogram-based [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk) languages. To support this, you must place the CJK language **first**.  **You should always specify a query 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/).
+     */
+    queryLanguages?: Array<SupportedLanguage>;
+    /**
+     * ISO language codes that adjust settings that are useful for processing natural language queries (as opposed to keyword searches):  - Sets `removeStopWords` and `ignorePlurals` to the list of provided languages. - Sets `removeWordsIfNoResults` to `allOptional`. - Adds a `natural_language` attribute to `ruleContexts` and `analyticsTags`.
+     */
+    naturalLanguages?: Array<SupportedLanguage>;
+    /**
+     * Whether to enable rules.
+     */
+    enableRules?: boolean;
+    /**
+     * Assigns a rule context to the search query.  [Rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) are strings that you can use to trigger matching rules.
+     */
+    ruleContexts?: Array<string>;
+    /**
+     * Unique pseudonymous or anonymous user identifier.  This helps with analytics and click and conversion events. For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
+     */
+    userToken?: string;
+    /**
+     * Whether to include a `queryID` attribute in the response.  The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/guides/sending-events/getting-started/).
+     */
+    clickAnalytics?: boolean;
+    /**
+     * Whether this search will be included in Analytics.
+     */
+    analytics?: boolean;
+    /**
+     * Tags to apply to the query for [segmenting analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     */
+    analyticsTags?: Array<string>;
+    /**
+     * Whether to enable A/B testing for this search.
+     */
+    enableABTest?: boolean;
+    /**
+     * Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/).  This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
+     */
+    enableReRanking?: boolean;
+};
+
+type RequestBody = {
+    params?: Params;
+};
+
+type SearchForFacetValuesParams = {
+    /**
+     * Search query.
+     */
+    query?: 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;
+    searchQuery?: Params;
+};
+
+type SearchForFacetValuesRequest = {
+    params?: SearchForFacetValuesParams;
+};
+
+/**
+ * Properties for the `search` method.
+ */
+type SearchProps = {
+    /**
+     * Unique Composition ObjectID.
+     */
+    compositionID: string;
+    requestBody: RequestBody;
+};
+/**
+ * Properties for the `searchForFacetValues` method.
+ */
+type SearchForFacetValuesProps = {
+    /**
+     * Unique Composition ObjectID.
+     */
+    compositionID: string;
+    /**
+     * Facet attribute in which to search for values.  This attribute must be included in the `attributesForFaceting` index setting with the `searchable()` modifier.
+     */
+    facetName: string;
+    searchForFacetValuesRequest?: SearchForFacetValuesRequest;
+};
+
+declare const apiClientVersion = "0.0.1-beta.10";
+declare function createCompositionClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
+    transporter: _algolia_client_common.Transporter;
+    /**
+     * The `appId` currently in use.
+     */
+    appId: string;
+    /**
+     * The `apiKey` currently in use.
+     */
+    apiKey: string;
+    /**
+     * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
+     */
+    clearCache(): Promise<void>;
+    /**
+     * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
+     */
+    readonly _ua: string;
+    /**
+     * 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.
+     */
+    addAlgoliaAgent(segment: string, version?: string): void;
+    /**
+     * 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.
+     */
+    setClientApiKey({ apiKey }: {
+        apiKey: string;
+    }): void;
+    /**
+     * Runs a query on a single composition and returns matching results.
+     *
+     * Required API Key ACLs:
+     *  - search
+     * @param search - The search object.
+     * @param search.compositionID - Unique Composition ObjectID.
+     * @param search.requestBody - The requestBody object.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    search<T>({ compositionID, requestBody }: SearchProps, requestOptions?: RequestOptions): Promise<SearchResponse<T>>;
+    /**
+     * Searches for values of a specified facet attribute on the composition\'s main source\'s index.  - By default, facet values are sorted by decreasing count.   You can adjust this with the `sortFacetValueBy` parameter. - Searching for facet values doesn\'t work if you have **more than 65 searchable facets and searchable attributes combined**.
+     *
+     * Required API Key ACLs:
+     *  - search
+     * @param searchForFacetValues - The searchForFacetValues object.
+     * @param searchForFacetValues.compositionID - Unique Composition ObjectID.
+     * @param searchForFacetValues.facetName - Facet attribute in which to search for values.  This attribute must be included in the `attributesForFaceting` index setting with the `searchable()` modifier.
+     * @param searchForFacetValues.searchForFacetValuesRequest - The searchForFacetValuesRequest object.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    searchForFacetValues({ compositionID, facetName, searchForFacetValuesRequest }: SearchForFacetValuesProps, requestOptions?: RequestOptions): Promise<SearchForFacetValuesResponse>;
+};
+
+/**
+ * Error.
+ */
+type ErrorBase = Record<string, any> & {
+    message?: string;
+};
+
+type CompositionClient = ReturnType<typeof createCompositionClient>;
+
+declare function compositionClient(appId: string, apiKey: string, options?: ClientOptions): CompositionClient;
+
+export { type AroundPrecision, type AroundRadius, type AroundRadiusAll, type Banner, type BannerImage, type BannerImageUrl, type BannerLink, type BaseSearchResponse, type CompositionBaseSearchResponse, type CompositionClient, type CompositionIdRankingInfo, type CompositionRankingInfo, type CompositionRunAppliedRules, type CompositionRunSearchResponse, type CompositionsSearchResponse, type ErrorBase, type Exhaustive, type FacetFilters, type FacetHits, type FacetOrdering, type FacetStats, type Facets, type HighlightResult, type HighlightResultOption, type Hit, type HitRankingInfo, type InsideBoundingBox, type MatchLevel, type MatchedGeoLocation, type NumericFilters, type OptionalFilters, type Params, type Personalization, type Range, type RankingInfo, type Redirect, type RedirectRuleIndexData, type RedirectRuleIndexMetadata, type RedirectURL, type RenderingContent, type RequestBody, type ResultsCompositionInfoResponse, type ResultsCompositionsResponse, type ResultsInjectedItemAppliedRulesInfoResponse, type ResultsInjectedItemInfoResponse, type SearchForFacetValuesParams, type SearchForFacetValuesProps, type SearchForFacetValuesRequest, type SearchForFacetValuesResponse, type SearchForFacetValuesResults, type SearchHits, type SearchPagination, type SearchProps, type SearchResponse, type SearchResults, type SearchResultsItem, type SnippetResult, type SnippetResultOption, type SortRemainingBy, type SupportedLanguage, type Value, type Widgets, apiClientVersion, compositionClient };