algoliasearch 5.0.0-alpha.53 → 5.0.0-alpha.54

package/dist/client-search/model/baseSearchResponse.d.ts

@@ -1,102 +1,102 @@
-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;
-    /**
-     * 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 { 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;
+    /**
+     * 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/client-search/model/batchAssignUserIdsParams.d.ts

@@ -1,14 +1,14 @@
-/**
- * Assign userID parameters.
- */
-export type BatchAssignUserIdsParams = {
-    /**
-     * Name of the cluster.
-     */
-    cluster: string;
-    /**
-     * UserIDs to assign. Note you cannot move users with this method.
-     */
-    users: string[];
-};
+/**
+ * Assign userID parameters.
+ */
+export type BatchAssignUserIdsParams = {
+    /**
+     * Name of the cluster.
+     */
+    cluster: string;
+    /**
+     * UserIDs to assign. Note you cannot move users with this method.
+     */
+    users: string[];
+};
 //# sourceMappingURL=batchAssignUserIdsParams.d.ts.map

package/dist/client-search/model/batchDictionaryEntriesParams.d.ts

@@ -1,15 +1,15 @@
-import type { BatchDictionaryEntriesRequest } from './batchDictionaryEntriesRequest';
-/**
- * The `batchDictionaryEntries` parameters.
- */
-export type BatchDictionaryEntriesParams = {
-    /**
-     * When `true`, start the batch by removing all the custom entries from the dictionary.
-     */
-    clearExistingDictionaryEntries?: boolean;
-    /**
-     * List of operations to batch. Each operation is described by an `action` and a `body`.
-     */
-    requests: BatchDictionaryEntriesRequest[];
-};
+import type { BatchDictionaryEntriesRequest } from './batchDictionaryEntriesRequest';
+/**
+ * The `batchDictionaryEntries` parameters.
+ */
+export type BatchDictionaryEntriesParams = {
+    /**
+     * When `true`, start the batch by removing all the custom entries from the dictionary.
+     */
+    clearExistingDictionaryEntries?: boolean;
+    /**
+     * List of operations to batch. Each operation is described by an `action` and a `body`.
+     */
+    requests: BatchDictionaryEntriesRequest[];
+};
 //# sourceMappingURL=batchDictionaryEntriesParams.d.ts.map

package/dist/client-search/model/batchDictionaryEntriesRequest.d.ts

@@ -1,7 +1,7 @@
-import type { DictionaryAction } from './dictionaryAction';
-import type { DictionaryEntry } from './dictionaryEntry';
-export type BatchDictionaryEntriesRequest = {
-    action: DictionaryAction;
-    body: DictionaryEntry;
-};
+import type { DictionaryAction } from './dictionaryAction';
+import type { DictionaryEntry } from './dictionaryEntry';
+export type BatchDictionaryEntriesRequest = {
+    action: DictionaryAction;
+    body: DictionaryEntry;
+};
 //# sourceMappingURL=batchDictionaryEntriesRequest.d.ts.map

package/dist/client-search/model/batchParams.d.ts

@@ -1,8 +1,8 @@
-import type { MultipleBatchRequest } from './multipleBatchRequest';
-/**
- * The `multipleBatch` parameters.
- */
-export type BatchParams = {
-    requests: MultipleBatchRequest[];
-};
+import type { MultipleBatchRequest } from './multipleBatchRequest';
+/**
+ * The `multipleBatch` parameters.
+ */
+export type BatchParams = {
+    requests: MultipleBatchRequest[];
+};
 //# sourceMappingURL=batchParams.d.ts.map

package/dist/client-search/model/batchRequest.d.ts

@@ -1,9 +1,9 @@
-import type { Action } from './action';
-export type BatchRequest = {
-    action: Action;
-    /**
-     * Arguments to the operation (depends on the type of the operation).
-     */
-    body: Record<string, any>;
-};
+import type { Action } from './action';
+export type BatchRequest = {
+    action: Action;
+    /**
+     * Arguments to the operation (depends on the type of the operation).
+     */
+    body: Record<string, any>;
+};
 //# sourceMappingURL=batchRequest.d.ts.map

package/dist/client-search/model/batchResponse.d.ts

@@ -1,11 +1,11 @@
-export type BatchResponse = {
-    /**
-     * TaskID of the task to wait for.
-     */
-    taskID: number;
-    /**
-     * List of objectID.
-     */
-    objectIDs: string[];
-};
+export type BatchResponse = {
+    /**
+     * TaskID of the task to wait for.
+     */
+    taskID: number;
+    /**
+     * List of objectID.
+     */
+    objectIDs: string[];
+};
 //# sourceMappingURL=batchResponse.d.ts.map

package/dist/client-search/model/batchWriteParams.d.ts

@@ -1,8 +1,8 @@
-import type { BatchRequest } from './batchRequest';
-/**
- * The `batch` parameters.
- */
-export type BatchWriteParams = {
-    requests: BatchRequest[];
-};
+import type { BatchRequest } from './batchRequest';
+/**
+ * The `batch` parameters.
+ */
+export type BatchWriteParams = {
+    requests: BatchRequest[];
+};
 //# sourceMappingURL=batchWriteParams.d.ts.map

package/dist/client-search/model/browseParams.d.ts

@@ -1,4 +1,4 @@
-import type { BrowseParamsObject } from './browseParamsObject';
-import type { SearchParamsString } from './searchParamsString';
-export 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/client-search/model/browseParamsObject.d.ts

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

package/dist/client-search/model/browseResponse.d.ts

@@ -1,5 +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>;
+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/client-search/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 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/client-search/model/builtInOperationType.d.ts

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