algoliasearch 5.0.0-alpha.104 → 5.0.0-alpha.105

package/builds/browser.ts

@@ -1,41 +1,35 @@
 // 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.
 
-import type {
-  Region as AbtestingRegion,
-  AbtestingClient,
-} from '@algolia/client-abtesting/src/abtestingClient';
+import type { AbtestingClient } from '@algolia/client-abtesting';
+import type { Region as AbtestingRegion } from '@algolia/client-abtesting/src/abtestingClient';
 import {
   createAbtestingClient,
   REGIONS as abtestingRegions,
 } from '@algolia/client-abtesting/src/abtestingClient';
-import type {
-  Region as AnalyticsRegion,
-  AnalyticsClient,
-} from '@algolia/client-analytics/src/analyticsClient';
+import type { AnalyticsClient } from '@algolia/client-analytics';
+import type { Region as AnalyticsRegion } from '@algolia/client-analytics/src/analyticsClient';
 import {
   createAnalyticsClient,
   REGIONS as analyticsRegions,
 } from '@algolia/client-analytics/src/analyticsClient';
+import type {
+  ClientOptions,
+  CreateClientOptions,
+} from '@algolia/client-common';
 import {
-  createMemoryCache,
-  createFallbackableCache,
-  createBrowserLocalStorageCache,
   DEFAULT_CONNECT_TIMEOUT_BROWSER,
   DEFAULT_READ_TIMEOUT_BROWSER,
   DEFAULT_WRITE_TIMEOUT_BROWSER,
+  createBrowserLocalStorageCache,
+  createFallbackableCache,
+  createMemoryCache,
 } from '@algolia/client-common';
-import type {
-  CreateClientOptions,
-  ClientOptions,
-} from '@algolia/client-common';
+import type { PersonalizationClient } from '@algolia/client-personalization';
+import type { Region as PersonalizationRegion } from '@algolia/client-personalization/src/personalizationClient';
 import {
   createPersonalizationClient,
   REGIONS as personalizationRegions,
 } from '@algolia/client-personalization/src/personalizationClient';
-import type {
-  Region as PersonalizationRegion,
-  PersonalizationClient,
-} from '@algolia/client-personalization/src/personalizationClient';
 import {
   createSearchClient,
   apiClientVersion as searchClientVersion,
@@ -66,7 +60,6 @@ export function algoliasearch(
   if (!apiKey || typeof apiKey !== 'string') {
     throw new Error('`apiKey` is missing.');
   }
-
   const commonOptions: CreateClientOptions = {
     apiKey,
     appId,

package/builds/node.ts

@@ -1,47 +1,49 @@
 // 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.
 
-import type {
-  Region as AbtestingRegion,
-  AbtestingClient,
-} from '@algolia/client-abtesting/src/abtestingClient';
+import { createHmac } from 'crypto';
+
+import type { AbtestingClient } from '@algolia/client-abtesting';
+import type { Region as AbtestingRegion } from '@algolia/client-abtesting/src/abtestingClient';
 import {
   createAbtestingClient,
   REGIONS as abtestingRegions,
 } from '@algolia/client-abtesting/src/abtestingClient';
-import type {
-  Region as AnalyticsRegion,
-  AnalyticsClient,
-} from '@algolia/client-analytics/src/analyticsClient';
+import type { AnalyticsClient } from '@algolia/client-analytics';
+import type { Region as AnalyticsRegion } from '@algolia/client-analytics/src/analyticsClient';
 import {
   createAnalyticsClient,
   REGIONS as analyticsRegions,
 } from '@algolia/client-analytics/src/analyticsClient';
+import type {
+  ClientOptions,
+  CreateClientOptions,
+} from '@algolia/client-common';
 import {
+  serializeQueryParameters,
   DEFAULT_CONNECT_TIMEOUT_NODE,
   DEFAULT_READ_TIMEOUT_NODE,
   DEFAULT_WRITE_TIMEOUT_NODE,
   createMemoryCache,
   createNullCache,
 } from '@algolia/client-common';
-import type {
-  CreateClientOptions,
-  ClientOptions,
-} from '@algolia/client-common';
+import type { PersonalizationClient } from '@algolia/client-personalization';
+import type { Region as PersonalizationRegion } from '@algolia/client-personalization/src/personalizationClient';
 import {
   createPersonalizationClient,
   REGIONS as personalizationRegions,
 } from '@algolia/client-personalization/src/personalizationClient';
-import type {
-  Region as PersonalizationRegion,
-  PersonalizationClient,
-} from '@algolia/client-personalization/src/personalizationClient';
 import {
   createSearchClient,
   apiClientVersion as searchClientVersion,
 } from '@algolia/client-search/src/searchClient';
 import { createHttpRequester } from '@algolia/requester-node-http';
 
-import type { InitClientOptions, InitClientRegion } from './models';
+import type {
+  InitClientOptions,
+  InitClientRegion,
+  GenerateSecuredApiKeyOptions,
+  GetSecuredApiKeyRemainingValidityOptions,
+} from './models';
 
 export * from './models';
 
@@ -65,7 +67,6 @@ export function algoliasearch(
   if (!apiKey || typeof apiKey !== 'string') {
     throw new Error('`apiKey` is missing.');
   }
-
   const commonOptions: CreateClientOptions = {
     apiKey,
     appId,
@@ -155,5 +156,47 @@ export function algoliasearch(
     initAnalytics,
     initPersonalization,
     initAbtesting,
+    /**
+     * Helper: Generates a secured API key based on the given `parentApiKey` and given `restrictions`.
+     *
+     * @summary Helper: Generates a secured API key based on the given `parentApiKey` and given `restrictions`.
+     * @param generateSecuredApiKey - The `generateSecuredApiKey` object.
+     * @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 = {},
+    }: GenerateSecuredApiKeyOptions): string {
+      const queryParameters = serializeQueryParameters(restrictions);
+      return Buffer.from(
+        createHmac('sha256', parentApiKey)
+          .update(queryParameters)
+          .digest('hex') + queryParameters
+      ).toString('base64');
+    },
+
+    /**
+     * Helper: Retrieves the remaining validity of the previous generated `secured_api_key`, the `ValidUntil` parameter must have been provided.
+     *
+     * @summary Helper: Retrieves the remaining validity of the previous generated `secured_api_key`, the `ValidUntil` parameter must have been provided.
+     * @param getSecuredApiKeyRemainingValidity - The `getSecuredApiKeyRemainingValidity` object.
+     * @param getSecuredApiKeyRemainingValidity.securedApiKey - The secured API key generated with the `generateSecuredApiKey` method.
+     */
+    getSecuredApiKeyRemainingValidity({
+      securedApiKey,
+    }: GetSecuredApiKeyRemainingValidityOptions): number {
+      const decodedString = Buffer.from(securedApiKey, 'base64').toString(
+        'ascii'
+      );
+      const regex = /validUntil=(\d+)/;
+      const match = decodedString.match(regex);
+
+      if (match === null) {
+        throw new Error('validUntil not found in given secured api key.');
+      }
+
+      return parseInt(match[1], 10) - Math.round(new Date().getTime() / 1000);
+    },
   };
 }

package/dist/algoliasearch/builds/browser.d.ts

@@ -1,10 +1,13 @@
-import type { Region as AbtestingRegion, AbtestingClient } from '@algolia/client-abtesting/src/abtestingClient';
-import type { Region as AnalyticsRegion, AnalyticsClient } from '@algolia/client-analytics/src/analyticsClient';
+import type { AbtestingClient } from '@algolia/client-abtesting';
+import type { Region as AbtestingRegion } from '@algolia/client-abtesting/src/abtestingClient';
+import type { AnalyticsClient } from '@algolia/client-analytics';
+import type { Region as AnalyticsRegion } from '@algolia/client-analytics/src/analyticsClient';
 import type { ClientOptions } from '@algolia/client-common';
-import type { Region as PersonalizationRegion, PersonalizationClient } from '@algolia/client-personalization/src/personalizationClient';
+import type { PersonalizationClient } from '@algolia/client-personalization';
+import type { Region as PersonalizationRegion } from '@algolia/client-personalization/src/personalizationClient';
 import type { InitClientOptions, InitClientRegion } from './models';
 export * from './models';
-export declare const apiClientVersion = "5.0.0-alpha.104";
+export declare const apiClientVersion = "5.0.0-alpha.105";
 /**
  * The client type.
  */
@@ -29,8 +32,6 @@ export declare function algoliasearch(appId: string, apiKey: string, options?: C
     searchForFacets(searchMethodParams: import("@algolia/client-search/model/clientMethodProps").LegacySearchMethodProps | import("@algolia/client-search/model/searchMethodParams").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<{
         results: import("@algolia/client-search/model/searchForFacetValuesResponse").SearchForFacetValuesResponse[];
     }>;
-    generateSecuredApiKey({ parentApiKey, restrictions, }: import("@algolia/client-search/model/clientMethodProps").GenerateSecuredApiKeyOptions): string;
-    getSecuredApiKeyRemainingValidity({ securedApiKey, }: import("@algolia/client-search/model/clientMethodProps").GetSecuredApiKeyRemainingValidityOptions): number;
     chunkedBatch({ indexName, objects, action, waitForTasks, batchSize, }: import("@algolia/client-search/model/clientMethodProps").ChunkedBatchOptions, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/batchResponse").BatchResponse[]>;
     replaceAllObjects({ indexName, objects, batchSize }: import("@algolia/client-search/model/clientMethodProps").ReplaceAllObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/clientMethodProps").ReplaceAllObjectsResponse>;
     addApiKey(apiKey: import("@algolia/client-search/model/apiKey").ApiKey, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/addApiKeyResponse").AddApiKeyResponse>;

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

@@ -1 +1 @@
-{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../../builds/browser.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,MAAM,IAAI,eAAe,EACzB,eAAe,EAChB,MAAM,+CAA+C,CAAC;AAKvD,OAAO,KAAK,EACV,MAAM,IAAI,eAAe,EACzB,eAAe,EAChB,MAAM,+CAA+C,CAAC;AAavD,OAAO,KAAK,EAEV,aAAa,EACd,MAAM,wBAAwB,CAAC;AAKhC,OAAO,KAAK,EACV,MAAM,IAAI,qBAAqB,EAC/B,qBAAqB,EACtB,MAAM,2DAA2D,CAAC;AAOnE,OAAO,KAAK,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAEpE,cAAc,UAAU,CAAC;AAEzB,eAAO,MAAM,gBAAgB,oBAAsB,CAAC;AAEpD;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,OAAO,aAAa,CAAC,CAAC;AAG7D,wBAAgB,aAAa,CAC3B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa;;kCAiCR,iBAAiB,GAAG,iBAAiB,eAAe,CAAC,KACjE,eAAe;uCAuCH,iBAAiB,GAC5B,SAAS,iBAAiB,qBAAqB,CAAC,CAAC,KAClD,qBAAqB;kCAtBT,iBAAiB,GAAG,iBAAiB,eAAe,CAAC,KACjE,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAoDnB"}
+{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../../builds/browser.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,KAAK,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,+CAA+C,CAAC;AAK/F,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,KAAK,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,+CAA+C,CAAC;AAK/F,OAAO,KAAK,EACV,aAAa,EAEd,MAAM,wBAAwB,CAAC;AAShC,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AAC7E,OAAO,KAAK,EAAE,MAAM,IAAI,qBAAqB,EAAE,MAAM,2DAA2D,CAAC;AAWjH,OAAO,KAAK,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAEpE,cAAc,UAAU,CAAC;AAEzB,eAAO,MAAM,gBAAgB,oBAAsB,CAAC;AAEpD;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,OAAO,aAAa,CAAC,CAAC;AAG7D,wBAAgB,aAAa,CAC3B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa;;kCAgCR,iBAAiB,GAAG,iBAAiB,eAAe,CAAC,KACjE,eAAe;uCAuCH,iBAAiB,GAC5B,SAAS,iBAAiB,qBAAqB,CAAC,CAAC,KAClD,qBAAqB;kCAtBT,iBAAiB,GAAG,iBAAiB,eAAe,CAAC,KACjE,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAoDnB"}

package/dist/algoliasearch/builds/node.d.ts

@@ -1,10 +1,13 @@
-import type { Region as AbtestingRegion, AbtestingClient } from '@algolia/client-abtesting/src/abtestingClient';
-import type { Region as AnalyticsRegion, AnalyticsClient } from '@algolia/client-analytics/src/analyticsClient';
+import type { AbtestingClient } from '@algolia/client-abtesting';
+import type { Region as AbtestingRegion } from '@algolia/client-abtesting/src/abtestingClient';
+import type { AnalyticsClient } from '@algolia/client-analytics';
+import type { Region as AnalyticsRegion } from '@algolia/client-analytics/src/analyticsClient';
 import type { ClientOptions } from '@algolia/client-common';
-import type { Region as PersonalizationRegion, PersonalizationClient } from '@algolia/client-personalization/src/personalizationClient';
-import type { InitClientOptions, InitClientRegion } from './models';
+import type { PersonalizationClient } from '@algolia/client-personalization';
+import type { Region as PersonalizationRegion } from '@algolia/client-personalization/src/personalizationClient';
+import type { InitClientOptions, InitClientRegion, GenerateSecuredApiKeyOptions, GetSecuredApiKeyRemainingValidityOptions } from './models';
 export * from './models';
-export declare const apiClientVersion = "5.0.0-alpha.104";
+export declare const apiClientVersion = "5.0.0-alpha.105";
 /**
  * The client type.
  */
@@ -14,6 +17,23 @@ export declare function algoliasearch(appId: string, apiKey: string, options?: C
     initAnalytics: (initOptions?: InitClientOptions & InitClientRegion<AnalyticsRegion>) => AnalyticsClient;
     initPersonalization: (initOptions: InitClientOptions & Required<InitClientRegion<PersonalizationRegion>>) => PersonalizationClient;
     initAbtesting: (initOptions?: InitClientOptions & InitClientRegion<AbtestingRegion>) => AbtestingClient;
+    /**
+     * Helper: Generates a secured API key based on the given `parentApiKey` and given `restrictions`.
+     *
+     * @summary Helper: Generates a secured API key based on the given `parentApiKey` and given `restrictions`.
+     * @param generateSecuredApiKey - The `generateSecuredApiKey` object.
+     * @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, }: GenerateSecuredApiKeyOptions): string;
+    /**
+     * Helper: Retrieves the remaining validity of the previous generated `secured_api_key`, the `ValidUntil` parameter must have been provided.
+     *
+     * @summary Helper: Retrieves the remaining validity of the previous generated `secured_api_key`, the `ValidUntil` parameter must have been provided.
+     * @param getSecuredApiKeyRemainingValidity - The `getSecuredApiKeyRemainingValidity` object.
+     * @param getSecuredApiKeyRemainingValidity.securedApiKey - The secured API key generated with the `generateSecuredApiKey` method.
+     */
+    getSecuredApiKeyRemainingValidity({ securedApiKey, }: GetSecuredApiKeyRemainingValidityOptions): number;
     transporter: import("@algolia/client-common").Transporter;
     appId: string;
     clearCache(): Promise<void>;
@@ -29,8 +49,6 @@ export declare function algoliasearch(appId: string, apiKey: string, options?: C
     searchForFacets(searchMethodParams: import("@algolia/client-search/model/clientMethodProps").LegacySearchMethodProps | import("@algolia/client-search/model/searchMethodParams").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<{
         results: import("@algolia/client-search/model/searchForFacetValuesResponse").SearchForFacetValuesResponse[];
     }>;
-    generateSecuredApiKey({ parentApiKey, restrictions, }: import("@algolia/client-search/model/clientMethodProps").GenerateSecuredApiKeyOptions): string;
-    getSecuredApiKeyRemainingValidity({ securedApiKey, }: import("@algolia/client-search/model/clientMethodProps").GetSecuredApiKeyRemainingValidityOptions): number;
     chunkedBatch({ indexName, objects, action, waitForTasks, batchSize, }: import("@algolia/client-search/model/clientMethodProps").ChunkedBatchOptions, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/batchResponse").BatchResponse[]>;
     replaceAllObjects({ indexName, objects, batchSize }: import("@algolia/client-search/model/clientMethodProps").ReplaceAllObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/clientMethodProps").ReplaceAllObjectsResponse>;
     addApiKey(apiKey: import("@algolia/client-search/model/apiKey").ApiKey, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-search/model/addApiKeyResponse").AddApiKeyResponse>;

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

@@ -1 +1 @@
-{"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../../../builds/node.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,MAAM,IAAI,eAAe,EACzB,eAAe,EAChB,MAAM,+CAA+C,CAAC;AAKvD,OAAO,KAAK,EACV,MAAM,IAAI,eAAe,EACzB,eAAe,EAChB,MAAM,+CAA+C,CAAC;AAYvD,OAAO,KAAK,EAEV,aAAa,EACd,MAAM,wBAAwB,CAAC;AAKhC,OAAO,KAAK,EACV,MAAM,IAAI,qBAAqB,EAC/B,qBAAqB,EACtB,MAAM,2DAA2D,CAAC;AAOnE,OAAO,KAAK,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAEpE,cAAc,UAAU,CAAC;AAEzB,eAAO,MAAM,gBAAgB,oBAAsB,CAAC;AAEpD;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,OAAO,aAAa,CAAC,CAAC;AAG7D,wBAAgB,aAAa,CAC3B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa;;kCA2BR,iBAAiB,GAAG,iBAAiB,eAAe,CAAC,KACjE,eAAe;uCAuCH,iBAAiB,GAC5B,SAAS,iBAAiB,qBAAqB,CAAC,CAAC,KAClD,qBAAqB;kCAtBT,iBAAiB,GAAG,iBAAiB,eAAe,CAAC,KACjE,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAoDnB"}
+{"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../../../builds/node.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,KAAK,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,+CAA+C,CAAC;AAK/F,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,KAAK,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,+CAA+C,CAAC;AAK/F,OAAO,KAAK,EACV,aAAa,EAEd,MAAM,wBAAwB,CAAC;AAShC,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AAC7E,OAAO,KAAK,EAAE,MAAM,IAAI,qBAAqB,EAAE,MAAM,2DAA2D,CAAC;AAWjH,OAAO,KAAK,EACV,iBAAiB,EACjB,gBAAgB,EAChB,4BAA4B,EAC5B,wCAAwC,EACzC,MAAM,UAAU,CAAC;AAElB,cAAc,UAAU,CAAC;AAEzB,eAAO,MAAM,gBAAgB,oBAAsB,CAAC;AAEpD;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,OAAO,aAAa,CAAC,CAAC;AAG7D,wBAAgB,aAAa,CAC3B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa;;kCA0BR,iBAAiB,GAAG,iBAAiB,eAAe,CAAC,KACjE,eAAe;uCAuCH,iBAAiB,GAC5B,SAAS,iBAAiB,qBAAqB,CAAC,CAAC,KAClD,qBAAqB;kCAtBT,iBAAiB,GAAG,iBAAiB,eAAe,CAAC,KACjE,eAAe;IAmDhB;;;;;;;OAOG;2DAIA,4BAA4B,GAAG,MAAM;IASxC;;;;;;OAMG;0DAGA,wCAAwC,GAAG,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAcvD"}

package/dist/algoliasearch.cjs

@@ -1,11 +1,11 @@
 'use strict';
 
-var clientCommon = require('@algolia/client-common');
 var crypto = require('crypto');
+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$4 = '5.0.0-alpha.104';
+const apiClientVersion$4 = '5.0.0-alpha.105';
 const REGIONS$2 = ['de', 'us'];
 function getDefaultHosts$3(region) {
     const url = !region
@@ -310,7 +310,7 @@ 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$3 = '5.0.0-alpha.104';
+const apiClientVersion$3 = '5.0.0-alpha.105';
 const REGIONS$1 = ['de', 'us'];
 function getDefaultHosts$2(region) {
     const url = !region
@@ -1237,7 +1237,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$2 = '5.0.0-alpha.104';
+const apiClientVersion$2 = '5.0.0-alpha.105';
 const REGIONS = ['eu', 'us'];
 function getDefaultHosts$1(region) {
     const url = 'personalization.{region}.algolia.com'.replace('{region}', region);
@@ -1498,7 +1498,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$1 = '5.0.0-alpha.104';
+const apiClientVersion$1 = '5.0.0-alpha.105';
 function getDefaultHosts(appId) {
     return [
         {
@@ -1770,36 +1770,6 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
         searchForFacets(searchMethodParams, requestOptions) {
             return this.search(searchMethodParams, requestOptions);
         },
-        /**
-         * Helper: Generates a secured API key based on the given `parentApiKey` and given `restrictions`.
-         *
-         * @summary Helper: Generates a secured API key based on the given `parentApiKey` and given `restrictions`.
-         * @param generateSecuredApiKey - The `generateSecuredApiKey` object.
-         * @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 = {}, }) {
-            const queryParameters = clientCommon.serializeQueryParameters(restrictions);
-            return Buffer.from(crypto.createHmac('sha256', parentApiKey)
-                .update(queryParameters)
-                .digest('hex') + queryParameters).toString('base64');
-        },
-        /**
-         * Helper: Retrieves the remaining validity of the previous generated `secured_api_key`, the `ValidUntil` parameter must have been provided.
-         *
-         * @summary Helper: Retrieves the remaining validity of the previous generated `secured_api_key`, the `ValidUntil` parameter must have been provided.
-         * @param getSecuredApiKeyRemainingValidity - The `getSecuredApiKeyRemainingValidity` object.
-         * @param getSecuredApiKeyRemainingValidity.securedApiKey - The secured API key generated with the `generateSecuredApiKey` method.
-         */
-        getSecuredApiKeyRemainingValidity({ securedApiKey, }) {
-            const decodedString = Buffer.from(securedApiKey, 'base64').toString('ascii');
-            const regex = /validUntil=(\d+)/;
-            const match = decodedString.match(regex);
-            if (match === null) {
-                throw new Error('ValidUntil not found in given secured api key.');
-            }
-            return parseInt(match[1], 10) - Math.round(new Date().getTime() / 1000);
-        },
         /**
          * Helper: Chunks the given `objects` list in subset of 1000 elements max in order to make it fit in `batch` requests.
          *
@@ -3760,6 +3730,36 @@ function algoliasearch(appId, apiKey, options) {
         initAnalytics,
         initPersonalization,
         initAbtesting,
+        /**
+         * Helper: Generates a secured API key based on the given `parentApiKey` and given `restrictions`.
+         *
+         * @summary Helper: Generates a secured API key based on the given `parentApiKey` and given `restrictions`.
+         * @param generateSecuredApiKey - The `generateSecuredApiKey` object.
+         * @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 = {}, }) {
+            const queryParameters = clientCommon.serializeQueryParameters(restrictions);
+            return Buffer.from(crypto.createHmac('sha256', parentApiKey)
+                .update(queryParameters)
+                .digest('hex') + queryParameters).toString('base64');
+        },
+        /**
+         * Helper: Retrieves the remaining validity of the previous generated `secured_api_key`, the `ValidUntil` parameter must have been provided.
+         *
+         * @summary Helper: Retrieves the remaining validity of the previous generated `secured_api_key`, the `ValidUntil` parameter must have been provided.
+         * @param getSecuredApiKeyRemainingValidity - The `getSecuredApiKeyRemainingValidity` object.
+         * @param getSecuredApiKeyRemainingValidity.securedApiKey - The secured API key generated with the `generateSecuredApiKey` method.
+         */
+        getSecuredApiKeyRemainingValidity({ securedApiKey, }) {
+            const decodedString = Buffer.from(securedApiKey, 'base64').toString('ascii');
+            const regex = /validUntil=(\d+)/;
+            const match = decodedString.match(regex);
+            if (match === null) {
+                throw new Error('validUntil not found in given secured api key.');
+            }
+            return parseInt(match[1], 10) - Math.round(new Date().getTime() / 1000);
+        },
     };
 }
 

package/dist/algoliasearch.esm.browser.js

@@ -1,5 +1,3 @@
-import { createHmac } from 'crypto';
-
 function createAuth(appId, apiKey, authMode = 'WithinHeaders') {
   const credentials = {
     'x-algolia-api-key': apiKey,
@@ -687,7 +685,7 @@ const DEFAULT_READ_TIMEOUT_BROWSER = 2000;
 const DEFAULT_WRITE_TIMEOUT_BROWSER = 30000;
 
 // 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.0.0-alpha.104';
+const apiClientVersion$4 = '5.0.0-alpha.105';
 const REGIONS$2 = ['de', 'us'];
 function getDefaultHosts$3(region) {
     const url = !region
@@ -992,7 +990,7 @@ 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$3 = '5.0.0-alpha.104';
+const apiClientVersion$3 = '5.0.0-alpha.105';
 const REGIONS$1 = ['de', 'us'];
 function getDefaultHosts$2(region) {
     const url = !region
@@ -1919,7 +1917,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$2 = '5.0.0-alpha.104';
+const apiClientVersion$2 = '5.0.0-alpha.105';
 const REGIONS = ['eu', 'us'];
 function getDefaultHosts$1(region) {
     const url = 'personalization.{region}.algolia.com'.replace('{region}', region);
@@ -2180,7 +2178,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$1 = '5.0.0-alpha.104';
+const apiClientVersion$1 = '5.0.0-alpha.105';
 function getDefaultHosts(appId) {
     return [
         {
@@ -2452,36 +2450,6 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
         searchForFacets(searchMethodParams, requestOptions) {
             return this.search(searchMethodParams, requestOptions);
         },
-        /**
-         * Helper: Generates a secured API key based on the given `parentApiKey` and given `restrictions`.
-         *
-         * @summary Helper: Generates a secured API key based on the given `parentApiKey` and given `restrictions`.
-         * @param generateSecuredApiKey - The `generateSecuredApiKey` object.
-         * @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 = {}, }) {
-            const queryParameters = serializeQueryParameters(restrictions);
-            return Buffer.from(createHmac('sha256', parentApiKey)
-                .update(queryParameters)
-                .digest('hex') + queryParameters).toString('base64');
-        },
-        /**
-         * Helper: Retrieves the remaining validity of the previous generated `secured_api_key`, the `ValidUntil` parameter must have been provided.
-         *
-         * @summary Helper: Retrieves the remaining validity of the previous generated `secured_api_key`, the `ValidUntil` parameter must have been provided.
-         * @param getSecuredApiKeyRemainingValidity - The `getSecuredApiKeyRemainingValidity` object.
-         * @param getSecuredApiKeyRemainingValidity.securedApiKey - The secured API key generated with the `generateSecuredApiKey` method.
-         */
-        getSecuredApiKeyRemainingValidity({ securedApiKey, }) {
-            const decodedString = Buffer.from(securedApiKey, 'base64').toString('ascii');
-            const regex = /validUntil=(\d+)/;
-            const match = decodedString.match(regex);
-            if (match === null) {
-                throw new Error('ValidUntil not found in given secured api key.');
-            }
-            return parseInt(match[1], 10) - Math.round(new Date().getTime() / 1000);
-        },
         /**
          * Helper: Chunks the given `objects` list in subset of 1000 elements max in order to make it fit in `batch` requests.
          *

package/dist/algoliasearch.esm.node.js

@@ -1,9 +1,9 @@
-import { createAuth, createTransporter, getAlgoliaAgent, createIterablePromise, serializeQueryParameters, shuffle, DEFAULT_CONNECT_TIMEOUT_NODE, DEFAULT_READ_TIMEOUT_NODE, DEFAULT_WRITE_TIMEOUT_NODE, createNullCache, createMemoryCache } from '@algolia/client-common';
 import { createHmac } from 'crypto';
+import { createAuth, createTransporter, getAlgoliaAgent, createIterablePromise, shuffle, DEFAULT_CONNECT_TIMEOUT_NODE, DEFAULT_READ_TIMEOUT_NODE, DEFAULT_WRITE_TIMEOUT_NODE, createNullCache, createMemoryCache, serializeQueryParameters } from '@algolia/client-common';
 import { createHttpRequester } from '@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$4 = '5.0.0-alpha.104';
+const apiClientVersion$4 = '5.0.0-alpha.105';
 const REGIONS$2 = ['de', 'us'];
 function getDefaultHosts$3(region) {
     const url = !region
@@ -308,7 +308,7 @@ 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$3 = '5.0.0-alpha.104';
+const apiClientVersion$3 = '5.0.0-alpha.105';
 const REGIONS$1 = ['de', 'us'];
 function getDefaultHosts$2(region) {
     const url = !region
@@ -1235,7 +1235,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$2 = '5.0.0-alpha.104';
+const apiClientVersion$2 = '5.0.0-alpha.105';
 const REGIONS = ['eu', 'us'];
 function getDefaultHosts$1(region) {
     const url = 'personalization.{region}.algolia.com'.replace('{region}', region);
@@ -1496,7 +1496,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$1 = '5.0.0-alpha.104';
+const apiClientVersion$1 = '5.0.0-alpha.105';
 function getDefaultHosts(appId) {
     return [
         {
@@ -1768,36 +1768,6 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
         searchForFacets(searchMethodParams, requestOptions) {
             return this.search(searchMethodParams, requestOptions);
         },
-        /**
-         * Helper: Generates a secured API key based on the given `parentApiKey` and given `restrictions`.
-         *
-         * @summary Helper: Generates a secured API key based on the given `parentApiKey` and given `restrictions`.
-         * @param generateSecuredApiKey - The `generateSecuredApiKey` object.
-         * @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 = {}, }) {
-            const queryParameters = serializeQueryParameters(restrictions);
-            return Buffer.from(createHmac('sha256', parentApiKey)
-                .update(queryParameters)
-                .digest('hex') + queryParameters).toString('base64');
-        },
-        /**
-         * Helper: Retrieves the remaining validity of the previous generated `secured_api_key`, the `ValidUntil` parameter must have been provided.
-         *
-         * @summary Helper: Retrieves the remaining validity of the previous generated `secured_api_key`, the `ValidUntil` parameter must have been provided.
-         * @param getSecuredApiKeyRemainingValidity - The `getSecuredApiKeyRemainingValidity` object.
-         * @param getSecuredApiKeyRemainingValidity.securedApiKey - The secured API key generated with the `generateSecuredApiKey` method.
-         */
-        getSecuredApiKeyRemainingValidity({ securedApiKey, }) {
-            const decodedString = Buffer.from(securedApiKey, 'base64').toString('ascii');
-            const regex = /validUntil=(\d+)/;
-            const match = decodedString.match(regex);
-            if (match === null) {
-                throw new Error('ValidUntil not found in given secured api key.');
-            }
-            return parseInt(match[1], 10) - Math.round(new Date().getTime() / 1000);
-        },
         /**
          * Helper: Chunks the given `objects` list in subset of 1000 elements max in order to make it fit in `batch` requests.
          *
@@ -3758,6 +3728,36 @@ function algoliasearch(appId, apiKey, options) {
         initAnalytics,
         initPersonalization,
         initAbtesting,
+        /**
+         * Helper: Generates a secured API key based on the given `parentApiKey` and given `restrictions`.
+         *
+         * @summary Helper: Generates a secured API key based on the given `parentApiKey` and given `restrictions`.
+         * @param generateSecuredApiKey - The `generateSecuredApiKey` object.
+         * @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 = {}, }) {
+            const queryParameters = serializeQueryParameters(restrictions);
+            return Buffer.from(createHmac('sha256', parentApiKey)
+                .update(queryParameters)
+                .digest('hex') + queryParameters).toString('base64');
+        },
+        /**
+         * Helper: Retrieves the remaining validity of the previous generated `secured_api_key`, the `ValidUntil` parameter must have been provided.
+         *
+         * @summary Helper: Retrieves the remaining validity of the previous generated `secured_api_key`, the `ValidUntil` parameter must have been provided.
+         * @param getSecuredApiKeyRemainingValidity - The `getSecuredApiKeyRemainingValidity` object.
+         * @param getSecuredApiKeyRemainingValidity.securedApiKey - The secured API key generated with the `generateSecuredApiKey` method.
+         */
+        getSecuredApiKeyRemainingValidity({ securedApiKey, }) {
+            const decodedString = Buffer.from(securedApiKey, 'base64').toString('ascii');
+            const regex = /validUntil=(\d+)/;
+            const match = decodedString.match(regex);
+            if (match === null) {
+                throw new Error('validUntil not found in given secured api key.');
+            }
+            return parseInt(match[1], 10) - Math.round(new Date().getTime() / 1000);
+        },
     };
 }