algoliasearch 5.0.0-alpha.7 → 5.0.0-alpha.70

package/dist/{algoliasearch/lite → lite}/model/baseSearchResponse.d.ts

@@ -1,102 +1,104 @@
-import type { FacetsStats } from './facetsStats';
-import type { RenderingContent } from './renderingContent';
-export declare type BaseSearchResponse = {
-    /**
-     * If a search encounters an index that is being A/B tested, abTestID reports the ongoing A/B test ID.
-     */
-    abTestID?: number;
-    /**
-     * If a search encounters an index that is being A/B tested, abTestVariantID reports the variant ID of the index used (starting at 1).
-     */
-    abTestVariantID?: number;
-    /**
-     * The computed geo location.
-     */
-    aroundLatLng?: string;
-    /**
-     * The automatically computed radius. For legacy reasons, this parameter is a string and not an integer.
-     */
-    automaticRadius?: string;
-    /**
-     * Whether the facet count is exhaustive or approximate.
-     */
-    exhaustiveFacetsCount?: boolean;
-    /**
-     * Indicate if the nbHits count was exhaustive or approximate.
-     */
-    exhaustiveNbHits: boolean;
-    /**
-     * Indicate if the typo-tolerance search was exhaustive or approximate (only included when typo-tolerance is enabled).
-     */
-    exhaustiveTypo?: boolean;
-    /**
-     * A mapping of each facet name to the corresponding facet counts.
-     */
-    facets?: Record<string, Record<string, number>>;
-    /**
-     * Statistics for numerical facets.
-     */
-    facets_stats?: Record<string, FacetsStats>;
-    /**
-     * Set the number of hits per page.
-     */
-    hitsPerPage: number;
-    /**
-     * Index name used for the query.
-     */
-    index?: string;
-    /**
-     * Index name used for the query. In the case of an A/B test, the targeted index isn\'t always the index used by the query.
-     */
-    indexUsed?: string;
-    /**
-     * Used to return warnings about the query.
-     */
-    message?: string;
-    /**
-     * Number of hits that the search query matched.
-     */
-    nbHits: number;
-    /**
-     * Number of pages available for the current query.
-     */
-    nbPages: number;
-    /**
-     * The number of hits selected and sorted by the relevant sort algorithm.
-     */
-    nbSortedHits?: number;
-    /**
-     * Specify the page to retrieve.
-     */
-    page: number;
-    /**
-     * A url-encoded string of all search parameters.
-     */
-    params: string;
-    /**
-     * The query string that will be searched, after normalization.
-     */
-    parsedQuery?: string;
-    /**
-     * Time the server took to process the request, in milliseconds.
-     */
-    processingTimeMS: number;
-    /**
-     * The text to search in the index.
-     */
-    query: string;
-    /**
-     * A markup text indicating which parts of the original query have been removed in order to retrieve a non-empty result set.
-     */
-    queryAfterRemoval?: string;
-    /**
-     * Actual host name of the server that processed the request.
-     */
-    serverUsed?: string;
-    /**
-     * Lets you store custom data in your indices.
-     */
-    userData?: Record<string, any>;
-    renderingContent?: RenderingContent;
-};
+import type { BaseSearchResponseRedirect } from './baseSearchResponseRedirect';
+import type { FacetsStats } from './facetsStats';
+import type { RenderingContent } from './renderingContent';
+export type BaseSearchResponse = {
+    /**
+     * If a search encounters an index that is being A/B tested, abTestID reports the ongoing A/B test ID.
+     */
+    abTestID?: number;
+    /**
+     * If a search encounters an index that is being A/B tested, abTestVariantID reports the variant ID of the index used (starting at 1).
+     */
+    abTestVariantID?: number;
+    /**
+     * The computed geo location.
+     */
+    aroundLatLng?: string;
+    /**
+     * The automatically computed radius. For legacy reasons, this parameter is a string and not an integer.
+     */
+    automaticRadius?: string;
+    /**
+     * Whether the facet count is exhaustive or approximate.
+     */
+    exhaustiveFacetsCount?: boolean;
+    /**
+     * Indicate if the nbHits count was exhaustive or approximate.
+     */
+    exhaustiveNbHits: boolean;
+    /**
+     * Indicate if the typo-tolerance search was exhaustive or approximate (only included when typo-tolerance is enabled).
+     */
+    exhaustiveTypo?: boolean;
+    /**
+     * A mapping of each facet name to the corresponding facet counts.
+     */
+    facets?: Record<string, Record<string, number>>;
+    /**
+     * Statistics for numerical facets.
+     */
+    facets_stats?: Record<string, FacetsStats>;
+    /**
+     * Set the number of hits per page.
+     */
+    hitsPerPage: number;
+    /**
+     * Index name used for the query.
+     */
+    index?: string;
+    /**
+     * Index name used for the query. In the case of an A/B test, the targeted index isn\'t always the index used by the query.
+     */
+    indexUsed?: string;
+    /**
+     * Used to return warnings about the query.
+     */
+    message?: string;
+    /**
+     * Number of hits that the search query matched.
+     */
+    nbHits: number;
+    /**
+     * Number of pages available for the current query.
+     */
+    nbPages: number;
+    /**
+     * The number of hits selected and sorted by the relevant sort algorithm.
+     */
+    nbSortedHits?: number;
+    /**
+     * Specify the page to retrieve.
+     */
+    page: number;
+    /**
+     * A url-encoded string of all search parameters.
+     */
+    params: string;
+    redirect?: BaseSearchResponseRedirect;
+    /**
+     * The query string that will be searched, after normalization.
+     */
+    parsedQuery?: string;
+    /**
+     * Time the server took to process the request, in milliseconds.
+     */
+    processingTimeMS: number;
+    /**
+     * The text to search in the index.
+     */
+    query: string;
+    /**
+     * A markup text indicating which parts of the original query have been removed in order to retrieve a non-empty result set.
+     */
+    queryAfterRemoval?: string;
+    /**
+     * Actual host name of the server that processed the request.
+     */
+    serverUsed?: string;
+    /**
+     * Lets you store custom data in your indices.
+     */
+    userData?: Record<string, any>;
+    renderingContent?: RenderingContent;
+};
 //# sourceMappingURL=baseSearchResponse.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"baseSearchResponse.d.ts","sourceRoot":"","sources":["../../../lite/model/baseSearchResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAC/E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE3D,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAEhD;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAE3C;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf,QAAQ,CAAC,EAAE,0BAA0B,CAAC;IAEtC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE/B,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CACrC,CAAC"}

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

@@ -0,0 +1,8 @@
+import type { RedirectRuleIndexMetadata } from './redirectRuleIndexMetadata';
+/**
+ * This parameter is for internal use only.
+ */
+export type BaseSearchResponseRedirect = {
+    index?: RedirectRuleIndexMetadata[];
+};
+//# sourceMappingURL=baseSearchResponseRedirect.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"baseSearchResponseRedirect.d.ts","sourceRoot":"","sources":["../../../lite/model/baseSearchResponseRedirect.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAE7E;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC,KAAK,CAAC,EAAE,yBAAyB,EAAE,CAAC;CACrC,CAAC"}

package/dist/{algoliasearch/lite → lite}/model/browseParams.d.ts

@@ -1,4 +1,4 @@
-import type { BrowseParamsObject } from './browseParamsObject';
-import type { SearchParamsString } from './searchParamsString';
-export declare type BrowseParams = BrowseParamsObject | SearchParamsString;
+import type { BrowseParamsObject } from './browseParamsObject';
+import type { SearchParamsString } from './searchParamsString';
+export type BrowseParams = BrowseParamsObject | SearchParamsString;
 //# sourceMappingURL=browseParams.d.ts.map

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

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

@@ -0,0 +1,4 @@
+import type { Cursor } from './cursor';
+import type { SearchParamsObject } from './searchParamsObject';
+export type BrowseParamsObject = Cursor & SearchParamsObject;
+//# sourceMappingURL=browseParamsObject.d.ts.map

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

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

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

@@ -0,0 +1,5 @@
+import type { BaseSearchResponse } from './baseSearchResponse';
+import type { Cursor } from './cursor';
+import type { SearchHits } from './searchHits';
+export type BrowseResponse<T = Record<string, any>> = BaseSearchResponse & Cursor & SearchHits<T>;
+//# sourceMappingURL=browseResponse.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"browseResponse.d.ts","sourceRoot":"","sources":["../../../lite/model/browseResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,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,MAAM,GACN,UAAU,CAAC,CAAC,CAAC,CAAC"}

package/dist/{algoliasearch/lite → lite}/model/builtInOperation.d.ts

@@ -1,12 +1,12 @@
-import type { BuiltInOperationType } from './builtInOperationType';
-/**
- * To update an attribute without pushing the entire record, you can use these built-in operations.
- */
-export declare type BuiltInOperation = {
-    _operation: BuiltInOperationType;
-    /**
-     * The right-hand side argument to the operation, for example, increment or decrement step, value to add or remove.
-     */
-    value: string;
-};
+import type { BuiltInOperationType } from './builtInOperationType';
+/**
+ * To update an attribute without pushing the entire record, you can use these built-in operations.
+ */
+export type BuiltInOperation = {
+    _operation: BuiltInOperationType;
+    /**
+     * The right-hand side argument to the operation, for example, increment or decrement step, value to add or remove.
+     */
+    value: string;
+};
 //# sourceMappingURL=builtInOperation.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"builtInOperation.d.ts","sourceRoot":"","sources":["../../../lite/model/builtInOperation.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,UAAU,EAAE,oBAAoB,CAAC;IAEjC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC"}

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

@@ -0,0 +1,5 @@
+/**
+ * The operation to apply on the attribute.
+ */
+export type BuiltInOperationType = 'Add' | 'AddUnique' | 'Decrement' | 'Increment' | 'IncrementFrom' | 'IncrementSet' | 'Remove';
+//# sourceMappingURL=builtInOperationType.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"builtInOperationType.d.ts","sourceRoot":"","sources":["../../../lite/model/builtInOperationType.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAC5B,KAAK,GACL,WAAW,GACX,WAAW,GACX,WAAW,GACX,eAAe,GACf,cAAc,GACd,QAAQ,CAAC"}

package/dist/{algoliasearch/lite → lite}/model/clientMethodProps.d.ts

@@ -1,49 +1,49 @@
-import type { SearchForFacetsOptions } from './searchForFacetsOptions';
-import type { SearchForHitsOptions } from './searchForHitsOptions';
-import type { SearchParamsObject } from './searchParamsObject';
-/**
- * Properties for the `post` method.
- */
-export declare type PostProps = {
-    /**
-     * The path of the API endpoint to target, anything after the /1 needs to be specified.
-     */
-    path: string;
-    /**
-     * Query parameters to be applied to the current query.
-     */
-    parameters?: Record<string, any>;
-    /**
-     * The parameters to send with the custom request.
-     */
-    body?: Record<string, any>;
-};
-/**
- * In v4, the search parameters are wrapped in a `params` parameter.
- *
- * @deprecated The `search` method now accepts flat `searchParams` at the root of the method.
- */
-declare type LegacySearchParams = {
-    params?: SearchParamsObject;
-};
-/**
- * In v4, the search parameters are wrapped in a `params` parameter.
- *
- * @deprecated The `search` method now accepts flat `searchParams` at the root of the method.
- */
-declare type LegacySearchForFacets = LegacySearchParams & SearchForFacetsOptions;
-/**
- * In v4, the search parameters are wrapped in a `params` parameter.
- *
- * @deprecated The `search` method now accepts flat `searchParams` at the root of the method.
- */
-declare type LegacySearchForHits = LegacySearchParams & SearchForHitsOptions;
-declare type LegacySearchQuery = LegacySearchForFacets | LegacySearchForHits;
-/**
- * Search method signature compatible with the `algoliasearch` v4 package. When using this signature, extra computation will be required to make it match the new signature.
- *
- * @deprecated This signature will be removed from the next major version, we recommend using the `SearchMethodParams` type for performances and future proof reasons.
- */
-export declare type LegacySearchMethodProps = LegacySearchQuery[];
-export {};
+import type { SearchForFacetsOptions } from './searchForFacetsOptions';
+import type { SearchForHitsOptions } from './searchForHitsOptions';
+import type { SearchParamsObject } from './searchParamsObject';
+/**
+ * Properties for the `post` method.
+ */
+export type PostProps = {
+    /**
+     * The path of the API endpoint to target, anything after the /1 needs to be specified.
+     */
+    path: string;
+    /**
+     * Query parameters to be applied to the current query.
+     */
+    parameters?: Record<string, any>;
+    /**
+     * The parameters to send with the custom request.
+     */
+    body?: Record<string, any>;
+};
+/**
+ * In v4, the search parameters are wrapped in a `params` parameter.
+ *
+ * @deprecated The `search` method now accepts flat `searchParams` at the root of the method.
+ */
+type LegacySearchParams = {
+    params?: SearchParamsObject;
+};
+/**
+ * In v4, the search parameters are wrapped in a `params` parameter.
+ *
+ * @deprecated The `search` method now accepts flat `searchParams` at the root of the method.
+ */
+type LegacySearchForFacets = LegacySearchParams & SearchForFacetsOptions;
+/**
+ * In v4, the search parameters are wrapped in a `params` parameter.
+ *
+ * @deprecated The `search` method now accepts flat `searchParams` at the root of the method.
+ */
+type LegacySearchForHits = LegacySearchParams & SearchForHitsOptions;
+type LegacySearchQuery = LegacySearchForFacets | LegacySearchForHits;
+/**
+ * Search method signature compatible with the `algoliasearch` v4 package. When using this signature, extra computation will be required to make it match the new signature.
+ *
+ * @deprecated This signature will be removed from the next major version, we recommend using the `SearchMethodParams` type for performances and future proof reasons.
+ */
+export type LegacySearchMethodProps = LegacySearchQuery[];
+export {};
 //# sourceMappingURL=clientMethodProps.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"clientMethodProps.d.ts","sourceRoot":"","sources":["../../../lite/model/clientMethodProps.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC5B,CAAC;AAEF;;;;GAIG;AACH,KAAK,kBAAkB,GAAG;IACxB,MAAM,CAAC,EAAE,kBAAkB,CAAC;CAC7B,CAAC;AAEF;;;;GAIG;AACH,KAAK,qBAAqB,GAAG,kBAAkB,GAAG,sBAAsB,CAAC;AAEzE;;;;GAIG;AACH,KAAK,mBAAmB,GAAG,kBAAkB,GAAG,oBAAoB,CAAC;AAErE,KAAK,iBAAiB,GAAG,qBAAqB,GAAG,mBAAmB,CAAC;AAErE;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAAG,iBAAiB,EAAE,CAAC"}

package/dist/lite/{lite/model → model}/condition.d.ts

@@ -1,17 +1,17 @@
-import type { Anchoring } from './anchoring';
-export declare type Condition = {
-    /**
-     * Query pattern syntax.
-     */
-    pattern?: string;
-    anchoring?: Anchoring;
-    /**
-     * Whether the pattern matches on plurals, synonyms, and typos.
-     */
-    alternatives?: boolean;
-    /**
-     * Rule context format: [A-Za-z0-9_-]+).
-     */
-    context?: string;
-};
+import type { Anchoring } from './anchoring';
+export type Condition = {
+    /**
+     * Query pattern syntax.
+     */
+    pattern?: string;
+    anchoring?: Anchoring;
+    /**
+     * Whether the pattern matches on plurals, synonyms, and typos.
+     */
+    alternatives?: boolean;
+    /**
+     * Rule context format: [A-Za-z0-9_-]+).
+     */
+    context?: string;
+};
 //# sourceMappingURL=condition.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"condition.d.ts","sourceRoot":"","sources":["../../../lite/model/condition.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,MAAM,MAAM,SAAS,GAAG;IACtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC"}

package/dist/{algoliasearch/lite → lite}/model/consequence.d.ts

@@ -1,26 +1,26 @@
-import type { ConsequenceHide } from './consequenceHide';
-import type { ConsequenceParams } from './consequenceParams';
-import type { Promote } from './promote';
-/**
- * Consequence of the Rule.
- */
-export declare type Consequence = {
-    params?: ConsequenceParams;
-    /**
-     * Objects to promote as hits.
-     */
-    promote?: Promote[];
-    /**
-     * Only use in combination with the promote consequence. When true, promoted results will be restricted to match the filters of the current search. When false, the promoted results will show up regardless of the filters.
-     */
-    filterPromotes?: boolean;
-    /**
-     * Objects to hide from hits. Each object must contain an objectID field. By default, you can hide up to 50 items per rule.
-     */
-    hide?: ConsequenceHide[];
-    /**
-     * Custom JSON object that will be appended to the userData array in the response. This object isn\'t interpreted by the API. It\'s limited to 1kB of minified JSON.
-     */
-    userData?: Record<string, any>;
-};
+import type { ConsequenceHide } from './consequenceHide';
+import type { ConsequenceParams } from './consequenceParams';
+import type { Promote } from './promote';
+/**
+ * Consequence of the Rule.
+ */
+export type Consequence = {
+    params?: ConsequenceParams;
+    /**
+     * Objects to promote as hits.
+     */
+    promote?: Promote[];
+    /**
+     * Only use in combination with the promote consequence. When true, promoted results will be restricted to match the filters of the current search. When false, the promoted results will show up regardless of the filters.
+     */
+    filterPromotes?: boolean;
+    /**
+     * Objects to hide from hits. Each object must contain an objectID field. By default, you can hide up to 50 items per rule.
+     */
+    hide?: ConsequenceHide[];
+    /**
+     * Custom JSON object that will be appended to the userData array in the response. This object isn\'t interpreted by the API. It\'s limited to 1kB of minified JSON.
+     */
+    userData?: Record<string, any>;
+};
 //# sourceMappingURL=consequence.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"consequence.d.ts","sourceRoot":"","sources":["../../../lite/model/consequence.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,MAAM,CAAC,EAAE,iBAAiB,CAAC;IAE3B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,EAAE,CAAC;IAEpB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,IAAI,CAAC,EAAE,eAAe,EAAE,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAChC,CAAC"}

package/dist/lite/{lite/model → model}/consequenceHide.d.ts

@@ -1,10 +1,10 @@
-/**
- * Unique identifier of the object to hide.
- */
-export declare type ConsequenceHide = {
-    /**
-     * Unique identifier of the object.
-     */
-    objectID: string;
-};
+/**
+ * Unique identifier of the object to hide.
+ */
+export type ConsequenceHide = {
+    /**
+     * Unique identifier of the object.
+     */
+    objectID: string;
+};
 //# sourceMappingURL=consequenceHide.d.ts.map

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

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

package/dist/{algoliasearch/lite → lite}/model/consequenceParams.d.ts

@@ -1,5 +1,5 @@
-import type { BaseSearchParamsWithoutQuery } from './baseSearchParamsWithoutQuery';
-import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';
-import type { Params } from './params';
-export declare type ConsequenceParams = BaseSearchParamsWithoutQuery & IndexSettingsAsSearchParams & Params;
+import type { BaseSearchParamsWithoutQuery } from './baseSearchParamsWithoutQuery';
+import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';
+import type { Params } from './params';
+export type ConsequenceParams = BaseSearchParamsWithoutQuery & IndexSettingsAsSearchParams & Params;
 //# sourceMappingURL=consequenceParams.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"consequenceParams.d.ts","sourceRoot":"","sources":["../../../lite/model/consequenceParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,gCAAgC,CAAC;AACnF,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AACjF,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAEvC,MAAM,MAAM,iBAAiB,GAAG,4BAA4B,GAC1D,2BAA2B,GAC3B,MAAM,CAAC"}

package/dist/{algoliasearch/lite → lite}/model/consequenceQuery.d.ts

@@ -1,6 +1,6 @@
-import type { ConsequenceQueryObject } from './consequenceQueryObject';
-/**
- * When providing a string, it replaces the entire query string. When providing an object, it describes incremental edits to be made to the query string (but you can\'t do both).
- */
-export declare type ConsequenceQuery = ConsequenceQueryObject | string;
+import type { ConsequenceQueryObject } from './consequenceQueryObject';
+/**
+ * When providing a string, it replaces the entire query string. When providing an object, it describes incremental edits to be made to the query string (but you can\'t do both).
+ */
+export type ConsequenceQuery = ConsequenceQueryObject | string;
 //# sourceMappingURL=consequenceQuery.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"consequenceQuery.d.ts","sourceRoot":"","sources":["../../../lite/model/consequenceQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAEvE;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,sBAAsB,GAAG,MAAM,CAAC"}

package/dist/{algoliasearch/lite → lite}/model/consequenceQueryObject.d.ts

@@ -1,12 +1,12 @@
-import type { Edit } from './edit';
-export declare type ConsequenceQueryObject = {
-    /**
-     * Words to remove.
-     */
-    remove?: string[];
-    /**
-     * Edits to apply.
-     */
-    edits?: Edit[];
-};
+import type { Edit } from './edit';
+export type ConsequenceQueryObject = {
+    /**
+     * Words to remove.
+     */
+    remove?: string[];
+    /**
+     * Edits to apply.
+     */
+    edits?: Edit[];
+};
 //# sourceMappingURL=consequenceQueryObject.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"consequenceQueryObject.d.ts","sourceRoot":"","sources":["../../../lite/model/consequenceQueryObject.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAEnC,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC;CAChB,CAAC"}

package/dist/lite/{lite/model → model}/cursor.d.ts

@@ -1,7 +1,7 @@
-export declare type Cursor = {
-    /**
-     * Cursor indicating the location to resume browsing from. Must match the value returned by the previous call.
-     */
-    cursor?: string;
-};
+export type Cursor = {
+    /**
+     * Cursor indicating the location to resume browsing from. Must match the value returned by the previous call.
+     */
+    cursor?: string;
+};
 //# sourceMappingURL=cursor.d.ts.map

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

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

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

@@ -0,0 +1,27 @@
+import type { AroundRadius } from './aroundRadius';
+import type { FacetFilters } from './facetFilters';
+import type { NumericFilters } from './numericFilters';
+import type { TagFilters } from './tagFilters';
+export type DeleteByParams = {
+    facetFilters?: FacetFilters;
+    /**
+     * Filter the query with numeric, facet and/or tag filters.
+     */
+    filters?: string;
+    numericFilters?: NumericFilters;
+    tagFilters?: TagFilters;
+    /**
+     * Search for entries around a central geolocation, enabling a geo search within a circular area.
+     */
+    aroundLatLng?: string;
+    aroundRadius?: AroundRadius;
+    /**
+     * Search inside a rectangular area (in geo coordinates).
+     */
+    insideBoundingBox?: number[];
+    /**
+     * Search inside a polygon (in geo coordinates).
+     */
+    insidePolygon?: number[];
+};
+//# sourceMappingURL=deleteByParams.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"deleteByParams.d.ts","sourceRoot":"","sources":["../../../lite/model/deleteByParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,MAAM,MAAM,cAAc,GAAG;IAC3B,YAAY,CAAC,EAAE,YAAY,CAAC;IAE5B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,cAAc,CAAC,EAAE,cAAc,CAAC;IAEhC,UAAU,CAAC,EAAE,UAAU,CAAC;IAExB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,YAAY,CAAC,EAAE,YAAY,CAAC;IAE5B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE7B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;CAC1B,CAAC"}