@algolia/client-search 4.14.2 → 5.0.0-alpha.3

package/dist/model/highlightResultOption.d.ts

@@ -0,0 +1,20 @@
+import type { MatchLevel } from './matchLevel';
+/**
+ * Show highlighted section and words matched on a query.
+ */
+export declare type HighlightResultOption = {
+    /**
+     * Markup text with occurrences highlighted.
+     */
+    value: string;
+    matchLevel: MatchLevel;
+    /**
+     * List of words from the query that matched the object.
+     */
+    matchedWords: string[];
+    /**
+     * Whether the entire attribute value is highlighted.
+     */
+    fullyHighlighted?: boolean;
+};
+//# sourceMappingURL=highlightResultOption.d.ts.map

package/dist/model/highlightResultOption.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"highlightResultOption.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/highlightResultOption.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C;;GAEG;AACH,oBAAY,qBAAqB,GAAG;IAClC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd,UAAU,EAAE,UAAU,CAAC;IAEvB;;OAEG;IACH,YAAY,EAAE,MAAM,EAAE,CAAC;IAEvB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B,CAAC"}

package/dist/model/hit.d.ts

@@ -0,0 +1,23 @@
+import type { HighlightResult } from './highlightResult';
+import type { RankingInfo } from './rankingInfo';
+import type { SnippetResult } from './snippetResult';
+/**
+ * A single hit.
+ */
+export declare type Hit<T = Record<string, any>> = T & {
+    /**
+     * Unique identifier of the object.
+     */
+    objectID: string;
+    /**
+     * Show highlighted section and words matched on a query.
+     */
+    _highlightResult?: Record<string, HighlightResult>;
+    /**
+     * Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.
+     */
+    _snippetResult?: Record<string, SnippetResult>;
+    _rankingInfo?: RankingInfo;
+    _distinctSeqID?: number;
+};
+//# sourceMappingURL=hit.d.ts.map

package/dist/model/hit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hit.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/hit.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD;;GAEG;AACH,oBAAY,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,CAAC,GAAG;IAC7C;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAEnD;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAE/C,YAAY,CAAC,EAAE,WAAW,CAAC;IAE3B,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC"}

package/dist/model/ignorePlurals.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Treats singular, plurals, and other forms of declensions as matching terms. IgnorePlurals is used in conjunction with the queryLanguages setting. List: language ISO codes for which ignoring plurals should be enabled. This list will override any values that you may have set in queryLanguages. True: enables the ignore plurals functionality, where singulars and plurals are considered equivalent (foot = feet). The languages supported here are either every language (this is the default, see list of languages below), or those set by queryLanguages. False: disables ignore plurals, where singulars and plurals are not considered the same for matching purposes (foot will not find feet).
+ */
+export declare type IgnorePlurals = string[] | boolean;
+//# sourceMappingURL=ignorePlurals.d.ts.map

package/dist/model/ignorePlurals.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ignorePlurals.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/ignorePlurals.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,aAAa,GAAG,MAAM,EAAE,GAAG,OAAO,CAAC"}

package/dist/model/index.d.ts

@@ -0,0 +1,154 @@
+export * from './acl';
+export * from './action';
+export * from './addApiKeyResponse';
+export * from './advancedSyntaxFeatures';
+export * from './alternativesAsExact';
+export * from './anchoring';
+export * from './apiKey';
+export * from './aroundRadius';
+export * from './aroundRadiusAll';
+export * from './assignUserIdParams';
+export * from './attributeOrBuiltInOperation';
+export * from './automaticFacetFilter';
+export * from './automaticFacetFilters';
+export * from './baseBrowseResponse';
+export * from './baseIndexSettings';
+export * from './baseSearchParams';
+export * from './baseSearchParamsWithoutQuery';
+export * from './baseSearchResponse';
+export * from './batchAssignUserIdsParams';
+export * from './batchDictionaryEntriesParams';
+export * from './batchDictionaryEntriesRequest';
+export * from './batchParams';
+export * from './batchRequest';
+export * from './batchResponse';
+export * from './batchWriteParams';
+export * from './browseRequest';
+export * from './browseResponse';
+export * from './builtInOperation';
+export * from './builtInOperationType';
+export * from './condition';
+export * from './consequence';
+export * from './consequenceHide';
+export * from './consequenceParams';
+export * from './consequenceQuery';
+export * from './consequenceQueryObject';
+export * from './createdAtObject';
+export * from './createdAtResponse';
+export * from './deleteApiKeyResponse';
+export * from './deleteSourceResponse';
+export * from './deletedAtResponse';
+export * from './dictionaryAction';
+export * from './dictionaryEntry';
+export * from './dictionaryEntryState';
+export * from './dictionaryLanguage';
+export * from './dictionarySettingsParams';
+export * from './dictionaryType';
+export * from './distinct';
+export * from './edit';
+export * from './editType';
+export * from './errorBase';
+export * from './exactOnSingleWordQuery';
+export * from './facetFilters';
+export * from './facetHits';
+export * from './facetOrdering';
+export * from './facets';
+export * from './facetsStats';
+export * from './fetchedIndex';
+export * from './getDictionarySettingsResponse';
+export * from './getLogsResponse';
+export * from './getObjectsParams';
+export * from './getObjectsRequest';
+export * from './getObjectsResponse';
+export * from './getTaskResponse';
+export * from './getTopUserIdsResponse';
+export * from './hasPendingMappingsResponse';
+export * from './highlightResult';
+export * from './highlightResultOption';
+export * from './hit';
+export * from './ignorePlurals';
+export * from './indexSettings';
+export * from './indexSettingsAsSearchParams';
+export * from './key';
+export * from './languages';
+export * from './listApiKeysResponse';
+export * from './listClustersResponse';
+export * from './listIndicesResponse';
+export * from './listUserIdsResponse';
+export * from './log';
+export * from './logQuery';
+export * from './logType';
+export * from './matchLevel';
+export * from './matchedGeoLocation';
+export * from './mixedSearchFilters';
+export * from './multipleBatchRequest';
+export * from './multipleBatchResponse';
+export * from './numericFilters';
+export * from './operationIndexParams';
+export * from './operationType';
+export * from './optionalFilters';
+export * from './params';
+export * from './personalization';
+export * from './promote';
+export * from './promoteObjectID';
+export * from './promoteObjectIDs';
+export * from './queryType';
+export * from './rankingInfo';
+export * from './reRankingApplyFilter';
+export * from './removeStopWords';
+export * from './removeUserIdResponse';
+export * from './removeWordsIfNoResults';
+export * from './renderingContent';
+export * from './replaceSourceResponse';
+export * from './rule';
+export * from './saveObjectResponse';
+export * from './saveSynonymResponse';
+export * from './scopeType';
+export * from './searchDictionaryEntriesParams';
+export * from './searchForFacetValuesRequest';
+export * from './searchForFacetValuesResponse';
+export * from './searchForFacets';
+export * from './searchForFacetsOptions';
+export * from './searchForHits';
+export * from './searchForHitsOptions';
+export * from './searchHits';
+export * from './searchMethodParams';
+export * from './searchParams';
+export * from './searchParamsObject';
+export * from './searchParamsQuery';
+export * from './searchParamsString';
+export * from './searchQuery';
+export * from './searchResponse';
+export * from './searchResponses';
+export * from './searchRulesParams';
+export * from './searchRulesResponse';
+export * from './searchStrategy';
+export * from './searchSynonymsParams';
+export * from './searchSynonymsResponse';
+export * from './searchTypeDefault';
+export * from './searchTypeFacet';
+export * from './searchUserIdsParams';
+export * from './searchUserIdsResponse';
+export * from './snippetResult';
+export * from './snippetResultOption';
+export * from './sortRemainingBy';
+export * from './source';
+export * from './standardEntries';
+export * from './synonymHit';
+export * from './synonymHitHighlightResult';
+export * from './synonymType';
+export * from './tagFilters';
+export * from './taskStatus';
+export * from './timeRange';
+export * from './typoTolerance';
+export * from './typoToleranceEnum';
+export * from './updateApiKeyResponse';
+export * from './updatedAtResponse';
+export * from './updatedAtWithObjectIdResponse';
+export * from './updatedRuleResponse';
+export * from './userHighlightResult';
+export * from './userHit';
+export * from './userId';
+export * from './value';
+export * from './clientMethodProps';
+//# sourceMappingURL=index.d.ts.map

package/dist/model/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/index.ts"],"names":[],"mappings":"AAEA,cAAc,OAAO,CAAC;AACtB,cAAc,UAAU,CAAC;AACzB,cAAc,qBAAqB,CAAC;AACpC,cAAc,0BAA0B,CAAC;AACzC,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AACnC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,sBAAsB,CAAC;AACrC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,iCAAiC,CAAC;AAChD,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,wBAAwB,CAAC;AACvC,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AACnC,cAAc,0BAA0B,CAAC;AACzC,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,kBAAkB,CAAC;AACjC,cAAc,YAAY,CAAC;AAC3B,cAAc,QAAQ,CAAC;AACvB,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,0BAA0B,CAAC;AACzC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC;AAChC,cAAc,UAAU,CAAC;AACzB,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iCAAiC,CAAC;AAChD,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,yBAAyB,CAAC;AACxC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,mBAAmB,CAAC;AAClC,cAAc,yBAAyB,CAAC;AACxC,cAAc,OAAO,CAAC;AACtB,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,OAAO,CAAC;AACtB,cAAc,aAAa,CAAC;AAC5B,cAAc,uBAAuB,CAAC;AACtC,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,OAAO,CAAC;AACtB,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC;AAC7B,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC;AACxC,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC;AACvC,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,UAAU,CAAC;AACzB,cAAc,mBAAmB,CAAC;AAClC,cAAc,WAAW,CAAC;AAC1B,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,wBAAwB,CAAC;AACvC,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,0BAA0B,CAAC;AACzC,cAAc,oBAAoB,CAAC;AACnC,cAAc,yBAAyB,CAAC;AACxC,cAAc,QAAQ,CAAC;AACvB,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC;AAC5B,cAAc,iCAAiC,CAAC;AAChD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,iBAAiB,CAAC;AAChC,cAAc,wBAAwB,CAAC;AACvC,cAAc,cAAc,CAAC;AAC7B,cAAc,sBAAsB,CAAC;AACrC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC;AACvC,cAAc,0BAA0B,CAAC;AACzC,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,yBAAyB,CAAC;AACxC,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,UAAU,CAAC;AACzB,cAAc,mBAAmB,CAAC;AAClC,cAAc,cAAc,CAAC;AAC7B,cAAc,6BAA6B,CAAC;AAC5C,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC;AAChC,cAAc,qBAAqB,CAAC;AACpC,cAAc,wBAAwB,CAAC;AACvC,cAAc,qBAAqB,CAAC;AACpC,cAAc,iCAAiC,CAAC;AAChD,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,qBAAqB,CAAC"}

package/dist/model/indexSettings.d.ts

@@ -0,0 +1,7 @@
+import type { BaseIndexSettings } from './baseIndexSettings';
+import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';
+/**
+ * The Algolia index settings.
+ */
+export declare type IndexSettings = BaseIndexSettings & IndexSettingsAsSearchParams;
+//# sourceMappingURL=indexSettings.d.ts.map

package/dist/model/indexSettings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"indexSettings.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/indexSettings.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAEjF;;GAEG;AACH,oBAAY,aAAa,GAAG,iBAAiB,GAAG,2BAA2B,CAAC"}

package/dist/model/indexSettingsAsSearchParams.d.ts

@@ -0,0 +1,157 @@
+import type { AdvancedSyntaxFeatures } from './advancedSyntaxFeatures';
+import type { AlternativesAsExact } from './alternativesAsExact';
+import type { Distinct } from './distinct';
+import type { ExactOnSingleWordQuery } from './exactOnSingleWordQuery';
+import type { IgnorePlurals } from './ignorePlurals';
+import type { QueryType } from './queryType';
+import type { RemoveStopWords } from './removeStopWords';
+import type { RemoveWordsIfNoResults } from './removeWordsIfNoResults';
+import type { RenderingContent } from './renderingContent';
+import type { TypoTolerance } from './typoTolerance';
+export declare type IndexSettingsAsSearchParams = {
+    /**
+     * The complete list of attributes that will be used for faceting.
+     */
+    attributesForFaceting?: string[];
+    /**
+     * List of attributes that can\'t be retrieved at query time.
+     */
+    unretrievableAttributes?: string[];
+    /**
+     * This parameter controls which attributes to retrieve and which not to retrieve.
+     */
+    attributesToRetrieve?: string[];
+    /**
+     * Restricts a given query to look in only a subset of your searchable attributes.
+     */
+    restrictSearchableAttributes?: string[];
+    /**
+     * Controls how Algolia should sort your results.
+     */
+    ranking?: string[];
+    /**
+     * Specifies the custom ranking criterion.
+     */
+    customRanking?: string[];
+    /**
+     * Controls the relevancy threshold below which less relevant results aren\'t included in the results.
+     */
+    relevancyStrictness?: number;
+    /**
+     * List of attributes to highlight.
+     */
+    attributesToHighlight?: string[];
+    /**
+     * List of attributes to snippet, with an optional maximum number of words to snippet.
+     */
+    attributesToSnippet?: string[];
+    /**
+     * The HTML string to insert before the highlighted parts in all highlight and snippet results.
+     */
+    highlightPreTag?: string;
+    /**
+     * The HTML string to insert after the highlighted parts in all highlight and snippet results.
+     */
+    highlightPostTag?: string;
+    /**
+     * String used as an ellipsis indicator when a snippet is truncated.
+     */
+    snippetEllipsisText?: string;
+    /**
+     * Restrict highlighting and snippeting to items that matched the query.
+     */
+    restrictHighlightAndSnippetArrays?: boolean;
+    /**
+     * Set the number of hits per page.
+     */
+    hitsPerPage?: number;
+    /**
+     * Minimum number of characters a word in the query string must contain to accept matches with 1 typo.
+     */
+    minWordSizefor1Typo?: number;
+    /**
+     * Minimum number of characters a word in the query string must contain to accept matches with 2 typos.
+     */
+    minWordSizefor2Typos?: number;
+    typoTolerance?: TypoTolerance;
+    /**
+     * Whether to allow typos on numbers (\"numeric tokens\") in the query string.
+     */
+    allowTyposOnNumericTokens?: boolean;
+    /**
+     * List of attributes on which you want to disable typo tolerance.
+     */
+    disableTypoToleranceOnAttributes?: string[];
+    ignorePlurals?: IgnorePlurals;
+    removeStopWords?: RemoveStopWords;
+    /**
+     * List of characters that the engine shouldn\'t automatically normalize.
+     */
+    keepDiacriticsOnCharacters?: string;
+    /**
+     * Sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection.
+     */
+    queryLanguages?: string[];
+    /**
+     * Splits compound words into their composing atoms in the query.
+     */
+    decompoundQuery?: boolean;
+    /**
+     * Whether Rules should be globally enabled.
+     */
+    enableRules?: boolean;
+    /**
+     * Enable the Personalization feature.
+     */
+    enablePersonalization?: boolean;
+    queryType?: QueryType;
+    removeWordsIfNoResults?: RemoveWordsIfNoResults;
+    /**
+     * Enables the advanced query syntax.
+     */
+    advancedSyntax?: boolean;
+    /**
+     * A list of words that should be considered as optional when found in the query.
+     */
+    optionalWords?: string[];
+    /**
+     * List of attributes on which you want to disable the exact ranking criterion.
+     */
+    disableExactOnAttributes?: string[];
+    exactOnSingleWordQuery?: ExactOnSingleWordQuery;
+    /**
+     * List of alternatives that should be considered an exact match by the exact ranking criterion.
+     */
+    alternativesAsExact?: AlternativesAsExact[];
+    /**
+     * Allows you to specify which advanced syntax features are active when ‘advancedSyntax\' is enabled.
+     */
+    advancedSyntaxFeatures?: AdvancedSyntaxFeatures[];
+    distinct?: Distinct;
+    /**
+     * Whether to take into account an index\'s synonyms for a particular search.
+     */
+    synonyms?: boolean;
+    /**
+     * Whether to highlight and snippet the original word that matches the synonym or the synonym itself.
+     */
+    replaceSynonymsInHighlight?: boolean;
+    /**
+     * Precision of the proximity ranking criterion.
+     */
+    minProximity?: number;
+    /**
+     * Choose which fields to return in the API response. This parameters applies to search and browse queries.
+     */
+    responseFields?: string[];
+    /**
+     * Maximum number of facet hits to return during a search for facet values. For performance reasons, the maximum allowed number of returned values is 100.
+     */
+    maxFacetHits?: number;
+    /**
+     * When attribute is ranked above proximity in your ranking formula, proximity is used to select which searchable attribute is matched in the attribute ranking stage.
+     */
+    attributeCriteriaComputedByMinProximity?: boolean;
+    renderingContent?: RenderingContent;
+};
+//# sourceMappingURL=indexSettingsAsSearchParams.d.ts.map

package/dist/model/indexSettingsAsSearchParams.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"indexSettingsAsSearchParams.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/indexSettingsAsSearchParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD,oBAAY,2BAA2B,GAAG;IACxC;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEjC;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEnC;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhC;;OAEG;IACH,4BAA4B,CAAC,EAAE,MAAM,EAAE,CAAC;IAExC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IAEnB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IAEzB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEjC;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE/B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,iCAAiC,CAAC,EAAE,OAAO,CAAC;IAE5C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,aAAa,CAAC,EAAE,aAAa,CAAC;IAE9B;;OAEG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAEpC;;OAEG;IACH,gCAAgC,CAAC,EAAE,MAAM,EAAE,CAAC;IAE5C,aAAa,CAAC,EAAE,aAAa,CAAC;IAE9B,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC;;OAEG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;IAEpC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAE1B;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB,sBAAsB,CAAC,EAAE,sBAAsB,CAAC;IAEhD;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IAEzB;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEpC,sBAAsB,CAAC,EAAE,sBAAsB,CAAC;IAEhD;;OAEG;IACH,mBAAmB,CAAC,EAAE,mBAAmB,EAAE,CAAC;IAE5C;;OAEG;IACH,sBAAsB,CAAC,EAAE,sBAAsB,EAAE,CAAC;IAElD,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;IAErC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAE1B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,uCAAuC,CAAC,EAAE,OAAO,CAAC;IAElD,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CACrC,CAAC"}

package/dist/model/key.d.ts

@@ -0,0 +1,4 @@
+import type { ApiKey } from './apiKey';
+import type { CreatedAtObject } from './createdAtObject';
+export declare type Key = ApiKey & CreatedAtObject;
+//# sourceMappingURL=key.d.ts.map

package/dist/model/key.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"key.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/key.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,oBAAY,GAAG,GAAG,MAAM,GAAG,eAAe,CAAC"}

package/dist/model/languages.d.ts

@@ -0,0 +1,10 @@
+import type { DictionaryLanguage } from './dictionaryLanguage';
+/**
+ * A dictionary language.
+ */
+export declare type Languages = {
+    plurals: DictionaryLanguage | null;
+    stopwords: DictionaryLanguage | null;
+    compounds: DictionaryLanguage | null;
+};
+//# sourceMappingURL=languages.d.ts.map

package/dist/model/languages.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"languages.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/languages.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D;;GAEG;AACH,oBAAY,SAAS,GAAG;IACtB,OAAO,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAEnC,SAAS,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAErC,SAAS,EAAE,kBAAkB,GAAG,IAAI,CAAC;CACtC,CAAC"}

package/dist/model/listApiKeysResponse.d.ts

@@ -0,0 +1,8 @@
+import type { Key } from './key';
+export declare type ListApiKeysResponse = {
+    /**
+     * List of api keys.
+     */
+    keys: Key[];
+};
+//# sourceMappingURL=listApiKeysResponse.d.ts.map

package/dist/model/listApiKeysResponse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"listApiKeysResponse.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/listApiKeysResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAEjC,oBAAY,mBAAmB,GAAG;IAChC;;OAEG;IACH,IAAI,EAAE,GAAG,EAAE,CAAC;CACb,CAAC"}

package/dist/model/listClustersResponse.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Array of clusters.
+ */
+export declare type ListClustersResponse = {
+    /**
+     * Mapping of cluster names to top users.
+     */
+    topUsers: string[];
+};
+//# sourceMappingURL=listClustersResponse.d.ts.map

package/dist/model/listClustersResponse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"listClustersResponse.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/listClustersResponse.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,oBAAoB,GAAG;IACjC;;OAEG;IACH,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB,CAAC"}

package/dist/model/listIndicesResponse.d.ts

@@ -0,0 +1,12 @@
+import type { FetchedIndex } from './fetchedIndex';
+export declare type ListIndicesResponse = {
+    /**
+     * List of the fetched indices.
+     */
+    items: FetchedIndex[];
+    /**
+     * Number of pages.
+     */
+    nbPages?: number;
+};
+//# sourceMappingURL=listIndicesResponse.d.ts.map

package/dist/model/listIndicesResponse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"listIndicesResponse.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/listIndicesResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,oBAAY,mBAAmB,GAAG;IAChC;;OAEG;IACH,KAAK,EAAE,YAAY,EAAE,CAAC;IAEtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC"}

package/dist/model/listUserIdsResponse.d.ts

@@ -0,0 +1,11 @@
+import type { UserId } from './userId';
+/**
+ * UserIDs data.
+ */
+export declare type ListUserIdsResponse = {
+    /**
+     * List of userIDs.
+     */
+    userIDs: UserId[];
+};
+//# sourceMappingURL=listUserIdsResponse.d.ts.map

package/dist/model/listUserIdsResponse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"listUserIdsResponse.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/listUserIdsResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAEvC;;GAEG;AACH,oBAAY,mBAAmB,GAAG;IAChC;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC"}

package/dist/model/log.d.ts

@@ -0,0 +1,64 @@
+import type { LogQuery } from './logQuery';
+export declare type Log = {
+    /**
+     * Timestamp in ISO-8601 format.
+     */
+    timestamp: string;
+    /**
+     * HTTP method of the performed request.
+     */
+    method: string;
+    /**
+     * HTTP response code.
+     */
+    answer_code: string;
+    /**
+     * Request body. Truncated after 1000 characters.
+     */
+    query_body: string;
+    /**
+     * Answer body. Truncated after 1000 characters.
+     */
+    answer: string;
+    /**
+     * Request URL.
+     */
+    url: string;
+    /**
+     * IP of the client which performed the request.
+     */
+    ip: string;
+    /**
+     * Request Headers (API Key is obfuscated).
+     */
+    query_headers: string;
+    /**
+     * SHA1 signature of the log entry.
+     */
+    sha1: string;
+    /**
+     * Number of API calls.
+     */
+    nb_api_calls: string;
+    /**
+     * Processing time for the query. It doesn\'t include network time.
+     */
+    processing_time_ms: string;
+    /**
+     * Index targeted by the query.
+     */
+    index?: string;
+    /**
+     * Query parameters sent with the request.
+     */
+    query_params?: string;
+    /**
+     * Number of hits returned for the query.
+     */
+    query_nb_hits?: string;
+    /**
+     * Array of all performed queries for the given request.
+     */
+    inner_queries?: LogQuery[];
+};
+//# sourceMappingURL=log.d.ts.map

package/dist/model/log.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"log.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/log.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C,oBAAY,GAAG,GAAG;IAChB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,QAAQ,EAAE,CAAC;CAC5B,CAAC"}

package/dist/model/logQuery.d.ts

@@ -0,0 +1,15 @@
+export declare type LogQuery = {
+    /**
+     * Index targeted by the query.
+     */
+    index_name?: string;
+    /**
+     * User identifier.
+     */
+    user_token?: string;
+    /**
+     * QueryID for the given query.
+     */
+    query_id?: string;
+};
+//# sourceMappingURL=logQuery.d.ts.map

package/dist/model/logQuery.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logQuery.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/logQuery.ts"],"names":[],"mappings":"AAEA,oBAAY,QAAQ,GAAG;IACrB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC"}

package/dist/model/logType.d.ts

@@ -0,0 +1,2 @@
+export declare type LogType = 'all' | 'build' | 'error' | 'query';
+//# sourceMappingURL=logType.d.ts.map

package/dist/model/logType.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logType.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/logType.ts"],"names":[],"mappings":"AAEA,oBAAY,OAAO,GAAG,KAAK,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,CAAC"}

package/dist/model/matchLevel.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Indicates how well the attribute matched the search query.
+ */
+export declare type MatchLevel = 'full' | 'none' | 'partial';
+//# sourceMappingURL=matchLevel.d.ts.map

package/dist/model/matchLevel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"matchLevel.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/matchLevel.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC"}

package/dist/model/matchedGeoLocation.d.ts

@@ -0,0 +1,15 @@
+export declare 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;
+};
+//# sourceMappingURL=matchedGeoLocation.d.ts.map

package/dist/model/matchedGeoLocation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"matchedGeoLocation.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/matchedGeoLocation.ts"],"names":[],"mappings":"AAEA,oBAAY,kBAAkB,GAAG;IAC/B;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC"}

package/dist/model/mixedSearchFilters.d.ts

@@ -0,0 +1,2 @@
+export declare type MixedSearchFilters = string[] | string;
+//# sourceMappingURL=mixedSearchFilters.d.ts.map

package/dist/model/mixedSearchFilters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mixedSearchFilters.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/mixedSearchFilters.ts"],"names":[],"mappings":"AAEA,oBAAY,kBAAkB,GAAG,MAAM,EAAE,GAAG,MAAM,CAAC"}

package/dist/model/multipleBatchRequest.d.ts

@@ -0,0 +1,13 @@
+import type { Action } from './action';
+export declare type MultipleBatchRequest = {
+    action?: Action;
+    /**
+     * Arguments to the operation (depends on the type of the operation).
+     */
+    body?: Record<string, any>;
+    /**
+     * Index to target for this operation.
+     */
+    indexName?: string;
+};
+//# sourceMappingURL=multipleBatchRequest.d.ts.map

package/dist/model/multipleBatchRequest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"multipleBatchRequest.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/multipleBatchRequest.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAEvC,oBAAY,oBAAoB,GAAG;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC"}