@algolia/client-search 5.0.0-alpha.9 → 5.0.0-alpha.90

package/dist/model/removeStopWords.d.ts

@@ -1,5 +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;
+/**
+ * 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 stop words should be enabled. This list will override any values that you may have set in `queryLanguages`. _true_: enables the stop words feature, ensuring that stop words are removed from consideration in a search. The languages supported here are either [every language](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/) (this is the default) or those set by `queryLanguages`. _false_: turns off the stop words feature, allowing stop words to be taken into account in a search.
+ */
+export type RemoveStopWords = string[] | boolean;
 //# sourceMappingURL=removeStopWords.d.ts.map

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

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

package/dist/model/removeUserIdResponse.d.ts

@@ -1,7 +1,7 @@
-export declare type RemoveUserIdResponse = {
-    /**
-     * Date of deletion (ISO-8601 format).
-     */
-    deletedAt: string;
-};
+export type RemoveUserIdResponse = {
+    /**
+     * Timestamp of deletion in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
+     */
+    deletedAt: string;
+};
 //# sourceMappingURL=removeUserIdResponse.d.ts.map

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

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

package/dist/model/removeWordsIfNoResults.d.ts

@@ -1,5 +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';
+/**
+ * Strategy to [remove words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/in-depth/why-use-remove-words-if-no-results/) from the query when it doesn\'t match any hits.
+ */
+export type RemoveWordsIfNoResults = 'allOptional' | 'firstWords' | 'lastWords' | 'none';
 //# sourceMappingURL=removeWordsIfNoResults.d.ts.map

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

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

package/dist/model/renderingContent.d.ts

@@ -1,8 +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;
-};
+import type { FacetOrdering } from './facetOrdering';
+/**
+ * Extra content for the search UI, for example, to control the [ordering and display of facets](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/merchandising-facets/#merchandise-facets-and-their-values-in-the-manual-editor). You can set a default value and dynamically override it with [Rules](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/).
+ */
+export type RenderingContent = {
+    facetOrdering?: FacetOrdering;
+};
 //# sourceMappingURL=renderingContent.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"renderingContent.d.ts","sourceRoot":"","sources":["../../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"}
+{"version":3,"file":"renderingContent.d.ts","sourceRoot":"","sources":["../../model/renderingContent.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC"}

package/dist/model/replaceSourceResponse.d.ts

@@ -1,7 +1,7 @@
-export declare type ReplaceSourceResponse = {
-    /**
-     * Date of last update (ISO-8601 format).
-     */
-    updatedAt: string;
-};
+export type ReplaceSourceResponse = {
+    /**
+     * Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
+     */
+    updatedAt: string;
+};
 //# sourceMappingURL=replaceSourceResponse.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"replaceSourceResponse.d.ts","sourceRoot":"","sources":["../../model/replaceSourceResponse.ts"],"names":[],"mappings":"AAEA,oBAAY,qBAAqB,GAAG;IAClC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}
+{"version":3,"file":"replaceSourceResponse.d.ts","sourceRoot":"","sources":["../../model/replaceSourceResponse.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}

package/dist/model/rule.d.ts

@@ -1,30 +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[];
-};
+import type { Condition } from './condition';
+import type { Consequence } from './consequence';
+import type { TimeRange } from './timeRange';
+/**
+ * Rule object.
+ */
+export type Rule = {
+    /**
+     * Unique identifier for a rule object.
+     */
+    objectID: string;
+    /**
+     * [Conditions](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#conditions) required to activate a rule. You can use up to 25 conditions per rule.
+     */
+    conditions?: Condition[];
+    consequence?: Consequence;
+    /**
+     * Description of the rule\'s purpose. This can be helpful for display in the Algolia dashboard.
+     */
+    description?: string;
+    /**
+     * Indicates whether to enable the rule. If it isn\'t enabled, it isn\'t applied at query time.
+     */
+    enabled?: boolean;
+    /**
+     * If you specify a validity period, the rule _only_ applies only during that period. If specified, the array must not be empty.
+     */
+    validity?: TimeRange[];
+};
 //# sourceMappingURL=rule.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"rule.d.ts","sourceRoot":"","sources":["../../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"}
+{"version":3,"file":"rule.d.ts","sourceRoot":"","sources":["../../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,MAAM,MAAM,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/model/saveObjectResponse.d.ts

@@ -1,12 +1,15 @@
-export declare type SaveObjectResponse = {
-    createdAt: string;
-    /**
-     * TaskID of the task to wait for.
-     */
-    taskID: number;
-    /**
-     * Unique identifier of the object.
-     */
-    objectID?: string;
-};
+export type SaveObjectResponse = {
+    /**
+     * Date of creation (ISO-8601 format).
+     */
+    createdAt: 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;
+    /**
+     * Unique object identifier.
+     */
+    objectID?: string;
+};
 //# sourceMappingURL=saveObjectResponse.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"saveObjectResponse.d.ts","sourceRoot":"","sources":["../../model/saveObjectResponse.ts"],"names":[],"mappings":"AAEA,oBAAY,kBAAkB,GAAG;IAC/B,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC"}
+{"version":3,"file":"saveObjectResponse.d.ts","sourceRoot":"","sources":["../../model/saveObjectResponse.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC"}

package/dist/model/saveSynonymResponse.d.ts

@@ -1,15 +1,15 @@
-export declare type SaveSynonymResponse = {
-    /**
-     * TaskID of the task to wait for.
-     */
-    taskID: number;
-    /**
-     * Date of last update (ISO-8601 format).
-     */
-    updatedAt: string;
-    /**
-     * ObjectID of the inserted object.
-     */
-    id: string;
-};
+export type SaveSynonymResponse = {
+    /**
+     * 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;
+    /**
+     * Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
+     */
+    updatedAt: string;
+    /**
+     * Unique identifier of a synonym object.
+     */
+    id: string;
+};
 //# sourceMappingURL=saveSynonymResponse.d.ts.map

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

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

package/dist/model/scopeType.d.ts

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

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

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

package/dist/model/searchDictionaryEntriesParams.d.ts

@@ -1,22 +1,22 @@
-/**
- * The `searchDictionaryEntries` parameters.
- */
-export declare type SearchDictionaryEntriesParams = {
-    /**
-     * The text to search in the index.
-     */
-    query: string;
-    /**
-     * Specify the page to retrieve.
-     */
-    page?: number;
-    /**
-     * Set the number of hits per page.
-     */
-    hitsPerPage?: number;
-    /**
-     * Language ISO code supported by the dictionary (e.g., \"en\" for English).
-     */
-    language?: string;
-};
+/**
+ * `searchDictionaryEntries` parameters.
+ */
+export type SearchDictionaryEntriesParams = {
+    /**
+     * Text to search for in an index.
+     */
+    query: string;
+    /**
+     * Page to retrieve (the first page is `0`, not `1`).
+     */
+    page?: number;
+    /**
+     * Number of hits per page.
+     */
+    hitsPerPage?: number;
+    /**
+     * [Supported language ISO code](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/).
+     */
+    language?: string;
+};
 //# sourceMappingURL=searchDictionaryEntriesParams.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"searchDictionaryEntriesParams.d.ts","sourceRoot":"","sources":["../../model/searchDictionaryEntriesParams.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,6BAA6B,GAAG;IAC1C;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC"}
+{"version":3,"file":"searchDictionaryEntriesParams.d.ts","sourceRoot":"","sources":["../../model/searchDictionaryEntriesParams.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC"}

package/dist/model/searchForFacetValuesRequest.d.ts

@@ -1,15 +1,15 @@
-export declare type SearchForFacetValuesRequest = {
-    /**
-     * Search parameters as URL-encoded query string.
-     */
-    params?: 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;
-};
+export type SearchForFacetValuesRequest = {
+    /**
+     * Search parameters as a URL-encoded query string.
+     */
+    params?: string;
+    /**
+     * Text to search inside the facet\'s values.
+     */
+    facetQuery?: string;
+    /**
+     * Maximum number of facet hits to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
+     */
+    maxFacetHits?: number;
+};
 //# sourceMappingURL=searchForFacetValuesRequest.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"searchForFacetValuesRequest.d.ts","sourceRoot":"","sources":["../../model/searchForFacetValuesRequest.ts"],"names":[],"mappings":"AAEA,oBAAY,2BAA2B,GAAG;IACxC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC"}
+{"version":3,"file":"searchForFacetValuesRequest.d.ts","sourceRoot":"","sources":["../../model/searchForFacetValuesRequest.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,2BAA2B,GAAG;IACxC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC"}

package/dist/model/searchForFacetValuesResponse.d.ts

@@ -1,5 +1,5 @@
-import type { FacetHits } from './facetHits';
-export declare type SearchForFacetValuesResponse = {
-    facetHits: FacetHits[];
-};
+import type { FacetHits } from './facetHits';
+export type SearchForFacetValuesResponse = {
+    facetHits: FacetHits[];
+};
 //# sourceMappingURL=searchForFacetValuesResponse.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"searchForFacetValuesResponse.d.ts","sourceRoot":"","sources":["../../model/searchForFacetValuesResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,oBAAY,4BAA4B,GAAG;IACzC,SAAS,EAAE,SAAS,EAAE,CAAC;CACxB,CAAC"}
+{"version":3,"file":"searchForFacetValuesResponse.d.ts","sourceRoot":"","sources":["../../model/searchForFacetValuesResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,MAAM,MAAM,4BAA4B,GAAG;IACzC,SAAS,EAAE,SAAS,EAAE,CAAC;CACxB,CAAC"}

package/dist/model/searchForFacets.d.ts

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

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

@@ -1 +1 @@
-{"version":3,"file":"searchForFacets.d.ts","sourceRoot":"","sources":["../../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"}
+{"version":3,"file":"searchForFacets.d.ts","sourceRoot":"","sources":["../../model/searchForFacets.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,MAAM,MAAM,eAAe,GAAG,sBAAsB,GAAG,YAAY,CAAC"}

package/dist/model/searchForFacetsOptions.d.ts

@@ -1,21 +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;
-};
+import type { SearchTypeFacet } from './searchTypeFacet';
+export type SearchForFacetsOptions = {
+    /**
+     * Facet name.
+     */
+    facet: string;
+    /**
+     * Algolia index name.
+     */
+    indexName: string;
+    /**
+     * Text to search inside the facet\'s values.
+     */
+    facetQuery?: string;
+    /**
+     * Maximum number of facet hits to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
+     */
+    maxFacetHits?: number;
+    type: SearchTypeFacet;
+};
 //# sourceMappingURL=searchForFacetsOptions.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"searchForFacetsOptions.d.ts","sourceRoot":"","sources":["../../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"}
+{"version":3,"file":"searchForFacetsOptions.d.ts","sourceRoot":"","sources":["../../model/searchForFacetsOptions.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,MAAM,MAAM,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/model/searchForHits.d.ts

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

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

@@ -1 +1 @@
-{"version":3,"file":"searchForHits.d.ts","sourceRoot":"","sources":["../../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"}
+{"version":3,"file":"searchForHits.d.ts","sourceRoot":"","sources":["../../model/searchForHits.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,MAAM,MAAM,aAAa,GAAG,oBAAoB,GAAG,YAAY,CAAC"}

package/dist/model/searchForHitsOptions.d.ts

@@ -1,13 +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;
-};
+import type { SearchTypeDefault } from './searchTypeDefault';
+export type SearchForHitsOptions = {
+    /**
+     * Algolia index name.
+     */
+    indexName: string;
+    type?: SearchTypeDefault;
+} & {
+    facet?: never;
+    maxFacetHits?: never;
+    facetQuery?: never;
+};
 //# sourceMappingURL=searchForHitsOptions.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"searchForHitsOptions.d.ts","sourceRoot":"","sources":["../../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"}
+{"version":3,"file":"searchForHitsOptions.d.ts","sourceRoot":"","sources":["../../model/searchForHitsOptions.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE7D,MAAM,MAAM,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/model/searchHits.d.ts

@@ -1,5 +1,13 @@
-import type { Hit } from './hit';
-export declare type SearchHits<T = Record<string, any>> = {
-    hits: Array<Hit<T>>;
-};
+import type { Hit } from './hit';
+export type SearchHits<T = Record<string, any>> = Record<string, any> & {
+    hits: Array<Hit<T>>;
+    /**
+     * Text to search for in an index.
+     */
+    query: T;
+    /**
+     * URL-encoded string of all search parameters.
+     */
+    params: T;
+};
 //# sourceMappingURL=searchHits.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"searchHits.d.ts","sourceRoot":"","sources":["../../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"}
+{"version":3,"file":"searchHits.d.ts","sourceRoot":"","sources":["../../model/searchHits.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAEjC,MAAM,MAAM,UAAU,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;IACtE,IAAI,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAEpB;;OAEG;IACH,KAAK,EAAE,CAAC,CAAC;IAET;;OAEG;IACH,MAAM,EAAE,CAAC,CAAC;CACX,CAAC"}

package/dist/model/searchMethodParams.d.ts

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

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

@@ -1 +1 @@
-{"version":3,"file":"searchMethodParams.d.ts","sourceRoot":"","sources":["../../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"}
+{"version":3,"file":"searchMethodParams.d.ts","sourceRoot":"","sources":["../../model/searchMethodParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAEvD,MAAM,MAAM,kBAAkB,GAAG;IAC/B,QAAQ,EAAE,WAAW,EAAE,CAAC;IAExB,QAAQ,CAAC,EAAE,cAAc,CAAC;CAC3B,CAAC"}

package/dist/model/searchParams.d.ts

@@ -1,4 +1,4 @@
-import type { SearchParamsObject } from './searchParamsObject';
-import type { SearchParamsString } from './searchParamsString';
-export declare type SearchParams = SearchParamsObject | SearchParamsString;
+import type { SearchParamsObject } from './searchParamsObject';
+import type { SearchParamsString } from './searchParamsString';
+export type SearchParams = SearchParamsObject | SearchParamsString;
 //# sourceMappingURL=searchParams.d.ts.map

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

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

package/dist/model/searchParamsObject.d.ts

@@ -1,4 +1,4 @@
-import type { BaseSearchParams } from './baseSearchParams';
-import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';
-export declare type SearchParamsObject = BaseSearchParams & IndexSettingsAsSearchParams;
+import type { BaseSearchParams } from './baseSearchParams';
+import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';
+export type SearchParamsObject = BaseSearchParams & IndexSettingsAsSearchParams;
 //# sourceMappingURL=searchParamsObject.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"searchParamsObject.d.ts","sourceRoot":"","sources":["../../model/searchParamsObject.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAEjF,oBAAY,kBAAkB,GAAG,gBAAgB,GAAG,2BAA2B,CAAC"}
+{"version":3,"file":"searchParamsObject.d.ts","sourceRoot":"","sources":["../../model/searchParamsObject.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAEjF,MAAM,MAAM,kBAAkB,GAAG,gBAAgB,GAAG,2BAA2B,CAAC"}

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

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

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

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

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

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

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