algoliasearch 5.0.0-alpha.9 → 5.0.0-alpha.91

package/dist/lite/model/searchParamsQuery.d.ts

@@ -1,7 +1,7 @@
-export declare type SearchParamsQuery = {
-    /**
-     * The text to search in the index.
-     */
-    query?: string;
-};
+export type SearchParamsQuery = {
+    /**
+     * Text to search for in an index.
+     */
+    query?: string;
+};
 //# sourceMappingURL=searchParamsQuery.d.ts.map

package/dist/lite/model/searchParamsQuery.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"searchParamsQuery.d.ts","sourceRoot":"","sources":["../../../lite/model/searchParamsQuery.ts"],"names":[],"mappings":"AAEA,oBAAY,iBAAiB,GAAG;IAC9B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC"}
+{"version":3,"file":"searchParamsQuery.d.ts","sourceRoot":"","sources":["../../../lite/model/searchParamsQuery.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC"}

package/dist/lite/model/searchParamsString.d.ts

@@ -1,7 +1,7 @@
-export declare type SearchParamsString = {
-    /**
-     * Search parameters as URL-encoded query string.
-     */
-    params?: string;
-};
+export type SearchParamsString = {
+    /**
+     * Search parameters as a URL-encoded query string.
+     */
+    params?: string;
+};
 //# sourceMappingURL=searchParamsString.d.ts.map

package/dist/lite/model/searchParamsString.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"searchParamsString.d.ts","sourceRoot":"","sources":["../../../lite/model/searchParamsString.ts"],"names":[],"mappings":"AAEA,oBAAY,kBAAkB,GAAG;IAC/B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC"}
+{"version":3,"file":"searchParamsString.d.ts","sourceRoot":"","sources":["../../../lite/model/searchParamsString.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC"}

package/dist/lite/model/searchQuery.d.ts

@@ -1,4 +1,4 @@
-import type { SearchForFacets } from './searchForFacets';
-import type { SearchForHits } from './searchForHits';
-export declare type SearchQuery = SearchForFacets | SearchForHits;
+import type { SearchForFacets } from './searchForFacets';
+import type { SearchForHits } from './searchForHits';
+export type SearchQuery = SearchForFacets | SearchForHits;
 //# sourceMappingURL=searchQuery.d.ts.map

package/dist/lite/model/searchQuery.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"searchQuery.d.ts","sourceRoot":"","sources":["../../../lite/model/searchQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD,oBAAY,WAAW,GAAG,eAAe,GAAG,aAAa,CAAC"}
+{"version":3,"file":"searchQuery.d.ts","sourceRoot":"","sources":["../../../lite/model/searchQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD,MAAM,MAAM,WAAW,GAAG,eAAe,GAAG,aAAa,CAAC"}

package/dist/lite/model/searchResponse.d.ts

@@ -1,4 +1,4 @@
-import type { BaseSearchResponse } from './baseSearchResponse';
-import type { SearchHits } from './searchHits';
-export declare type SearchResponse<T = Record<string, any>> = BaseSearchResponse & SearchHits<T>;
+import type { BaseSearchResponse } from './baseSearchResponse';
+import type { SearchHits } from './searchHits';
+export type SearchResponse<T = Record<string, any>> = BaseSearchResponse & SearchHits<T>;
 //# sourceMappingURL=searchResponse.d.ts.map

package/dist/lite/model/searchResponse.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"searchResponse.d.ts","sourceRoot":"","sources":["../../../lite/model/searchResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,oBAAY,cAAc,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,kBAAkB,GACtE,UAAU,CAAC,CAAC,CAAC,CAAC"}
+{"version":3,"file":"searchResponse.d.ts","sourceRoot":"","sources":["../../../lite/model/searchResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,MAAM,MAAM,cAAc,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,kBAAkB,GACtE,UAAU,CAAC,CAAC,CAAC,CAAC"}

package/dist/lite/model/searchResponses.d.ts

@@ -1,5 +1,5 @@
-import type { SearchResponse } from './searchResponse';
-export declare type SearchResponses<T = Record<string, any>> = {
-    results: Array<SearchResponse<T>>;
-};
+import type { SearchResult } from './searchResult';
+export type SearchResponses = {
+    results: SearchResult[];
+};
 //# sourceMappingURL=searchResponses.d.ts.map

package/dist/lite/model/searchResponses.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"searchResponses.d.ts","sourceRoot":"","sources":["../../../lite/model/searchResponses.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAEvD,oBAAY,eAAe,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI;IACrD,OAAO,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;CACnC,CAAC"}
+{"version":3,"file":"searchResponses.d.ts","sourceRoot":"","sources":["../../../lite/model/searchResponses.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,MAAM,MAAM,eAAe,GAAG;IAC5B,OAAO,EAAE,YAAY,EAAE,CAAC;CACzB,CAAC"}

package/dist/lite/model/searchResult.d.ts

@@ -0,0 +1,4 @@
+import type { SearchForFacetValuesResponse } from './searchForFacetValuesResponse';
+import type { SearchResponse } from './searchResponse';
+export type SearchResult = SearchForFacetValuesResponse | SearchResponse;
+//# sourceMappingURL=searchResult.d.ts.map

package/dist/lite/model/searchResult.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"searchResult.d.ts","sourceRoot":"","sources":["../../../lite/model/searchResult.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,gCAAgC,CAAC;AACnF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAEvD,MAAM,MAAM,YAAY,GAAG,4BAA4B,GAAG,cAAc,CAAC"}

package/dist/lite/model/searchStrategy.d.ts

@@ -1,2 +1,5 @@
-export declare type SearchStrategy = 'none' | 'stopIfEnoughMatches';
+/**
+ * - `none`: executes all queries. - `stopIfEnoughMatches`: executes queries one by one, stopping further query execution as soon as a query matches at least the `hitsPerPage` number of results.
+ */
+export type SearchStrategy = 'none' | 'stopIfEnoughMatches';
 //# sourceMappingURL=searchStrategy.d.ts.map

package/dist/lite/model/searchStrategy.d.ts.map

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

package/dist/lite/model/searchSynonymsResponse.d.ts

@@ -1,12 +1,12 @@
-import type { SynonymHit } from './synonymHit';
-export declare type SearchSynonymsResponse = Record<string, any> & {
-    /**
-     * Array of synonym objects.
-     */
-    hits: SynonymHit[];
-    /**
-     * Number of hits that the search query matched.
-     */
-    nbHits: number;
-};
+import type { SynonymHit } from './synonymHit';
+export type SearchSynonymsResponse = Record<string, any> & {
+    /**
+     * Synonym objects.
+     */
+    hits: SynonymHit[];
+    /**
+     * Number of hits the search query matched.
+     */
+    nbHits: number;
+};
 //# sourceMappingURL=searchSynonymsResponse.d.ts.map

package/dist/lite/model/searchSynonymsResponse.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"searchSynonymsResponse.d.ts","sourceRoot":"","sources":["../../../lite/model/searchSynonymsResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,oBAAY,sBAAsB,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;IACzD;;OAEG;IACH,IAAI,EAAE,UAAU,EAAE,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}
+{"version":3,"file":"searchSynonymsResponse.d.ts","sourceRoot":"","sources":["../../../lite/model/searchSynonymsResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,MAAM,MAAM,sBAAsB,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;IACzD;;OAEG;IACH,IAAI,EAAE,UAAU,EAAE,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}

package/dist/lite/model/searchTypeDefault.d.ts

@@ -1,5 +1,5 @@
-/**
- * Perform a search query with `default`, will search for facet values if `facet` is given.
- */
-export declare type SearchTypeDefault = 'default';
+/**
+ * - `default`: perform a search query - `facet` [searches for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
+ */
+export type SearchTypeDefault = 'default';
 //# sourceMappingURL=searchTypeDefault.d.ts.map

package/dist/lite/model/searchTypeDefault.d.ts.map

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

package/dist/lite/model/searchTypeFacet.d.ts

@@ -1,5 +1,5 @@
-/**
- * Perform a search query with `default`, will search for facet values if `facet` is given.
- */
-export declare type SearchTypeFacet = 'facet';
+/**
+ * - `default`: perform a search query - `facet` [searches for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
+ */
+export type SearchTypeFacet = 'facet';
 //# sourceMappingURL=searchTypeFacet.d.ts.map

package/dist/lite/model/searchTypeFacet.d.ts.map

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

package/dist/lite/model/semanticSearch.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Settings for the semantic search part of NeuralSearch. Only used when `mode` is _neuralSearch_.
+ */
+export type SemanticSearch = {
+    /**
+     * Indices from which to collect click and conversion events. If null, the current index and replica group will be used as the event source.
+     */
+    eventSources?: string[] | null;
+};
+//# sourceMappingURL=semanticSearch.d.ts.map

package/dist/lite/model/semanticSearch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"semanticSearch.d.ts","sourceRoot":"","sources":["../../../lite/model/semanticSearch.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;CAChC,CAAC"}

package/dist/lite/model/snippetResult.d.ts

@@ -1,3 +1,3 @@
-import type { SnippetResultOption } from './snippetResultOption';
-export declare type SnippetResult = SnippetResultOption | SnippetResultOption[];
+import type { SnippetResultOption } from './snippetResultOption';
+export type SnippetResult = SnippetResultOption | SnippetResultOption[];
 //# sourceMappingURL=snippetResult.d.ts.map

package/dist/lite/model/snippetResult.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"snippetResult.d.ts","sourceRoot":"","sources":["../../../lite/model/snippetResult.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE,oBAAY,aAAa,GAAG,mBAAmB,GAAG,mBAAmB,EAAE,CAAC"}
+{"version":3,"file":"snippetResult.d.ts","sourceRoot":"","sources":["../../../lite/model/snippetResult.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE,MAAM,MAAM,aAAa,GAAG,mBAAmB,GAAG,mBAAmB,EAAE,CAAC"}

package/dist/lite/model/snippetResultOption.d.ts

@@ -1,12 +1,12 @@
-import type { MatchLevel } from './matchLevel';
-/**
- * Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.
- */
-export declare type SnippetResultOption = {
-    /**
-     * Markup text with occurrences highlighted.
-     */
-    value: string;
-    matchLevel: MatchLevel;
-};
+import type { MatchLevel } from './matchLevel';
+/**
+ * Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.
+ */
+export type SnippetResultOption = {
+    /**
+     * Markup text with `facetQuery` matches highlighted.
+     */
+    value: string;
+    matchLevel: MatchLevel;
+};
 //# sourceMappingURL=snippetResultOption.d.ts.map

package/dist/lite/model/snippetResultOption.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"snippetResultOption.d.ts","sourceRoot":"","sources":["../../../lite/model/snippetResultOption.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C;;GAEG;AACH,oBAAY,mBAAmB,GAAG;IAChC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd,UAAU,EAAE,UAAU,CAAC;CACxB,CAAC"}
+{"version":3,"file":"snippetResultOption.d.ts","sourceRoot":"","sources":["../../../lite/model/snippetResultOption.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd,UAAU,EAAE,UAAU,CAAC;CACxB,CAAC"}

package/dist/lite/model/sortRemainingBy.d.ts

@@ -1,5 +1,5 @@
-/**
- * How to display the remaining items.   - `count`: facet count (descending).   - `alpha`: alphabetical (ascending).   - `hidden`: show only pinned values.
- */
-export declare type SortRemainingBy = 'alpha' | 'count' | 'hidden';
+/**
+ * How to display the remaining items:    - `count`: facet count (descending).   - `alpha`: alphabetical (ascending).   - `hidden`: show only pinned values.
+ */
+export type SortRemainingBy = 'alpha' | 'count' | 'hidden';
 //# sourceMappingURL=sortRemainingBy.d.ts.map

package/dist/lite/model/sortRemainingBy.d.ts.map

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

package/dist/lite/model/source.d.ts

@@ -1,14 +1,14 @@
-/**
- * The source.
- */
-export declare type Source = {
-    /**
-     * The IP range of the source.
-     */
-    source: string;
-    /**
-     * The description of the source.
-     */
-    description?: string;
-};
+/**
+ * Source.
+ */
+export type Source = {
+    /**
+     * IP address range of the source.
+     */
+    source: string;
+    /**
+     * Source description.
+     */
+    description?: string;
+};
 //# sourceMappingURL=source.d.ts.map

package/dist/lite/model/source.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"source.d.ts","sourceRoot":"","sources":["../../../lite/model/source.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,MAAM,GAAG;IACnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC"}
+{"version":3,"file":"source.d.ts","sourceRoot":"","sources":["../../../lite/model/source.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC"}

package/dist/lite/model/standardEntries.d.ts

@@ -1,18 +1,18 @@
-/**
- * Map of language ISO code supported by the dictionary (e.g., \"en\" for English) to a boolean value.
- */
-export declare type StandardEntries = {
-    /**
-     * Language ISO code.
-     */
-    plurals?: Record<string, boolean> | null;
-    /**
-     * Language ISO code.
-     */
-    stopwords?: Record<string, boolean> | null;
-    /**
-     * Language ISO code.
-     */
-    compounds?: Record<string, boolean> | null;
-};
+/**
+ * Key-value pairs of [supported language ISO codes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/) and boolean values.
+ */
+export type StandardEntries = {
+    /**
+     * Key-value pair of a language ISO code and a boolean value.
+     */
+    plurals?: Record<string, boolean> | null;
+    /**
+     * Key-value pair of a language ISO code and a boolean value.
+     */
+    stopwords?: Record<string, boolean> | null;
+    /**
+     * Key-value pair of a language ISO code and a boolean value.
+     */
+    compounds?: Record<string, boolean> | null;
+};
 //# sourceMappingURL=standardEntries.d.ts.map

package/dist/lite/model/standardEntries.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"standardEntries.d.ts","sourceRoot":"","sources":["../../../lite/model/standardEntries.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,eAAe,GAAG;IAC5B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;CAC5C,CAAC"}
+{"version":3,"file":"standardEntries.d.ts","sourceRoot":"","sources":["../../../lite/model/standardEntries.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;CAC5C,CAAC"}

package/dist/lite/model/synonymHit.d.ts

@@ -1,38 +1,36 @@
-import type { SynonymHitHighlightResult } from './synonymHitHighlightResult';
-import type { SynonymType } from './synonymType';
-/**
- * Synonym object.
- */
-export declare type SynonymHit = {
-    /**
-     * Unique identifier of the synonym object to be created or updated.
-     */
-    objectID: string;
-    type: SynonymType;
-    /**
-     * Words or phrases to be considered equivalent.
-     */
-    synonyms?: string[];
-    /**
-     * Word or phrase to appear in query strings (for onewaysynonym).
-     */
-    input?: string;
-    /**
-     * Word or phrase to appear in query strings (for altcorrection1 and altcorrection2).
-     */
-    word?: string;
-    /**
-     * Words to be matched in records.
-     */
-    corrections?: string[];
-    /**
-     * Token to be put inside records.
-     */
-    placeholder?: string;
-    /**
-     * List of query words that will match the token.
-     */
-    replacements?: string[];
-    _highlightResult?: SynonymHitHighlightResult;
-};
+import type { SynonymType } from './synonymType';
+/**
+ * Synonym object.
+ */
+export type SynonymHit = {
+    /**
+     * Unique identifier of a synonym object.
+     */
+    objectID: string;
+    type: SynonymType;
+    /**
+     * Words or phrases considered equivalent.
+     */
+    synonyms?: string[];
+    /**
+     * Word or phrase to appear in query strings (for [`onewaysynonym`s](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/one-way-synonyms/)).
+     */
+    input?: string;
+    /**
+     * Word or phrase to appear in query strings (for [`altcorrection1` and `altcorrection2`](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-alternative-corrections/)).
+     */
+    word?: string;
+    /**
+     * Words to be matched in records.
+     */
+    corrections?: string[];
+    /**
+     * [Placeholder token](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-placeholders/) to be put inside records.
+     */
+    placeholder?: string;
+    /**
+     * Query words that will match the [placeholder token](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-placeholders/).
+     */
+    replacements?: string[];
+};
 //# sourceMappingURL=synonymHit.d.ts.map

package/dist/lite/model/synonymHit.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"synonymHit.d.ts","sourceRoot":"","sources":["../../../lite/model/synonymHit.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAC7E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAEjD;;GAEG;AACH,oBAAY,UAAU,GAAG;IACvB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB,IAAI,EAAE,WAAW,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IAEvB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IAExB,gBAAgB,CAAC,EAAE,yBAAyB,CAAC;CAC9C,CAAC"}
+{"version":3,"file":"synonymHit.d.ts","sourceRoot":"","sources":["../../../lite/model/synonymHit.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAEjD;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB,IAAI,EAAE,WAAW,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IAEvB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;CACzB,CAAC"}

package/dist/lite/model/synonymType.d.ts

@@ -1,5 +1,5 @@
-/**
- * Type of the synonym object.
- */
-export declare type SynonymType = 'altcorrection1' | 'altcorrection2' | 'onewaysynonym' | 'placeholder' | 'synonym';
+/**
+ * Synonym type.
+ */
+export type SynonymType = 'altcorrection1' | 'altcorrection2' | 'onewaysynonym' | 'placeholder' | 'synonym';
 //# sourceMappingURL=synonymType.d.ts.map

package/dist/lite/model/synonymType.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"synonymType.d.ts","sourceRoot":"","sources":["../../../lite/model/synonymType.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,WAAW,GACnB,gBAAgB,GAChB,gBAAgB,GAChB,eAAe,GACf,aAAa,GACb,SAAS,CAAC"}
+{"version":3,"file":"synonymType.d.ts","sourceRoot":"","sources":["../../../lite/model/synonymType.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,WAAW,GACnB,gBAAgB,GAChB,gBAAgB,GAChB,eAAe,GACf,aAAa,GACb,SAAS,CAAC"}

package/dist/lite/model/tagFilters.d.ts

@@ -1,6 +1,6 @@
-import type { MixedSearchFilters } from './mixedSearchFilters';
-/**
- * Filter hits by tags.
- */
-export declare type TagFilters = MixedSearchFilters[] | string;
+import type { MixedSearchFilters } from './mixedSearchFilters';
+/**
+ * [Filter hits by tags](https://www.algolia.com/doc/api-reference/api-parameters/tagFilters/).
+ */
+export type TagFilters = MixedSearchFilters[] | string;
 //# sourceMappingURL=tagFilters.d.ts.map

package/dist/lite/model/tagFilters.d.ts.map

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

package/dist/lite/model/taskStatus.d.ts

@@ -1,2 +1,5 @@
-export declare type TaskStatus = 'notPublished' | 'published';
+/**
+ * _published_ if the task has been processed, _notPublished_ otherwise.
+ */
+export type TaskStatus = 'notPublished' | 'published';
 //# sourceMappingURL=taskStatus.d.ts.map

package/dist/lite/model/taskStatus.d.ts.map

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

package/dist/lite/model/timeRange.d.ts

@@ -1,11 +1,11 @@
-export declare type TimeRange = {
-    /**
-     * Lower bound of the time range (Unix timestamp).
-     */
-    from: number;
-    /**
-     * Upper bound of the time range (Unix timestamp).
-     */
-    until: number;
-};
+export type TimeRange = {
+    /**
+     * Lower bound of the time range (Unix timestamp).
+     */
+    from: number;
+    /**
+     * Upper bound of the time range (Unix timestamp).
+     */
+    until: number;
+};
 //# sourceMappingURL=timeRange.d.ts.map

package/dist/lite/model/timeRange.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"timeRange.d.ts","sourceRoot":"","sources":["../../../lite/model/timeRange.ts"],"names":[],"mappings":"AAEA,oBAAY,SAAS,GAAG;IACtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC"}
+{"version":3,"file":"timeRange.d.ts","sourceRoot":"","sources":["../../../lite/model/timeRange.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,SAAS,GAAG;IACtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC"}

package/dist/lite/model/typoTolerance.d.ts

@@ -1,6 +1,6 @@
-import type { TypoToleranceEnum } from './typoToleranceEnum';
-/**
- * Controls whether typo tolerance is enabled and how it is applied.
- */
-export declare type TypoTolerance = TypoToleranceEnum | boolean;
+import type { TypoToleranceEnum } from './typoToleranceEnum';
+/**
+ * Controls whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied.
+ */
+export type TypoTolerance = TypoToleranceEnum | boolean;
 //# sourceMappingURL=typoTolerance.d.ts.map

package/dist/lite/model/typoTolerance.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"typoTolerance.d.ts","sourceRoot":"","sources":["../../../lite/model/typoTolerance.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE7D;;GAEG;AACH,oBAAY,aAAa,GAAG,iBAAiB,GAAG,OAAO,CAAC"}
+{"version":3,"file":"typoTolerance.d.ts","sourceRoot":"","sources":["../../../lite/model/typoTolerance.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE7D;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,iBAAiB,GAAG,OAAO,CAAC"}

package/dist/lite/model/typoToleranceEnum.d.ts

@@ -1,2 +1,2 @@
-export declare type TypoToleranceEnum = 'min' | 'strict';
+export type TypoToleranceEnum = 'min' | 'strict';
 //# sourceMappingURL=typoToleranceEnum.d.ts.map

package/dist/lite/model/typoToleranceEnum.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"typoToleranceEnum.d.ts","sourceRoot":"","sources":["../../../lite/model/typoToleranceEnum.ts"],"names":[],"mappings":"AAEA,oBAAY,iBAAiB,GAAG,KAAK,GAAG,QAAQ,CAAC"}
+{"version":3,"file":"typoToleranceEnum.d.ts","sourceRoot":"","sources":["../../../lite/model/typoToleranceEnum.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,iBAAiB,GAAG,KAAK,GAAG,QAAQ,CAAC"}

package/dist/lite/model/updatedRuleResponse.d.ts

@@ -1,15 +1,15 @@
-export declare type UpdatedRuleResponse = {
-    /**
-     * Unique identifier of the object.
-     */
-    objectID: string;
-    /**
-     * Date of last update (ISO-8601 format).
-     */
-    updatedAt: string;
-    /**
-     * TaskID of the task to wait for.
-     */
-    taskID: number;
-};
+export type UpdatedRuleResponse = {
+    /**
+     * Unique object identifier.
+     */
+    objectID: string;
+    /**
+     * Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
+     */
+    updatedAt: string;
+    /**
+     * Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the `task` operation and this `taskID`.
+     */
+    taskID: number;
+};
 //# sourceMappingURL=updatedRuleResponse.d.ts.map

package/dist/lite/model/updatedRuleResponse.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"updatedRuleResponse.d.ts","sourceRoot":"","sources":["../../../lite/model/updatedRuleResponse.ts"],"names":[],"mappings":"AAEA,oBAAY,mBAAmB,GAAG;IAChC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}
+{"version":3,"file":"updatedRuleResponse.d.ts","sourceRoot":"","sources":["../../../lite/model/updatedRuleResponse.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}

package/dist/lite/model/userId.d.ts

@@ -1,22 +1,22 @@
-/**
- * A userID.
- */
-export declare type UserId = {
-    /**
-     * UserID of the user.
-     */
-    userID: string;
-    /**
-     * Cluster on which the user is assigned.
-     */
-    clusterName: string;
-    /**
-     * Number of records belonging to the user.
-     */
-    nbRecords: number;
-    /**
-     * Data size used by the user.
-     */
-    dataSize: number;
-};
+/**
+ * Unique user ID.
+ */
+export type UserId = {
+    /**
+     * UserID of the user.
+     */
+    userID: string;
+    /**
+     * Cluster to which the user is assigned.
+     */
+    clusterName: string;
+    /**
+     * Number of records belonging to the user.
+     */
+    nbRecords: number;
+    /**
+     * Data size used by the user.
+     */
+    dataSize: number;
+};
 //# sourceMappingURL=userId.d.ts.map

package/dist/lite/model/userId.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"userId.d.ts","sourceRoot":"","sources":["../../../lite/model/userId.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,MAAM,GAAG;IACnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC"}
+{"version":3,"file":"userId.d.ts","sourceRoot":"","sources":["../../../lite/model/userId.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC"}