chore: generated code for commit 98b40e8. [skip ci]

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

Author: algolia-bot

clients/algoliasearch-client-javascript/packages/algoliasearch-lite/model/clientMethodProps.ts

@@ -1,3 +1,7 @@
+import type { SearchForFacetsOptions } from './searchForFacetsOptions';
+import type { SearchForHitsOptions } from './searchForHitsOptions';
+import type { SearchParamsObject } from './searchParamsObject';
+
 /**
  * Properties for the `post` method.
  */
@@ -15,3 +19,35 @@ export type PostProps = {
    */
   body?: Record<string, any>;
 };
+
+/**
+ * In v4, the search parameters are wrapped in a `params` parameter.
+ *
+ * @deprecated The `search` method now accepts flat `searchParams` at the root of the method.
+ */
+type LegacySearchParams = {
+  params?: SearchParamsObject;
+};
+
+/**
+ * In v4, the search parameters are wrapped in a `params` parameter.
+ *
+ * @deprecated The `search` method now accepts flat `searchParams` at the root of the method.
+ */
+type LegacySearchForFacets = LegacySearchParams & SearchForFacetsOptions;
+
+/**
+ * In v4, the search parameters are wrapped in a `params` parameter.
+ *
+ * @deprecated The `search` method now accepts flat `searchParams` at the root of the method.
+ */
+type LegacySearchForHits = LegacySearchParams & SearchForHitsOptions;
+
+type LegacySearchQuery = LegacySearchForFacets | LegacySearchForHits;
+
+/**
+ * Search method signature compatible with the `algoliasearch` v4 package. When using this signature, extra computation will be required to make it match the new signature.
+ *
+ * @deprecated This signature will be removed from the next major version, we recommend using the `SearchMethodParams` type for performances and future proof reasons.
+ */
+export type LegacySearchMethodProps = LegacySearchQuery[];

clients/algoliasearch-client-javascript/packages/algoliasearch-lite/src/algoliasearchLiteClient.ts

@@ -13,7 +13,10 @@ import type {
   QueryParameters,
 } from '@experimental-api-clients-automation/client-common';
 
-import type { PostProps } from '../model/clientMethodProps';
+import type {
+  PostProps,
+  LegacySearchMethodProps,
+} from '../model/clientMethodProps';
 import type { SearchMethodParams } from '../model/searchMethodParams';
 import type { SearchResponses } from '../model/searchResponses';
 
@@ -129,9 +132,34 @@ export function createAlgoliasearchLiteClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     search(
-      searchMethodParams: SearchMethodParams,
+      searchMethodParams: LegacySearchMethodProps | SearchMethodParams,
       requestOptions?: RequestOptions
     ): Promise<SearchResponses> {
+      if (searchMethodParams && Array.isArray(searchMethodParams)) {
+        const newSignatureRequest: SearchMethodParams = {
+          requests: searchMethodParams.map(({ params, ...legacyRequest }) => {
+            if (legacyRequest.type === 'facet') {
+              return {
+                ...legacyRequest,
+                ...params,
+                type: 'facet',
+              };
+            }
+
+            return {
+              ...legacyRequest,
+              ...params,
+              facet: undefined,
+              maxFacetHits: undefined,
+              facetQuery: undefined,
+            };
+          }),
+        };
+
+        // eslint-disable-next-line no-param-reassign
+        searchMethodParams = newSignatureRequest;
+      }
+
       if (!searchMethodParams) {
         throw new Error(
           'Parameter `searchMethodParams` is required when calling `search`.'

clients/algoliasearch-client-javascript/packages/client-search/model/clientMethodProps.ts

@@ -12,7 +12,10 @@ import type { OperationIndexParams } from './operationIndexParams';
 import type { Rule } from './rule';
 import type { SearchDictionaryEntriesParams } from './searchDictionaryEntriesParams';
 import type { SearchForFacetValuesRequest } from './searchForFacetValuesRequest';
+import type { SearchForFacetsOptions } from './searchForFacetsOptions';
+import type { SearchForHitsOptions } from './searchForHitsOptions';
 import type { SearchParams } from './searchParams';
+import type { SearchParamsObject } from './searchParamsObject';
 import type { SearchRulesParams } from './searchRulesParams';
 import type { Source } from './source';
 import type { SynonymHit } from './synonymHit';
@@ -585,6 +588,38 @@ export type SaveSynonymsProps = {
   replaceExistingSynonyms?: boolean;
 };
 
+/**
+ * In v4, the search parameters are wrapped in a `params` parameter.
+ *
+ * @deprecated The `search` method now accepts flat `searchParams` at the root of the method.
+ */
+type LegacySearchParams = {
+  params?: SearchParamsObject;
+};
+
+/**
+ * In v4, the search parameters are wrapped in a `params` parameter.
+ *
+ * @deprecated The `search` method now accepts flat `searchParams` at the root of the method.
+ */
+type LegacySearchForFacets = LegacySearchParams & SearchForFacetsOptions;
+
+/**
+ * In v4, the search parameters are wrapped in a `params` parameter.
+ *
+ * @deprecated The `search` method now accepts flat `searchParams` at the root of the method.
+ */
+type LegacySearchForHits = LegacySearchParams & SearchForHitsOptions;
+
+type LegacySearchQuery = LegacySearchForFacets | LegacySearchForHits;
+
+/**
+ * Search method signature compatible with the `algoliasearch` v4 package. When using this signature, extra computation will be required to make it match the new signature.
+ *
+ * @deprecated This signature will be removed from the next major version, we recommend using the `SearchMethodParams` type for performances and future proof reasons.
+ */
+export type LegacySearchMethodProps = LegacySearchQuery[];
+
 /**
  * Properties for the `searchDictionaryEntries` method.
  */

clients/algoliasearch-client-javascript/packages/client-search/src/searchClient.ts

@@ -62,6 +62,7 @@ import type {
   SaveRulesProps,
   SaveSynonymProps,
   SaveSynonymsProps,
+  LegacySearchMethodProps,
   SearchDictionaryEntriesProps,
   SearchForFacetValuesProps,
   SearchRulesProps,
@@ -2213,9 +2214,34 @@ export function createSearchClient({
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     search(
-      searchMethodParams: SearchMethodParams,
+      searchMethodParams: LegacySearchMethodProps | SearchMethodParams,
       requestOptions?: RequestOptions
     ): Promise<SearchResponses> {
+      if (searchMethodParams && Array.isArray(searchMethodParams)) {
+        const newSignatureRequest: SearchMethodParams = {
+          requests: searchMethodParams.map(({ params, ...legacyRequest }) => {
+            if (legacyRequest.type === 'facet') {
+              return {
+                ...legacyRequest,
+                ...params,
+                type: 'facet',
+              };
+            }
+
+            return {
+              ...legacyRequest,
+              ...params,
+              facet: undefined,
+              maxFacetHits: undefined,
+              facetQuery: undefined,
+            };
+          }),
+        };
+
+        // eslint-disable-next-line no-param-reassign
+        searchMethodParams = newSignatureRequest;
+      }
+
       if (!searchMethodParams) {
         throw new Error(
           'Parameter `searchMethodParams` is required when calling `search`.'

specs/bundled/algoliasearch-lite.yml

@@ -2071,6 +2071,7 @@ paths:
       operationId: search
       x-use-read-transporter: true
       x-cacheable: true
+      x-legacy-signature: true
       summary: Search multiple indices.
       description: Perform a search operation targeting one or many indices.
       requestBody:

specs/bundled/search.yml

@@ -2181,6 +2181,7 @@ paths:
       operationId: search
       x-use-read-transporter: true
       x-cacheable: true
+      x-legacy-signature: true
       summary: Search multiple indices.
       description: Perform a search operation targeting one or many indices.
       requestBody: