algoliasearch 4.14.2 → 5.0.0-alpha.3

package/dist/algoliasearch/lite/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/algoliasearch/lite/model/indexSettingsAsSearchParams.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"indexSettingsAsSearchParams.d.ts","sourceRoot":"","sources":["../../../../../../packages/algoliasearch/lite/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/algoliasearch/lite/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/algoliasearch/lite/model/key.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"key.d.ts","sourceRoot":"","sources":["../../../../../../packages/algoliasearch/lite/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/algoliasearch/lite/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/algoliasearch/lite/model/languages.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"languages.d.ts","sourceRoot":"","sources":["../../../../../../packages/algoliasearch/lite/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/algoliasearch/lite/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/algoliasearch/lite/model/listIndicesResponse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"listIndicesResponse.d.ts","sourceRoot":"","sources":["../../../../../../packages/algoliasearch/lite/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/algoliasearch/lite/model/logType.d.ts

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

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

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

package/dist/algoliasearch/lite/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/algoliasearch/lite/model/matchLevel.d.ts.map

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

package/dist/algoliasearch/lite/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/algoliasearch/lite/model/matchedGeoLocation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"matchedGeoLocation.d.ts","sourceRoot":"","sources":["../../../../../../packages/algoliasearch/lite/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/algoliasearch/lite/model/mixedSearchFilters.d.ts

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

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

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

package/dist/algoliasearch/lite/model/numericFilters.d.ts

@@ -0,0 +1,6 @@
+import type { MixedSearchFilters } from './mixedSearchFilters';
+/**
+ * Filter on numeric attributes.
+ */
+export declare type NumericFilters = MixedSearchFilters[] | string;
+//# sourceMappingURL=numericFilters.d.ts.map

package/dist/algoliasearch/lite/model/numericFilters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"numericFilters.d.ts","sourceRoot":"","sources":["../../../../../../packages/algoliasearch/lite/model/numericFilters.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D;;GAEG;AACH,oBAAY,cAAc,GAAG,kBAAkB,EAAE,GAAG,MAAM,CAAC"}

package/dist/algoliasearch/lite/model/operationType.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Type of operation to perform (move or copy).
+ */
+export declare type OperationType = 'copy' | 'move';
+//# sourceMappingURL=operationType.d.ts.map

package/dist/algoliasearch/lite/model/operationType.d.ts.map

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

package/dist/algoliasearch/lite/model/optionalFilters.d.ts

@@ -0,0 +1,6 @@
+import type { MixedSearchFilters } from './mixedSearchFilters';
+/**
+ * Create filters for ranking purposes, where records that match the filter are ranked higher, or lower in the case of a negative optional filter.
+ */
+export declare type OptionalFilters = MixedSearchFilters[] | string;
+//# sourceMappingURL=optionalFilters.d.ts.map

package/dist/algoliasearch/lite/model/optionalFilters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"optionalFilters.d.ts","sourceRoot":"","sources":["../../../../../../packages/algoliasearch/lite/model/optionalFilters.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D;;GAEG;AACH,oBAAY,eAAe,GAAG,kBAAkB,EAAE,GAAG,MAAM,CAAC"}

package/dist/algoliasearch/lite/model/params.d.ts

@@ -0,0 +1,13 @@
+import type { AutomaticFacetFilters } from './automaticFacetFilters';
+import type { ConsequenceQuery } from './consequenceQuery';
+import type { RenderingContent } from './renderingContent';
+/**
+ * Additional search parameters. Any valid search parameter is allowed.
+ */
+export declare type Params = {
+    query?: ConsequenceQuery;
+    automaticFacetFilters?: AutomaticFacetFilters;
+    automaticOptionalFacetFilters?: AutomaticFacetFilters;
+    renderingContent?: RenderingContent;
+};
+//# sourceMappingURL=params.d.ts.map

package/dist/algoliasearch/lite/model/params.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"params.d.ts","sourceRoot":"","sources":["../../../../../../packages/algoliasearch/lite/model/params.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AACrE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE3D;;GAEG;AACH,oBAAY,MAAM,GAAG;IACnB,KAAK,CAAC,EAAE,gBAAgB,CAAC;IAEzB,qBAAqB,CAAC,EAAE,qBAAqB,CAAC;IAE9C,6BAA6B,CAAC,EAAE,qBAAqB,CAAC;IAEtD,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CACrC,CAAC"}

package/dist/algoliasearch/lite/model/personalization.d.ts

@@ -0,0 +1,15 @@
+export declare type Personalization = {
+    /**
+     * The score of the filters.
+     */
+    filtersScore?: number;
+    /**
+     * The score of the ranking.
+     */
+    rankingScore?: number;
+    /**
+     * The score of the event.
+     */
+    score?: number;
+};
+//# sourceMappingURL=personalization.d.ts.map

package/dist/algoliasearch/lite/model/personalization.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"personalization.d.ts","sourceRoot":"","sources":["../../../../../../packages/algoliasearch/lite/model/personalization.ts"],"names":[],"mappings":"AAEA,oBAAY,eAAe,GAAG;IAC5B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC"}

package/dist/algoliasearch/lite/model/promote.d.ts

@@ -0,0 +1,4 @@
+import type { PromoteObjectID } from './promoteObjectID';
+import type { PromoteObjectIDs } from './promoteObjectIDs';
+export declare type Promote = PromoteObjectID | PromoteObjectIDs;
+//# sourceMappingURL=promote.d.ts.map

package/dist/algoliasearch/lite/model/promote.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"promote.d.ts","sourceRoot":"","sources":["../../../../../../packages/algoliasearch/lite/model/promote.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE3D,oBAAY,OAAO,GAAG,eAAe,GAAG,gBAAgB,CAAC"}

package/dist/algoliasearch/lite/model/promoteObjectID.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Single objectID to promote as hits.
+ */
+export declare type PromoteObjectID = {
+    /**
+     * Unique identifier of the object to promote.
+     */
+    objectID: string;
+    /**
+     * The position to promote the objects to (zero-based). If you pass objectIDs, the objects are placed at this position as a group. For example, if you pass four objectIDs to position 0, the objects take the first four positions.
+     */
+    position: number;
+};
+//# sourceMappingURL=promoteObjectID.d.ts.map

package/dist/algoliasearch/lite/model/promoteObjectID.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"promoteObjectID.d.ts","sourceRoot":"","sources":["../../../../../../packages/algoliasearch/lite/model/promoteObjectID.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,eAAe,GAAG;IAC5B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC"}

package/dist/algoliasearch/lite/model/promoteObjectIDs.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Multiple objectIDs to promote as hits.
+ */
+export declare type PromoteObjectIDs = {
+    /**
+     * Array of unique identifiers of the objects to promote.
+     */
+    objectIDs: string[];
+    /**
+     * The position to promote the objects to (zero-based). If you pass objectIDs, the objects are placed at this position as a group. For example, if you pass four objectIDs to position 0, the objects take the first four positions.
+     */
+    position: number;
+};
+//# sourceMappingURL=promoteObjectIDs.d.ts.map

package/dist/algoliasearch/lite/model/promoteObjectIDs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"promoteObjectIDs.d.ts","sourceRoot":"","sources":["../../../../../../packages/algoliasearch/lite/model/promoteObjectIDs.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,gBAAgB,GAAG;IAC7B;;OAEG;IACH,SAAS,EAAE,MAAM,EAAE,CAAC;IAEpB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC"}

package/dist/algoliasearch/lite/model/queryType.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Controls if and how query words are interpreted as prefixes.
+ */
+export declare type QueryType = 'prefixAll' | 'prefixLast' | 'prefixNone';
+//# sourceMappingURL=queryType.d.ts.map

package/dist/algoliasearch/lite/model/queryType.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"queryType.d.ts","sourceRoot":"","sources":["../../../../../../packages/algoliasearch/lite/model/queryType.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,SAAS,GAAG,WAAW,GAAG,YAAY,GAAG,YAAY,CAAC"}

package/dist/algoliasearch/lite/model/rankingInfo.d.ts

@@ -0,0 +1,51 @@
+import type { MatchedGeoLocation } from './matchedGeoLocation';
+import type { Personalization } from './personalization';
+export declare type RankingInfo = {
+    /**
+     * This field is reserved for advanced usage.
+     */
+    filters: number;
+    /**
+     * Position of the most important matched attribute in the attributes to index list.
+     */
+    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;
+    /**
+     * Present and set to true if a Rule promoted the hit.
+     */
+    promoted: boolean;
+    /**
+     * When the query contains more than one word, the sum of the distances between matched words (in meters).
+     */
+    proximityDistance?: number;
+    /**
+     * Custom ranking for the object, expressed as a single integer value.
+     */
+    userScore: number;
+    /**
+     * Number of matched words, including prefixes and typos.
+     */
+    words: number;
+    /**
+     * Wether the record are promoted by the re-ranking strategy.
+     */
+    promotedByReRanking?: boolean;
+};
+//# sourceMappingURL=rankingInfo.d.ts.map

package/dist/algoliasearch/lite/model/rankingInfo.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rankingInfo.d.ts","sourceRoot":"","sources":["../../../../../../packages/algoliasearch/lite/model/rankingInfo.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,oBAAY,WAAW,GAAG;IACxB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;IAExC,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B,CAAC"}

package/dist/algoliasearch/lite/model/reRankingApplyFilter.d.ts

@@ -0,0 +1,6 @@
+import type { MixedSearchFilters } from './mixedSearchFilters';
+/**
+ * When Dynamic Re-Ranking is enabled, only records that match these filters will be impacted by Dynamic Re-Ranking.
+ */
+export declare type ReRankingApplyFilter = MixedSearchFilters[] | string;
+//# sourceMappingURL=reRankingApplyFilter.d.ts.map

package/dist/algoliasearch/lite/model/reRankingApplyFilter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reRankingApplyFilter.d.ts","sourceRoot":"","sources":["../../../../../../packages/algoliasearch/lite/model/reRankingApplyFilter.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D;;GAEG;AACH,oBAAY,oBAAoB,GAAG,kBAAkB,EAAE,GAAG,MAAM,CAAC"}

package/dist/algoliasearch/lite/model/removeStopWords.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Removes stop (common) words from the query before executing it. RemoveStopWords 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 stop word functionality, ensuring that stop words are removed from consideration in a search. The languages supported here are either every language, or those set by queryLanguages. False: disables stop word functionality, allowing stop words to be taken into account in a search.
+ */
+export declare type RemoveStopWords = string[] | boolean;
+//# sourceMappingURL=removeStopWords.d.ts.map

package/dist/algoliasearch/lite/model/removeStopWords.d.ts.map

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

package/dist/algoliasearch/lite/model/removeWordsIfNoResults.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Selects a strategy to remove words from the query when it doesn\'t match any hits.
+ */
+export declare type RemoveWordsIfNoResults = 'allOptional' | 'firstWords' | 'lastWords' | 'none';
+//# sourceMappingURL=removeWordsIfNoResults.d.ts.map

package/dist/algoliasearch/lite/model/removeWordsIfNoResults.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"removeWordsIfNoResults.d.ts","sourceRoot":"","sources":["../../../../../../packages/algoliasearch/lite/model/removeWordsIfNoResults.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,sBAAsB,GAC9B,aAAa,GACb,YAAY,GACZ,WAAW,GACX,MAAM,CAAC"}

package/dist/algoliasearch/lite/model/renderingContent.d.ts

@@ -0,0 +1,8 @@
+import type { FacetOrdering } from './facetOrdering';
+/**
+ * Content defining how the search interface should be rendered. Can be set via the settings for a default value and can be overridden via rules.
+ */
+export declare type RenderingContent = {
+    facetOrdering?: FacetOrdering;
+};
+//# sourceMappingURL=renderingContent.d.ts.map

package/dist/algoliasearch/lite/model/renderingContent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"renderingContent.d.ts","sourceRoot":"","sources":["../../../../../../packages/algoliasearch/lite/model/renderingContent.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD;;GAEG;AACH,oBAAY,gBAAgB,GAAG;IAC7B,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC"}

package/dist/algoliasearch/lite/model/rule.d.ts

@@ -0,0 +1,30 @@
+import type { Condition } from './condition';
+import type { Consequence } from './consequence';
+import type { TimeRange } from './timeRange';
+/**
+ * Rule object.
+ */
+export declare type Rule = {
+    /**
+     * Unique identifier of the object.
+     */
+    objectID: string;
+    /**
+     * A list of conditions that should apply to activate a Rule. You can use up to 25 conditions per Rule.
+     */
+    conditions?: Condition[];
+    consequence?: Consequence;
+    /**
+     * This field is intended for Rule management purposes, in particular to ease searching for Rules and presenting them to human readers. It\'s not interpreted by the API.
+     */
+    description?: string;
+    /**
+     * Whether the Rule is enabled. Disabled Rules remain in the index, but aren\'t applied at query time.
+     */
+    enabled?: boolean;
+    /**
+     * By default, Rules are permanently valid. When validity periods are specified, the Rule applies only during those periods; it\'s ignored the rest of the time. The list must not be empty.
+     */
+    validity?: TimeRange[];
+};
+//# sourceMappingURL=rule.d.ts.map

package/dist/algoliasearch/lite/model/rule.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rule.d.ts","sourceRoot":"","sources":["../../../../../../packages/algoliasearch/lite/model/rule.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C;;GAEG;AACH,oBAAY,IAAI,GAAG;IACjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,SAAS,EAAE,CAAC;IAEzB,WAAW,CAAC,EAAE,WAAW,CAAC;IAE1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,SAAS,EAAE,CAAC;CACxB,CAAC"}

package/dist/algoliasearch/lite/model/scopeType.d.ts

@@ -0,0 +1,2 @@
+export declare type ScopeType = 'rules' | 'settings' | 'synonyms';
+//# sourceMappingURL=scopeType.d.ts.map

package/dist/algoliasearch/lite/model/scopeType.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scopeType.d.ts","sourceRoot":"","sources":["../../../../../../packages/algoliasearch/lite/model/scopeType.ts"],"names":[],"mappings":"AAEA,oBAAY,SAAS,GAAG,OAAO,GAAG,UAAU,GAAG,UAAU,CAAC"}

package/dist/algoliasearch/lite/model/searchForFacets.d.ts

@@ -0,0 +1,4 @@
+import type { SearchForFacetsOptions } from './searchForFacetsOptions';
+import type { SearchParams } from './searchParams';
+export declare type SearchForFacets = SearchForFacetsOptions & SearchParams;
+//# sourceMappingURL=searchForFacets.d.ts.map

package/dist/algoliasearch/lite/model/searchForFacets.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"searchForFacets.d.ts","sourceRoot":"","sources":["../../../../../../packages/algoliasearch/lite/model/searchForFacets.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,oBAAY,eAAe,GAAG,sBAAsB,GAAG,YAAY,CAAC"}

package/dist/algoliasearch/lite/model/searchForFacetsOptions.d.ts

@@ -0,0 +1,21 @@
+import type { SearchTypeFacet } from './searchTypeFacet';
+export declare type SearchForFacetsOptions = {
+    /**
+     * The `facet` name.
+     */
+    facet: string;
+    /**
+     * The Algolia index name.
+     */
+    indexName: string;
+    /**
+     * Text to search inside the facet\'s values.
+     */
+    facetQuery?: 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;
+    type: SearchTypeFacet;
+};
+//# sourceMappingURL=searchForFacetsOptions.d.ts.map

package/dist/algoliasearch/lite/model/searchForFacetsOptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"searchForFacetsOptions.d.ts","sourceRoot":"","sources":["../../../../../../packages/algoliasearch/lite/model/searchForFacetsOptions.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,oBAAY,sBAAsB,GAAG;IACnC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,IAAI,EAAE,eAAe,CAAC;CACvB,CAAC"}

package/dist/algoliasearch/lite/model/searchForHits.d.ts

@@ -0,0 +1,4 @@
+import type { SearchForHitsOptions } from './searchForHitsOptions';
+import type { SearchParams } from './searchParams';
+export declare type SearchForHits = SearchForHitsOptions & SearchParams;
+//# sourceMappingURL=searchForHits.d.ts.map

package/dist/algoliasearch/lite/model/searchForHits.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"searchForHits.d.ts","sourceRoot":"","sources":["../../../../../../packages/algoliasearch/lite/model/searchForHits.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,oBAAY,aAAa,GAAG,oBAAoB,GAAG,YAAY,CAAC"}

package/dist/algoliasearch/lite/model/searchForHitsOptions.d.ts

@@ -0,0 +1,13 @@
+import type { SearchTypeDefault } from './searchTypeDefault';
+export declare type SearchForHitsOptions = {
+    /**
+     * The Algolia index name.
+     */
+    indexName: string;
+    type?: SearchTypeDefault;
+} & {
+    facet?: never;
+    maxFacetHits?: never;
+    facetQuery?: never;
+};
+//# sourceMappingURL=searchForHitsOptions.d.ts.map

package/dist/algoliasearch/lite/model/searchForHitsOptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"searchForHitsOptions.d.ts","sourceRoot":"","sources":["../../../../../../packages/algoliasearch/lite/model/searchForHitsOptions.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE7D,oBAAY,oBAAoB,GAAG;IACjC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB,IAAI,CAAC,EAAE,iBAAiB,CAAC;CAC1B,GAAG;IAAE,KAAK,CAAC,EAAE,KAAK,CAAC;IAAC,YAAY,CAAC,EAAE,KAAK,CAAC;IAAC,UAAU,CAAC,EAAE,KAAK,CAAA;CAAE,CAAC"}

package/dist/algoliasearch/lite/model/searchHits.d.ts

@@ -0,0 +1,5 @@
+import type { Hit } from './hit';
+export declare type SearchHits<T = Record<string, any>> = {
+    hits: Array<Hit<T>>;
+};
+//# sourceMappingURL=searchHits.d.ts.map

package/dist/algoliasearch/lite/model/searchHits.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"searchHits.d.ts","sourceRoot":"","sources":["../../../../../../packages/algoliasearch/lite/model/searchHits.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAEjC,oBAAY,UAAU,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI;IAChD,IAAI,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;CACrB,CAAC"}

package/dist/algoliasearch/lite/model/searchMethodParams.d.ts

@@ -0,0 +1,7 @@
+import type { SearchQuery } from './searchQuery';
+import type { SearchStrategy } from './searchStrategy';
+export declare type SearchMethodParams = {
+    requests: SearchQuery[];
+    strategy?: SearchStrategy;
+};
+//# sourceMappingURL=searchMethodParams.d.ts.map

package/dist/algoliasearch/lite/model/searchMethodParams.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"searchMethodParams.d.ts","sourceRoot":"","sources":["../../../../../../packages/algoliasearch/lite/model/searchMethodParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAEvD,oBAAY,kBAAkB,GAAG;IAC/B,QAAQ,EAAE,WAAW,EAAE,CAAC;IAExB,QAAQ,CAAC,EAAE,cAAc,CAAC;CAC3B,CAAC"}