Merge branch 'main' into feat/realtime-perso-specs

Author: shortcuts

.github/actions/setup/action.yml

@@ -202,7 +202,7 @@ runs:
       if: ${{ inputs.language == 'swift' }}
       id: swiftformat-version
       shell: bash
-      run: echo "SWIFTFORMAT_VERSION=0.56.2" >> $GITHUB_OUTPUT
+      run: echo "SWIFTFORMAT_VERSION=0.56.3" >> $GITHUB_OUTPUT
 
     - name: Checkout swiftformat
       if: ${{ inputs.language == 'swift' }}

.yarn/releases/yarn-4.9.1.cjs renamed to .yarn/releases/yarn-4.9.2.cjs

@@ -4,7 +4,7 @@ enableGlobalCache: false
 
 nodeLinker: node-modules
 
-yarnPath: .yarn/releases/yarn-4.9.1.cjs
+yarnPath: .yarn/releases/yarn-4.9.2.cjs
 
 # esbuild use native binaries, we need both to work locally and on the CI.
 supportedArchitectures:

.yarnrc.yml

@@ -28,7 +28,8 @@ public abstract class ApiClient implements Closeable {
 
   private final Requester requester;
   private final ExecutorService executor;
-  private AuthInterceptor authInterceptor;
+  public final ClientOptions clientOptions;
+  public AuthInterceptor authInterceptor;
 
   /** Constructs a new instance of the {@link ApiClient}. */
   protected ApiClient(
@@ -47,9 +48,9 @@ protected ApiClient(
     if (apiKey == null || apiKey.isEmpty()) {
       throw new AlgoliaRuntimeException("`apiKey` is missing.");
     }
-    final ClientOptions clientOptions = options != null ? options : new ClientOptions();
-    this.executor = clientOptions.getExecutor();
-    this.requester = clientOptions.getCustomRequester() != null
+    clientOptions = options != null ? options : new ClientOptions();
+    executor = clientOptions.getExecutor();
+    requester = clientOptions.getCustomRequester() != null
       ? clientOptions.getCustomRequester()
       : defaultRequester(appId, apiKey, clientName, clientOptions, defaultHosts, connectTimeout, readTimeout, writeTimeout);
   }

clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/ApiClient.java

@@ -8,9 +8,13 @@
 import com.algolia.config.ClientOptions;
 import com.algolia.exceptions.*;
 import com.algolia.internal.JsonSerializer;
+import com.algolia.model.ingestion.PushTaskPayload;
+import com.algolia.model.ingestion.PushTaskRecords;
+import com.algolia.model.ingestion.WatchResponse;
 import com.algolia.model.search.*;
 import com.algolia.utils.*;
 import com.fasterxml.jackson.core.type.TypeReference;
+import com.fasterxml.jackson.databind.ObjectMapper;
 import java.nio.charset.Charset;
 import java.security.InvalidKeyException;
 import java.security.NoSuchAlgorithmException;
@@ -36,6 +40,24 @@
 
 public class SearchClient extends ApiClient {
 
+  private IngestionClient ingestionTransporter;
+
+  /**
+   * Sets the region of the current algolia application to the configuration, this is required to be
+   * called if you wish to leverage the transformation pipeline (via the *WithTransformation
+   * methods).
+   *
+   * @param region (required)
+   */
+  public void setTransformationRegion(String region) {
+    this.ingestionTransporter = new IngestionClient(
+      this.authInterceptor.getApplicationId(),
+      this.authInterceptor.getApiKey(),
+      region,
+      this.clientOptions
+    );
+  }
+
   public SearchClient(String appId, String apiKey) {
     this(appId, apiKey, null);
   }
@@ -6731,6 +6753,108 @@ public <T> List<BatchResponse> chunkedBatch(
     return chunkedBatch(indexName, objects, action, waitForTasks, 1000, requestOptions);
   }
 
+  /**
+   * Helper: Similar to the `saveObjects` method but requires a Push connector
+   * (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/)
+   * to be created first, in order to transform records before indexing them to Algolia. The
+   * `region` must have been passed to the client instantiation method.
+   *
+   * @param indexName The `indexName` to replace `objects` in.
+   * @param objects The array of `objects` to store in the given Algolia `indexName`.
+   * @throws AlgoliaRetryException When the retry has failed on all hosts
+   * @throws AlgoliaApiException When the API sends an http error code
+   * @throws AlgoliaRuntimeException When an error occurred during the serialization
+   */
+  public <T> WatchResponse saveObjectsWithTransformation(String indexName, Iterable<T> objects) {
+    return saveObjectsWithTransformation(indexName, objects, null);
+  }
+
+  /**
+   * Helper: Similar to the `saveObjects` method but requires a Push connector
+   * (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/)
+   * to be created first, in order to transform records before indexing them to Algolia. The
+   * `region` must have been passed to the client instantiation method.
+   *
+   * @param indexName The `indexName` to replace `objects` in.
+   * @param objects The array of `objects` to store in the given Algolia `indexName`.
+   * @param requestOptions The requestOptions to send along with the query, they will be merged with
+   *     the transporter requestOptions. (optional)
+   */
+  public <T> WatchResponse saveObjectsWithTransformation(String indexName, Iterable<T> objects, RequestOptions requestOptions) {
+    return saveObjectsWithTransformation(indexName, objects, false, requestOptions);
+  }
+
+  /**
+   * Helper: Similar to the `saveObjects` method but requires a Push connector
+   * (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/)
+   * to be created first, in order to transform records before indexing them to Algolia. The
+   * `region` must have been passed to the client instantiation method.
+   *
+   * @param indexName The `indexName` to replace `objects` in.
+   * @param objects The array of `objects` to store in the given Algolia `indexName`.
+   * @param waitForTasks - Whether or not we should wait until every `batch` tasks has been
+   *     processed, this operation may slow the total execution time of this method but is more
+   *     reliable.
+   * @param requestOptions The requestOptions to send along with the query, they will be merged with
+   *     the transporter requestOptions. (optional)
+   */
+  public <T> WatchResponse saveObjectsWithTransformation(
+    String indexName,
+    Iterable<T> objects,
+    boolean waitForTasks,
+    RequestOptions requestOptions
+  ) {
+    return saveObjectsWithTransformation(indexName, objects, waitForTasks, 1000, requestOptions);
+  }
+
+  /**
+   * Helper: Similar to the `saveObjects` method but requires a Push connector
+   * (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/)
+   * to be created first, in order to transform records before indexing them to Algolia. The
+   * `region` must have been passed to the client instantiation method.
+   *
+   * @param indexName The `indexName` to replace `objects` in.
+   * @param objects The array of `objects` to store in the given Algolia `indexName`.
+   * @param waitForTasks - Whether or not we should wait until every `batch` tasks has been
+   *     processed, this operation may slow the total execution time of this method but is more
+   *     reliable.
+   * @param batchSize The size of the chunk of `objects`. The number of `batch` calls will be equal
+   *     to `length(objects) / batchSize`.
+   * @param requestOptions The requestOptions to send along with the query, they will be merged with
+   *     the transporter requestOptions. (optional)
+   */
+  public <T> WatchResponse saveObjectsWithTransformation(
+    String indexName,
+    Iterable<T> objects,
+    boolean waitForTasks,
+    int batchSize,
+    RequestOptions requestOptions
+  ) {
+    if (this.ingestionTransporter == null) {
+      throw new AlgoliaRuntimeException("`setTransformationRegion` must have been called before calling this method.");
+    }
+
+    return this.ingestionTransporter.push(
+        indexName,
+        new PushTaskPayload().setAction(com.algolia.model.ingestion.Action.ADD_OBJECT).setRecords(this.objectsToPushTaskRecords(objects)),
+        waitForTasks,
+        requestOptions
+      );
+  }
+
+  private <T> List<PushTaskRecords> objectsToPushTaskRecords(Iterable<T> objects) {
+    try {
+      ObjectMapper mapper = new ObjectMapper();
+      String json = mapper.writeValueAsString(objects);
+
+      return mapper.readValue(json, new TypeReference<List<PushTaskRecords>>() {});
+    } catch (Exception e) {
+      throw new AlgoliaRuntimeException(
+        "each object must have an `objectID` key in order to be used with the" + " WithTransformation methods"
+      );
+    }
+  }
+
   /**
    * Helper: Saves the given array of objects in the given index. The `chunkedBatch` helper is used
    * under the hood, which creates a `batch` requests with at most 1000 objects in it.
@@ -6867,6 +6991,114 @@ public List<BatchResponse> deleteObjects(
     return chunkedBatch(indexName, objects, Action.DELETE_OBJECT, waitForTasks, batchSize, requestOptions);
   }
 
+  /**
+   * Helper: Similar to the `partialUpdateObjects` method but requires a Push connector
+   * (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/)
+   * to be created first, in order to transform records before indexing them to Algolia. The
+   * `region` must have been passed to the client instantiation method.
+   *
+   * @param indexName The `indexName` to update `objects` in.
+   * @param objects The array of `objects` to update in the given Algolia `indexName`.
+   * @param createIfNotExists To be provided if non-existing objects are passed, otherwise, the call
+   *     will fail.
+   */
+  public <T> WatchResponse partialUpdateObjectsWithTransformation(String indexName, Iterable<T> objects, boolean createIfNotExists) {
+    return partialUpdateObjectsWithTransformation(indexName, objects, createIfNotExists, false, null);
+  }
+
+  /**
+   * Helper: Similar to the `partialUpdateObjects` method but requires a Push connector
+   * (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/)
+   * to be created first, in order to transform records before indexing them to Algolia. The
+   * `region` must have been passed to the client instantiation method.
+   *
+   * @param indexName The `indexName` to update `objects` in.
+   * @param objects The array of `objects` to update in the given Algolia `indexName`.
+   * @param createIfNotExists To be provided if non-existing objects are passed, otherwise, the call
+   *     will fail.
+   * @param waitForTasks - Whether or not we should wait until every `batch` tasks has been
+   *     processed, this operation may slow the total execution time of this method but is more
+   *     reliable.
+   */
+  public <T> WatchResponse partialUpdateObjectsWithTransformation(
+    String indexName,
+    Iterable<T> objects,
+    boolean createIfNotExists,
+    boolean waitForTasks
+  ) {
+    return partialUpdateObjectsWithTransformation(indexName, objects, createIfNotExists, waitForTasks, null);
+  }
+
+  /**
+   * Helper: Similar to the `partialUpdateObjects` method but requires a Push connector
+   * (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/)
+   * to be created first, in order to transform records before indexing them to Algolia. The
+   * `region` must have been passed to the client instantiation method.
+   *
+   * @param indexName The `indexName` to update `objects` in.
+   * @param objects The array of `objects` to update in the given Algolia `indexName`.
+   * @param createIfNotExists To be provided if non-existing objects are passed, otherwise, the call
+   *     will fail.
+   * @param waitForTasks - Whether or not we should wait until every `batch` tasks has been
+   *     processed, this operation may slow the total execution time of this method but is more
+   *     reliable.
+   * @param requestOptions The requestOptions to send along with the query, they will be merged with
+   *     the transporter requestOptions. (optional)
+   */
+  public <T> WatchResponse partialUpdateObjectsWithTransformation(
+    String indexName,
+    Iterable<T> objects,
+    boolean createIfNotExists,
+    boolean waitForTasks,
+    RequestOptions requestOptions
+  ) {
+    return partialUpdateObjectsWithTransformation(indexName, objects, createIfNotExists, waitForTasks, 1000, null);
+  }
+
+  /**
+   * Helper: Similar to the `partialUpdateObjects` method but requires a Push connector
+   * (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/)
+   * to be created first, in order to transform records before indexing them to Algolia. The
+   * `region` must have been passed to the client instantiation method.
+   *
+   * @param indexName The `indexName` to update `objects` in.
+   * @param objects The array of `objects` to update in the given Algolia `indexName`.
+   * @param createIfNotExists To be provided if non-existing objects are passed, otherwise, the call
+   *     will fail.
+   * @param waitForTasks - Whether or not we should wait until every `batch` tasks has been
+   *     processed, this operation may slow the total execution time of this method but is more
+   *     reliable.
+   * @param batchSize The size of the chunk of `objects`. The number of `batch` calls will be equal
+   *     to `length(objects) / batchSize`.
+   * @param requestOptions The requestOptions to send along with the query, they will be merged with
+   *     the transporter requestOptions. (optional)
+   */
+  public <T> WatchResponse partialUpdateObjectsWithTransformation(
+    String indexName,
+    Iterable<T> objects,
+    boolean createIfNotExists,
+    boolean waitForTasks,
+    int batchSize,
+    RequestOptions requestOptions
+  ) {
+    if (this.ingestionTransporter == null) {
+      throw new AlgoliaRuntimeException("`setTransformationRegion` must have been called before calling this method.");
+    }
+
+    return this.ingestionTransporter.push(
+        indexName,
+        new PushTaskPayload()
+          .setAction(
+            createIfNotExists
+              ? com.algolia.model.ingestion.Action.PARTIAL_UPDATE_OBJECT
+              : com.algolia.model.ingestion.Action.PARTIAL_UPDATE_OBJECT_NO_CREATE
+          )
+          .setRecords(this.objectsToPushTaskRecords(objects)),
+        waitForTasks,
+        requestOptions
+      );
+  }
+
   /**
    * Helper: Replaces object content of all the given objects according to their respective
    * `objectID` field. The `chunkedBatch` helper is used under the hood, which creates a `batch`

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

@@ -23,6 +23,14 @@ public void setApiKey(String apiKey) {
     this.apiKey = apiKey;
   }
 
+  public String getApiKey() {
+    return this.apiKey;
+  }
+
+  public String getApplicationId() {
+    return this.applicationId;
+  }
+
   @Nonnull
   @Override
   public Response intercept(Chain chain) throws IOException {

clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/internal/interceptors/AuthInterceptor.java

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.14.1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.14.2-bin.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME

clients/algoliasearch-client-java/gradle/wrapper/gradle-wrapper.properties

@@ -15,7 +15,7 @@
     "test:bundle": "lerna run test:bundle --verbose --include-dependencies"
   },
   "devDependencies": {
-    "@types/node": "22.15.29",
+    "@types/node": "22.15.30",
     "bundlewatch": "0.4.1",
     "execa": "9.6.0",
     "lerna": "8.2.2",

clients/algoliasearch-client-javascript/package.json

@@ -62,7 +62,7 @@ export type Algoliasearch = SearchClient & {
    */
   saveObjectsWithTransformation: (
     options: SaveObjectsOptions,
-    requestOptions?: RequestOptions,
+    requestOptions?: RequestOptions | undefined,
   ) => Promise<WatchResponse>;
 
   /**
@@ -79,22 +79,24 @@ export type Algoliasearch = SearchClient & {
    */
   partialUpdateObjectsWithTransformation: (
     options: PartialUpdateObjectsOptions,
-    requestOptions?: RequestOptions,
+    requestOptions?: RequestOptions | undefined,
   ) => Promise<WatchResponse>;
 };
 
 export type TransformationOptions = {
   // When provided, a second transporter will be created in order to leverage the `*WithTransformation` methods exposed by the Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/).
-  transformation?: {
-    // The region of your Algolia application ID, used to target the correct hosts of the transformation service.
-    region: IngestionRegion;
-  };
+  transformation?:
+    | {
+        // The region of your Algolia application ID, used to target the correct hosts of the transformation service.
+        region: IngestionRegion;
+      }
+    | undefined;
 };
 
 export function algoliasearch(
   appId: string,
   apiKey: string,
-  options?: ClientOptions & TransformationOptions,
+  options?: (ClientOptions & TransformationOptions) | undefined,
 ): Algoliasearch {
   if (!appId || typeof appId !== 'string') {
     throw new Error('`appId` is missing.');