algoliasearch 5.0.0-alpha.3 → 5.0.0-alpha.31

package/dist/algoliasearch.esm.node.js

@@ -1,8 +1,8 @@
-import { createAuth, createTransporter, getAlgoliaAgent, createRetryablePromise, shuffle, DEFAULT_CONNECT_TIMEOUT_NODE, DEFAULT_READ_TIMEOUT_NODE, DEFAULT_WRITE_TIMEOUT_NODE, createNullCache, createMemoryCache } from '@algolia/client-common';
+import { createAuth, createTransporter, getAlgoliaAgent, createIterablePromise, shuffle, DEFAULT_CONNECT_TIMEOUT_NODE, DEFAULT_READ_TIMEOUT_NODE, DEFAULT_WRITE_TIMEOUT_NODE, createNullCache, createMemoryCache } from '@algolia/client-common';
 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.3';
+const apiClientVersion$4 = '5.0.0-alpha.31';
 const REGIONS$2 = ['de', 'us'];
 function getDefaultHosts$3(region) {
     const url = !region
@@ -33,6 +33,19 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
     });
     return {
         transporter,
+        /**
+         * The `appId` currently in use.
+         */
+        appId: appIdOption,
+        /**
+         * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
+         */
+        clearCache() {
+            return Promise.all([
+                transporter.requestsCache.clear(),
+                transporter.responsesCache.clear(),
+            ]).then(() => undefined);
+        },
         /**
          * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
          */
@@ -183,7 +196,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 = {};
@@ -280,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.3';
+const apiClientVersion$3 = '5.0.0-alpha.31';
 const REGIONS$1 = ['de', 'us'];
 function getDefaultHosts$2(region) {
     const url = !region
@@ -311,6 +324,19 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
     });
     return {
         transporter,
+        /**
+         * The `appId` currently in use.
+         */
+        appId: appIdOption,
+        /**
+         * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
+         */
+        clearCache() {
+            return Promise.all([
+                transporter.requestsCache.clear(),
+                transporter.responsesCache.clear(),
+            ]).then(() => undefined);
+        },
         /**
          * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
          */
@@ -1164,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.3';
+const apiClientVersion$2 = '5.0.0-alpha.31';
 const REGIONS = ['eu', 'us'];
 function getDefaultHosts$1(region) {
     const url = 'personalization.{region}.algolia.com'.replace('{region}', region);
@@ -1193,6 +1219,19 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
     });
     return {
         transporter,
+        /**
+         * The `appId` currently in use.
+         */
+        appId: appIdOption,
+        /**
+         * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
+         */
+        clearCache() {
+            return Promise.all([
+                transporter.requestsCache.clear(),
+                transporter.responsesCache.clear(),
+            ]).then(() => undefined);
+        },
         /**
          * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
          */
@@ -1408,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.3';
+const apiClientVersion$1 = '5.0.0-alpha.31';
 function getDefaultHosts(appId) {
     return [
         {
@@ -1462,6 +1501,19 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
     });
     return {
         transporter,
+        /**
+         * The `appId` currently in use.
+         */
+        appId: appIdOption,
+        /**
+         * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
+         */
+        clearCache() {
+            return Promise.all([
+                transporter.requestsCache.clear(),
+                transporter.responsesCache.clear(),
+            ]).then(() => undefined);
+        },
         /**
          * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
          */
@@ -1478,38 +1530,57 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
             transporter.algoliaAgent.add({ segment, version });
         },
         /**
-         * Helper: Wait for a task to complete with `indexName` and `taskID`.
+         * Helper: Wait for a task to be published (completed) for a given `indexName` and `taskID`.
          *
-         * @summary Wait for a task to complete.
+         * @summary Helper method that waits for a task to be published (completed).
          * @param waitForTaskOptions - The waitForTaskOptions object.
          * @param waitForTaskOptions.indexName - The `indexName` where the operation was performed.
          * @param waitForTaskOptions.taskID - The `taskID` returned in the method response.
+         * @param waitForTaskOptions.maxRetries - The maximum number of retries. 50 by default.
+         * @param waitForTaskOptions.timeout - The function to decide how long to wait between retries.
          * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `getTask` method and merged with the transporter requestOptions.
          */
-        waitForTask({ indexName, taskID, ...createRetryablePromiseOptions }, requestOptions) {
-            return createRetryablePromise({
-                ...createRetryablePromiseOptions,
+        waitForTask({ indexName, taskID, maxRetries = 50, timeout = (retryCount) => Math.min(retryCount * 200, 5000), }, requestOptions) {
+            let retryCount = 0;
+            return createIterablePromise({
                 func: () => this.getTask({ indexName, taskID }, requestOptions),
                 validate: (response) => response.status === 'published',
+                aggregator: () => (retryCount += 1),
+                error: {
+                    validate: () => retryCount >= maxRetries,
+                    message: () => `The maximum number of retries exceeded. (${retryCount}/${maxRetries})`,
+                },
+                timeout: () => timeout(retryCount),
             });
         },
         /**
          * Helper: Wait for an API key to be added, updated or deleted based on a given `operation`.
          *
-         * @summary Wait for an API key task to be processed.
+         * @summary Helper method that waits for an API key task to be processed.
          * @param waitForApiKeyOptions - The waitForApiKeyOptions object.
          * @param waitForApiKeyOptions.operation - The `operation` that was done on a `key`.
          * @param waitForApiKeyOptions.key - The `key` that has been added, deleted or updated.
          * @param waitForApiKeyOptions.apiKey - Necessary to know if an `update` operation has been processed, compare fields of the response with it.
+         * @param waitForApiKeyOptions.maxRetries - The maximum number of retries. 50 by default.
+         * @param waitForApiKeyOptions.timeout - The function to decide how long to wait between retries.
          * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `getApikey` method and merged with the transporter requestOptions.
          */
-        waitForApiKey({ operation, key, apiKey, ...createRetryablePromiseOptions }, requestOptions) {
+        waitForApiKey({ operation, key, apiKey, maxRetries = 50, timeout = (retryCount) => Math.min(retryCount * 200, 5000), }, requestOptions) {
+            let retryCount = 0;
+            const baseIteratorOptions = {
+                aggregator: () => (retryCount += 1),
+                error: {
+                    validate: () => retryCount >= maxRetries,
+                    message: () => `The maximum number of retries exceeded. (${retryCount}/${maxRetries})`,
+                },
+                timeout: () => timeout(retryCount),
+            };
             if (operation === 'update') {
                 if (!apiKey) {
                     throw new Error('`apiKey` is required when waiting for an `update` operation.');
                 }
-                return createRetryablePromise({
-                    ...createRetryablePromiseOptions,
+                return createIterablePromise({
+                    ...baseIteratorOptions,
                     func: () => this.getApiKey({ key }, requestOptions),
                     validate: (response) => {
                         for (const field of Object.keys(apiKey)) {
@@ -1527,12 +1598,99 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
                     },
                 });
             }
-            return createRetryablePromise({
-                ...createRetryablePromiseOptions,
+            return createIterablePromise({
+                ...baseIteratorOptions,
                 func: () => this.getApiKey({ key }, requestOptions).catch((error) => error),
                 validate: (error) => operation === 'add' ? error.status !== 404 : error.status === 404,
             });
         },
+        /**
+         * Helper: Iterate on the `browse` method of the client to allow aggregating objects of an index.
+         *
+         * @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.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, browseParams, ...browseObjectsOptions }, requestOptions) {
+            return createIterablePromise({
+                func: (previousResponse) => {
+                    return this.browse({
+                        indexName,
+                        browseParams: {
+                            cursor: previousResponse ? previousResponse.cursor : undefined,
+                            ...browseParams,
+                        },
+                    }, requestOptions);
+                },
+                validate: (response) => response.cursor === undefined,
+                ...browseObjectsOptions,
+            });
+        },
+        /**
+         * Helper: Iterate on the `searchRules` method of the client to allow aggregating rules of an index.
+         *
+         * @summary Helper method that iterates on the `searchRules` method.
+         * @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. 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.
+         */
+        browseRules({ indexName, searchRulesParams, ...browseRulesOptions }, requestOptions) {
+            const params = {
+                hitsPerPage: 1000,
+                ...searchRulesParams,
+            };
+            return createIterablePromise({
+                func: (previousResponse) => {
+                    return this.searchRules({
+                        indexName,
+                        searchRulesParams: {
+                            ...params,
+                            page: previousResponse
+                                ? previousResponse.page + 1
+                                : params.page || 0,
+                        },
+                    }, requestOptions);
+                },
+                validate: (response) => response.nbHits < params.hitsPerPage,
+                ...browseRulesOptions,
+            });
+        },
+        /**
+         * Helper: Iterate on the `searchSynonyms` method of the client to allow aggregating rules of an index.
+         *
+         * @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. 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.
+         */
+        browseSynonyms({ indexName, validate, aggregator, ...browseSynonymsOptions }, requestOptions) {
+            const params = {
+                hitsPerPage: 1000,
+                ...browseSynonymsOptions,
+            };
+            return createIterablePromise({
+                func: (previousResponse) => {
+                    return this.searchSynonyms({
+                        ...params,
+                        indexName,
+                        page: previousResponse
+                            ? previousResponse.page + 1
+                            : browseSynonymsOptions.page || 0,
+                    }, requestOptions);
+                },
+                validate: (response) => response.nbHits < params.hitsPerPage,
+                ...browseSynonymsOptions,
+            });
+        },
         /**
          * Add a new API Key with specific permissions/restrictions.
          *
@@ -1666,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 = {};
@@ -1752,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`.');
             }
@@ -1767,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);
         },
@@ -1901,15 +2062,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 = {};
@@ -1919,7 +2080,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
                 path: requestPath,
                 queryParameters,
                 headers,
-                data: searchParams,
+                data: deleteByParams,
             };
             return transporter.request(request, requestOptions);
         },
@@ -2158,7 +2319,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 = {};
@@ -2226,6 +2387,9 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
             if (!getObjectsParams) {
                 throw new Error('Parameter `getObjectsParams` is required when calling `getObjects`.');
             }
+            if (!getObjectsParams.requests) {
+                throw new Error('Parameter `getObjectsParams.requests` is required when calling `getObjects`.');
+            }
             const requestPath = '/1/indexes/*/objects';
             const headers = {};
             const queryParameters = {};
@@ -2417,7 +2581,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 = {};
@@ -2476,7 +2640,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 = {};
@@ -2500,7 +2664,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 = {};
@@ -2529,6 +2693,9 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
             if (!batchParams) {
                 throw new Error('Parameter `batchParams` is required when calling `multipleBatch`.');
             }
+            if (!batchParams.requests) {
+                throw new Error('Parameter `batchParams.requests` is required when calling `multipleBatch`.');
+            }
             const requestPath = '/1/indexes/*/batch';
             const headers = {};
             const queryParameters = {};
@@ -2582,19 +2749,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.attributeOrBuiltInOperation - 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, attributeOrBuiltInOperation, 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 (!attributeOrBuiltInOperation) {
-                throw new Error('Parameter `attributeOrBuiltInOperation` 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))
@@ -2609,7 +2776,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
                 path: requestPath,
                 queryParameters,
                 headers,
-                data: attributeOrBuiltInOperation,
+                data: attributesToUpdate,
             };
             return transporter.request(request, requestOptions);
         },
@@ -2810,17 +2977,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 = {};
@@ -2836,7 +3003,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
                 path: requestPath,
                 queryParameters,
                 headers,
-                data: rule,
+                data: rules,
             };
             return transporter.request(request, requestOptions);
         },
@@ -3047,9 +3214,6 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
             if (!indexName) {
                 throw new Error('Parameter `indexName` is required when calling `searchRules`.');
             }
-            if (!searchRulesParams) {
-                throw new Error('Parameter `searchRulesParams` is required when calling `searchRules`.');
-            }
             const requestPath = '/1/indexes/{indexName}/rules/search'.replace('{indexName}', encodeURIComponent(indexName));
             const headers = {};
             const queryParameters = {};
@@ -3058,7 +3222,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
                 path: requestPath,
                 queryParameters,
                 headers,
-                data: searchRulesParams,
+                data: searchRulesParams ? searchRulesParams : {},
                 useReadTransporter: true,
                 cacheable: true,
             };
@@ -3300,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,