Number-based enums with Jackson2 (fixes #66)

Author: vojtechhabarta

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

@@ -0,0 +1,13 @@
+
+package cz.habarta.typescript.generator.compiler;
+
+
+public final class EnumKind<T> {
+
+    public static final EnumKind<String> StringBased = new EnumKind<>();
+    public static final EnumKind<Number> NumberBased = new EnumKind<>();
+
+    private EnumKind() {
+    }
+
+}

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

@@ -0,0 +1,35 @@
+
+package cz.habarta.typescript.generator.compiler;
+
+import java.util.List;
+
+
+public class EnumMemberModel<T> {
+    
+    private final String propertyName;
+    private final T enumValue;
+    private final List<String> comments;
+
+    public EnumMemberModel(String propertyName, T enumValue, List<String> comments) {
+        this.propertyName = propertyName;
+        this.enumValue = enumValue;
+        this.comments = comments;
+    }
+
+    public String getPropertyName() {
+        return propertyName;
+    }
+
+    public T getEnumValue() {
+        return enumValue;
+    }
+
+    public List<String> getComments() {
+        return comments;
+    }
+
+    public EnumMemberModel<T> withComments(List<String> comments) {
+        return new EnumMemberModel<>(propertyName, enumValue, comments);
+    }
+
+}

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

@@ -52,7 +52,7 @@ public TsModel javaToTypeScript(Model model) {
 
     public TsType javaToTypeScript(Type type) {
         final BeanModel beanModel = new BeanModel(Object.class, Object.class, Collections.<Type>emptyList(), Collections.singletonList(new PropertyModel("property", type, false, null, null)));
-        final Model model = new Model(Collections.singletonList(beanModel), Collections.<EnumModel>emptyList());
+        final Model model = new Model(Collections.singletonList(beanModel), Collections.<EnumModel<?>>emptyList());
         final TsModel tsModel = javaToTypeScript(model);
         return tsModel.getBeans().get(0).getProperties().get(0).getTsType();
     }
@@ -62,8 +62,8 @@ private TsModel processModel(SymbolTable symbolTable, Model model) {
         for (BeanModel bean : model.getBeans()) {
             beans.add(processBean(symbolTable, bean));
         }
-        final List<TsEnumModel> enums = new ArrayList<>();
-        for (EnumModel enumModel : model.getEnums()) {
+        final List<TsEnumModel<?>> enums = new ArrayList<>();
+        for (EnumModel<?> enumModel : model.getEnums()) {
             enums.add(processEnum(symbolTable, enumModel));
         }
         final List<TsAliasModel> typeAliases = new ArrayList<>();
@@ -96,9 +96,9 @@ private TsPropertyModel processProperty(SymbolTable symbolTable, BeanModel bean,
         return new TsPropertyModel(property.getName(), tsType, property.getComments());
     }
 
-    private TsEnumModel processEnum(SymbolTable symbolTable, EnumModel enumModel) {
+    private TsEnumModel<?> processEnum(SymbolTable symbolTable, EnumModel<?> enumModel) {
         final TsType enumType = typeFromJava(symbolTable, enumModel.getOrigin());
-        return new TsEnumModel(enumModel.getOrigin(), enumType, enumModel.getComments(), new ArrayList<>(enumModel.getValues()));
+        return TsEnumModel.fromEnumModel(enumType, enumModel);
     }
 
     private TsType typeFromJava(SymbolTable symbolTable, Type javaType) {
@@ -149,10 +149,10 @@ public TsType transform(TsType type) {
 
     private TsModel transformEnums(TsModel tsModel) {
         final LinkedHashSet<TsAliasModel> typeAliases = new LinkedHashSet<>(tsModel.getTypeAliases());
-        for (TsEnumModel enumModel : tsModel.getEnums()) {
+        for (TsEnumModel<String> enumModel : tsModel.getEnums(EnumKind.StringBased)) {
             final List<TsType> values = new ArrayList<>();
-            for (String value : enumModel.getValues()) {
-                values.add(new TsType.StringLiteralType(value));
+            for (EnumMemberModel<String> member : enumModel.getMembers()) {
+                values.add(new TsType.StringLiteralType(member.getEnumValue()));
             }
             final TsType union = new TsType.UnionType(values);
             typeAliases.add(new TsAliasModel(enumModel.getOrigin(), enumModel.getName(), union, enumModel.getComments()));

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

@@ -2,6 +2,8 @@
 package cz.habarta.typescript.generator.emitter;
 
 import cz.habarta.typescript.generator.*;
+import cz.habarta.typescript.generator.compiler.EnumKind;
+import cz.habarta.typescript.generator.compiler.EnumMemberModel;
 import java.io.*;
 import java.text.*;
 import java.util.*;
@@ -86,20 +88,22 @@ private void emitNamespace(TsModel model) {
             writeIndentedLine(prefix +  "namespace " + settings.namespace + " {");
             indent++;
             final boolean exportElements = settings.outputFileType == TypeScriptFileType.implementationFile;
-            emitElements(model, exportElements);
+            emitElements(model, exportElements, false);
             indent--;
             writeNewLine();
             writeIndentedLine("}");
         } else {
             final boolean exportElements = settings.outputKind == TypeScriptOutputKind.module;
-            emitElements(model, exportElements);
+            final boolean declareElements = settings.outputKind == TypeScriptOutputKind.global;
+            emitElements(model, exportElements, declareElements);
         }
     }
 
-    private void emitElements(TsModel model, boolean exportKeyword) {
+    private void emitElements(TsModel model, boolean exportKeyword, boolean declareKeyword) {
         exportKeyword = exportKeyword || forceExportKeyword;
         emitInterfaces(model, exportKeyword);
         emitTypeAliases(model, exportKeyword);
+        emitNumberEnums(model, exportKeyword, declareKeyword);
         for (EmitterExtension emitterExtension : settings.extensions) {
             emitterExtension.emitElements(new EmitterExtension.Writer() {
                 @Override
@@ -175,6 +179,25 @@ private void emitTypeAliases(TsModel model, boolean exportKeyword) {
         }
     }
 
+    private void emitNumberEnums(TsModel model, boolean exportKeyword, boolean declareKeyword) {
+        final ArrayList<TsEnumModel<Number>> enums = new ArrayList<>(model.getEnums(EnumKind.NumberBased));
+        if (settings.sortDeclarations || settings.sortTypeDeclarations) {
+            Collections.sort(enums);
+        }
+        for (TsEnumModel<Number> enumModel : enums) {
+            writeNewLine();
+            emitComments(enumModel.getComments());
+            writeIndentedLine(exportKeyword, (declareKeyword ? "declare " : "") + "const enum " + enumModel.getName() + " {");
+            indent++;
+            for (EnumMemberModel<Number> member : enumModel.getMembers()) {
+                emitComments(member.getComments());
+                writeIndentedLine(member.getPropertyName() + " = " + member.getEnumValue() + ",");
+            }
+            indent--;
+            writeIndentedLine("}");
+        }
+    }
+
     private void emitComments(List<String> comments) {
         if (comments != null) {
             writeIndentedLine("/**");

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

@@ -2,25 +2,34 @@
 package cz.habarta.typescript.generator.emitter;
 
 import cz.habarta.typescript.generator.TsType;
+import cz.habarta.typescript.generator.compiler.EnumKind;
+import cz.habarta.typescript.generator.compiler.EnumMemberModel;
+import cz.habarta.typescript.generator.parser.EnumModel;
 import java.util.List;
 
 
-public class TsEnumModel extends TsDeclarationModel {
+// T extends String | Number
+public class TsEnumModel<T> extends TsDeclarationModel {
 
-    private final List<String> values;
+    private final EnumKind<T> kind;
+    private final List<EnumMemberModel<T>> members;
 
-    public TsEnumModel(TsType name, List<String> comments, List<String> values) {
-        super(name, comments);
-        this.values = values;
+    public TsEnumModel(Class<?> origin, TsType name, EnumKind<T> kind, List<EnumMemberModel<T>> members, List<String> comments) {
+        super(origin, name, comments);
+        this.kind = kind;
+        this.members = members;
     }
 
-    public TsEnumModel(Class<?> origin, TsType name, List<String> comments, List<String> values) {
-        super(origin, name, comments);
-        this.values = values;
+    public static <T> TsEnumModel<T> fromEnumModel(TsType name, EnumModel<T> enumModel) {
+        return new TsEnumModel<>(enumModel.getOrigin(), name, enumModel.getKind(), enumModel.getMembers(), enumModel.getComments());
+    }
+
+    public EnumKind<T> getKind() {
+        return kind;
     }
 
-    public List<String> getValues() {
-        return values;
+    public List<EnumMemberModel<T>> getMembers() {
+        return members;
     }
 
 }

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

@@ -1,20 +1,21 @@
 
 package cz.habarta.typescript.generator.emitter;
 
+import cz.habarta.typescript.generator.compiler.EnumKind;
 import java.util.*;
 
 
 public class TsModel {
 
     private final List<TsBeanModel> beans;
-    private final List<TsEnumModel> enums;
+    private final List<TsEnumModel<?>> enums;
     private final List<TsAliasModel> typeAliases;
 
     public TsModel() {
-        this (new ArrayList<TsBeanModel>(), new ArrayList<TsEnumModel>(), new ArrayList<TsAliasModel>());
+        this (new ArrayList<TsBeanModel>(), new ArrayList<TsEnumModel<?>>(), new ArrayList<TsAliasModel>());
     }
 
-    public TsModel(List<TsBeanModel> beans, List<TsEnumModel> enums, List<TsAliasModel> typeAliases) {
+    public TsModel(List<TsBeanModel> beans, List<TsEnumModel<?>> enums, List<TsAliasModel> typeAliases) {
         if (beans == null) throw new NullPointerException();
         if (enums == null) throw new NullPointerException();
         if (typeAliases == null) throw new NullPointerException();
@@ -31,11 +32,22 @@ public TsModel setBeans(List<TsBeanModel> beans) {
         return new TsModel(beans, enums, typeAliases);
     }
 
-    public List<TsEnumModel> getEnums() {
+    public List<TsEnumModel<?>> getEnums() {
         return enums;
     }
 
-    public TsModel setEnums(List<TsEnumModel> enums) {
+    @SuppressWarnings("unchecked")
+    public <T> List<TsEnumModel<T>> getEnums(EnumKind<T> enumKind) {
+        final List<TsEnumModel<T>> result = new ArrayList<>();
+        for (TsEnumModel<?> enumModel : enums) {
+            if (enumModel.getKind() == enumKind) {
+                result.add((TsEnumModel<T>) enumModel);
+            }
+        }
+        return result;
+    }
+
+    public TsModel setEnums(List<TsEnumModel<?>> enums) {
         return new TsModel(beans, enums, typeAliases);
     }
 

typescript-generator-core/src/main/java/cz/habarta/typescript/generator/ext/EnumConstantsExtension.java

@@ -5,6 +5,8 @@
 import java.util.List;
 
 import cz.habarta.typescript.generator.Settings;
+import cz.habarta.typescript.generator.compiler.EnumKind;
+import cz.habarta.typescript.generator.compiler.EnumMemberModel;
 import cz.habarta.typescript.generator.emitter.EmitterExtension;
 import cz.habarta.typescript.generator.emitter.TsEnumModel;
 import cz.habarta.typescript.generator.emitter.TsModel;
@@ -20,13 +22,13 @@ public boolean generatesRuntimeCode() {
     @Override
     public void emitElements(Writer writer, Settings settings, boolean exportKeyword, TsModel model) {
         String exportString = exportKeyword ? "export " : "";
-        List<TsEnumModel> enums = model.getEnums();
+        List<TsEnumModel<String>> enums = model.getEnums(EnumKind.StringBased);
         Collections.sort(enums);
-        for (TsEnumModel tsEnum : enums) {
+        for (TsEnumModel<String> tsEnum : enums) {
             writer.writeIndentedLine("");
             writer.writeIndentedLine(exportString + "const " + tsEnum.getName() + " = {");
-            for (String value : tsEnum.getValues()) {
-                writer.writeIndentedLine(settings.indentString + value + ": " + "<" + tsEnum.getName() + ">\"" + value + "\",");
+            for (EnumMemberModel<String> member : tsEnum.getMembers()) {
+                writer.writeIndentedLine(settings.indentString + member.getPropertyName() + ": " + "<" + tsEnum.getName() + ">\"" + member.getEnumValue() + "\",");
             }
             writer.writeIndentedLine("}");
         }

typescript-generator-core/src/main/java/cz/habarta/typescript/generator/parser/BeanModel.java

@@ -34,6 +34,15 @@ public List<PropertyModel> getProperties() {
         return properties;
     }
 
+    public BeanModel withProperties(List<PropertyModel> properties) {
+        return new BeanModel(origin, parent, interfaces, properties, comments);
+    }
+
+    @Override
+    public BeanModel withComments(List<String> comments) {
+        return new BeanModel(origin, parent, interfaces, properties, comments);
+    }
+
     @Override
     public String toString() {
         return "BeanModel{" + "origin=" + getOrigin() + ", properties=" + properties + '}';

typescript-generator-core/src/main/java/cz/habarta/typescript/generator/parser/DeclarationModel.java

@@ -4,10 +4,10 @@
 import java.util.List;
 
 
-public class DeclarationModel {
+public abstract class DeclarationModel {
 
-    private final Class<?> origin;
-    private final List<String> comments;
+    protected final Class<?> origin;
+    protected final List<String> comments;
 
     public DeclarationModel(Class<?> origin, List<String> comments) {
         this.origin = origin;
@@ -22,4 +22,6 @@ public List<String> getComments() {
         return comments;
     }
 
+    public abstract DeclarationModel withComments(List<String> comments);
+
 }

typescript-generator-core/src/main/java/cz/habarta/typescript/generator/parser/EnumModel.java

@@ -1,20 +1,38 @@
 
 package cz.habarta.typescript.generator.parser;
 
+import cz.habarta.typescript.generator.compiler.EnumMemberModel;
+import cz.habarta.typescript.generator.compiler.EnumKind;
 import java.util.*;
 
 
-public class EnumModel extends DeclarationModel {
-    
-    private final List<String> values;
+// T extends String | Number
+public class EnumModel<T> extends DeclarationModel {
 
-    public EnumModel(Class<?> origin, List<String> values, List<String> comments) {
+    private final EnumKind<T> kind;
+    private final List<EnumMemberModel<T>> members;
+
+    public EnumModel(Class<?> origin, EnumKind<T> kind, List<EnumMemberModel<T>> members, List<String> comments) {
         super (origin, comments);
-        this.values = values;
+        this.kind = kind;
+        this.members = members;
+    }
+
+    public EnumKind<T> getKind() {
+        return kind;
+    }
+
+    public List<EnumMemberModel<T>> getMembers() {
+        return members;
+    }
+
+    public EnumModel<T> withMembers(List<EnumMemberModel<T>> members) {
+        return new EnumModel<>(origin, kind, members, comments);
     }
 
-    public List<String> getValues() {
-        return values;
+    @Override
+    public EnumModel<T> withComments(List<String> comments) {
+        return new EnumModel<>(origin, kind, members, comments);
     }
 
 }