fix(clients): correctly deserialize SearchResult (#4756) (generated) [skip ci]

Co-authored-by: Pierre Millot <[email protected]>

Author: algolia-bot

clients/algoliasearch-client-csharp/algoliasearch/Clients/SearchClient.cs

@@ -1640,7 +1640,7 @@ public partial interface ISearchClient
   UpdatedAtResponse SaveSynonyms(string indexName, List<SynonymHit> synonymHit, bool? forwardToReplicas = default, bool? replaceExistingSynonyms = default, RequestOptions options = null, CancellationToken cancellationToken = default);
 
   /// <summary>
-  /// Sends multiple search requests to one or more indices.  This can be useful in these cases:  - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters. 
+  /// Sends multiple search requests to one or more indices.  This can be useful in these cases:  - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters.  Use the helper `searchForHits` or `searchForFacets` to get the results in a more convenient format, if you already know the return type you want. 
   /// </summary>
   ///
   /// Required API Key ACLs:
@@ -1655,7 +1655,7 @@ public partial interface ISearchClient
   Task<SearchResponses<T>> SearchAsync<T>(SearchMethodParams searchMethodParams, RequestOptions options = null, CancellationToken cancellationToken = default);
 
   /// <summary>
-  /// Sends multiple search requests to one or more indices.  This can be useful in these cases:  - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters.  (Synchronous version)
+  /// Sends multiple search requests to one or more indices.  This can be useful in these cases:  - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters.  Use the helper `searchForHits` or `searchForFacets` to get the results in a more convenient format, if you already know the return type you want.  (Synchronous version)
   /// </summary>
   ///
   /// Required API Key ACLs:

clients/algoliasearch-client-dart/packages/algoliasearch/lib/src/api/search_client.dart

@@ -111,7 +111,7 @@ final class SearchClient implements ApiClient {
     );
   }
 
-  /// Sends multiple search requests to one or more indices.  This can be useful in these cases:  - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters.
+  /// Sends multiple search requests to one or more indices.  This can be useful in these cases:  - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters.  Use the helper `searchForHits` or `searchForFacets` to get the results in a more convenient format, if you already know the return type you want.
   ///
   /// Required API Key ACLs:
   ///   - search

clients/algoliasearch-client-dart/packages/client_search/lib/src/api/search_client.dart

@@ -1952,7 +1952,7 @@ final class SearchClient implements ApiClient {
     );
   }
 
-  /// Sends multiple search requests to one or more indices.  This can be useful in these cases:  - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters.
+  /// Sends multiple search requests to one or more indices.  This can be useful in these cases:  - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters.  Use the helper `searchForHits` or `searchForFacets` to get the results in a more convenient format, if you already know the return type you want.
   ///
   /// Required API Key ACLs:
   ///   - search

clients/algoliasearch-client-go/algolia/search/api_search.go

@@ -5025,6 +5025,8 @@ public CompletableFuture<UpdatedAtResponse> saveSynonymsAsync(@Nonnull String in
    * Sends multiple search requests to one or more indices. This can be useful in these cases: -
    * Different indices for different purposes, such as, one index for products, another one for
    * marketing content. - Multiple searches to the same index—for example, with different filters.
+   * Use the helper `searchForHits` or `searchForFacets` to get the results in a more convenient
+   * format, if you already know the return type you want.
    *
    * @param searchMethodParams Muli-search request body. Results are returned in the same order as
    *     the requests. (required)
@@ -5045,6 +5047,8 @@ public <T> SearchResponses<T> search(
    * Sends multiple search requests to one or more indices. This can be useful in these cases: -
    * Different indices for different purposes, such as, one index for products, another one for
    * marketing content. - Multiple searches to the same index—for example, with different filters.
+   * Use the helper `searchForHits` or `searchForFacets` to get the results in a more convenient
+   * format, if you already know the return type you want.
    *
    * @param searchMethodParams Muli-search request body. Results are returned in the same order as
    *     the requests. (required)
@@ -5059,7 +5063,8 @@ public <T> SearchResponses<T> search(@Nonnull SearchMethodParams searchMethodPar
    * (asynchronously) Sends multiple search requests to one or more indices. This can be useful in
    * these cases: - Different indices for different purposes, such as, one index for products,
    * another one for marketing content. - Multiple searches to the same index—for example, with
-   * different filters.
+   * different filters. Use the helper `searchForHits` or `searchForFacets` to get the results in a
+   * more convenient format, if you already know the return type you want.
    *
    * @param searchMethodParams Muli-search request body. Results are returned in the same order as
    *     the requests. (required)
@@ -5088,7 +5093,8 @@ public <T> CompletableFuture<SearchResponses<T>> searchAsync(
    * (asynchronously) Sends multiple search requests to one or more indices. This can be useful in
    * these cases: - Different indices for different purposes, such as, one index for products,
    * another one for marketing content. - Multiple searches to the same index—for example, with
-   * different filters.
+   * different filters. Use the helper `searchForHits` or `searchForFacets` to get the results in a
+   * more convenient format, if you already know the return type you want.
    *
    * @param searchMethodParams Muli-search request body. Results are returned in the same order as
    *     the requests. (required)

clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/api/SearchClient.java

@@ -6,19 +6,34 @@
 import com.algolia.exceptions.AlgoliaRuntimeException;
 import com.fasterxml.jackson.annotation.*;
 import com.fasterxml.jackson.core.*;
-import com.fasterxml.jackson.core.type.TypeReference;
 import com.fasterxml.jackson.databind.*;
+import com.fasterxml.jackson.databind.BeanProperty;
 import com.fasterxml.jackson.databind.annotation.*;
+import com.fasterxml.jackson.databind.deser.ContextualDeserializer;
 import java.io.IOException;
 import java.util.logging.Logger;
 
 /** SearchResult */
 @JsonDeserialize(using = SearchResult.Deserializer.class)
 public interface SearchResult<T> {
-  class Deserializer<T> extends JsonDeserializer<SearchResult<T>> {
+  class Deserializer<T> extends JsonDeserializer<SearchResult<T>> implements ContextualDeserializer {
 
     private static final Logger LOGGER = Logger.getLogger(Deserializer.class.getName());
 
+    private JavaType returnType;
+
+    public Deserializer() {}
+
+    private Deserializer(JavaType returnType) {
+      this.returnType = returnType;
+    }
+
+    @Override
+    public JsonDeserializer<?> createContextual(DeserializationContext ctxt, BeanProperty property) {
+      JavaType contextualType = ctxt.getContextualType().containedType(0);
+      return new Deserializer(contextualType);
+    }
+
     @Override
     public SearchResult<T> deserialize(JsonParser jp, DeserializationContext ctxt) throws IOException {
       JsonNode tree = jp.readValueAsTree();
@@ -36,7 +51,12 @@ public SearchResult<T> deserialize(JsonParser jp, DeserializationContext ctxt) t
       // deserialize SearchResponse
       if (tree.isObject()) {
         try (JsonParser parser = tree.traverse(jp.getCodec())) {
-          return parser.readValueAs(new TypeReference<SearchResponse<T>>() {});
+          // For generic types, the innerType is erased by Java, we need to use the contextual type.
+          JavaType innerType = ctxt.getTypeFactory().constructParametricType(SearchResponse.class, returnType);
+          if (parser.getCurrentToken() == null) {
+            parser.nextToken();
+          }
+          return ctxt.readValue(parser, innerType);
         } catch (Exception e) {
           // deserialization failed, continue
           LOGGER.finest("Failed to deserialize oneOf SearchResponse (error: " + e.getMessage() + ") (type: SearchResponse)");

clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/model/search/SearchResult.java

@@ -247,7 +247,7 @@ export function createLiteClient({
     },
 
     /**
-     * Sends multiple search requests to one or more indices.  This can be useful in these cases:  - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters.
+     * Sends multiple search requests to one or more indices.  This can be useful in these cases:  - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters.  Use the helper `searchForHits` or `searchForFacets` to get the results in a more convenient format, if you already know the return type you want.
      *
      * Required API Key ACLs:
      *  - search

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

@@ -2561,7 +2561,7 @@ export function createSearchClient({
     },
 
     /**
-     * Sends multiple search requests to one or more indices.  This can be useful in these cases:  - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters.
+     * Sends multiple search requests to one or more indices.  This can be useful in these cases:  - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters.  Use the helper `searchForHits` or `searchForFacets` to get the results in a more convenient format, if you already know the return type you want.
      *
      * Required API Key ACLs:
      *  - search

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

@@ -1188,7 +1188,7 @@ public class SearchClient(
   }
 
   /**
-   * Sends multiple search requests to one or more indices.  This can be useful in these cases:  - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters.
+   * Sends multiple search requests to one or more indices.  This can be useful in these cases:  - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters.  Use the helper `searchForHits` or `searchForFacets` to get the results in a more convenient format, if you already know the return type you want.
    *
    * Required API Key ACLs:
    *   - search

clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/api/SearchClient.kt

@@ -2340,7 +2340,7 @@ public function saveSynonyms($indexName, $synonymHit, $forwardToReplicas = null,
     }
 
     /**
-     * Sends multiple search requests to one or more indices.  This can be useful in these cases:  - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters.
+     * Sends multiple search requests to one or more indices.  This can be useful in these cases:  - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters.  Use the helper `searchForHits` or `searchForFacets` to get the results in a more convenient format, if you already know the return type you want.
      *
      * Required API Key ACLs:
      *  - search