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

package/model/clientMethodProps.ts

@@ -1,18 +1,17 @@
 // 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 { BrowseParams } from './browseParams';
+import type { DeleteByParams } from './deleteByParams';
 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';
@@ -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,11 +427,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 +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.
    */
@@ -661,7 +658,7 @@ export type SearchRulesProps = {
    * The index in which to perform the request.
    */
   indexName: string;
-  searchRulesParams: SearchRulesParams;
+  searchRulesParams?: SearchRulesParams;
 };
 
 /**
@@ -727,12 +724,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 +755,7 @@ export type WaitForTaskOptions = WaitForOptions<GetTaskResponse> & {
   taskID: number;
 };
 
-export type WaitForApiKeyOptions = WaitForOptions<Key> & {
+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/{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,10 @@ 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';
@@ -25,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';
@@ -35,9 +36,10 @@ export * from './consequenceHide';
 export * from './consequenceParams';
 export * from './consequenceQuery';
 export * from './consequenceQueryObject';
-export * from './createdAtObject';
 export * from './createdAtResponse';
+export * from './cursor';
 export * from './deleteApiKeyResponse';
+export * from './deleteByParams';
 export * from './deleteSourceResponse';
 export * from './deletedAtResponse';
 export * from './dictionaryAction';
@@ -57,6 +59,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 +74,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';
@@ -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/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/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/model/updateApiKeyResponse.ts

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

package/package.json

@@ -1,16 +1,32 @@
 {
   "name": "@algolia/client-search",
-  "version": "5.0.0-alpha.3",
+  "version": "5.0.0-alpha.31",
   "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.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.31",
+    "@algolia/requester-browser-xhr": "5.0.0-alpha.31",
+    "@algolia/requester-node-http": "5.0.0-alpha.31"
   },
   "devDependencies": {
-    "@types/node": "16.11.45",
-    "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/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/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/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/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/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;
-};

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>>;
-};