@algolia/client-search 5.0.0-alpha.8 → 5.0.0-alpha.80

package/dist/model/searchResult.d.ts

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"searchResult.d.ts","sourceRoot":"","sources":["../../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,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAC5C,4BAA4B,GAC5B,cAAc,CAAC,CAAC,CAAC,CAAC"}

package/dist/model/searchRulesParams.d.ts

@@ -1,32 +1,32 @@
-import type { Anchoring } from './anchoring';
-/**
- * Parameters for the search.
- */
-export declare type SearchRulesParams = {
-    /**
-     * Full text query.
-     */
-    query?: string;
-    anchoring?: Anchoring;
-    /**
-     * Restricts matches to contextual rules with a specific context (exact match).
-     */
-    context?: string;
-    /**
-     * Requested page (zero-based).
-     */
-    page?: number;
-    /**
-     * Maximum number of hits in a page. Minimum is 1, maximum is 1000.
-     */
-    hitsPerPage?: number;
-    /**
-     * When specified, restricts matches to rules with a specific enabled status. When absent (default), all rules are retrieved, regardless of their enabled status.
-     */
-    enabled?: boolean;
-    /**
-     * A mapping of requestOptions to send along with the request.
-     */
-    requestOptions?: Array<Record<string, any>>;
-};
+import type { Anchoring } from './anchoring';
+/**
+ * Rules search parameters.
+ */
+export type SearchRulesParams = {
+    /**
+     * Rule object query.
+     */
+    query?: string;
+    anchoring?: Anchoring;
+    /**
+     * Restricts responses to the specified [contextual rule](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#creating-contextual-rules).
+     */
+    context?: string;
+    /**
+     * Requested page (the first page is page 0).
+     */
+    page?: number;
+    /**
+     * Maximum number of hits per page.
+     */
+    hitsPerPage?: number;
+    /**
+     * Restricts responses to enabled rules. When not specified (default), _all_ rules are retrieved.
+     */
+    enabled?: boolean | null;
+    /**
+     * Request options to send with the API call.
+     */
+    requestOptions?: Array<Record<string, any>>;
+};
 //# sourceMappingURL=searchRulesParams.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"searchRulesParams.d.ts","sourceRoot":"","sources":["../../model/searchRulesParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C;;GAEG;AACH,oBAAY,iBAAiB,GAAG;IAC9B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;CAC7C,CAAC"}
+{"version":3,"file":"searchRulesParams.d.ts","sourceRoot":"","sources":["../../model/searchRulesParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;CAC7C,CAAC"}

package/dist/model/searchRulesResponse.d.ts

@@ -1,20 +1,20 @@
-import type { Rule } from './rule';
-export declare type SearchRulesResponse = {
-    /**
-     * Fetched rules.
-     */
-    hits: Rule[];
-    /**
-     * Number of fetched rules.
-     */
-    nbHits: number;
-    /**
-     * Current page.
-     */
-    page: number;
-    /**
-     * Number of pages.
-     */
-    nbPages: number;
-};
+import type { Rule } from './rule';
+export type SearchRulesResponse = {
+    /**
+     * Fetched rules.
+     */
+    hits: Rule[];
+    /**
+     * Number of fetched rules.
+     */
+    nbHits: number;
+    /**
+     * Current page.
+     */
+    page: number;
+    /**
+     * Number of pages.
+     */
+    nbPages: number;
+};
 //# sourceMappingURL=searchRulesResponse.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"searchRulesResponse.d.ts","sourceRoot":"","sources":["../../model/searchRulesResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAEnC,oBAAY,mBAAmB,GAAG;IAChC;;OAEG;IACH,IAAI,EAAE,IAAI,EAAE,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC"}
+{"version":3,"file":"searchRulesResponse.d.ts","sourceRoot":"","sources":["../../model/searchRulesResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAEnC,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,IAAI,EAAE,IAAI,EAAE,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC"}

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

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

package/dist/model/searchSynonymsParams.d.ts

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

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

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

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

@@ -1 +1 @@
-{"version":3,"file":"searchSynonymsResponse.d.ts","sourceRoot":"","sources":["../../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":["../../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/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/model/searchTypeDefault.d.ts.map

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

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

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

package/dist/model/searchUserIdsParams.d.ts

@@ -1,22 +1,22 @@
-/**
- * OK.
- */
-export declare type SearchUserIdsParams = {
-    /**
-     * Query to search. The search is a prefix search with typoTolerance. Use empty query to retrieve all users.
-     */
-    query: string;
-    /**
-     * Name of the cluster.
-     */
-    clusterName?: string;
-    /**
-     * Specify the page to retrieve.
-     */
-    page?: number;
-    /**
-     * Set the number of hits per page.
-     */
-    hitsPerPage?: number;
-};
+/**
+ * OK.
+ */
+export type SearchUserIdsParams = {
+    /**
+     * Query to search. The search is a prefix search with [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) enabled. An empty query will retrieve all users.
+     */
+    query: string;
+    /**
+     * Cluster name.
+     */
+    clusterName?: string;
+    /**
+     * Page to retrieve (the first page is `0`, not `1`).
+     */
+    page?: number;
+    /**
+     * Number of hits per page.
+     */
+    hitsPerPage?: number;
+};
 //# sourceMappingURL=searchUserIdsParams.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"searchUserIdsParams.d.ts","sourceRoot":"","sources":["../../model/searchUserIdsParams.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,mBAAmB,GAAG;IAChC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC"}
+{"version":3,"file":"searchUserIdsParams.d.ts","sourceRoot":"","sources":["../../model/searchUserIdsParams.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC"}

package/dist/model/searchUserIdsResponse.d.ts

@@ -1,27 +1,27 @@
-import type { UserHit } from './userHit';
-/**
- * UserIDs data.
- */
-export declare type SearchUserIdsResponse = {
-    /**
-     * List of user object matching the query.
-     */
-    hits: UserHit[];
-    /**
-     * Number of hits that the search query matched.
-     */
-    nbHits: number;
-    /**
-     * Specify the page to retrieve.
-     */
-    page: number;
-    /**
-     * Maximum number of hits in a page. Minimum is 1, maximum is 1000.
-     */
-    hitsPerPage: number;
-    /**
-     * Date of last update (ISO-8601 format).
-     */
-    updatedAt: string;
-};
+import type { UserHit } from './userHit';
+/**
+ * UserIDs data.
+ */
+export type SearchUserIdsResponse = {
+    /**
+     * User objects that match the query.
+     */
+    hits: UserHit[];
+    /**
+     * Number of hits the search query matched.
+     */
+    nbHits: number;
+    /**
+     * Page to retrieve (the first page is `0`, not `1`).
+     */
+    page: number;
+    /**
+     * Maximum number of hits per page.
+     */
+    hitsPerPage: number;
+    /**
+     * Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
+     */
+    updatedAt: string;
+};
 //# sourceMappingURL=searchUserIdsResponse.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"searchUserIdsResponse.d.ts","sourceRoot":"","sources":["../../model/searchUserIdsResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC;;GAEG;AACH,oBAAY,qBAAqB,GAAG;IAClC;;OAEG;IACH,IAAI,EAAE,OAAO,EAAE,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}
+{"version":3,"file":"searchUserIdsResponse.d.ts","sourceRoot":"","sources":["../../model/searchUserIdsResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,IAAI,EAAE,OAAO,EAAE,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}

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

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

@@ -1 +1 @@
-{"version":3,"file":"snippetResult.d.ts","sourceRoot":"","sources":["../../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":["../../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/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/model/snippetResultOption.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"snippetResultOption.d.ts","sourceRoot":"","sources":["../../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":["../../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/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/model/sortRemainingBy.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sortRemainingBy.d.ts","sourceRoot":"","sources":["../../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":["../../model/sortRemainingBy.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,OAAO,GAAG,QAAQ,CAAC"}

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

@@ -1 +1 @@
-{"version":3,"file":"source.d.ts","sourceRoot":"","sources":["../../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":["../../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/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/model/standardEntries.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"standardEntries.d.ts","sourceRoot":"","sources":["../../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":["../../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/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/model/synonymHit.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"synonymHit.d.ts","sourceRoot":"","sources":["../../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":["../../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/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/model/synonymType.d.ts.map

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

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

@@ -1 +1 @@
-{"version":3,"file":"tagFilters.d.ts","sourceRoot":"","sources":["../../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":["../../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/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/model/taskStatus.d.ts.map

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