algoliasearch 5.0.0-alpha.4 → 5.0.0-alpha.41

package/builds/browser.ts

@@ -137,17 +137,14 @@ export function algoliasearch(
     initOptions: InitClientOptions &
       Required<InitClientRegion<PersonalizationRegion>>
   ): PersonalizationClient {
-    if (!initOptions.region) {
-      throw new Error('`region` is missing.');
-    }
-
     if (
-      initOptions.region &&
-      (typeof initOptions.region !== 'string' ||
-        !personalizationRegions.includes(initOptions.region))
+      !initOptions.region ||
+      (initOptions.region &&
+        (typeof initOptions.region !== 'string' ||
+          !personalizationRegions.includes(initOptions.region)))
     ) {
       throw new Error(
-        `\`region\` must be one of the following: ${personalizationRegions.join(
+        `\`region\` is required and must be one of the following: ${personalizationRegions.join(
           ', '
         )}`
       );

package/builds/node.ts

@@ -130,17 +130,14 @@ export function algoliasearch(
     initOptions: InitClientOptions &
       Required<InitClientRegion<PersonalizationRegion>>
   ): PersonalizationClient {
-    if (!initOptions.region) {
-      throw new Error('`region` is missing.');
-    }
-
     if (
-      initOptions.region &&
-      (typeof initOptions.region !== 'string' ||
-        !personalizationRegions.includes(initOptions.region))
+      !initOptions.region ||
+      (initOptions.region &&
+        (typeof initOptions.region !== 'string' ||
+          !personalizationRegions.includes(initOptions.region)))
     ) {
       throw new Error(
-        `\`region\` must be one of the following: ${personalizationRegions.join(
+        `\`region\` is required and must be one of the following: ${personalizationRegions.join(
           ', '
         )}`
       );

package/dist/algoliasearch/builds/models.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"models.d.ts","sourceRoot":"","sources":["../../../builds/models.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,EACL,SAAS,EACT,QAAQ,EACR,SAAS,EACT,QAAQ,EACR,QAAQ,EACT,MAAM,8BAA8B,CAAC;AAEtC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,uCAAuC,CAAC;AACtD,cAAc,iCAAiC,CAAC;AAChD,cAAc,iCAAiC,CAAC;AAEhD,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AACxE,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAE5D,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC;AAE9D;;GAEG;AACH,oBAAY,iBAAiB,GAAG,OAAO,CAAC;IACtC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,aAAa,CAAC;CACxB,CAAC,CAAC;AAEH,oBAAY,gBAAgB,CAAC,OAAO,IAAI,OAAO,CAAC;IAC9C;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;CACjB,CAAC,CAAC"}

package/dist/algoliasearch/jest.config.d.ts

@@ -0,0 +1,4 @@
+import type { Config } from '@jest/types';
+declare const config: Config.InitialOptions;
+export default config;
+//# sourceMappingURL=jest.config.d.ts.map

package/dist/algoliasearch/jest.config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"jest.config.d.ts","sourceRoot":"","sources":["../../jest.config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAE1C,QAAA,MAAM,MAAM,EAAE,MAAM,CAAC,cAKpB,CAAC;AAEF,eAAe,MAAM,CAAC"}

package/dist/algoliasearch.cjs.js

@@ -6,7 +6,7 @@ var clientCommon = require('@algolia/client-common');
 var requesterNodeHttp = require('@algolia/requester-node-http');
 
 // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
-const apiClientVersion$4 = '5.0.0-alpha.4';
+const apiClientVersion$4 = '5.0.0-alpha.41';
 const REGIONS$2 = ['de', 'us'];
 function getDefaultHosts$3(region) {
     const url = !region
@@ -200,7 +200,7 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          * @param listABTests.limit - Number of records to return. Limit is the size of the page.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
-        listABTests({ offset, limit }, requestOptions) {
+        listABTests({ offset, limit } = {}, requestOptions = undefined) {
             const requestPath = '/2/abtests';
             const headers = {};
             const queryParameters = {};
@@ -297,7 +297,7 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
 }
 
 // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
-const apiClientVersion$3 = '5.0.0-alpha.4';
+const apiClientVersion$3 = '5.0.0-alpha.41';
 const REGIONS$1 = ['de', 'us'];
 function getDefaultHosts$2(region) {
     const url = !region
@@ -1194,7 +1194,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
 }
 
 // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
-const apiClientVersion$2 = '5.0.0-alpha.4';
+const apiClientVersion$2 = '5.0.0-alpha.41';
 const REGIONS = ['eu', 'us'];
 function getDefaultHosts$1(region) {
     const url = 'personalization.{region}.algolia.com'.replace('{region}', region);
@@ -1451,7 +1451,7 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
 }
 
 // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
-const apiClientVersion$1 = '5.0.0-alpha.4';
+const apiClientVersion$1 = '5.0.0-alpha.41';
 function getDefaultHosts(appId) {
     return [
         {
@@ -1614,19 +1614,19 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * @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({ indexName, browseRequest, ...browseObjectsOptions }, requestOptions) {
+        browseObjects({ indexName, browseParams, ...browseObjectsOptions }, requestOptions) {
             return clientCommon.createIterablePromise({
                 func: (previousResponse) => {
                     return this.browse({
                         indexName,
-                        browseRequest: {
+                        browseParams: {
                             cursor: previousResponse ? previousResponse.cursor : undefined,
-                            ...browseRequest,
+                            ...browseParams,
                         },
                     }, requestOptions);
                 },
@@ -1641,7 +1641,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * @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.
          */
@@ -1672,7 +1672,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * @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.
          */
@@ -1828,6 +1828,9 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
             if (!batchWriteParams) {
                 throw new Error('Parameter `batchWriteParams` is required when calling `batch`.');
             }
+            if (!batchWriteParams.requests) {
+                throw new Error('Parameter `batchWriteParams.requests` is required when calling `batch`.');
+            }
             const requestPath = '/1/indexes/{indexName}/batch'.replace('{indexName}', encodeURIComponent(indexName));
             const headers = {};
             const queryParameters = {};
@@ -1914,10 +1917,10 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * @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({ indexName, browseRequest }, requestOptions) {
+        browse({ indexName, browseParams }, requestOptions) {
             if (!indexName) {
                 throw new Error('Parameter `indexName` is required when calling `browse`.');
             }
@@ -1929,7 +1932,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
                 path: requestPath,
                 queryParameters,
                 headers,
-                data: browseRequest ? browseRequest : {},
+                data: browseParams ? browseParams : {},
             };
             return transporter.request(request, requestOptions);
         },
@@ -2063,15 +2066,15 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * @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 }, requestOptions) {
+        deleteBy({ indexName, deleteByParams }, requestOptions) {
             if (!indexName) {
                 throw new Error('Parameter `indexName` is required when calling `deleteBy`.');
             }
-            if (!searchParams) {
-                throw new Error('Parameter `searchParams` is required when calling `deleteBy`.');
+            if (!deleteByParams) {
+                throw new Error('Parameter `deleteByParams` is required when calling `deleteBy`.');
             }
             const requestPath = '/1/indexes/{indexName}/deleteByQuery'.replace('{indexName}', encodeURIComponent(indexName));
             const headers = {};
@@ -2081,7 +2084,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
                 path: requestPath,
                 queryParameters,
                 headers,
-                data: searchParams,
+                data: deleteByParams,
             };
             return transporter.request(request, requestOptions);
         },
@@ -2320,7 +2323,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * @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 }, requestOptions) {
+        getLogs({ offset, length, indexName, type } = {}, requestOptions = undefined) {
             const requestPath = '/1/logs';
             const headers = {};
             const queryParameters = {};
@@ -2582,7 +2585,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * @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 }, requestOptions) {
+        hasPendingMappings({ getClusters } = {}, requestOptions = undefined) {
             const requestPath = '/1/clusters/mapping/pending';
             const headers = {};
             const queryParameters = {};
@@ -2641,7 +2644,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * @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 }, requestOptions) {
+        listIndices({ page } = {}, requestOptions = undefined) {
             const requestPath = '/1/indexes';
             const headers = {};
             const queryParameters = {};
@@ -2665,7 +2668,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * @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 }, requestOptions) {
+        listUserIds({ page, hitsPerPage } = {}, requestOptions = undefined) {
             const requestPath = '/1/clusters/mapping';
             const headers = {};
             const queryParameters = {};
@@ -2750,19 +2753,19 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * @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, }, requestOptions) {
+        partialUpdateObject({ indexName, objectID, attributesToUpdate, createIfNotExists, }, requestOptions) {
             if (!indexName) {
                 throw new Error('Parameter `indexName` is required when calling `partialUpdateObject`.');
             }
             if (!objectID) {
                 throw new Error('Parameter `objectID` is required when calling `partialUpdateObject`.');
             }
-            if (!attributeToUpdate) {
-                throw new Error('Parameter `attributeToUpdate` is required when calling `partialUpdateObject`.');
+            if (!attributesToUpdate) {
+                throw new Error('Parameter `attributesToUpdate` is required when calling `partialUpdateObject`.');
             }
             const requestPath = '/1/indexes/{indexName}/{objectID}/partial'
                 .replace('{indexName}', encodeURIComponent(indexName))
@@ -2777,7 +2780,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
                 path: requestPath,
                 queryParameters,
                 headers,
-                data: attributeToUpdate,
+                data: attributesToUpdate,
             };
             return transporter.request(request, requestOptions);
         },
@@ -2978,17 +2981,17 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * @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, }, requestOptions) {
+        saveRules({ indexName, rules, forwardToReplicas, clearExistingRules, }, requestOptions) {
             if (!indexName) {
                 throw new Error('Parameter `indexName` is required when calling `saveRules`.');
             }
-            if (!rule) {
-                throw new Error('Parameter `rule` is required when calling `saveRules`.');
+            if (!rules) {
+                throw new Error('Parameter `rules` is required when calling `saveRules`.');
             }
             const requestPath = '/1/indexes/{indexName}/rules/batch'.replace('{indexName}', encodeURIComponent(indexName));
             const headers = {};
@@ -3004,7 +3007,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
                 path: requestPath,
                 queryParameters,
                 headers,
-                data: rule,
+                data: rules,
             };
             return transporter.request(request, requestOptions);
         },
@@ -3465,13 +3468,11 @@ function algoliasearch(appId, apiKey, options) {
         });
     }
     function initPersonalization(initOptions) {
-        if (!initOptions.region) {
-            throw new Error('`region` is missing.');
-        }
-        if (initOptions.region &&
-            (typeof initOptions.region !== 'string' ||
-                !REGIONS.includes(initOptions.region))) {
-            throw new Error(`\`region\` must be one of the following: ${REGIONS.join(', ')}`);
+        if (!initOptions.region ||
+            (initOptions.region &&
+                (typeof initOptions.region !== 'string' ||
+                    !REGIONS.includes(initOptions.region)))) {
+            throw new Error(`\`region\` is required and must be one of the following: ${REGIONS.join(', ')}`);
         }
         return createPersonalizationClient({
             ...commonOptions,