chore: generated code for commit cefa6674. [skip ci]

algolia/api-clients-automation@cefa667

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Clément Vannicatte <[email protected]>

Author: algolia-bot

packages/algoliasearch/builds/node.ts

@@ -168,7 +168,29 @@ export function algoliasearch(
       parentApiKey,
       restrictions = {},
     }: GenerateSecuredApiKeyOptions): string {
-      const queryParameters = serializeQueryParameters(restrictions);
+      let mergedRestrictions = restrictions;
+      if (restrictions.searchParams) {
+        // merge searchParams with the root restrictions
+        mergedRestrictions = {
+          ...restrictions,
+          ...restrictions.searchParams,
+        };
+
+        delete mergedRestrictions.searchParams;
+      }
+
+      mergedRestrictions = Object.keys(mergedRestrictions)
+        .sort()
+        .reduce(
+          (acc, key) => {
+            // eslint-disable-next-line no-param-reassign
+            acc[key] = (mergedRestrictions as any)[key];
+            return acc;
+          },
+          {} as Record<string, unknown>
+        );
+
+      const queryParameters = serializeQueryParameters(mergedRestrictions);
       return Buffer.from(
         createHmac('sha256', parentApiKey)
           .update(queryParameters)

packages/client-common/src/transporter/helpers.ts

@@ -42,16 +42,14 @@ export function serializeUrl(
 }
 
 export function serializeQueryParameters(parameters: QueryParameters): string {
-  const isObjectOrArray = (value: any): boolean =>
-    Object.prototype.toString.call(value) === '[object Object]' ||
-    Object.prototype.toString.call(value) === '[object Array]';
-
   return Object.keys(parameters)
+    .filter((key) => parameters[key] !== undefined)
+    .sort()
     .map(
       (key) =>
         `${key}=${encodeURIComponent(
-          isObjectOrArray(parameters[key])
-            ? JSON.stringify(parameters[key])
+          Object.prototype.toString.call(parameters[key]) === '[object Array]'
+            ? parameters[key].join(',')
             : parameters[key]
         ).replaceAll('+', '%20')}`
     )

packages/client-search/builds/node.ts

@@ -70,7 +70,29 @@ export function searchClient(
       parentApiKey,
       restrictions = {},
     }: GenerateSecuredApiKeyOptions): string {
-      const queryParameters = serializeQueryParameters(restrictions);
+      let mergedRestrictions = restrictions;
+      if (restrictions.searchParams) {
+        // merge searchParams with the root restrictions
+        mergedRestrictions = {
+          ...restrictions,
+          ...restrictions.searchParams,
+        };
+
+        delete mergedRestrictions.searchParams;
+      }
+
+      mergedRestrictions = Object.keys(mergedRestrictions)
+        .sort()
+        .reduce(
+          (acc, key) => {
+            // eslint-disable-next-line no-param-reassign
+            acc[key] = (mergedRestrictions as any)[key];
+            return acc;
+          },
+          {} as Record<string, unknown>
+        );
+
+      const queryParameters = serializeQueryParameters(mergedRestrictions);
       return Buffer.from(
         createHmac('sha256', parentApiKey)
           .update(queryParameters)

packages/client-search/model/clientMethodProps.ts

@@ -25,7 +25,7 @@ import type { SearchParams } from './searchParams';
 import type { SearchParamsObject } from './searchParamsObject';
 import type { SearchRulesParams } from './searchRulesParams';
 import type { SearchSynonymsParams } from './searchSynonymsParams';
-import type { SecuredAPIKeyRestrictions } from './securedAPIKeyRestrictions';
+import type { SecuredApiKeyRestrictions } from './securedApiKeyRestrictions';
 import type { Source } from './source';
 import type { SynonymHit } from './synonymHit';
 
@@ -796,7 +796,7 @@ export type GenerateSecuredApiKeyOptions = {
   /**
    * A set of properties defining the restrictions of the secured API key.
    */
-  restrictions?: SecuredAPIKeyRestrictions;
+  restrictions?: SecuredApiKeyRestrictions;
 };
 
 export type GetSecuredApiKeyRemainingValidityOptions = {

packages/client-search/model/index.ts

@@ -143,7 +143,7 @@ export * from './searchTypeDefault';
 export * from './searchTypeFacet';
 export * from './searchUserIdsParams';
 export * from './searchUserIdsResponse';
-export * from './securedAPIKeyRestrictions';
+export * from './securedApiKeyRestrictions';
 export * from './semanticSearch';
 export * from './snippetResult';
 export * from './snippetResultOption';

packages/client-search/model/securedAPIKeyRestrictions.ts renamed to packages/client-search/model/securedApiKeyRestrictions.ts

@@ -2,7 +2,7 @@
 
 import type { SearchParamsObject } from './searchParamsObject';
 
-export type SecuredAPIKeyRestrictions = {
+export type SecuredApiKeyRestrictions = {
   searchParams?: SearchParamsObject;
 
   /**

packages/client-search/src/searchClient.ts

@@ -647,6 +647,7 @@ export function createSearchClient({
 
       return { copyOperationResponse, batchResponses, moveOperationResponse };
     },
+
     /**
      * Creates a new API key with specific permissions and restrictions.
      *