algoliasearch 5.1.1 → 5.2.1

package/dist/algoliasearch.cjs

@@ -5,12 +5,10 @@ var clientCommon = require('@algolia/client-common');
 var requesterNodeHttp = require('@algolia/requester-node-http');
 
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-const apiClientVersion$5 = '5.1.1';
+const apiClientVersion$5 = '5.2.1';
 const REGIONS$2 = ['de', 'us'];
 function getDefaultHosts$4(region) {
-    const url = !region
-        ? 'analytics.algolia.com'
-        : 'analytics.{region}.algolia.com'.replace('{region}', region);
+    const url = !region ? 'analytics.algolia.com' : 'analytics.{region}.algolia.com'.replace('{region}', region);
     return [{ url, accept: 'readWrite', protocol: 'https' }];
 }
 // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
@@ -44,10 +42,7 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
          */
         clearCache() {
-            return Promise.all([
-                transporter.requestsCache.clear(),
-                transporter.responsesCache.clear(),
-            ]).then(() => undefined);
+            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.
@@ -347,12 +342,10 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
 }
 
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-const apiClientVersion$4 = '5.1.1';
+const apiClientVersion$4 = '5.2.1';
 const REGIONS$1 = ['de', 'us'];
 function getDefaultHosts$3(region) {
-    const url = !region
-        ? 'analytics.algolia.com'
-        : 'analytics.{region}.algolia.com'.replace('{region}', region);
+    const url = !region ? 'analytics.algolia.com' : 'analytics.{region}.algolia.com'.replace('{region}', region);
     return [{ url, accept: 'readWrite', protocol: 'https' }];
 }
 // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
@@ -386,10 +379,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
          */
         clearCache() {
-            return Promise.all([
-                transporter.requestsCache.clear(),
-                transporter.responsesCache.clear(),
-            ]).then(() => undefined);
+            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.
@@ -917,7 +907,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          * @param getSearchesNoClicks.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
-        getSearchesNoClicks({ index, startDate, endDate, limit, offset, tags, }, requestOptions) {
+        getSearchesNoClicks({ index, startDate, endDate, limit, offset, tags }, requestOptions) {
             if (!index) {
                 throw new Error('Parameter `index` is required when calling `getSearchesNoClicks`.');
             }
@@ -965,7 +955,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          * @param getSearchesNoResults.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
-        getSearchesNoResults({ index, startDate, endDate, limit, offset, tags, }, requestOptions) {
+        getSearchesNoResults({ index, startDate, endDate, limit, offset, tags }, requestOptions) {
             if (!index) {
                 throw new Error('Parameter `index` is required when calling `getSearchesNoResults`.');
             }
@@ -1090,7 +1080,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          * @param getTopFilterAttributes.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
-        getTopFilterAttributes({ index, search, startDate, endDate, limit, offset, tags, }, requestOptions) {
+        getTopFilterAttributes({ index, search, startDate, endDate, limit, offset, tags }, requestOptions) {
             if (!index) {
                 throw new Error('Parameter `index` is required when calling `getTopFilterAttributes`.');
             }
@@ -1143,7 +1133,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          * @param getTopFilterForAttribute.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
-        getTopFilterForAttribute({ attribute, index, search, startDate, endDate, limit, offset, tags, }, requestOptions) {
+        getTopFilterForAttribute({ attribute, index, search, startDate, endDate, limit, offset, tags }, requestOptions) {
             if (!attribute) {
                 throw new Error('Parameter `attribute` is required when calling `getTopFilterForAttribute`.');
             }
@@ -1198,7 +1188,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          * @param getTopFiltersNoResults.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
-        getTopFiltersNoResults({ index, search, startDate, endDate, limit, offset, tags, }, requestOptions) {
+        getTopFiltersNoResults({ index, search, startDate, endDate, limit, offset, tags }, requestOptions) {
             if (!index) {
                 throw new Error('Parameter `index` is required when calling `getTopFiltersNoResults`.');
             }
@@ -1252,7 +1242,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          * @param getTopHits.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
-        getTopHits({ index, search, clickAnalytics, revenueAnalytics, startDate, endDate, limit, offset, tags, }, requestOptions) {
+        getTopHits({ index, search, clickAnalytics, revenueAnalytics, startDate, endDate, limit, offset, tags }, requestOptions) {
             if (!index) {
                 throw new Error('Parameter `index` is required when calling `getTopHits`.');
             }
@@ -1402,7 +1392,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
 }
 
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-const apiClientVersion$3 = '5.1.1';
+const apiClientVersion$3 = '5.2.1';
 const REGIONS = ['eu', 'us'];
 function getDefaultHosts$2(region) {
     const url = 'personalization.{region}.algolia.com'.replace('{region}', region);
@@ -1439,10 +1429,7 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
          * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
          */
         clearCache() {
-            return Promise.all([
-                transporter.requestsCache.clear(),
-                transporter.responsesCache.clear(),
-            ]).then(() => undefined);
+            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.
@@ -1663,7 +1650,7 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
 }
 
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-const apiClientVersion$2 = '5.1.1';
+const apiClientVersion$2 = '5.2.1';
 function getDefaultHosts$1(appId) {
     return [
         {
@@ -1725,10 +1712,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
          */
         clearCache() {
-            return Promise.all([
-                transporter.requestsCache.clear(),
-                transporter.responsesCache.clear(),
-            ]).then(() => undefined);
+            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.
@@ -1826,8 +1810,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
                             const value = apiKey[field];
                             const resValue = response[field];
                             if (Array.isArray(value) && Array.isArray(resValue)) {
-                                if (value.length !== resValue.length ||
-                                    value.some((v, index) => v !== resValue[index])) {
+                                if (value.length !== resValue.length || value.some((v, index) => v !== resValue[index])) {
                                     return false;
                                 }
                             }
@@ -1847,7 +1830,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
                     }
                     throw error;
                 }),
-                validate: (response) => operation === 'add' ? response !== undefined : response === undefined,
+                validate: (response) => (operation === 'add' ? response !== undefined : response === undefined),
             });
         },
         /**
@@ -1898,9 +1881,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
                         indexName,
                         searchRulesParams: {
                             ...params,
-                            page: previousResponse
-                                ? previousResponse.page + 1
-                                : params.page || 0,
+                            page: previousResponse ? previousResponse.page + 1 : params.page || 0,
                         },
                     }, requestOptions);
                 },
@@ -1953,7 +1934,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * @param chunkedBatch.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
          * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `getTask` method and merged with the transporter requestOptions.
          */
-        async chunkedBatch({ indexName, objects, action = 'addObject', waitForTasks, batchSize = 1000, }, requestOptions) {
+        async chunkedBatch({ indexName, objects, action = 'addObject', waitForTasks, batchSize = 1000 }, requestOptions) {
             let requests = [];
             const responses = [];
             const objectEntries = objects.entries();
@@ -2013,9 +1994,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
             return await this.chunkedBatch({
                 indexName,
                 objects,
-                action: createIfNotExists
-                    ? 'partialUpdateObject'
-                    : 'partialUpdateObjectNoCreate',
+                action: createIfNotExists ? 'partialUpdateObject' : 'partialUpdateObjectNoCreate',
             }, requestOptions);
         },
         /**
@@ -2297,7 +2276,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * @param batchDictionaryEntries.batchDictionaryEntriesParams - The batchDictionaryEntriesParams object.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
-        batchDictionaryEntries({ dictionaryName, batchDictionaryEntriesParams, }, requestOptions) {
+        batchDictionaryEntries({ dictionaryName, batchDictionaryEntriesParams }, requestOptions) {
             if (!dictionaryName) {
                 throw new Error('Parameter `dictionaryName` is required when calling `batchDictionaryEntries`.');
             }
@@ -3288,7 +3267,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
             return transporter.request(request, requestOptions);
         },
         /**
-         * Adds new attributes to a record, or update existing ones.  - If a record with the specified object ID doesn\'t exist,   a new record is added to the index **if** `createIfNotExists` is true. - If the index doesn\'t exist yet, this method creates a new index. - You can use any first-level attribute but not nested attributes.   If you specify a nested attribute, the engine treats it as a replacement for its first-level ancestor.
+         * Adds new attributes to a record, or update existing ones.  - If a record with the specified object ID doesn\'t exist,   a new record is added to the index **if** `createIfNotExists` is true. - If the index doesn\'t exist yet, this method creates a new index. - You can use any first-level attribute but not nested attributes.   If you specify a nested attribute, the engine treats it as a replacement for its first-level ancestor.  To update an attribute without pushing the entire record, you can use these built-in operations. These operations can be helpful if you don\'t have access to your initial data.  - Increment: increment a numeric attribute - Decrement: decrement a numeric attribute - Add: append a number or string element to an array attribute - Remove: remove all matching number or string elements from an array attribute made of numbers or strings - AddUnique: add a number or string element to an array attribute made of numbers or strings only if it\'s not already present - IncrementFrom: increment a numeric integer attribute only if the provided value matches the current value, and otherwise ignore the whole object update. For example, if you pass an IncrementFrom value of 2 for the version attribute, but the current value of the attribute is 1, the engine ignores the update. If the object doesn\'t exist, the engine only creates it if you pass an IncrementFrom value of 0. - IncrementSet: increment a numeric integer attribute only if the provided value is greater than the current value, and otherwise ignore the whole object update. For example, if you pass an IncrementSet value of 2 for the version attribute, and the current value of the attribute is 1, the engine updates the object. If the object doesn\'t exist yet, the engine only creates it if you pass an IncrementSet value that\'s greater than 0.  You can specify an operation by providing an object with the attribute to update as the key and its value being an object with the following properties:  - _operation: the operation to apply on the attribute - value: the right-hand side argument to the operation, for example, increment or decrement step, value to add or remove.
          *
          * Required API Key ACLs:
          * - addObject.
@@ -3300,7 +3279,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * @param partialUpdateObject.createIfNotExists - Whether to create a new record if it doesn\'t exist.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
-        partialUpdateObject({ indexName, objectID, attributesToUpdate, createIfNotExists, }, requestOptions) {
+        partialUpdateObject({ indexName, objectID, attributesToUpdate, createIfNotExists }, requestOptions) {
             if (!indexName) {
                 throw new Error('Parameter `indexName` is required when calling `partialUpdateObject`.');
             }
@@ -3489,7 +3468,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * @param saveRules.clearExistingRules - Whether existing rules should be deleted before adding this batch.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
-        saveRules({ indexName, rules, forwardToReplicas, clearExistingRules, }, requestOptions) {
+        saveRules({ indexName, rules, forwardToReplicas, clearExistingRules }, requestOptions) {
             if (!indexName) {
                 throw new Error('Parameter `indexName` is required when calling `saveRules`.');
             }
@@ -3573,7 +3552,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * @param saveSynonyms.replaceExistingSynonyms - Whether to replace all synonyms in the index with the ones sent with this request.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
-        saveSynonyms({ indexName, synonymHit, forwardToReplicas, replaceExistingSynonyms, }, requestOptions) {
+        saveSynonyms({ indexName, synonymHit, forwardToReplicas, replaceExistingSynonyms }, requestOptions) {
             if (!indexName) {
                 throw new Error('Parameter `indexName` is required when calling `saveSynonyms`.');
             }
@@ -3587,8 +3566,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
                 queryParameters.forwardToReplicas = forwardToReplicas.toString();
             }
             if (replaceExistingSynonyms !== undefined) {
-                queryParameters.replaceExistingSynonyms =
-                    replaceExistingSynonyms.toString();
+                queryParameters.replaceExistingSynonyms = replaceExistingSynonyms.toString();
             }
             const request = {
                 method: 'POST',
@@ -3662,7 +3640,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * @param searchDictionaryEntries.searchDictionaryEntriesParams - The searchDictionaryEntriesParams object.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
-        searchDictionaryEntries({ dictionaryName, searchDictionaryEntriesParams, }, requestOptions) {
+        searchDictionaryEntries({ dictionaryName, searchDictionaryEntriesParams }, requestOptions) {
             if (!dictionaryName) {
                 throw new Error('Parameter `dictionaryName` is required when calling `searchDictionaryEntries`.');
             }
@@ -3698,7 +3676,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * @param searchForFacetValues.searchForFacetValuesRequest - The searchForFacetValuesRequest object.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
-        searchForFacetValues({ indexName, facetName, searchForFacetValuesRequest, }, requestOptions) {
+        searchForFacetValues({ indexName, facetName, searchForFacetValuesRequest }, requestOptions) {
             if (!indexName) {
                 throw new Error('Parameter `indexName` is required when calling `searchForFacetValues`.');
             }
@@ -3937,7 +3915,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
 }
 
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-const apiClientVersion$1 = '5.1.1';
+const apiClientVersion$1 = '5.2.1';
 function getDefaultHosts(appId) {
     return [
         {
@@ -3999,10 +3977,7 @@ function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
          */
         clearCache() {
-            return Promise.all([
-                transporter.requestsCache.clear(),
-                transporter.responsesCache.clear(),
-            ]).then(() => undefined);
+            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.
@@ -4272,7 +4247,7 @@ function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          * @param searchRecommendRules.searchRecommendRulesParams - The searchRecommendRulesParams object.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
-        searchRecommendRules({ indexName, model, searchRecommendRulesParams, }, requestOptions) {
+        searchRecommendRules({ indexName, model, searchRecommendRulesParams }, requestOptions) {
             if (!indexName) {
                 throw new Error('Parameter `indexName` is required when calling `searchRecommendRules`.');
             }
@@ -4332,8 +4307,7 @@ function algoliasearch(appId, apiKey, options) {
     }
     function initAnalytics(initOptions = {}) {
         if (initOptions.region &&
-            (typeof initOptions.region !== 'string' ||
-                !REGIONS$1.includes(initOptions.region))) {
+            (typeof initOptions.region !== 'string' || !REGIONS$1.includes(initOptions.region))) {
             throw new Error(`\`region\` must be one of the following: ${REGIONS$1.join(', ')}`);
         }
         return createAnalyticsClient({
@@ -4344,8 +4318,7 @@ function algoliasearch(appId, apiKey, options) {
     }
     function initAbtesting(initOptions = {}) {
         if (initOptions.region &&
-            (typeof initOptions.region !== 'string' ||
-                !REGIONS$2.includes(initOptions.region))) {
+            (typeof initOptions.region !== 'string' || !REGIONS$2.includes(initOptions.region))) {
             throw new Error(`\`region\` must be one of the following: ${REGIONS$2.join(', ')}`);
         }
         return createAbtestingClient({
@@ -4357,8 +4330,7 @@ function algoliasearch(appId, apiKey, options) {
     function initPersonalization(initOptions) {
         if (!initOptions.region ||
             (initOptions.region &&
-                (typeof initOptions.region !== 'string' ||
-                    !REGIONS.includes(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({
@@ -4387,7 +4359,7 @@ function algoliasearch(appId, apiKey, options) {
          * @param generateSecuredApiKey.parentApiKey - The base API key from which to generate the new secured one.
          * @param generateSecuredApiKey.restrictions - A set of properties defining the restrictions of the secured API key.
          */
-        generateSecuredApiKey({ parentApiKey, restrictions = {}, }) {
+        generateSecuredApiKey({ parentApiKey, restrictions = {} }) {
             let mergedRestrictions = restrictions;
             if (restrictions.searchParams) {
                 // merge searchParams with the root restrictions
@@ -4405,9 +4377,7 @@ function algoliasearch(appId, apiKey, options) {
                 return acc;
             }, {});
             const queryParameters = clientCommon.serializeQueryParameters(mergedRestrictions);
-            return Buffer.from(crypto.createHmac('sha256', parentApiKey)
-                .update(queryParameters)
-                .digest('hex') + queryParameters).toString('base64');
+            return Buffer.from(crypto.createHmac('sha256', parentApiKey).update(queryParameters).digest('hex') + queryParameters).toString('base64');
         },
         /**
          * Helper: Retrieves the remaining validity of the previous generated `securedApiKey`, the `ValidUntil` parameter must have been provided.
@@ -4416,7 +4386,7 @@ function algoliasearch(appId, apiKey, options) {
          * @param getSecuredApiKeyRemainingValidity - The `getSecuredApiKeyRemainingValidity` object.
          * @param getSecuredApiKeyRemainingValidity.securedApiKey - The secured API key generated with the `generateSecuredApiKey` method.
          */
-        getSecuredApiKeyRemainingValidity({ securedApiKey, }) {
+        getSecuredApiKeyRemainingValidity({ securedApiKey }) {
             const decodedString = Buffer.from(securedApiKey, 'base64').toString('ascii');
             const regex = /validUntil=(\d+)/;
             const match = decodedString.match(regex);