@algolia/client-search 5.0.0-alpha.3 → 5.0.0-alpha.6

package/model/clientMethodProps.ts

@@ -1,18 +1,16 @@
 // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
 
-import type { CreateRetryablePromiseOptions } from '@algolia/client-common';
+import type { CreateIterablePromise } from '@algolia/client-common';
 
 import type { ApiKey } from './apiKey';
 import type { AssignUserIdParams } from './assignUserIdParams';
-import type { AttributeOrBuiltInOperation } from './attributeOrBuiltInOperation';
+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 { DictionaryType } from './dictionaryType';
-import type { GetTaskResponse } from './getTaskResponse';
 import type { IndexSettings } from './indexSettings';
-import type { Key } from './key';
 import type { LogType } from './logType';
 import type { OperationIndexParams } from './operationIndexParams';
 import type { Rule } from './rule';
@@ -428,11 +426,9 @@ export type PartialUpdateObjectProps = {
    */
   objectID: string;
   /**
-   * List of attributes to update.
+   * Map of attribute(s) to update.
    */
-  attributeOrBuiltInOperation: Array<
-    Record<string, AttributeOrBuiltInOperation>
-  >;
+  attributesToUpdate: Record<string, AttributeToUpdate>;
   /**
    * Creates the record if it does not exist yet.
    */
@@ -546,7 +542,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.
    */
@@ -661,7 +657,7 @@ export type SearchRulesProps = {
    * The index in which to perform the request.
    */
   indexName: string;
-  searchRulesParams: SearchRulesParams;
+  searchRulesParams?: SearchRulesParams;
 };
 
 /**
@@ -727,12 +723,27 @@ export type UpdateApiKeyProps = {
   apiKey: ApiKey;
 };
 
-type WaitForOptions<T> = Omit<
-  CreateRetryablePromiseOptions<T>,
-  'func' | 'validate'
->;
+/**
+ * The `browseObjects`, `browseRules`, `browseSynonyms` options.
+ */
+export type BrowseOptions<T> = Partial<
+  Pick<CreateIterablePromise<T>, 'validate'>
+> &
+  Required<Pick<CreateIterablePromise<T>, 'aggregator'>>;
+
+type WaitForOptions = Partial<{
+  /**
+   * The maximum number of retries. 50 by default.
+   */
+  maxRetries: number;
+
+  /**
+   * 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.
    */
@@ -743,7 +754,7 @@ export type WaitForTaskOptions = WaitForOptions<GetTaskResponse> & {
   taskID: number;
 };
 
-export type WaitForApiKeyOptions = WaitForOptions<Key> & {
+export type WaitForApiKeyOptions = WaitForOptions & {
   /**
    * The API Key.
    */

package/model/{key.ts → getApiKeyResponse.ts}

@@ -1,6 +1,6 @@
 // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
 
 import type { ApiKey } from './apiKey';
-import type { CreatedAtObject } from './createdAtObject';
+import type { BaseGetApiKeyResponse } from './baseGetApiKeyResponse';
 
-export type Key = ApiKey & CreatedAtObject;
+export type GetApiKeyResponse = ApiKey & BaseGetApiKeyResponse;

package/model/getObjectsParams.ts

@@ -6,5 +6,5 @@ import type { GetObjectsRequest } from './getObjectsRequest';
  * The `getObjects` parameters.
  */
 export type GetObjectsParams = {
-  requests?: GetObjectsRequest[];
+  requests: GetObjectsRequest[];
 };

package/model/index.ts

@@ -10,10 +10,11 @@ export * from './apiKey';
 export * from './aroundRadius';
 export * from './aroundRadiusAll';
 export * from './assignUserIdParams';
-export * from './attributeOrBuiltInOperation';
+export * from './attributeToUpdate';
 export * from './automaticFacetFilter';
 export * from './automaticFacetFilters';
 export * from './baseBrowseResponse';
+export * from './baseGetApiKeyResponse';
 export * from './baseIndexSettings';
 export * from './baseSearchParams';
 export * from './baseSearchParamsWithoutQuery';
@@ -35,7 +36,6 @@ export * from './consequenceHide';
 export * from './consequenceParams';
 export * from './consequenceQuery';
 export * from './consequenceQueryObject';
-export * from './createdAtObject';
 export * from './createdAtResponse';
 export * from './deleteApiKeyResponse';
 export * from './deleteSourceResponse';
@@ -57,6 +57,7 @@ export * from './facetOrdering';
 export * from './facets';
 export * from './facetsStats';
 export * from './fetchedIndex';
+export * from './getApiKeyResponse';
 export * from './getDictionarySettingsResponse';
 export * from './getLogsResponse';
 export * from './getObjectsParams';
@@ -71,7 +72,6 @@ export * from './hit';
 export * from './ignorePlurals';
 export * from './indexSettings';
 export * from './indexSettingsAsSearchParams';
-export * from './key';
 export * from './languages';
 export * from './listApiKeysResponse';
 export * from './listClustersResponse';

package/model/indexSettingsAsSearchParams.ts

@@ -166,6 +166,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/listApiKeysResponse.ts

@@ -1,10 +1,10 @@
 // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
 
-import type { Key } from './key';
+import type { GetApiKeyResponse } from './getApiKeyResponse';
 
 export type ListApiKeysResponse = {
   /**
    * List of api keys.
    */
-  keys: Key[];
+  keys: GetApiKeyResponse[];
 };

package/model/multipleBatchRequest.ts

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

package/model/multipleBatchResponse.ts

@@ -4,10 +4,10 @@ export type MultipleBatchResponse = {
   /**
    * List of tasksIDs per index.
    */
-  taskID?: Record<string, any>;
+  taskID: Record<string, number>;
 
   /**
    * List of objectID.
    */
-  objectIDs?: string[];
+  objectIDs: string[];
 };

package/model/updateApiKeyResponse.ts

@@ -2,7 +2,7 @@
 
 export type UpdateApiKeyResponse = {
   /**
-   * Key string.
+   * The API key.
    */
   key: string;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@algolia/client-search",
-  "version": "5.0.0-alpha.3",
+  "version": "5.0.0-alpha.6",
   "description": "JavaScript client for client-search",
   "repository": "algolia/algoliasearch-client-javascript",
   "license": "MIT",
@@ -21,12 +21,12 @@
     "clean": "rm -rf ./dist"
   },
   "dependencies": {
-    "@algolia/client-common": "5.0.0-alpha.3",
-    "@algolia/requester-browser-xhr": "5.0.0-alpha.3",
-    "@algolia/requester-node-http": "5.0.0-alpha.3"
+    "@algolia/client-common": "5.0.0-alpha.6",
+    "@algolia/requester-browser-xhr": "5.0.0-alpha.6",
+    "@algolia/requester-node-http": "5.0.0-alpha.6"
   },
   "devDependencies": {
-    "@types/node": "16.11.45",
+    "@types/node": "16.11.47",
     "typescript": "4.7.4"
   },
   "engines": {

package/dist/model/attributeOrBuiltInOperation.d.ts

@@ -1,3 +0,0 @@
-import type { BuiltInOperation } from './builtInOperation';
-export declare type AttributeOrBuiltInOperation = BuiltInOperation | string;
-//# sourceMappingURL=attributeOrBuiltInOperation.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"attributeOrBuiltInOperation.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/attributeOrBuiltInOperation.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE3D,oBAAY,2BAA2B,GAAG,gBAAgB,GAAG,MAAM,CAAC"}

package/dist/model/createdAtObject.d.ts

@@ -1,7 +0,0 @@
-export declare type CreatedAtObject = {
-    /**
-     * Date of creation (ISO-8601 format).
-     */
-    createdAt: string;
-};
-//# sourceMappingURL=createdAtObject.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"createdAtObject.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/createdAtObject.ts"],"names":[],"mappings":"AAEA,oBAAY,eAAe,GAAG;IAC5B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}

package/dist/model/key.d.ts

@@ -1,4 +0,0 @@
-import type { ApiKey } from './apiKey';
-import type { CreatedAtObject } from './createdAtObject';
-export declare type Key = ApiKey & CreatedAtObject;
-//# sourceMappingURL=key.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"key.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/key.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,oBAAY,GAAG,GAAG,MAAM,GAAG,eAAe,CAAC"}

package/model/createdAtObject.ts

@@ -1,8 +0,0 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
-
-export type CreatedAtObject = {
-  /**
-   * Date of creation (ISO-8601 format).
-   */
-  createdAt: string;
-};