@algolia/client-search 5.0.0-alpha.4 → 5.0.0-alpha.41

package/dist/src/searchClient.d.ts

@@ -45,7 +45,7 @@ import type { UpdatedAtResponse } from '../model/updatedAtResponse';
 import type { UpdatedAtWithObjectIdResponse } from '../model/updatedAtWithObjectIdResponse';
 import type { UpdatedRuleResponse } from '../model/updatedRuleResponse';
 import type { UserId } from '../model/userId';
-export declare const apiClientVersion = "5.0.0-alpha.4";
+export declare const apiClientVersion = "5.0.0-alpha.41";
 export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
     transporter: import("@algolia/client-common").Transporter;
     /**
@@ -98,12 +98,12 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
      * @summary Helper method that iterates on the `browse` method.
      * @param browseObjects - The browseObjects object.
      * @param browseObjects.indexName - The index in which to perform the request.
-     * @param browseObjects.browseRequest - The `browse` method parameters.
-     * @param browseObjects.validate - The validator function. It receive the resolved return of the API call.
+     * @param browseObjects.browseParams - The `browse` parameters.
+     * @param browseObjects.validate - The validator function. It receive the resolved return of the API call. By default, stops when there is no `cursor` in the response.
      * @param browseObjects.aggregator - The function that runs right after the API call has been resolved, allows you to do anything with the response before `validate`.
      * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `browse` method and merged with the transporter requestOptions.
      */
-    browseObjects<T>({ indexName, browseRequest, ...browseObjectsOptions }: Partial<Pick<import("@algolia/client-common").CreateIterablePromise<BrowseResponse<T>>, "validate">> & Required<Pick<import("@algolia/client-common").CreateIterablePromise<BrowseResponse<T>>, "aggregator">> & BrowseProps, requestOptions?: RequestOptions): Promise<BrowseResponse<T>>;
+    browseObjects<T>({ indexName, browseParams, ...browseObjectsOptions }: Partial<Pick<import("@algolia/client-common").CreateIterablePromise<BrowseResponse<T>>, "validate">> & Required<Pick<import("@algolia/client-common").CreateIterablePromise<BrowseResponse<T>>, "aggregator">> & BrowseProps, requestOptions?: RequestOptions): Promise<BrowseResponse<T>>;
     /**
      * Helper: Iterate on the `searchRules` method of the client to allow aggregating rules of an index.
      *
@@ -111,7 +111,7 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
      * @param browseObjects - The browseObjects object.
      * @param browseObjects.indexName - The index in which to perform the request.
      * @param browseObjects.searchRulesParams - The `searchRules` method parameters.
-     * @param browseObjects.validate - The validator function. It receive the resolved return of the API call.
+     * @param browseObjects.validate - The validator function. It receive the resolved return of the API call. By default, stops when there is less hits returned than the number of maximum hits (1000).
      * @param browseObjects.aggregator - The function that runs right after the API call has been resolved, allows you to do anything with the response before `validate`.
      * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `searchRules` method and merged with the transporter requestOptions.
      */
@@ -122,7 +122,7 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
      * @summary Helper method that iterates on the `searchSynonyms` method.
      * @param browseObjects - The browseObjects object.
      * @param browseObjects.indexName - The index in which to perform the request.
-     * @param browseObjects.validate - The validator function. It receive the resolved return of the API call.
+     * @param browseObjects.validate - The validator function. It receive the resolved return of the API call. By default, stops when there is less hits returned than the number of maximum hits (1000).
      * @param browseObjects.aggregator - The function that runs right after the API call has been resolved, allows you to do anything with the response before `validate`.
      * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `searchSynonyms` method and merged with the transporter requestOptions.
      */
@@ -200,10 +200,10 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
      * @summary Retrieve all index content.
      * @param browse - The browse object.
      * @param browse.indexName - The index in which to perform the request.
-     * @param browse.browseRequest - The browseRequest object.
+     * @param browse.browseParams - The browseParams object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    browse<T_1>({ indexName, browseRequest }: BrowseProps, requestOptions?: RequestOptions): Promise<BrowseResponse<T_1>>;
+    browse<T_1>({ indexName, browseParams }: BrowseProps, requestOptions?: RequestOptions): Promise<BrowseResponse<T_1>>;
     /**
      * Remove all synonyms from an index.
      *
@@ -258,10 +258,10 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
      * @summary Delete all records matching the query.
      * @param deleteBy - The deleteBy object.
      * @param deleteBy.indexName - The index in which to perform the request.
-     * @param deleteBy.searchParams - The searchParams object.
+     * @param deleteBy.deleteByParams - The deleteByParams object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    deleteBy({ indexName, searchParams }: DeleteByProps, requestOptions?: RequestOptions): Promise<DeletedAtResponse>;
+    deleteBy({ indexName, deleteByParams }: DeleteByProps, requestOptions?: RequestOptions): Promise<DeletedAtResponse>;
     /**
      * Delete an existing index.
      *
@@ -356,7 +356,7 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
      * @param getLogs.type - Type of log entries to retrieve. When omitted, all log entries are retrieved.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    getLogs({ offset, length, indexName, type }: GetLogsProps, requestOptions?: RequestOptions): Promise<GetLogsResponse>;
+    getLogs({ offset, length, indexName, type }?: GetLogsProps, requestOptions?: RequestOptions | undefined): Promise<GetLogsResponse>;
     /**
      * Retrieve one object from the index.
      *
@@ -446,7 +446,7 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
      * @param hasPendingMappings.getClusters - If the clusters pending mapping state should be on the response.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    hasPendingMappings({ getClusters }: HasPendingMappingsProps, requestOptions?: RequestOptions): Promise<HasPendingMappingsResponse>;
+    hasPendingMappings({ getClusters }?: HasPendingMappingsProps, requestOptions?: RequestOptions | undefined): Promise<HasPendingMappingsResponse>;
     /**
      * List API keys, along with their associated rights.
      *
@@ -469,7 +469,7 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
      * @param listIndices.page - Requested page (zero-based). When specified, will retrieve a specific page; the page size is implicitly set to 100. When null, will retrieve all indices (no pagination).
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    listIndices({ page }: ListIndicesProps, requestOptions?: RequestOptions): Promise<ListIndicesResponse>;
+    listIndices({ page }?: ListIndicesProps, requestOptions?: RequestOptions | undefined): Promise<ListIndicesResponse>;
     /**
      * List the userIDs assigned to a multi-clusters appID. The data returned will usually be a few seconds behind real time, because userID usage may take up to a few seconds to propagate to the different clusters. Upon success, the response is 200 OK and contains the following userIDs data.
      *
@@ -479,7 +479,7 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
      * @param listUserIds.hitsPerPage - Maximum number of objects to retrieve.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    listUserIds({ page, hitsPerPage }: ListUserIdsProps, requestOptions?: RequestOptions): Promise<ListUserIdsResponse>;
+    listUserIds({ page, hitsPerPage }?: ListUserIdsProps, requestOptions?: RequestOptions | undefined): Promise<ListUserIdsResponse>;
     /**
      * Perform multiple write operations, potentially targeting multiple indices, in a single API call.
      *
@@ -505,11 +505,11 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
      * @param partialUpdateObject - The partialUpdateObject object.
      * @param partialUpdateObject.indexName - The index in which to perform the request.
      * @param partialUpdateObject.objectID - Unique identifier of an object.
-     * @param partialUpdateObject.attributeToUpdate - List of attributes to update.
+     * @param partialUpdateObject.attributesToUpdate - Map of attribute(s) to update.
      * @param partialUpdateObject.createIfNotExists - Creates the record if it does not exist yet.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    partialUpdateObject({ indexName, objectID, attributeToUpdate, createIfNotExists, }: PartialUpdateObjectProps, requestOptions?: RequestOptions): Promise<UpdatedAtWithObjectIdResponse>;
+    partialUpdateObject({ indexName, objectID, attributesToUpdate, createIfNotExists, }: PartialUpdateObjectProps, requestOptions?: RequestOptions): Promise<UpdatedAtWithObjectIdResponse>;
     /**
      * This method allow you to send requests to the Algolia REST API.
      *
@@ -587,12 +587,12 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
      * @summary Save a batch of rules.
      * @param saveRules - The saveRules object.
      * @param saveRules.indexName - The index in which to perform the request.
-     * @param saveRules.rule - The rule object.
+     * @param saveRules.rules - The rules object.
      * @param saveRules.forwardToReplicas - When true, changes are also propagated to replicas of the given indexName.
      * @param saveRules.clearExistingRules - When true, existing Rules are cleared before adding this batch. When false, existing Rules are kept.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    saveRules({ indexName, rule, forwardToReplicas, clearExistingRules, }: SaveRulesProps, requestOptions?: RequestOptions): Promise<UpdatedAtResponse>;
+    saveRules({ indexName, rules, forwardToReplicas, clearExistingRules, }: SaveRulesProps, requestOptions?: RequestOptions): Promise<UpdatedAtResponse>;
     /**
      * Create a new synonym object or update the existing synonym object with the given object ID.
      *

package/dist/src/searchClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"searchClient.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/src/searchClient.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EACV,mBAAmB,EAInB,cAAc,EAEd,QAAQ,EAET,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EACV,aAAa,EACb,kBAAkB,EAClB,oBAAoB,EACpB,sBAAsB,EACtB,iBAAiB,EACjB,UAAU,EACV,uBAAuB,EACvB,2BAA2B,EAC3B,WAAW,EACX,qBAAqB,EACrB,iBAAiB,EACjB,eAAe,EACf,QAAQ,EACR,iBAAiB,EACjB,aAAa,EACb,gBAAgB,EAChB,iBAAiB,EACjB,eAAe,EACf,iBAAiB,EACjB,kBAAkB,EAClB,QAAQ,EACR,cAAc,EACd,YAAY,EACZ,cAAc,EACd,YAAY,EACZ,gBAAgB,EAChB,eAAe,EACf,YAAY,EACZ,cAAc,EACd,uBAAuB,EACvB,gBAAgB,EAChB,gBAAgB,EAChB,mBAAmB,EACnB,wBAAwB,EACxB,SAAS,EACT,QAAQ,EACR,iBAAiB,EACjB,mBAAmB,EACnB,kBAAkB,EAClB,eAAe,EACf,aAAa,EACb,cAAc,EACd,gBAAgB,EAChB,iBAAiB,EACjB,uBAAuB,EACvB,4BAA4B,EAC5B,yBAAyB,EACzB,gBAAgB,EAChB,sBAAsB,EACtB,mBAAmB,EACnB,gBAAgB,EAChB,iBAAiB,EAClB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAC;AAClF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,wCAAwC,CAAC;AAC5F,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAClE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAC5E,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,qCAAqC,CAAC;AACtF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAC5E,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAC5E,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,uCAAuC,CAAC;AAC1F,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AAC9E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAC5E,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,wCAAwC,CAAC;AAC5F,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAE9C,eAAO,MAAM,gBAAgB,kBAAkB,CAAC;AAsChD,wBAAgB,kBAAkB,CAAC,EACjC,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,YAAY,EACpB,QAAQ,EACR,aAAa,EACb,GAAG,OAAO,EACX,EAAE,mBAAmB;;IAwBlB;;OAEG;;IAGH;;OAEG;kBACW,QAAQ,IAAI,CAAC;IAO3B;;OAEG;;IAKH;;;;;OAKG;6BACsB,MAAM,YAAY,MAAM,GAAG,IAAI;IAIxD;;;;;;;;;;OAUG;6DAQE,kBAAkB,mBACJ,cAAc,GAC9B,QAAQ,eAAe,CAAC;IAgB3B;;;;;;;;;;;OAWG;oEASE,oBAAoB,mBACN,cAAc,GAC9B,QAAQ,QAAQ,GAAG,iBAAiB,CAAC;IAoDxC;;;;;;;;;;OAUG;2TAOgB,cAAc;IAoBjC;;;;;;;;;;OAUG;yEAME,cAAc,mBAAmB,CAAC,GAAG,gBAAgB,mBACvC,cAAc,GAC9B,QAAQ,mBAAmB,CAAC;IA0B/B;;;;;;;;;OASG;kFAOE,cAAc,sBAAsB,CAAC,GAAG,mBAAmB,mBAC7C,cAAc,GAC9B,QAAQ,sBAAsB,CAAC;IAwBlC;;;;;;OAMG;sBAEO,MAAM,mBACG,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA4B7B;;;;;;;;;OASG;qDAE8B,sBAAsB,mBACpC,cAAc,GAC9B,QAAQ,6BAA6B,CAAC;IAoCzC;;;;;;OAMG;yBAEO,MAAM,mBACG,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAsB7B;;;;;;;;OAQG;yDAEuC,iBAAiB,mBACxC,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAsC7B;;;;;;;;OAQG;2CAEgC,UAAU,mBAC1B,cAAc,GAC9B,QAAQ,aAAa,CAAC;IA+BzB;;;;;;;;OAQG;qEAE6C,uBAAuB,mBACpD,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA2C7B;;;;;;;;OAQG;8EAKE,2BAA2B,mBACb,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAqC7B;;;;;;;;OAQG;8CAE6B,WAAW,mBACxB,cAAc;IA0BjC;;;;;;;;OAQG;uDAEiC,qBAAqB,mBACtC,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA4B7B;;;;;;;OAOG;gCAEc,iBAAiB,mBACf,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAwB7B;;;;;;;;OAQG;iDAEiC,eAAe,mBAChC,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA4B7B;;;;;;;;OAQG;8BAEqB,QAAQ,mBACb,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAmB/B;;;;;;;OAOG;0BAEQ,iBAAiB,mBACT,cAAc,GAC9B,QAAQ,oBAAoB,CAAC;IAwBhC;;;;;;;;OAQG;0CAE4B,aAAa,mBACzB,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA+B7B;;;;;;;OAOG;+BAEc,gBAAgB,mBACd,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAwB7B;;;;;;;;OAQG;0CAEwB,iBAAiB,mBACzB,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA6B7B;;;;;;;;;OASG;2DAE2C,eAAe,mBAC1C,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAiC7B;;;;;;;OAOG;6BAEW,iBAAiB,mBACZ,cAAc,GAC9B,QAAQ,oBAAoB,CAAC;IAwBhC;;;;;;;;;OASG;8DAE2C,kBAAkB,mBAC7C,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAiC7B;;;;;;;;OAQG;8BAEqB,QAAQ,mBACb,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAmB/B;;;;;;;OAOG;uBAEQ,cAAc,mBACN,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAwB7B;;;;;OAKG;4CAEgB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,SAAS,CAAC,CAAC;IAerC;;;;;OAKG;2CAEgB,cAAc,GAC9B,QAAQ,6BAA6B,CAAC;IAezC;;;;;;;;;;OAUG;iDAEoC,YAAY,mBAChC,cAAc,GAC9B,QAAQ,eAAe,CAAC;IA+B3B;;;;;;;;;OASG;6DAE8C,cAAc,mBAC5C,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,MAAM,CAAC,CAAC;IAiClC;;;;;;OAMG;sCAEiB,gBAAgB,mBACjB,cAAc;IA+BjC;;;;;;;;OAQG;qCAEwB,YAAY,mBACpB,cAAc,GAC9B,QAAQ,IAAI,CAAC;IA6BhB;;;;;;;OAOG;+BAEc,gBAAgB,mBACd,cAAc,GAC9B,QAAQ,aAAa,CAAC;IAwBzB;;;;;OAKG;gCACyB,cAAc,GAAG,QAAQ,MAAM,EAAE,CAAC;IAe9D;;;;;;;;OAQG;wCAEwB,eAAe,mBACvB,cAAc,GAC9B,QAAQ,UAAU,CAAC;IA6BtB;;;;;;;;OAQG;mCAEsB,YAAY,mBAClB,cAAc,GAC9B,QAAQ,eAAe,CAAC;IA6B3B;;;;;OAKG;mCAEgB,cAAc,GAC9B,QAAQ,qBAAqB,CAAC;IAejC;;;;;;;OAOG;0BAEW,cAAc,mBACT,cAAc,GAC9B,QAAQ,MAAM,CAAC;IAwBlB;;;;;;;OAOG;wCAEgB,uBAAuB,mBACvB,cAAc,GAC9B,QAAQ,0BAA0B,CAAC;IAmBtC;;;;;OAKG;iCAC0B,cAAc,GAAG,QAAQ,mBAAmB,CAAC;IAe1E;;;;;OAKG;kCAEgB,cAAc,GAC9B,QAAQ,oBAAoB,CAAC;IAehC;;;;;;;OAOG;0BAES,gBAAgB,mBACT,cAAc,GAC9B,QAAQ,mBAAmB,CAAC;IAmB/B;;;;;;;;OAQG;uCAEsB,gBAAgB,mBACtB,cAAc,GAC9B,QAAQ,mBAAmB,CAAC;IAuB/B;;;;;;OAMG;+BAEY,WAAW,mBACP,cAAc,GAC9B,QAAQ,qBAAqB,CAAC;IA4BjC;;;;;;;;OAQG;wDAEoC,mBAAmB,mBACvC,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA0C7B;;;;;;;;;;OAUG;wFAOE,wBAAwB,mBACV,cAAc,GAC9B,QAAQ,6BAA6B,CAAC;IAwCzC;;;;;;;;;OASG;qCAE2B,SAAS,mBACpB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAoB/B;;;;;;;;;OASG;oCAE2B,QAAQ,mBACnB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAoB/B;;;;;;;OAOG;6BAEW,iBAAiB,mBACZ,cAAc,GAC9B,QAAQ,oBAAoB,CAAC;IAwBhC;;;;;;;OAOG;+BAEW,mBAAmB,mBACd,cAAc,GAC9B,QAAQ,qBAAqB,CAAC;IAsBjC;;;;;;;OAOG;2BAEQ,kBAAkB,mBACV,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAwB7B;;;;;;;;OAQG;oCAEoB,eAAe,mBACnB,cAAc,GAC9B,QAAQ,kBAAkB,CAAC;IA+B9B;;;;;;;;;;OAUG;+DAEiD,aAAa,mBAC9C,cAAc,GAC9B,QAAQ,mBAAmB,CAAC;IA8C/B;;;;;;;;;;OAUG;2EAOE,cAAc,mBACA,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAuC7B;;;;;;;;;;OAUG;wEAEuD,gBAAgB,mBACvD,cAAc,GAC9B,QAAQ,mBAAmB,CAAC;IA8C/B;;;;;;;;;;OAUG;yFAOE,iBAAiB,mBACH,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAwC7B;;;;;;OAMG;oCAEmB,uBAAuB,GAAG,kBAAkB,mBAC/C,cAAc;IAwDjC;;;;;;;;OAQG;gFAKE,4BAA4B,mBACd,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAuC7B;;;;;;;;;OASG;iFAME,yBAAyB,mBACX,cAAc,GAC9B,QAAQ,4BAA4B,CAAC;IAgCxC;;;;;;;;OAQG;kDAEiC,gBAAgB,mBACjC,cAAc,GAC9B,QAAQ,mBAAmB,CAAC;IA2B/B;;;;;;;;OAQG;wDAE4B,sBAAsB,mBAClC,cAAc;IA4BjC;;;;;;;;;;;OAWG;kFAQE,mBAAmB,mBACL,cAAc,GAC9B,QAAQ,sBAAsB,CAAC;IAuClC;;;;;;OAMG;uCAEoB,mBAAmB,mBACvB,cAAc,GAC9B,QAAQ,qBAAqB,CAAC;IA8BjC;;;;;;OAMG;oDAEyB,wBAAwB,mBACjC,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA4B7B;;;;;;;;;OASG;iEAEgD,gBAAgB,mBAChD,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAmC7B;;;;;;;;OAQG;kCAEgB,iBAAiB,mBACjB,cAAc,GAC9B,QAAQ,oBAAoB,CAAC;EAqCnC;AAED;;GAEG;AACH,oBAAY,YAAY,GAAG,UAAU,CAAC,OAAO,kBAAkB,CAAC,CAAC"}
+{"version":3,"file":"searchClient.d.ts","sourceRoot":"","sources":["../../src/searchClient.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EACV,mBAAmB,EAInB,cAAc,EAEd,QAAQ,EAET,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EACV,aAAa,EACb,kBAAkB,EAClB,oBAAoB,EACpB,sBAAsB,EACtB,iBAAiB,EACjB,UAAU,EACV,uBAAuB,EACvB,2BAA2B,EAC3B,WAAW,EACX,qBAAqB,EACrB,iBAAiB,EACjB,eAAe,EACf,QAAQ,EACR,iBAAiB,EACjB,aAAa,EACb,gBAAgB,EAChB,iBAAiB,EACjB,eAAe,EACf,iBAAiB,EACjB,kBAAkB,EAClB,QAAQ,EACR,cAAc,EACd,YAAY,EACZ,cAAc,EACd,YAAY,EACZ,gBAAgB,EAChB,eAAe,EACf,YAAY,EACZ,cAAc,EACd,uBAAuB,EACvB,gBAAgB,EAChB,gBAAgB,EAChB,mBAAmB,EACnB,wBAAwB,EACxB,SAAS,EACT,QAAQ,EACR,iBAAiB,EACjB,mBAAmB,EACnB,kBAAkB,EAClB,eAAe,EACf,aAAa,EACb,cAAc,EACd,gBAAgB,EAChB,iBAAiB,EACjB,uBAAuB,EACvB,4BAA4B,EAC5B,yBAAyB,EACzB,gBAAgB,EAChB,sBAAsB,EACtB,mBAAmB,EACnB,gBAAgB,EAChB,iBAAiB,EAClB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAC;AAClF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,wCAAwC,CAAC;AAC5F,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAClE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAC5E,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,qCAAqC,CAAC;AACtF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAC5E,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAC5E,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,uCAAuC,CAAC;AAC1F,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AAC9E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAC5E,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,wCAAwC,CAAC;AAC5F,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAE9C,eAAO,MAAM,gBAAgB,mBAAmB,CAAC;AAsCjD,wBAAgB,kBAAkB,CAAC,EACjC,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,YAAY,EACpB,QAAQ,EACR,aAAa,EACb,GAAG,OAAO,EACX,EAAE,mBAAmB;;IAwBlB;;OAEG;;IAGH;;OAEG;kBACW,QAAQ,IAAI,CAAC;IAO3B;;OAEG;;IAKH;;;;;OAKG;6BACsB,MAAM,YAAY,MAAM,GAAG,IAAI;IAIxD;;;;;;;;;;OAUG;6DAQE,kBAAkB,mBACJ,cAAc,GAC9B,QAAQ,eAAe,CAAC;IAgB3B;;;;;;;;;;;OAWG;oEASE,oBAAoB,mBACN,cAAc,GAC9B,QAAQ,QAAQ,GAAG,iBAAiB,CAAC;IAoDxC;;;;;;;;;;OAUG;0TAOgB,cAAc;IAoBjC;;;;;;;;;;OAUG;yEAME,cAAc,mBAAmB,CAAC,GAAG,gBAAgB,mBACvC,cAAc,GAC9B,QAAQ,mBAAmB,CAAC;IA0B/B;;;;;;;;;OASG;kFAOE,cAAc,sBAAsB,CAAC,GAAG,mBAAmB,mBAC7C,cAAc,GAC9B,QAAQ,sBAAsB,CAAC;IAwBlC;;;;;;OAMG;sBAEO,MAAM,mBACG,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA4B7B;;;;;;;;;OASG;qDAE8B,sBAAsB,mBACpC,cAAc,GAC9B,QAAQ,6BAA6B,CAAC;IAoCzC;;;;;;OAMG;yBAEO,MAAM,mBACG,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAsB7B;;;;;;;;OAQG;yDAEuC,iBAAiB,mBACxC,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAsC7B;;;;;;;;OAQG;2CAEgC,UAAU,mBAC1B,cAAc,GAC9B,QAAQ,aAAa,CAAC;IAqCzB;;;;;;;;OAQG;qEAE6C,uBAAuB,mBACpD,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA2C7B;;;;;;;;OAQG;8EAKE,2BAA2B,mBACb,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAqC7B;;;;;;;;OAQG;6CAE4B,WAAW,mBACvB,cAAc;IA0BjC;;;;;;;;OAQG;uDAEiC,qBAAqB,mBACtC,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA4B7B;;;;;;;OAOG;gCAEc,iBAAiB,mBACf,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAwB7B;;;;;;;;OAQG;iDAEiC,eAAe,mBAChC,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA4B7B;;;;;;;;OAQG;8BAEqB,QAAQ,mBACb,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAmB/B;;;;;;;OAOG;0BAEQ,iBAAiB,mBACT,cAAc,GAC9B,QAAQ,oBAAoB,CAAC;IAwBhC;;;;;;;;OAQG;4CAE8B,aAAa,mBAC3B,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA+B7B;;;;;;;OAOG;+BAEc,gBAAgB,mBACd,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAwB7B;;;;;;;;OAQG;0CAEwB,iBAAiB,mBACzB,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA6B7B;;;;;;;;;OASG;2DAE2C,eAAe,mBAC1C,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAiC7B;;;;;;;OAOG;6BAEW,iBAAiB,mBACZ,cAAc,GAC9B,QAAQ,oBAAoB,CAAC;IAwBhC;;;;;;;;;OASG;8DAE2C,kBAAkB,mBAC7C,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAiC7B;;;;;;;;OAQG;8BAEqB,QAAQ,mBACb,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAmB/B;;;;;;;OAOG;uBAEQ,cAAc,mBACN,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAwB7B;;;;;OAKG;4CAEgB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,SAAS,CAAC,CAAC;IAerC;;;;;OAKG;2CAEgB,cAAc,GAC9B,QAAQ,6BAA6B,CAAC;IAezC;;;;;;;;;;OAUG;kDAEoC,YAAY,mBACjC,cAAc,GAAG,SAAS,GACzC,QAAQ,eAAe,CAAC;IA+B3B;;;;;;;;;OASG;6DAE8C,cAAc,mBAC5C,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,MAAM,CAAC,CAAC;IAiClC;;;;;;OAMG;sCAEiB,gBAAgB,mBACjB,cAAc;IA+BjC;;;;;;;;OAQG;qCAEwB,YAAY,mBACpB,cAAc,GAC9B,QAAQ,IAAI,CAAC;IA6BhB;;;;;;;OAOG;+BAEc,gBAAgB,mBACd,cAAc,GAC9B,QAAQ,aAAa,CAAC;IAwBzB;;;;;OAKG;gCACyB,cAAc,GAAG,QAAQ,MAAM,EAAE,CAAC;IAe9D;;;;;;;;OAQG;wCAEwB,eAAe,mBACvB,cAAc,GAC9B,QAAQ,UAAU,CAAC;IA6BtB;;;;;;;;OAQG;mCAEsB,YAAY,mBAClB,cAAc,GAC9B,QAAQ,eAAe,CAAC;IA6B3B;;;;;OAKG;mCAEgB,cAAc,GAC9B,QAAQ,qBAAqB,CAAC;IAejC;;;;;;;OAOG;0BAEW,cAAc,mBACT,cAAc,GAC9B,QAAQ,MAAM,CAAC;IAwBlB;;;;;;;OAOG;yCAEgB,uBAAuB,mBACxB,cAAc,GAAG,SAAS,GACzC,QAAQ,0BAA0B,CAAC;IAmBtC;;;;;OAKG;iCAC0B,cAAc,GAAG,QAAQ,mBAAmB,CAAC;IAe1E;;;;;OAKG;kCAEgB,cAAc,GAC9B,QAAQ,oBAAoB,CAAC;IAehC;;;;;;;OAOG;2BAES,gBAAgB,mBACV,cAAc,GAAG,SAAS,GACzC,QAAQ,mBAAmB,CAAC;IAmB/B;;;;;;;;OAQG;wCAEsB,gBAAgB,mBACvB,cAAc,GAAG,SAAS,GACzC,QAAQ,mBAAmB,CAAC;IAuB/B;;;;;;OAMG;+BAEY,WAAW,mBACP,cAAc,GAC9B,QAAQ,qBAAqB,CAAC;IA4BjC;;;;;;;;OAQG;wDAEoC,mBAAmB,mBACvC,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA0C7B;;;;;;;;;;OAUG;yFAOE,wBAAwB,mBACV,cAAc,GAC9B,QAAQ,6BAA6B,CAAC;IAwCzC;;;;;;;;;OASG;qCAE2B,SAAS,mBACpB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAoB/B;;;;;;;;;OASG;oCAE2B,QAAQ,mBACnB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAoB/B;;;;;;;OAOG;6BAEW,iBAAiB,mBACZ,cAAc,GAC9B,QAAQ,oBAAoB,CAAC;IAwBhC;;;;;;;OAOG;+BAEW,mBAAmB,mBACd,cAAc,GAC9B,QAAQ,qBAAqB,CAAC;IAsBjC;;;;;;;OAOG;2BAEQ,kBAAkB,mBACV,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAwB7B;;;;;;;;OAQG;oCAEoB,eAAe,mBACnB,cAAc,GAC9B,QAAQ,kBAAkB,CAAC;IA+B9B;;;;;;;;;;OAUG;+DAEiD,aAAa,mBAC9C,cAAc,GAC9B,QAAQ,mBAAmB,CAAC;IA8C/B;;;;;;;;;;OAUG;4EAOE,cAAc,mBACA,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAuC7B;;;;;;;;;;OAUG;wEAEuD,gBAAgB,mBACvD,cAAc,GAC9B,QAAQ,mBAAmB,CAAC;IA8C/B;;;;;;;;;;OAUG;yFAOE,iBAAiB,mBACH,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAwC7B;;;;;;OAMG;oCAEmB,uBAAuB,GAAG,kBAAkB,mBAC/C,cAAc;IAwDjC;;;;;;;;OAQG;gFAKE,4BAA4B,mBACd,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAuC7B;;;;;;;;;OASG;iFAME,yBAAyB,mBACX,cAAc,GAC9B,QAAQ,4BAA4B,CAAC;IAgCxC;;;;;;;;OAQG;kDAEiC,gBAAgB,mBACjC,cAAc,GAC9B,QAAQ,mBAAmB,CAAC;IA2B/B;;;;;;;;OAQG;wDAE4B,sBAAsB,mBAClC,cAAc;IA4BjC;;;;;;;;;;;OAWG;kFAQE,mBAAmB,mBACL,cAAc,GAC9B,QAAQ,sBAAsB,CAAC;IAuClC;;;;;;OAMG;uCAEoB,mBAAmB,mBACvB,cAAc,GAC9B,QAAQ,qBAAqB,CAAC;IA8BjC;;;;;;OAMG;oDAEyB,wBAAwB,mBACjC,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA4B7B;;;;;;;;;OASG;iEAEgD,gBAAgB,mBAChD,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAmC7B;;;;;;;;OAQG;kCAEgB,iBAAiB,mBACjB,cAAc,GAC9B,QAAQ,oBAAoB,CAAC;EAqCnC;AAED;;GAEG;AACH,oBAAY,YAAY,GAAG,UAAU,CAAC,OAAO,kBAAkB,CAAC,CAAC"}

package/model/baseIndexSettings.ts

@@ -11,6 +11,11 @@ export type BaseIndexSettings = {
    */
   paginationLimitedTo?: number;
 
+  /**
+   * List of attributes that can\'t be retrieved at query time.
+   */
+  unretrievableAttributes?: string[];
+
   /**
    * A list of words for which you want to turn off typo tolerance.
    */

package/model/baseSearchResponse.ts

@@ -37,7 +37,7 @@ export type BaseSearchResponse = {
   /**
    * Indicate if the typo-tolerance search was exhaustive or approximate (only included when typo-tolerance is enabled).
    */
-  exhaustiveTypo: boolean;
+  exhaustiveTypo?: boolean;
 
   /**
    * A mapping of each facet name to the corresponding facet counts.

package/model/batchRequest.ts

@@ -3,10 +3,10 @@
 import type { Action } from './action';
 
 export type BatchRequest = {
-  action?: Action;
+  action: Action;
 
   /**
    * Arguments to the operation (depends on the type of the operation).
    */
-  body?: Record<string, any>;
+  body: Record<string, any>;
 };

package/model/batchWriteParams.ts

@@ -6,5 +6,5 @@ import type { BatchRequest } from './batchRequest';
  * The `batch` parameters.
  */
 export type BatchWriteParams = {
-  requests?: BatchRequest[];
+  requests: BatchRequest[];
 };

package/model/browseParams.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { BrowseParamsObject } from './browseParamsObject';
+import type { SearchParamsString } from './searchParamsString';
+
+export type BrowseParams = BrowseParamsObject | SearchParamsString;

package/model/browseParamsObject.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { Cursor } from './cursor';
+import type { SearchParamsObject } from './searchParamsObject';
+
+export type BrowseParamsObject = Cursor & SearchParamsObject;

package/model/browseResponse.ts

@@ -1,9 +1,9 @@
 // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
 
-import type { BaseBrowseResponse } from './baseBrowseResponse';
 import type { BaseSearchResponse } from './baseSearchResponse';
+import type { Cursor } from './cursor';
 import type { SearchHits } from './searchHits';
 
-export type BrowseResponse<T = Record<string, any>> = BaseBrowseResponse &
-  BaseSearchResponse &
+export type BrowseResponse<T = Record<string, any>> = BaseSearchResponse &
+  Cursor &
   SearchHits<T>;

package/model/clientMethodProps.ts

@@ -8,10 +8,9 @@ import type { AttributeToUpdate } from './attributeToUpdate';
 import type { BatchAssignUserIdsParams } from './batchAssignUserIdsParams';
 import type { BatchDictionaryEntriesParams } from './batchDictionaryEntriesParams';
 import type { BatchWriteParams } from './batchWriteParams';
-import type { BrowseRequest } from './browseRequest';
+import type { BrowseParams } from './browseParams';
+import type { DeleteByParams } from './deleteByParams';
 import type { DictionaryType } from './dictionaryType';
-import type { GetApiKeyResponse } from './getApiKeyResponse';
-import type { GetTaskResponse } from './getTaskResponse';
 import type { IndexSettings } from './indexSettings';
 import type { LogType } from './logType';
 import type { OperationIndexParams } from './operationIndexParams';
@@ -98,7 +97,7 @@ export type BrowseProps = {
    * The index in which to perform the request.
    */
   indexName: string;
-  browseRequest?: BrowseRequest;
+  browseParams?: BrowseParams;
 };
 
 /**
@@ -171,7 +170,7 @@ export type DeleteByProps = {
    * The index in which to perform the request.
    */
   indexName: string;
-  searchParams: SearchParams;
+  deleteByParams: DeleteByParams;
 };
 
 /**
@@ -428,9 +427,9 @@ export type PartialUpdateObjectProps = {
    */
   objectID: string;
   /**
-   * List of attributes to update.
+   * Map of attribute(s) to update.
    */
-  attributeToUpdate: Array<Record<string, AttributeToUpdate>>;
+  attributesToUpdate: Record<string, AttributeToUpdate>;
   /**
    * Creates the record if it does not exist yet.
    */
@@ -544,7 +543,7 @@ export type SaveRulesProps = {
    * The index in which to perform the request.
    */
   indexName: string;
-  rule: Rule[];
+  rules: Rule[];
   /**
    * When true, changes are also propagated to replicas of the given indexName.
    */
@@ -733,10 +732,7 @@ export type BrowseOptions<T> = Partial<
 > &
   Required<Pick<CreateIterablePromise<T>, 'aggregator'>>;
 
-type WaitForOptions<T> = Omit<
-  CreateIterablePromise<T>,
-  'func' | 'timeout' | 'validate'
-> & {
+type WaitForOptions = Partial<{
   /**
    * The maximum number of retries. 50 by default.
    */
@@ -746,9 +742,9 @@ type WaitForOptions<T> = Omit<
    * The function to decide how long to wait between retries.
    */
   timeout: (retryCount: number) => number;
-};
+}>;
 
-export type WaitForTaskOptions = WaitForOptions<GetTaskResponse> & {
+export type WaitForTaskOptions = WaitForOptions & {
   /**
    * The `indexName` where the operation was performed.
    */
@@ -759,7 +755,7 @@ export type WaitForTaskOptions = WaitForOptions<GetTaskResponse> & {
   taskID: number;
 };
 
-export type WaitForApiKeyOptions = WaitForOptions<GetApiKeyResponse> & {
+export type WaitForApiKeyOptions = WaitForOptions & {
   /**
    * The API Key.
    */

package/model/{baseBrowseResponse.ts → cursor.ts}

@@ -1,8 +1,8 @@
 // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
 
-export type BaseBrowseResponse = {
+export type Cursor = {
   /**
    * Cursor indicating the location to resume browsing from. Must match the value returned by the previous call.
    */
-  cursor: string;
+  cursor?: string;
 };

package/model/deleteByParams.ts

@@ -0,0 +1,36 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+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[];
+};

package/model/fetchedIndex.ts

@@ -39,7 +39,7 @@ export type FetchedIndex = {
   /**
    * Number of pending indexing operations. This value is deprecated and should not be used.
    */
-  numberOfPendingTask?: number;
+  numberOfPendingTasks: number;
 
   /**
    * A boolean which says whether the index has pending tasks. This value is deprecated and should not be used.

package/model/index.ts

@@ -13,7 +13,6 @@ export * from './assignUserIdParams';
 export * from './attributeToUpdate';
 export * from './automaticFacetFilter';
 export * from './automaticFacetFilters';
-export * from './baseBrowseResponse';
 export * from './baseGetApiKeyResponse';
 export * from './baseIndexSettings';
 export * from './baseSearchParams';
@@ -26,7 +25,8 @@ export * from './batchParams';
 export * from './batchRequest';
 export * from './batchResponse';
 export * from './batchWriteParams';
-export * from './browseRequest';
+export * from './browseParams';
+export * from './browseParamsObject';
 export * from './browseResponse';
 export * from './builtInOperation';
 export * from './builtInOperationType';
@@ -37,7 +37,9 @@ export * from './consequenceParams';
 export * from './consequenceQuery';
 export * from './consequenceQueryObject';
 export * from './createdAtResponse';
+export * from './cursor';
 export * from './deleteApiKeyResponse';
+export * from './deleteByParams';
 export * from './deleteSourceResponse';
 export * from './deletedAtResponse';
 export * from './dictionaryAction';
@@ -137,7 +139,6 @@ export * from './sortRemainingBy';
 export * from './source';
 export * from './standardEntries';
 export * from './synonymHit';
-export * from './synonymHitHighlightResult';
 export * from './synonymType';
 export * from './tagFilters';
 export * from './taskStatus';

package/model/indexSettingsAsSearchParams.ts

@@ -17,11 +17,6 @@ export type IndexSettingsAsSearchParams = {
    */
   attributesForFaceting?: string[];
 
-  /**
-   * List of attributes that can\'t be retrieved at query time.
-   */
-  unretrievableAttributes?: string[];
-
   /**
    * This parameter controls which attributes to retrieve and which not to retrieve.
    */
@@ -166,6 +161,11 @@ export type IndexSettingsAsSearchParams = {
 
   distinct?: Distinct;
 
+  /**
+   * Name of the de-duplication attribute to be used with the distinct feature.
+   */
+  attributeForDistinct?: string;
+
   /**
    * Whether to take into account an index\'s synonyms for a particular search.
    */

package/model/searchRulesParams.ts

@@ -31,7 +31,7 @@ export type SearchRulesParams = {
   /**
    * When specified, restricts matches to rules with a specific enabled status. When absent (default), all rules are retrieved, regardless of their enabled status.
    */
-  enabled?: boolean;
+  enabled?: boolean | null;
 
   /**
    * A mapping of requestOptions to send along with the request.

package/model/synonymHit.ts

@@ -1,6 +1,5 @@
 // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
 
-import type { SynonymHitHighlightResult } from './synonymHitHighlightResult';
 import type { SynonymType } from './synonymType';
 
 /**
@@ -43,6 +42,4 @@ export type SynonymHit = {
    * List of query words that will match the token.
    */
   replacements?: string[];
-
-  _highlightResult?: SynonymHitHighlightResult;
 };

package/package.json

@@ -1,16 +1,32 @@
 {
   "name": "@algolia/client-search",
-  "version": "5.0.0-alpha.4",
+  "version": "5.0.0-alpha.41",
   "description": "JavaScript client for client-search",
   "repository": "algolia/algoliasearch-client-javascript",
   "license": "MIT",
   "author": "Algolia",
-  "main": "index.js",
-  "jsdelivr": "dist/client-search.umd.js",
-  "unpkg": "dist/client-search.umd.js",
-  "module": "dist/client-search.esm.node.js",
-  "browser": "dist/client-search.umd.js",
-  "types": "index.d.ts",
+  "exports": {
+    ".": {
+      "node": {
+        "import": "./dist/client-search.esm.node.js",
+        "module": "./dist/client-search.esm.node.js",
+        "require": "./dist/client-search.cjs.js",
+        "default": "./dist/client-search.cjs.js"
+      },
+      "default": {
+        "umd": "./dist/client-search.umd.js",
+        "module": "./dist/client-search.esm.browser.js",
+        "import": "./dist/client-search.esm.browser.js",
+        "default": "./dist/client-search.umd.js"
+      }
+    },
+    "./src/*": "./src/*.ts",
+    "./model": "./model/index.ts"
+  },
+  "jsdelivr": "./dist/client-search.umd.js",
+  "unpkg": "./dist/client-search.umd.js",
+  "browser": "./dist/client-search.umd.js",
+  "types": "./index.d.ts",
   "files": [
     "dist",
     "model",
@@ -18,16 +34,18 @@
     "index.d.ts"
   ],
   "scripts": {
-    "clean": "rm -rf ./dist"
+    "build": "yarn clean && rollup --config",
+    "clean": "rm -rf ./dist || true"
   },
   "dependencies": {
-    "@algolia/client-common": "5.0.0-alpha.4",
-    "@algolia/requester-browser-xhr": "5.0.0-alpha.4",
-    "@algolia/requester-node-http": "5.0.0-alpha.4"
+    "@algolia/client-common": "5.0.0-alpha.41",
+    "@algolia/requester-browser-xhr": "5.0.0-alpha.41",
+    "@algolia/requester-node-http": "5.0.0-alpha.41"
   },
   "devDependencies": {
-    "@types/node": "16.11.47",
-    "typescript": "4.7.4"
+    "@types/node": "16.11.59",
+    "rollup": "2.79.1",
+    "typescript": "4.8.3"
   },
   "engines": {
     "node": ">= 14.0.0"

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

@@ -1 +0,0 @@
-{"version":3,"file":"baseBrowseResponse.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/baseBrowseResponse.ts"],"names":[],"mappings":"AAEA,oBAAY,kBAAkB,GAAG;IAC/B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}

package/dist/model/browseRequest.d.ts

@@ -1,11 +0,0 @@
-export declare type BrowseRequest = {
-    /**
-     * Search parameters as URL-encoded query string.
-     */
-    params?: string;
-    /**
-     * Cursor indicating the location to resume browsing from. Must match the value returned by the previous call.
-     */
-    cursor?: string;
-};
-//# sourceMappingURL=browseRequest.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"browseRequest.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/browseRequest.ts"],"names":[],"mappings":"AAEA,oBAAY,aAAa,GAAG;IAC1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC"}

package/dist/model/synonymHitHighlightResult.d.ts

@@ -1,12 +0,0 @@
-import type { HighlightResult } from './highlightResult';
-/**
- * Highlighted results.
- */
-export declare type SynonymHitHighlightResult = {
-    /**
-     * Show highlighted section and words matched on a query.
-     */
-    type?: Record<string, HighlightResult>;
-    synonyms?: Array<Record<string, HighlightResult>>;
-};
-//# sourceMappingURL=synonymHitHighlightResult.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"synonymHitHighlightResult.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/synonymHitHighlightResult.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD;;GAEG;AACH,oBAAY,yBAAyB,GAAG;IACtC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAEvC,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC;CACnD,CAAC"}

package/model/browseRequest.ts

@@ -1,13 +0,0 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
-
-export type BrowseRequest = {
-  /**
-   * Search parameters as URL-encoded query string.
-   */
-  params?: string;
-
-  /**
-   * Cursor indicating the location to resume browsing from. Must match the value returned by the previous call.
-   */
-  cursor?: string;
-};

package/model/synonymHitHighlightResult.ts

@@ -1,15 +0,0 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
-
-import type { HighlightResult } from './highlightResult';
-
-/**
- * Highlighted results.
- */
-export type SynonymHitHighlightResult = {
-  /**
-   * Show highlighted section and words matched on a query.
-   */
-  type?: Record<string, HighlightResult>;
-
-  synonyms?: Array<Record<string, HighlightResult>>;
-};