customTypeAliases parameter

Author: vojtechhabarta

typescript-generator-core/src/main/java/cz/habarta/typescript/generator/Settings.java

@@ -15,6 +15,7 @@
 import java.net.URL;
 import java.net.URLClassLoader;
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.Collections;
 import java.util.LinkedHashMap;
 import java.util.LinkedHashSet;
@@ -23,6 +24,7 @@
 import java.util.Objects;
 import java.util.Set;
 import java.util.function.Predicate;
+import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
 
@@ -60,6 +62,7 @@ public class Settings {
     public List<String> referencedFiles = new ArrayList<>();
     public List<String> importDeclarations = new ArrayList<>();
     public Map<String, String> customTypeMappings = new LinkedHashMap<>();
+    public Map<String, String> customTypeAliases = new LinkedHashMap<>();
     public DateMapping mapDate; // default is DateMapping.asDate
     public EnumMapping mapEnum; // default is EnumMapping.asUnion
     public boolean nonConstEnums = false;
@@ -205,6 +208,30 @@ public static Map<String, String> convertToMap(List<String> mappings) {
         return result;
     }
 
+    public static Pair<String, List<String>> parseGenericTypeName(String type) {
+        final Matcher matcher = Pattern.compile("([^<]+)<([^>]+)>").matcher(type);
+        final String name;
+        final List<String> typeParameters;
+        if (matcher.matches()) {  // is generic?
+            name = matcher.group(1);
+            typeParameters = Arrays.asList(matcher.group(2).split(","));
+        } else {
+            name = type;
+            typeParameters = null;
+        }
+        if (!ModelCompiler.isValidIdentifierName(name)) {
+            throw new RuntimeException(String.format("Invalid identifier: '%s'", name));
+        }
+        if (typeParameters != null) {
+            for (String typeParameter : typeParameters) {
+                if (!ModelCompiler.isValidIdentifierName(typeParameter)) {
+                    throw new RuntimeException(String.format("Invalid generic type parameter: '%s'", typeParameter));
+                }
+            }
+        }
+        return Pair.of(name, typeParameters);
+    }
+
     public void validate() {
         if (outputKind == null) {
             throw new RuntimeException("Required 'outputKind' parameter is not configured. " + seeLink());
@@ -233,6 +260,9 @@ public void validate() {
         if (jackson2Configuration != null && jsonLibrary != JsonLibrary.jackson2) {
             throw new RuntimeException("'jackson2Configuration' parameter is only applicable to 'jackson2' library.");
         }
+        for (Map.Entry<String, String> entry : customTypeAliases.entrySet()) {
+            parseGenericTypeName(entry.getValue());
+        }
         for (EmitterExtension extension : extensions) {
             final String extensionName = extension.getClass().getSimpleName();
             final DeprecationText deprecation = extension.getClass().getAnnotation(DeprecationText.class);

typescript-generator-core/src/main/java/cz/habarta/typescript/generator/compiler/ModelCompiler.java

@@ -111,6 +111,7 @@ public TsModel javaToTypeScript(Model model) {
         final List<Extension.TransformerDefinition> extensionTransformers = getExtensionTransformers();
         model = applyExtensionModelTransformers(symbolTable, model, extensionTransformers);
         TsModel tsModel = processModel(symbolTable, model);
+        tsModel = addCustomTypeAliases(symbolTable, tsModel);
         tsModel = removeInheritedProperties(symbolTable, tsModel);
         tsModel = addImplementedProperties(symbolTable, tsModel);
 
@@ -420,6 +421,20 @@ private TsType typeFromJava(SymbolTable symbolTable, Type javaType, Object typeC
         }
     }
 
+    private TsModel addCustomTypeAliases(SymbolTable symbolTable, TsModel tsModel) {
+        final List<TsAliasModel> aliases = new ArrayList<>(tsModel.getTypeAliases());
+        for (Map.Entry<String, String> entry : settings.customTypeAliases.entrySet()) {
+            final Pair<String, List<String>> pair = Settings.parseGenericTypeName(entry.getKey());
+            final Symbol name = symbolTable.getSyntheticSymbol(pair.getValue1());
+            final List<TsType.GenericVariableType> typeParameters = pair.getValue2().stream()
+                    .map(TsType.GenericVariableType::new)
+                    .collect(Collectors.toList());
+            final TsType definition = new TsType.VerbatimType(entry.getValue());
+            aliases.add(new TsAliasModel(null, name, typeParameters, definition, null));
+        }
+        return tsModel.withTypeAliases(aliases);
+    }
+
     private TsModel removeInheritedProperties(SymbolTable symbolTable, TsModel tsModel) {
         final List<TsBeanModel> beans = new ArrayList<>();
         for (TsBeanModel bean : tsModel.getBeans()) {

typescript-generator-core/src/test/java/cz/habarta/typescript/generator/CustomTypeAliasesTest.java

@@ -0,0 +1,30 @@
+
+package cz.habarta.typescript.generator;
+
+import java.util.Collections;
+import org.junit.Assert;
+import org.junit.Test;
+
+
+public class CustomTypeAliasesTest {
+
+    @Test
+    public void test() {
+        final Settings settings = TestUtils.settings();
+        settings.outputKind = TypeScriptOutputKind.module;
+        settings.customTypeAliases = Collections.singletonMap("Id<T>", "string");
+        settings.customTypeMappings = Collections.singletonMap(IdRepresentation.class.getName(), "Id");
+        final String output = new TypeScriptGenerator(settings).generateTypeScript(Input.from(MyEntityRepresentation.class));
+        Assert.assertTrue(output.contains("id: Id<MyEntityRepresentation>"));
+        Assert.assertTrue(output.contains("export type Id<T> = string"));
+    }
+
+    private static class MyEntityRepresentation {
+        public IdRepresentation<MyEntityRepresentation> id;
+    }
+
+    private static class IdRepresentation<T> {
+        public String id;
+    }
+
+}

typescript-generator-gradle-plugin/src/main/java/cz/habarta/typescript/generator/gradle/GenerateTask.java

@@ -68,6 +68,7 @@ public class GenerateTask extends DefaultTask {
     public List<String> referencedFiles;
     public List<String> importDeclarations;
     public List<String> customTypeMappings;
+    public List<String> customTypeAliases;
     public DateMapping mapDate;
     public EnumMapping mapEnum;
     public boolean nonConstEnums;
@@ -165,6 +166,7 @@ public void generate() throws Exception {
             settings.referencedFiles = referencedFiles;
             settings.importDeclarations = importDeclarations;
             settings.customTypeMappings = Settings.convertToMap(customTypeMappings);
+            settings.customTypeAliases = Settings.convertToMap(customTypeAliases);
             settings.mapDate = mapDate;
             settings.mapEnum = mapEnum;
             settings.nonConstEnums = nonConstEnums;

typescript-generator-maven-plugin/src/main/java/cz/habarta/typescript/generator/maven/GenerateMojo.java

@@ -325,6 +325,16 @@ public class GenerateMojo extends AbstractMojo {
     @Parameter
     private List<String> customTypeMappings;
 
+    /**
+     * List of custom type aliases.
+     * Each item it this list specifies type alias name (possibly with generic parameters) and its definition.
+     * Item format is: <code>name:definition</code>.
+     * For example for <code>Unwrap&lt;T>:T</code> following type alias will be generated <code>type Unwrap&lt;T> = T</code>.
+     * Other examples: <code>SimpleName:VeryLongGeneratedName</code>, <code>StringID&lt;T>:string</code>.
+     */
+    @Parameter
+    private List<String> customTypeAliases;
+
     /**
      * Specifies how {@link java.util.Date} will be mapped.
      * Supported values are:
@@ -743,6 +753,7 @@ public void execute() {
             settings.referencedFiles = referencedFiles;
             settings.importDeclarations = importDeclarations;
             settings.customTypeMappings = Settings.convertToMap(customTypeMappings);
+            settings.customTypeAliases = Settings.convertToMap(customTypeAliases);
             settings.mapDate = mapDate;
             settings.mapEnum = mapEnum;
             settings.nonConstEnums = nonConstEnums;