readonly properties - declarePropertiesAsReadOnly

Author: vojtechhabarta

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

@@ -27,6 +27,7 @@ public class Settings {
     public JsonLibrary jsonLibrary = null;
     private Predicate<String> excludeFilter = null;
     public boolean declarePropertiesAsOptional = false;
+    public boolean declarePropertiesAsReadOnly = false;
     public String removeTypeNamePrefix = null;
     public String removeTypeNameSuffix = null;
     public String addTypeNamePrefix = null;

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

@@ -150,7 +150,7 @@ private <T> TsBeanModel processBean(SymbolTable symbolTable, Map<Type, List<Bean
             final TsType discriminantType = literals.isEmpty()
                     ? TsType.String
                     : new TsType.UnionType(literals);
-            properties.add(0, new TsPropertyModel(bean.getDiscriminantProperty(), discriminantType, null));
+            properties.add(0, new TsPropertyModel(bean.getDiscriminantProperty(), discriminantType, settings.declarePropertiesAsReadOnly, null));
         }
 
         return new TsBeanModel(bean.getOrigin(), isClass, beanIdentifier, typeParameters, parentType, bean.getTaggedUnionClasses(), interfaces, properties, null, null, bean.getComments());
@@ -180,7 +180,7 @@ private static boolean containsProperty(List<TsPropertyModel> properties, String
     private TsPropertyModel processProperty(SymbolTable symbolTable, BeanModel bean, PropertyModel property) {
         final TsType type = typeFromJava(symbolTable, property.getType(), property.getName(), bean.getOrigin());
         final TsType tsType = property.isOptional() ? type.optional() : type;
-        return new TsPropertyModel(property.getName(), tsType, property.getComments());
+        return new TsPropertyModel(property.getName(), tsType, settings.declarePropertiesAsReadOnly, property.getComments());
     }
 
     private TsEnumModel<?> processEnum(SymbolTable symbolTable, EnumModel<?> enumModel) {

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

@@ -145,8 +145,9 @@ private void emitBeans(TsModel model, boolean exportKeyword) {
     private void emitProperty(TsPropertyModel property) {
         emitComments(property.getComments());
         final TsType tsType = property.getTsType();
+        final String readonly = property.readonly ? "readonly " : "";
         final String questionMark = settings.declarePropertiesAsOptional || (tsType instanceof TsType.OptionalType) ? "?" : "";
-        writeIndentedLine(quoteIfNeeded(property.getName(), settings) + questionMark + ": " + tsType.format(settings) + ";");
+        writeIndentedLine(readonly + quoteIfNeeded(property.getName(), settings) + questionMark + ": " + tsType.format(settings) + ";");
     }
 
     public static String quoteIfNeeded(String name, Settings settings) {

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

@@ -8,10 +8,12 @@
 
 public class TsPropertyModel extends TsProperty implements Comparable<TsProperty> {
 
+    public final boolean readonly;
     public final List<String> comments;
 
-    public TsPropertyModel(String name, TsType tsType, List<String> comments) {
+    public TsPropertyModel(String name, TsType tsType, boolean readonly, List<String> comments) {
         super(name, tsType);
+        this.readonly = readonly;
         this.comments = comments;
     }
 
@@ -20,7 +22,7 @@ public List<String> getComments() {
     }
 
     public TsPropertyModel setTsType(TsType type) {
-        return new TsPropertyModel(getName(), type, getComments());
+        return new TsPropertyModel(getName(), type, readonly, getComments());
     }
 
     @Override

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

@@ -16,6 +16,16 @@ public void test() {
         Assert.assertTrue(output.contains("interface Author"));
     }
 
+    @Test
+    public void testReadOnlyProperties() {
+        final Settings settings = TestUtils.settings();
+        settings.declarePropertiesAsReadOnly = true;
+        final String output = new TypeScriptGenerator(settings).generateTypeScript(Input.from(Book.class));
+        Assert.assertTrue(output.contains("readonly author: Author;"));
+        Assert.assertTrue(output.contains("readonly title: string;"));
+        Assert.assertTrue(output.contains("readonly name: string;"));
+    }
+
     static interface Book {
         Author getAuthor();
         String getTitle();

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

@@ -27,6 +27,7 @@ public class GenerateTask extends DefaultTask {
     public List<String> includePropertyAnnotations;
     public JsonLibrary jsonLibrary;
     public boolean declarePropertiesAsOptional;
+    public boolean declarePropertiesAsReadOnly;
     public String removeTypeNamePrefix;
     public String removeTypeNameSuffix;
     public String addTypeNamePrefix;
@@ -93,6 +94,7 @@ public void generate() throws Exception {
         settings.setExcludeFilter(excludeClasses, excludeClassPatterns);
         settings.jsonLibrary = jsonLibrary;
         settings.declarePropertiesAsOptional = declarePropertiesAsOptional;
+        settings.declarePropertiesAsReadOnly = declarePropertiesAsReadOnly;
         settings.removeTypeNamePrefix = removeTypeNamePrefix;
         settings.removeTypeNameSuffix = removeTypeNameSuffix;
         settings.addTypeNamePrefix = addTypeNamePrefix;

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

@@ -130,6 +130,12 @@ public class GenerateMojo extends AbstractMojo {
     @Parameter
     private boolean declarePropertiesAsOptional;
 
+    /**
+     * If true declared properties will be <code>readonly</code>.
+     */
+    @Parameter
+    private boolean declarePropertiesAsReadOnly;
+
     /**
      * Prefix which will be removed from names of classes, interfaces, enums.
      * For example if set to "Json" then mapping for "JsonData" will be "Data".
@@ -390,6 +396,7 @@ public void execute() {
             settings.setExcludeFilter(excludeClasses, excludeClassPatterns);
             settings.jsonLibrary = jsonLibrary;
             settings.declarePropertiesAsOptional = declarePropertiesAsOptional;
+            settings.declarePropertiesAsReadOnly = declarePropertiesAsReadOnly;
             settings.removeTypeNamePrefix = removeTypeNamePrefix;
             settings.removeTypeNameSuffix = removeTypeNameSuffix;
             settings.addTypeNamePrefix = addTypeNamePrefix;