custom type mapping (closes #60)

Author: vojtechhabarta

.gitignore

@@ -10,4 +10,3 @@ release.properties
 **.classpath
 **.project
 **.settings
-*.d.ts

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

@@ -0,0 +1,28 @@
+
+package cz.habarta.typescript.generator;
+
+import java.lang.reflect.Type;
+import java.util.*;
+
+
+public class CustomMappingTypeProcessor implements TypeProcessor {
+
+    private final Map<String, String> customMappings;
+
+    public CustomMappingTypeProcessor(Map<String, String> customMappings) {
+        this.customMappings = customMappings;
+    }
+
+    @Override
+    public Result processType(Type javaType, Context context) {
+        final Class<?> rawClass = Utils.getRawClassOrNull(javaType);
+        if (rawClass != null) {
+            final String tsTypeName = customMappings.get(rawClass.getName());
+            if (tsTypeName != null) {
+                return new Result(new TsType.BasicType(tsTypeName));
+            }
+        }
+        return null;
+    }
+
+}

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

@@ -28,6 +28,9 @@ public class Settings {
     public String addTypeNamePrefix = null;
     public String addTypeNameSuffix = null;
     public Map<String, String> customTypeNaming = new LinkedHashMap<>();
+    public List<String> referencedFiles = new ArrayList<>();
+    public List<String> importDeclarations = new ArrayList<>();
+    public Map<String, String> customTypeMappings = new LinkedHashMap<>();
     public DateMapping mapDate = DateMapping.asDate;
     public TypeProcessor customTypeProcessor = null;
     public boolean sortDeclarations = false;

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

@@ -58,6 +58,7 @@ public TypeProcessor getTypeProcessor() {
             if (settings.customTypeProcessor != null) {
                 processors.add(settings.customTypeProcessor);
             }
+            processors.add(new CustomMappingTypeProcessor(settings.customTypeMappings));
             processors.add(new GenericsTypeProcessor());
             processors.add(new DefaultTypeProcessor());
             typeProcessor = new TypeProcessor.Chain(processors);

typescript-generator-core/src/main/java/cz/habarta/typescript/generator/emitter/Emitter.java

@@ -26,6 +26,8 @@ public void emit(TsModel model, Writer output, String outputName, boolean closeO
             System.out.println("Writing declarations to: " + outputName);
         }
         emitFileComment();
+        emitReferences();
+        emitImports();
         emitModule(model);
         if (closeOutput) {
             close();
@@ -39,10 +41,28 @@ private void emitFileComment() {
         }
     }
 
+    private void emitReferences() {
+        if (settings.referencedFiles != null && !settings.referencedFiles.isEmpty()) {
+            writeNewLine();
+            for (String reference : settings.referencedFiles) {
+                writeIndentedLine("/// <reference path=" + quote(reference) + " />");
+            }
+        }
+    }
+
+    private void emitImports() {
+        if (settings.importDeclarations != null && !settings.importDeclarations.isEmpty()) {
+            writeNewLine();
+            for (String importDeclaration : settings.importDeclarations) {
+                writeIndentedLine(importDeclaration + ";");
+            }
+        }
+    }
+
     private void emitModule(TsModel model) {
         if (settings.outputKind == TypeScriptOutputKind.ambientModule) {
             writeNewLine();
-            writeIndentedLine("declare module " + settings.quotes + settings.module + settings.quotes + " {");
+            writeIndentedLine("declare module " + quote(settings.module) + " {");
             indent++;
             emitNamespace(model);
             indent--;
@@ -122,7 +142,7 @@ private void emitProperty(TsPropertyModel property) {
     }
 
     private String toPropertyName(String name) {
-        return isValidIdentifierName(name) ? name : (settings.quotes + name + settings.quotes);
+        return isValidIdentifierName(name) ? name : quote(name);
     }
 
     // https://github.com/Microsoft/TypeScript/blob/master/doc/spec.md#2.2.2
@@ -192,6 +212,10 @@ private void writeNewLine() {
         }
     }
 
+    private String quote(String value) {
+        return settings.quotes + value + settings.quotes;
+    }
+
     private void close() {
         try {
             writer.close();

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

@@ -0,0 +1,32 @@
+
+package cz.habarta.typescript.generator;
+
+import java.util.*;
+import static org.junit.Assert.*;
+import org.junit.Test;
+
+
+public class CustomTypeMappingTest {
+
+    @Test
+    public void test() {
+        final Settings settings = TestUtils.settings();
+        settings.quotes = "'";
+        settings.referencedFiles.add("../src/test/ts/my-custom-types.d.ts");
+        settings.importDeclarations.add("import * as myModule from '../src/test/ts/my-module.d.ts'");
+        settings.customTypeMappings.put("java.util.Date", "MyDate");
+        settings.customTypeMappings.put("java.util.Calendar", "myModule.MyCalendar");
+//        new TypeScriptGenerator(settings).generateTypeScript(Input.from(CustomTypesUsage.class), Output.to(new File("target/CustomTypeMappingTest.d.ts")));
+        final String output = new TypeScriptGenerator(settings).generateTypeScript(Input.from(CustomTypesUsage.class));
+        assertTrue(output.contains("/// <reference path='../src/test/ts/my-custom-types.d.ts' />"));
+        assertTrue(output.contains("import * as myModule from '../src/test/ts/my-module.d.ts';"));
+        assertTrue(output.contains("date1: MyDate;"));
+        assertTrue(output.contains("calendar1: myModule.MyCalendar;"));
+    }
+
+    private static class CustomTypesUsage {
+        public Date date1;
+        public Calendar calendar1;
+    }
+
+}

typescript-generator-core/src/test/ts/my-custom-types.d.ts

@@ -0,0 +1,3 @@
+// used in CustomTypeMappingTest
+
+type MyDate = string;

typescript-generator-core/src/test/ts/my-module.d.ts

@@ -0,0 +1,3 @@
+// used in CustomTypeMappingTest
+
+export type MyCalendar = string;

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

@@ -28,6 +28,9 @@ public class GenerateTask extends DefaultTask {
     public String addTypeNamePrefix;
     public String addTypeNameSuffix;
     public List<String> customTypeNaming;
+    public List<String> referencedFiles;
+    public List<String> importDeclarations;
+    public List<String> customTypeMappings;
     public DateMapping mapDate;
     public String customTypeProcessor;
     public boolean sortDeclarations;
@@ -77,6 +80,9 @@ public void generate() throws Exception {
         settings.addTypeNamePrefix = addTypeNamePrefix;
         settings.addTypeNameSuffix = addTypeNameSuffix;
         settings.customTypeNaming = Settings.convertToMap(customTypeNaming);
+        settings.referencedFiles = referencedFiles;
+        settings.importDeclarations = importDeclarations;
+        settings.customTypeMappings = Settings.convertToMap(customTypeMappings);
         settings.mapDate = mapDate;
         settings.loadCustomTypeProcessor(classLoader, customTypeProcessor);
         settings.sortDeclarations = sortDeclarations;

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

@@ -137,6 +137,29 @@ public class GenerateMojo extends AbstractMojo {
     @Parameter
     private List<String> customTypeNaming;
 
+    /**
+     * List of files which will be referenced using triple-slash directive: /// &lt;reference path="file" />.
+     * This can be used with "customTypeMappings" to provide needed TypeScript types.
+     */
+    @Parameter
+    private List<String> referencedFiles;
+
+    /**
+     * List of import declarations which will be added to generated output.
+     * This can be used with "customTypeMappings" to provide needed TypeScript types.
+     */
+    @Parameter
+    private List<String> importDeclarations;
+
+    /**
+     * List of custom mappings.
+     * Each item specifies TypeScript type which will be used for particular Java class.
+     * Item format is: "javaClass:typescriptType".
+     * For example mapping "ZonedDateTime" to "string" would be added as "java.time.ZonedDateTime:string".
+     */
+    @Parameter
+    private List<String> customTypeMappings;
+
     /**
      * Specifies how {@link java.util.Date} will be mapped.
      * Supported values are 'asDate', 'asNumber, 'asString'.
@@ -238,6 +261,9 @@ public void execute() {
             settings.addTypeNamePrefix = addTypeNamePrefix;
             settings.addTypeNameSuffix = addTypeNameSuffix;
             settings.customTypeNaming = Settings.convertToMap(customTypeNaming);
+            settings.referencedFiles = referencedFiles;
+            settings.importDeclarations = importDeclarations;
+            settings.customTypeMappings = Settings.convertToMap(customTypeMappings);
             settings.mapDate = mapDate;
             settings.loadCustomTypeProcessor(classLoader, customTypeProcessor);
             settings.sortDeclarations = sortDeclarations;