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

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

@@ -1,8 +1,8 @@
-import type { GetApiKeyResponse } from './getApiKeyResponse';
-export type ListApiKeysResponse = {
-    /**
-     * List of api keys.
-     */
-    keys: GetApiKeyResponse[];
-};
+import type { GetApiKeyResponse } from './getApiKeyResponse';
+export type ListApiKeysResponse = {
+    /**
+     * List of api keys.
+     */
+    keys: GetApiKeyResponse[];
+};
 //# sourceMappingURL=listApiKeysResponse.d.ts.map

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

@@ -1,10 +1,10 @@
-/**
- * Array of clusters.
- */
-export type ListClustersResponse = {
-    /**
-     * Mapping of cluster names to top users.
-     */
-    topUsers: string[];
-};
+/**
+ * Array of clusters.
+ */
+export type ListClustersResponse = {
+    /**
+     * Mapping of cluster names to top users.
+     */
+    topUsers: string[];
+};
 //# sourceMappingURL=listClustersResponse.d.ts.map

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

@@ -1,12 +1,12 @@
-import type { FetchedIndex } from './fetchedIndex';
-export type ListIndicesResponse = {
-    /**
-     * List of the fetched indices.
-     */
-    items: FetchedIndex[];
-    /**
-     * Number of pages.
-     */
-    nbPages?: number;
-};
+import type { FetchedIndex } from './fetchedIndex';
+export type ListIndicesResponse = {
+    /**
+     * List of the fetched indices.
+     */
+    items: FetchedIndex[];
+    /**
+     * Number of pages.
+     */
+    nbPages?: number;
+};
 //# sourceMappingURL=listIndicesResponse.d.ts.map

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

@@ -1,11 +1,11 @@
-import type { UserId } from './userId';
-/**
- * UserIDs data.
- */
-export type ListUserIdsResponse = {
-    /**
-     * List of userIDs.
-     */
-    userIDs: UserId[];
-};
+import type { UserId } from './userId';
+/**
+ * UserIDs data.
+ */
+export type ListUserIdsResponse = {
+    /**
+     * List of userIDs.
+     */
+    userIDs: UserId[];
+};
 //# sourceMappingURL=listUserIdsResponse.d.ts.map

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

@@ -1,64 +1,64 @@
-import type { LogQuery } from './logQuery';
-export type Log = {
-    /**
-     * Timestamp in ISO-8601 format.
-     */
-    timestamp: string;
-    /**
-     * HTTP method of the performed request.
-     */
-    method: string;
-    /**
-     * HTTP response code.
-     */
-    answer_code: string;
-    /**
-     * Request body. Truncated after 1000 characters.
-     */
-    query_body: string;
-    /**
-     * Answer body. Truncated after 1000 characters.
-     */
-    answer: string;
-    /**
-     * Request URL.
-     */
-    url: string;
-    /**
-     * IP of the client which performed the request.
-     */
-    ip: string;
-    /**
-     * Request Headers (API Key is obfuscated).
-     */
-    query_headers: string;
-    /**
-     * SHA1 signature of the log entry.
-     */
-    sha1: string;
-    /**
-     * Number of API calls.
-     */
-    nb_api_calls: string;
-    /**
-     * Processing time for the query. It doesn\'t include network time.
-     */
-    processing_time_ms: string;
-    /**
-     * Index targeted by the query.
-     */
-    index?: string;
-    /**
-     * Query parameters sent with the request.
-     */
-    query_params?: string;
-    /**
-     * Number of hits returned for the query.
-     */
-    query_nb_hits?: string;
-    /**
-     * Array of all performed queries for the given request.
-     */
-    inner_queries?: LogQuery[];
-};
+import type { LogQuery } from './logQuery';
+export type Log = {
+    /**
+     * Timestamp in ISO-8601 format.
+     */
+    timestamp: string;
+    /**
+     * HTTP method of the performed request.
+     */
+    method: string;
+    /**
+     * HTTP response code.
+     */
+    answer_code: string;
+    /**
+     * Request body. Truncated after 1000 characters.
+     */
+    query_body: string;
+    /**
+     * Answer body. Truncated after 1000 characters.
+     */
+    answer: string;
+    /**
+     * Request URL.
+     */
+    url: string;
+    /**
+     * IP of the client which performed the request.
+     */
+    ip: string;
+    /**
+     * Request Headers (API Key is obfuscated).
+     */
+    query_headers: string;
+    /**
+     * SHA1 signature of the log entry.
+     */
+    sha1: string;
+    /**
+     * Number of API calls.
+     */
+    nb_api_calls: string;
+    /**
+     * Processing time for the query. It doesn\'t include network time.
+     */
+    processing_time_ms: string;
+    /**
+     * Index targeted by the query.
+     */
+    index?: string;
+    /**
+     * Query parameters sent with the request.
+     */
+    query_params?: string;
+    /**
+     * Number of hits returned for the query.
+     */
+    query_nb_hits?: string;
+    /**
+     * Array of all performed queries for the given request.
+     */
+    inner_queries?: LogQuery[];
+};
 //# sourceMappingURL=log.d.ts.map

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

@@ -1,15 +1,15 @@
-export type LogQuery = {
-    /**
-     * Index targeted by the query.
-     */
-    index_name?: string;
-    /**
-     * User identifier.
-     */
-    user_token?: string;
-    /**
-     * QueryID for the given query.
-     */
-    query_id?: string;
-};
+export type LogQuery = {
+    /**
+     * Index targeted by the query.
+     */
+    index_name?: string;
+    /**
+     * User identifier.
+     */
+    user_token?: string;
+    /**
+     * QueryID for the given query.
+     */
+    query_id?: string;
+};
 //# sourceMappingURL=logQuery.d.ts.map

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

@@ -1,2 +1,2 @@
-export type LogType = 'all' | 'build' | 'error' | 'query';
+export type LogType = 'all' | 'build' | 'error' | 'query';
 //# sourceMappingURL=logType.d.ts.map

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

@@ -1,5 +1,5 @@
-/**
- * Indicates how well the attribute matched the search query.
- */
-export type MatchLevel = 'full' | 'none' | 'partial';
+/**
+ * Indicates how well the attribute matched the search query.
+ */
+export type MatchLevel = 'full' | 'none' | 'partial';
 //# sourceMappingURL=matchLevel.d.ts.map

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

@@ -1,15 +1,15 @@
-export type MatchedGeoLocation = {
-    /**
-     * Latitude of the matched location.
-     */
-    lat?: number;
-    /**
-     * Longitude of the matched location.
-     */
-    lng?: number;
-    /**
-     * Distance between the matched location and the search location (in meters).
-     */
-    distance?: number;
-};
+export type MatchedGeoLocation = {
+    /**
+     * Latitude of the matched location.
+     */
+    lat?: number;
+    /**
+     * Longitude of the matched location.
+     */
+    lng?: number;
+    /**
+     * Distance between the matched location and the search location (in meters).
+     */
+    distance?: number;
+};
 //# sourceMappingURL=matchedGeoLocation.d.ts.map

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

@@ -1,2 +1,2 @@
-export type MixedSearchFilters = string[] | string;
+export type MixedSearchFilters = string[] | string;
 //# sourceMappingURL=mixedSearchFilters.d.ts.map

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

@@ -1,13 +1,13 @@
-import type { Action } from './action';
-export type MultipleBatchRequest = {
-    action: Action;
-    /**
-     * Arguments to the operation (depends on the type of the operation).
-     */
-    body: Record<string, any>;
-    /**
-     * Index to target for this operation.
-     */
-    indexName: string;
-};
+import type { Action } from './action';
+export type MultipleBatchRequest = {
+    action: Action;
+    /**
+     * Arguments to the operation (depends on the type of the operation).
+     */
+    body: Record<string, any>;
+    /**
+     * Index to target for this operation.
+     */
+    indexName: string;
+};
 //# sourceMappingURL=multipleBatchRequest.d.ts.map

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

@@ -1,11 +1,11 @@
-export type MultipleBatchResponse = {
-    /**
-     * List of tasksIDs per index.
-     */
-    taskID: Record<string, number>;
-    /**
-     * List of objectID.
-     */
-    objectIDs: string[];
-};
+export type MultipleBatchResponse = {
+    /**
+     * List of tasksIDs per index.
+     */
+    taskID: Record<string, number>;
+    /**
+     * List of objectID.
+     */
+    objectIDs: string[];
+};
 //# sourceMappingURL=multipleBatchResponse.d.ts.map

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

@@ -1,6 +1,6 @@
-import type { MixedSearchFilters } from './mixedSearchFilters';
-/**
- * Filter on numeric attributes.
- */
-export type NumericFilters = MixedSearchFilters[] | string;
+import type { MixedSearchFilters } from './mixedSearchFilters';
+/**
+ * Filter on numeric attributes.
+ */
+export type NumericFilters = MixedSearchFilters[] | string;
 //# sourceMappingURL=numericFilters.d.ts.map

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

@@ -1,14 +1,14 @@
-import type { OperationType } from './operationType';
-import type { ScopeType } from './scopeType';
-export type OperationIndexParams = {
-    operation: OperationType;
-    /**
-     * The Algolia index name.
-     */
-    destination: string;
-    /**
-     * Scope of the data to copy. When absent, a full copy is performed. When present, only the selected scopes are copied.
-     */
-    scope?: ScopeType[];
-};
+import type { OperationType } from './operationType';
+import type { ScopeType } from './scopeType';
+export type OperationIndexParams = {
+    operation: OperationType;
+    /**
+     * The Algolia index name.
+     */
+    destination: string;
+    /**
+     * Scope of the data to copy. When absent, a full copy is performed. When present, only the selected scopes are copied.
+     */
+    scope?: ScopeType[];
+};
 //# sourceMappingURL=operationIndexParams.d.ts.map

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

@@ -1,5 +1,5 @@
-/**
- * Type of operation to perform (move or copy).
- */
-export type OperationType = 'copy' | 'move';
+/**
+ * Type of operation to perform (move or copy).
+ */
+export type OperationType = 'copy' | 'move';
 //# sourceMappingURL=operationType.d.ts.map

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

@@ -1,6 +1,6 @@
-import type { MixedSearchFilters } from './mixedSearchFilters';
-/**
- * Create filters for ranking purposes, where records that match the filter are ranked higher, or lower in the case of a negative optional filter.
- */
-export type OptionalFilters = MixedSearchFilters[] | string;
+import type { MixedSearchFilters } from './mixedSearchFilters';
+/**
+ * Create filters for ranking purposes, where records that match the filter are ranked higher, or lower in the case of a negative optional filter.
+ */
+export type OptionalFilters = MixedSearchFilters[] | string;
 //# sourceMappingURL=optionalFilters.d.ts.map

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

@@ -1,13 +1,13 @@
-import type { AutomaticFacetFilters } from './automaticFacetFilters';
-import type { ConsequenceQuery } from './consequenceQuery';
-import type { RenderingContent } from './renderingContent';
-/**
- * Additional search parameters. Any valid search parameter is allowed.
- */
-export type Params = {
-    query?: ConsequenceQuery;
-    automaticFacetFilters?: AutomaticFacetFilters;
-    automaticOptionalFacetFilters?: AutomaticFacetFilters;
-    renderingContent?: RenderingContent;
-};
+import type { AutomaticFacetFilters } from './automaticFacetFilters';
+import type { ConsequenceQuery } from './consequenceQuery';
+import type { RenderingContent } from './renderingContent';
+/**
+ * Additional search parameters. Any valid search parameter is allowed.
+ */
+export type Params = {
+    query?: ConsequenceQuery;
+    automaticFacetFilters?: AutomaticFacetFilters;
+    automaticOptionalFacetFilters?: AutomaticFacetFilters;
+    renderingContent?: RenderingContent;
+};
 //# sourceMappingURL=params.d.ts.map

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

@@ -1,15 +1,15 @@
-export type Personalization = {
-    /**
-     * The score of the filters.
-     */
-    filtersScore?: number;
-    /**
-     * The score of the ranking.
-     */
-    rankingScore?: number;
-    /**
-     * The score of the event.
-     */
-    score?: number;
-};
+export type Personalization = {
+    /**
+     * The score of the filters.
+     */
+    filtersScore?: number;
+    /**
+     * The score of the ranking.
+     */
+    rankingScore?: number;
+    /**
+     * The score of the event.
+     */
+    score?: number;
+};
 //# sourceMappingURL=personalization.d.ts.map

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

@@ -1,4 +1,4 @@
-import type { PromoteObjectID } from './promoteObjectID';
-import type { PromoteObjectIDs } from './promoteObjectIDs';
-export type Promote = PromoteObjectID | PromoteObjectIDs;
+import type { PromoteObjectID } from './promoteObjectID';
+import type { PromoteObjectIDs } from './promoteObjectIDs';
+export type Promote = PromoteObjectID | PromoteObjectIDs;
 //# sourceMappingURL=promote.d.ts.map

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

@@ -1,14 +1,14 @@
-/**
- * Single objectID to promote as hits.
- */
-export type PromoteObjectID = {
-    /**
-     * Unique identifier of the object to promote.
-     */
-    objectID: string;
-    /**
-     * The position to promote the objects to (zero-based). If you pass objectIDs, the objects are placed at this position as a group. For example, if you pass four objectIDs to position 0, the objects take the first four positions.
-     */
-    position: number;
-};
+/**
+ * Single objectID to promote as hits.
+ */
+export type PromoteObjectID = {
+    /**
+     * Unique identifier of the object to promote.
+     */
+    objectID: string;
+    /**
+     * The position to promote the objects to (zero-based). If you pass objectIDs, the objects are placed at this position as a group. For example, if you pass four objectIDs to position 0, the objects take the first four positions.
+     */
+    position: number;
+};
 //# sourceMappingURL=promoteObjectID.d.ts.map

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

@@ -1,14 +1,14 @@
-/**
- * Multiple objectIDs to promote as hits.
- */
-export type PromoteObjectIDs = {
-    /**
-     * Array of unique identifiers of the objects to promote.
-     */
-    objectIDs: string[];
-    /**
-     * The position to promote the objects to (zero-based). If you pass objectIDs, the objects are placed at this position as a group. For example, if you pass four objectIDs to position 0, the objects take the first four positions.
-     */
-    position: number;
-};
+/**
+ * Multiple objectIDs to promote as hits.
+ */
+export type PromoteObjectIDs = {
+    /**
+     * Array of unique identifiers of the objects to promote.
+     */
+    objectIDs: string[];
+    /**
+     * The position to promote the objects to (zero-based). If you pass objectIDs, the objects are placed at this position as a group. For example, if you pass four objectIDs to position 0, the objects take the first four positions.
+     */
+    position: number;
+};
 //# sourceMappingURL=promoteObjectIDs.d.ts.map

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

@@ -1,5 +1,5 @@
-/**
- * Controls if and how query words are interpreted as prefixes.
- */
-export type QueryType = 'prefixAll' | 'prefixLast' | 'prefixNone';
+/**
+ * Controls if and how query words are interpreted as prefixes.
+ */
+export type QueryType = 'prefixAll' | 'prefixLast' | 'prefixNone';
 //# sourceMappingURL=queryType.d.ts.map

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

@@ -1,51 +1,51 @@
-import type { MatchedGeoLocation } from './matchedGeoLocation';
-import type { Personalization } from './personalization';
-export type RankingInfo = {
-    /**
-     * This field is reserved for advanced usage.
-     */
-    filters: number;
-    /**
-     * Position of the most important matched attribute in the attributes to index list.
-     */
-    firstMatchedWord: number;
-    /**
-     * Distance between the geo location in the search query and the best matching geo location in the record, divided by the geo precision (in meters).
-     */
-    geoDistance: number;
-    /**
-     * Precision used when computing the geo distance, in meters.
-     */
-    geoPrecision?: number;
-    matchedGeoLocation?: MatchedGeoLocation;
-    personalization?: Personalization;
-    /**
-     * Number of exactly matched words.
-     */
-    nbExactWords: number;
-    /**
-     * Number of typos encountered when matching the record.
-     */
-    nbTypos: number;
-    /**
-     * Present and set to true if a Rule promoted the hit.
-     */
-    promoted: boolean;
-    /**
-     * When the query contains more than one word, the sum of the distances between matched words (in meters).
-     */
-    proximityDistance?: number;
-    /**
-     * Custom ranking for the object, expressed as a single integer value.
-     */
-    userScore: number;
-    /**
-     * Number of matched words, including prefixes and typos.
-     */
-    words: number;
-    /**
-     * Wether the record are promoted by the re-ranking strategy.
-     */
-    promotedByReRanking?: boolean;
-};
+import type { MatchedGeoLocation } from './matchedGeoLocation';
+import type { Personalization } from './personalization';
+export type RankingInfo = {
+    /**
+     * This field is reserved for advanced usage.
+     */
+    filters: number;
+    /**
+     * Position of the most important matched attribute in the attributes to index list.
+     */
+    firstMatchedWord: number;
+    /**
+     * Distance between the geo location in the search query and the best matching geo location in the record, divided by the geo precision (in meters).
+     */
+    geoDistance: number;
+    /**
+     * Precision used when computing the geo distance, in meters.
+     */
+    geoPrecision?: number;
+    matchedGeoLocation?: MatchedGeoLocation;
+    personalization?: Personalization;
+    /**
+     * Number of exactly matched words.
+     */
+    nbExactWords: number;
+    /**
+     * Number of typos encountered when matching the record.
+     */
+    nbTypos: number;
+    /**
+     * Present and set to true if a Rule promoted the hit.
+     */
+    promoted: boolean;
+    /**
+     * When the query contains more than one word, the sum of the distances between matched words (in meters).
+     */
+    proximityDistance?: number;
+    /**
+     * Custom ranking for the object, expressed as a single integer value.
+     */
+    userScore: number;
+    /**
+     * Number of matched words, including prefixes and typos.
+     */
+    words: number;
+    /**
+     * Wether the record are promoted by the re-ranking strategy.
+     */
+    promotedByReRanking?: boolean;
+};
 //# sourceMappingURL=rankingInfo.d.ts.map

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

@@ -1,6 +1,6 @@
-import type { MixedSearchFilters } from './mixedSearchFilters';
-/**
- * When Dynamic Re-Ranking is enabled, only records that match these filters will be impacted by Dynamic Re-Ranking.
- */
-export type ReRankingApplyFilter = MixedSearchFilters[] | string;
+import type { MixedSearchFilters } from './mixedSearchFilters';
+/**
+ * When Dynamic Re-Ranking is enabled, only records that match these filters will be impacted by Dynamic Re-Ranking.
+ */
+export type ReRankingApplyFilter = MixedSearchFilters[] | string;
 //# sourceMappingURL=reRankingApplyFilter.d.ts.map