Introduce 2.8.0-alpha

- Add support to TSV format
- Add support for key-to-file and vice versa
- Add support for exporting files for customers
- Add support for download custom paths
- Include file name in upload requests
- Include a file path in upload requests (must be turned on explicitly)

Author: jpomykala

pom.xml

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

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

@@ -5,6 +5,9 @@ public class TemplateKeys
 
   public static final String LANGUAGE_TEMPLATE_KEY = "{lang}";
   public static final String NAMESPACE_TEMPLATE_KEY = "{ns}";
+  public static final String CUSTOMER_KEY_TEMPLATE_KEY = "{customer}";
+  public static final String TRANSLATION_KEY_TEMPLATE_KEY = "{translationKey}";
+  public static final String REMOTE_PATH = "{remotePath}";
 
   private TemplateKeys()
   {

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

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

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

@@ -26,8 +26,7 @@
 import java.util.Objects;
 import java.util.Optional;
 
-import static io.simplelocalize.cli.TemplateKeys.LANGUAGE_TEMPLATE_KEY;
-import static io.simplelocalize.cli.TemplateKeys.NAMESPACE_TEMPLATE_KEY;
+import static io.simplelocalize.cli.TemplateKeys.*;
 
 public class SimpleLocalizeClient
 {
@@ -91,7 +90,10 @@ public void downloadFile(DownloadableFile downloadableFile, String downloadPathT
     Optional<DownloadableFile> optionalDownloadableFile = Optional.of(downloadableFile);
     String downloadPath = downloadPathTemplate
             .replace(NAMESPACE_TEMPLATE_KEY, optionalDownloadableFile.map(DownloadableFile::namespace).orElse(""))
-            .replace(LANGUAGE_TEMPLATE_KEY, optionalDownloadableFile.map(DownloadableFile::language).orElse(""));
+            .replace(LANGUAGE_TEMPLATE_KEY, optionalDownloadableFile.map(DownloadableFile::language).orElse(""))
+            .replace(CUSTOMER_KEY_TEMPLATE_KEY, optionalDownloadableFile.map(DownloadableFile::customer).orElse(""))
+            .replace(TRANSLATION_KEY_TEMPLATE_KEY, optionalDownloadableFile.map(DownloadableFile::translationKey).orElse(""))
+            .replace(REMOTE_PATH, optionalDownloadableFile.map(DownloadableFile::remotePath).orElse(""));
     String url = downloadableFile.url();
     Path savePath = Path.of(downloadPath);
     downloadFile(url, savePath);

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

@@ -5,6 +5,7 @@
 import io.simplelocalize.cli.util.StringUtils;
 
 import java.net.URI;
+import java.nio.file.Path;
 import java.util.List;
 
 public class SimpleLocalizeUriFactory
@@ -81,6 +82,29 @@ URI buildUploadUri(UploadRequest uploadRequest)
       endpointUrl += "&customerId=" + customerId;
     }
 
+    String translationKey = uploadRequest.translationKey();
+    if (StringUtils.isNotEmpty(translationKey))
+    {
+      if (translationKey.length() > 500)
+      {
+        throw new IllegalArgumentException("Translation key is too long. Max length is 500 characters");
+      }
+      endpointUrl += "&translationKey=" + translationKey;
+    }
+
+    Path filePath = uploadRequest.path();
+    String fileName = filePath.getFileName().toString();
+    if (StringUtils.isNotEmpty(fileName))
+    {
+      endpointUrl += "&fileName=" + fileName;
+    }
+
+    boolean includeFilePath = uploadOptions.contains("INCLUDE_FILE_PATH");
+    if (includeFilePath)
+    {
+      endpointUrl += "&path=" + filePath;
+    }
+
     return URI.create(endpointUrl);
   }
 

src/main/java/io/simplelocalize/cli/client/dto/FileToUpload.java

@@ -6,6 +6,6 @@
 import java.nio.file.Path;
 
 @Builder(setterPrefix = "with")
-public record FileToUpload(Path path, String language, String namespace)
+public record FileToUpload(Path path, String language, String namespace, String translationKey)
 {
 }

src/main/java/io/simplelocalize/cli/client/dto/UploadRequest.java

@@ -12,7 +12,8 @@ public record UploadRequest(
         String format,
         List<String> options,
         String namespace,
-        String customerId
+        String customerId,
+        String translationKey
 )
 {
 }

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

@@ -5,6 +5,6 @@
 
 @NativeProxy
 @Builder(setterPrefix = "with")
-public record DownloadableFile(String url, String namespace, String language)
+public record DownloadableFile(String url, String namespace, String language, String customer, String translationKey, String remotePath)
 {
 }

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

@@ -73,6 +73,11 @@ public void invoke() throws IOException, InterruptedException
       downloadOptions.add("SPLIT_BY_LANGUAGES");
     }
 
+    if (downloadPath.contains(TemplateKeys.CUSTOMER_KEY_TEMPLATE_KEY))
+    {
+      downloadOptions.add("SPLIT_BY_CUSTOMERS");
+    }
+
     if (!downloadOptions.isEmpty())
     {
       log.info("Options: {}", downloadOptions);

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

@@ -104,8 +104,11 @@ public void invoke() throws IOException, InterruptedException
       final String fileNamespace = fileToUpload.namespace();
       final String effectiveNamespace = hasDefinedNamespace ? uploadNamespace : fileNamespace;
 
+      final String translationKey = fileToUpload.translationKey();
+
       final UploadRequest uploadRequest = UploadRequest.builder()
               .withPath(path)
+              .withTranslationKey(translationKey)
               .withFormat(uploadFormat)
               .withLanguageKey(effectiveLanguageKey)
               .withNamespace(effectiveNamespace)
@@ -132,6 +135,11 @@ public void invoke() throws IOException, InterruptedException
         logMessage += " (namespace: " + fileNamespace + ")";
       }
 
+      if (StringUtils.isNotEmpty(translationKey))
+      {
+        logMessage += " (translation key: " + translationKey + ")";
+      }
+
       log.info(logMessage, path);
       if (isDryRun)
       {
@@ -180,7 +188,7 @@ private void validateConfiguration(Configuration configuration)
 
   private boolean isMultiLanguage(Configuration configuration)
   {
-    final List<String> multiLanguageFileFormats = List.of("multi-language-json", "excel", "csv-translations", "localizable-xcstrings");
+    final List<String> multiLanguageFileFormats = List.of("multi-language-json", "excel", "csv-translations", "tsv", "localizable-xcstrings");
     for (String uploadFormat : multiLanguageFileFormats)
     {
       if (uploadFormat.equalsIgnoreCase(configuration.getUploadFormat()))