algoliasearch 5.0.0-alpha.6 → 5.0.0-alpha.9

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/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.6';
+const apiClientVersion$4 = '5.0.0-alpha.9';
 const REGIONS$2 = ['de', 'us'];
 function getDefaultHosts$3(region) {
     const url = !region
@@ -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.6';
+const apiClientVersion$3 = '5.0.0-alpha.9';
 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.6';
+const apiClientVersion$2 = '5.0.0-alpha.9';
 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.6';
+const apiClientVersion$1 = '5.0.0-alpha.9';
 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.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);
                 },
@@ -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);
         },
@@ -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,

package/dist/algoliasearch.esm.browser.js

@@ -472,13 +472,15 @@ function createTransporter({
     const dataQueryParameters = request.method === 'GET' ? { ...request.data,
       ...requestOptions.data
     } : {};
-    const queryParameters = {
-      'x-algolia-agent': algoliaAgent.value,
-      ...baseQueryParameters,
+    const queryParameters = { ...baseQueryParameters,
       ...request.queryParameters,
       ...dataQueryParameters
     };
 
+    if (algoliaAgent.value) {
+      queryParameters['x-algolia-agent'] = algoliaAgent.value;
+    }
+
     if (requestOptions && requestOptions.queryParameters) {
       for (const key of Object.keys(requestOptions.queryParameters)) {
         // We want to keep `undefined` and `null` values,
@@ -715,7 +717,7 @@ const DEFAULT_READ_TIMEOUT_BROWSER = 2000;
 const DEFAULT_WRITE_TIMEOUT_BROWSER = 30000;
 
 // 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.6';
+const apiClientVersion$4 = '5.0.0-alpha.9';
 const REGIONS$2 = ['de', 'us'];
 function getDefaultHosts$3(region) {
     const url = !region
@@ -1006,7 +1008,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.6';
+const apiClientVersion$3 = '5.0.0-alpha.9';
 const REGIONS$1 = ['de', 'us'];
 function getDefaultHosts$2(region) {
     const url = !region
@@ -1903,7 +1905,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.6';
+const apiClientVersion$2 = '5.0.0-alpha.9';
 const REGIONS = ['eu', 'us'];
 function getDefaultHosts$1(region) {
     const url = 'personalization.{region}.algolia.com'.replace('{region}', region);
@@ -2160,7 +2162,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.6';
+const apiClientVersion$1 = '5.0.0-alpha.9';
 function getDefaultHosts(appId) {
     return [
         {
@@ -2323,19 +2325,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.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 createIterablePromise({
                 func: (previousResponse) => {
                     return this.browse({
                         indexName,
-                        browseRequest: {
+                        browseParams: {
                             cursor: previousResponse ? previousResponse.cursor : undefined,
-                            ...browseRequest,
+                            ...browseParams,
                         },
                     }, requestOptions);
                 },
@@ -2537,6 +2539,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 = {};
@@ -2623,10 +2628,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`.');
             }
@@ -2638,7 +2643,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
                 path: requestPath,
                 queryParameters,
                 headers,
-                data: browseRequest ? browseRequest : {},
+                data: browseParams ? browseParams : {},
             };
             return transporter.request(request, requestOptions);
         },
@@ -4232,13 +4237,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,

package/dist/algoliasearch.esm.node.js

@@ -2,7 +2,7 @@ import { createAuth, createTransporter, getAlgoliaAgent, createIterablePromise,
 import { createHttpRequester } from '@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.6';
+const apiClientVersion$4 = '5.0.0-alpha.9';
 const REGIONS$2 = ['de', 'us'];
 function getDefaultHosts$3(region) {
     const url = !region
@@ -293,7 +293,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.6';
+const apiClientVersion$3 = '5.0.0-alpha.9';
 const REGIONS$1 = ['de', 'us'];
 function getDefaultHosts$2(region) {
     const url = !region
@@ -1190,7 +1190,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.6';
+const apiClientVersion$2 = '5.0.0-alpha.9';
 const REGIONS = ['eu', 'us'];
 function getDefaultHosts$1(region) {
     const url = 'personalization.{region}.algolia.com'.replace('{region}', region);
@@ -1447,7 +1447,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.6';
+const apiClientVersion$1 = '5.0.0-alpha.9';
 function getDefaultHosts(appId) {
     return [
         {
@@ -1610,19 +1610,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.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 createIterablePromise({
                 func: (previousResponse) => {
                     return this.browse({
                         indexName,
-                        browseRequest: {
+                        browseParams: {
                             cursor: previousResponse ? previousResponse.cursor : undefined,
-                            ...browseRequest,
+                            ...browseParams,
                         },
                     }, requestOptions);
                 },
@@ -1824,6 +1824,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 = {};
@@ -1910,10 +1913,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`.');
             }
@@ -1925,7 +1928,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
                 path: requestPath,
                 queryParameters,
                 headers,
-                data: browseRequest ? browseRequest : {},
+                data: browseParams ? browseParams : {},
             };
             return transporter.request(request, requestOptions);
         },
@@ -3461,13 +3464,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,