Add preview mode & support for auto-translation options

Author: jpomykala

pom.xml

@@ -4,7 +4,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>io.simplelocalize</groupId>
     <artifactId>simplelocalize-cli</artifactId>
-    <version>2.8.0</version>
+    <version>2.9.0</version>
     <packaging>jar</packaging>
     <name>simplelocalize-cli</name>
     <description>Official SimpleLocalize Command Line Interface</description>

src/main/java/io/simplelocalize/cli/SimplelocalizeCliCommand.java

@@ -94,9 +94,10 @@ public void upload(
           @Option(names = {"--uploadNamespace", "--namespace"}, description = "(Optional) Specify namespace for single file upload (cannot be used with {ns} in uploadPath)") String namespace,
           @Option(names = {"--uploadLanguageKey", "--languageKey"}, description = "(Optional) Specify language key for single file upload (cannot be used with {lang} in uploadPath)") String languageKey,
           @Option(names = {"--uploadCustomerId", "--customerId"}, description = "(Optional) Assign customerId to uploaded translations") String customerId,
-          @Option(names = {"--overwrite"}, description = "(Optional) Overwrite existing translations", defaultValue = "false") Boolean overwrite,
+          @Option(names = {"--overwrite", "--replace", "--update"}, description = "(Optional) Update existing translations", defaultValue = "false") Boolean updateTranslations,
           @Option(names = {"--delete"}, description = "(Optional) Delete translations which are not present in uploaded file", defaultValue = "false") Boolean delete,
           @Option(names = {"--dryRun"}, description = "(Optional) Dry run mode. Do not upload anything to SimpleLocalize", defaultValue = "false") Boolean dryRun,
+          @Option(names = {"--preview"}, description = "(Optional) Preview changes before importing files", defaultValue = "false") Boolean preview,
           @Option(names = {"--baseUrl"}, description = "(Optional) Set custom server URL") String baseUrl
   )
   {
@@ -150,7 +151,7 @@ public void upload(
         effectiveUploadOptions = new ArrayList<>(uploadOptions);
       }
 
-      if (Boolean.TRUE.equals(overwrite))
+      if (Boolean.TRUE.equals(updateTranslations))
       {
         effectiveUploadOptions.add("REPLACE_TRANSLATION_IF_FOUND");
       }
@@ -166,6 +167,11 @@ public void upload(
         configuration.setDryRun(true);
       }
 
+      if (Boolean.TRUE.equals(preview))
+      {
+        configuration.setPreview(true);
+      }
+
       this.effectiveCommandConfiguration = configuration;
       SimpleLocalizeClient client = SimpleLocalizeClient.create(configuration.getBaseUrl(), configuration.getApiKey());
       UploadCommand uploadCommand = new UploadCommand(client, configuration);
@@ -310,6 +316,8 @@ public void pull(
   public void autoTranslate(
           @Option(names = {"--apiKey"}, description = "Project API Key") String apiKey,
           @Option(names = {"--autoTranslateLanguageKey", "--languageKey", "--languageKeys"}, description = "(Optional) Project language keys to auto-translate", split = ",") List<String> languageKeys,
+          @Option(names = {"--force"}, description = "(Optional) Force auto-translation for all translations") Boolean forceAutoTranslate,
+          @Option(names = {"--autoTranslateOptions", "--options"}, description = "(Optional) Auto-translate options") List<String> autoTranslateOptions,
           @Option(names = {"--baseUrl"}, description = "(Optional) Set custom server URL") String baseUrl
   )
   {
@@ -332,6 +340,19 @@ public void autoTranslate(
         configuration.setAutoTranslateLanguageKeys(languageKeys);
       }
 
+      List<String> effectiveAutoTranslateOptions = new ArrayList<>();
+      if (autoTranslateOptions != null && !autoTranslateOptions.isEmpty())
+      {
+        effectiveAutoTranslateOptions.addAll(autoTranslateOptions);
+      }
+
+      if (Boolean.TRUE.equals(forceAutoTranslate))
+      {
+        effectiveAutoTranslateOptions.add("FORCE_REPLACE");
+      }
+      configuration.setAutoTranslateOptions(effectiveAutoTranslateOptions);
+
+      configuration.setAutoTranslateOptions(autoTranslateOptions);
       this.effectiveCommandConfiguration = configuration;
       SimpleLocalizeClient client = SimpleLocalizeClient.create(configuration.getBaseUrl(), configuration.getApiKey());
       AutoTranslationCommand command = new AutoTranslationCommand(client, configuration);

src/main/java/io/simplelocalize/cli/Version.java

@@ -3,7 +3,7 @@
 public class Version
 {
 
-  public static final String NUMBER = "2.8.0";
+  public static final String NUMBER = "2.9.0";
 
   private Version()
   {

src/main/java/io/simplelocalize/cli/client/ClientBodyBuilders.java

@@ -33,9 +33,9 @@ static HttpRequest.BodyPublisher ofKeysBody(Collection<String> keys) throws Json
     return HttpRequest.BodyPublishers.ofString(jsonString);
   }
 
-  static HttpRequest.BodyPublisher ofStartAutoTranslation(Collection<String> languageKeys) throws JsonProcessingException
+  static HttpRequest.BodyPublisher ofStartAutoTranslation(Collection<String> languageKeys, Collection<String> options) throws JsonProcessingException
   {
-    StartAutoTranslationRequest request = new StartAutoTranslationRequest(languageKeys, "CLI");
+    StartAutoTranslationRequest request = new StartAutoTranslationRequest(languageKeys, "CLI", options);
     String jsonString = ObjectMapperSingleton.getInstance().writeValueAsString(request);
     return HttpRequest.BodyPublishers.ofString(jsonString);
   }

src/main/java/io/simplelocalize/cli/client/SimpleLocalizeClient.java

@@ -1,6 +1,7 @@
 package io.simplelocalize.cli.client;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
+import com.jayway.jsonpath.DocumentContext;
 import com.jayway.jsonpath.JsonPath;
 import com.jayway.jsonpath.Option;
 import io.simplelocalize.cli.client.dto.ExportRequest;
@@ -68,12 +69,22 @@ public static String loadApiKeyFromEnvironmentVariable()
 
   public void uploadFile(UploadRequest uploadRequest) throws IOException, InterruptedException
   {
-    URI uri = uriFactory.buildUploadUri(uploadRequest);
+    URI uri = uriFactory.buildUploadUri(uploadRequest, false);
     HttpRequest httpRequest = httpRequestFactory.createUploadFileRequest(uri, uploadRequest);
     HttpResponse<String> httpResponse = httpClient.send(httpRequest, HttpResponse.BodyHandlers.ofString());
     throwOnError(httpResponse);
   }
 
+  public String previewFile(UploadRequest uploadRequest) throws IOException, InterruptedException
+  {
+    URI uri = uriFactory.buildUploadUri(uploadRequest, true);
+    HttpRequest httpRequest = httpRequestFactory.createUploadFileRequest(uri, uploadRequest);
+    HttpResponse<String> httpResponse = httpClient.send(httpRequest, HttpResponse.BodyHandlers.ofString());
+    throwOnError(httpResponse);
+    DocumentContext json = JsonPath.parse(httpResponse.body());
+    return json.read("$.data", String.class);
+  }
+
   public List<DownloadableFile> exportFiles(ExportRequest exportRequest) throws IOException, InterruptedException
   {
     URI downloadUri = uriFactory.buildDownloadUri(exportRequest);
@@ -130,12 +141,12 @@ public String getAutoTranslationJobs() throws IOException, InterruptedException
     return httpResponse.body();
   }
 
-  public void startAutoTranslation(List<String> languageKeys) throws IOException, InterruptedException
+  public void startAutoTranslation(List<String> languageKeys, List<String> options) throws IOException, InterruptedException
   {
     URI startAutoTranslationUri = uriFactory.buildStartAutoTranslationUri();
     HttpRequest httpRequest = httpRequestFactory.createBaseRequest(startAutoTranslationUri)
             .header("Content-Type", "application/json; charset=utf-8")
-            .POST(ClientBodyBuilders.ofStartAutoTranslation(languageKeys)).build();
+            .POST(ClientBodyBuilders.ofStartAutoTranslation(languageKeys, options)).build();
     HttpResponse<String> httpResponse = httpClient.send(httpRequest, HttpResponse.BodyHandlers.ofString());
     throwOnError(httpResponse);
   }

src/main/java/io/simplelocalize/cli/client/SimpleLocalizeUriFactory.java

@@ -54,10 +54,16 @@ URI buildDownloadUri(ExportRequest exportRequest)
     return URI.create(endpointUrl);
   }
 
-
-  URI buildUploadUri(UploadRequest uploadRequest)
+  URI buildUploadUri(UploadRequest uploadRequest, boolean isPreviewMode)
   {
-    String endpointUrl = baseUrl + "/cli/v2/upload?uploadFormat=" + uploadRequest.format();
+    String command = "upload";
+    if (isPreviewMode)
+    {
+      command = "upload-preview";
+    }
+
+    String endpointUrl = baseUrl + "/cli/v2/" + command + "?uploadFormat=" + uploadRequest.format();
+
     String languageKey = uploadRequest.languageKey();
     if (StringUtils.isNotEmpty(languageKey))
     {

src/main/java/io/simplelocalize/cli/client/dto/proxy/Configuration.java

@@ -55,6 +55,9 @@ public class Configuration
   @Builder.Default
   private Boolean dryRun = false;
 
+  @Builder.Default
+  private Boolean preview = false;
+
   /**
    * Download command
    */
@@ -75,6 +78,8 @@ public class Configuration
    * Auto-translate command
    */
   private List<String> autoTranslateLanguageKeys = new ArrayList<>();
+  @Builder.Default
+  private List<String> autoTranslateOptions = new ArrayList<>();
 
   /**
    * Pull & Publish command

src/main/java/io/simplelocalize/cli/client/dto/proxy/StartAutoTranslationRequest.java

@@ -11,6 +11,9 @@ public record StartAutoTranslationRequest(
         @JsonProperty("languageKeys")
         Collection<String> languageKeys,
         @JsonProperty("source")
-        String source)
+        String source,
+        @JsonProperty("options")
+        Collection<String> options
+)
 {
 }

src/main/java/io/simplelocalize/cli/command/AutoTranslationCommand.java

@@ -43,7 +43,16 @@ public void invoke() throws IOException, InterruptedException
     {
       log.info("Starting auto-translation for languages: {}", languageKeys);
     }
-    client.startAutoTranslation(languageKeys);
+    List<String> autoTranslateOptions = Optional.of(configuration)
+            .map(Configuration::getAutoTranslateOptions)
+            .orElse(List.of());
+
+    if (!autoTranslateOptions.isEmpty())
+    {
+      log.info("Auto-translation options: {}", autoTranslateOptions);
+    }
+
+    client.startAutoTranslation(languageKeys, autoTranslateOptions);
     log.info("Auto-translation started");
     Thread.sleep(5_000);
 

src/main/java/io/simplelocalize/cli/command/UploadCommand.java

@@ -40,6 +40,12 @@ public void invoke() throws IOException, InterruptedException
       log.info("Dry run mode enabled, no files will be uploaded");
     }
 
+    final boolean isPreviewMode = Boolean.TRUE.equals(configuration.getPreview());
+    if (isPreviewMode)
+    {
+      log.info("Preview mode enabled");
+    }
+
     String uploadPath = configuration.getUploadPath();
     if (SystemUtils.isWindows())
     {
@@ -145,7 +151,21 @@ public void invoke() throws IOException, InterruptedException
       {
         continue;
       }
-      client.uploadFile(uploadRequest);
+
+      if (isPreviewMode)
+      {
+        String output = client.previewFile(uploadRequest);
+        log.info("{}", output);
+      } else
+      {
+        client.uploadFile(uploadRequest);
+      }
+    }
+
+    if (isPreviewMode)
+    {
+      log.info("Preview completed. No files were imported. To import files, run the command without --preview flag.");
+      return;
     }
 
     if (isDryRun)