118 enum value referencing constants (#122)

* Refactor value resolution logic to support constant and enum value referencing
* Simplify TypeInfoParser contract
* Move typeInfo to package
* Move domain objs to packages
* Update doc

Author: cuzfrog

annotation/src/main/java/online/sharedtype/SharedType.java

@@ -11,7 +11,7 @@
  *
  * <p>
  * <b>Annotation Processing:</b><br>
- * This annotation is retained only in source code.
+ * This annotation is retained only at source code level.
  * That means it is not visible if source code is not directly participating in annotation processing.
  * E.g. if it is in a dependency jar in a project with multi-module build.
  * <br>
@@ -24,6 +24,13 @@
  * </p>
  *
  * <p>
+ * <b>Serialization:</b><br>
+ * Although SharedType does not depend on any serialization format, it assumes the contract of JSON.
+ * That means a client can use any format of serializations, but may not exceed JSON capacity.
+ * E.g. SharedType treats {@code List} and {@code Set} as arrays, and will not differentiate them in target code.
+ * </p>
+ *
+ * <p>
  * <b>Configurations:</b><br>
  * Global properties can be defined in a client provided property file or system properties.
  * By default, SharedType will look for file name "sharedtype.properties" on cmd path.
@@ -57,11 +64,26 @@
  * </ul>
  *
  * <p>
+ * <b>Enums:</b><br>
+ * Enums are emitted as according to target schema:
+ * <ul>
+ *     <li>Typescript: type union or enum. By default enum values are strings.</li>
+ *     <li>Rust: plain enum (Enum values of different types are not supported yet.)</li>
+ * </ul>
+ * See {@link EnumValue} for how to mark an enum value.
+ *
+ * <p>
  * <b>Constants:</b><br>
- * Static fields are treated as constants. Only compile-time resolvable values are supported.
+ * Static fields are treated as constants.
  * By default, constants are not included, see {@link #includes()}.
  * Only constants in explicitly annotated types will be emitted.
- * </p>
+ * <br>
+ * Only compile-time resolvable values are supported, which include:
+ * <ul>
+ *     <li>literal values: primitives, boxed primitives, String</li>
+ *     <li>enums (with compile-time resolvable values)</li>
+ *     <li>references that eventually reach other compile-time resolvable values</li>
+ * </ul>
  *
  * <p>
  * <b>Generics:</b><br>
@@ -258,22 +280,25 @@
     }
 
     /**
-     * Mark enum value. By default, enum value is the enum constant name. The enum value must be literals (e.g. 1, "a", true) in enum constant expressions.
-     * <b>Note: When there are multiple enum constant constructor parameters, the value is resolved by field order.</b>
+     * Mark enum value. By default, enum value is the enum constant name.
+     * The enum value must be "compile-time resolvable" in enum constant expressions (See "Constant" section in {@link SharedType}).
+     * Note: When there are multiple enum constant constructor parameters, the value is resolved by field order.
      * If the constructor parameter order is different from the field order, value will not be resolved correctly.
+     * Additional custom annotation types can be configured via global properties.
      * <pre>
-     * Example:
      * {@code
+     * //A simple example:
      * enum Enum {
      *   A(1), B(2);
      *
      *   @SharedType.EnumValue
      *   private final int value;
      * }
+     * //output in typescript union:
+     * type Enum = 1 | 2;
      * }
      * </pre>
      * <br>
-     * Additional annotation types can be configured via global properties.
      */
     @Target({ElementType.FIELD})
     @Retention(RetentionPolicy.CLASS)

client-test/typescript/src/types.java17.ts

@@ -6,6 +6,8 @@ import {
     type JavaTimeClass,
     type JodaTimeClass,
     type MathClass,
+    type EnumConstReference,
+    type EnumEnumReference,
 } from "./index.java17";
 
 export const list1: EnumGalaxy[] = ["Andromeda", "MilkyWay", "Triangulum"];
@@ -135,3 +137,7 @@ export const mathClass: MathClass = {
     bigDecimal: 1,
     bigInteger: 1,
 }
+
+  
+export const enumConstValue1: EnumConstReference = 156;
+export const enumEnumValue1: EnumEnumReference = 3;

internal/src/main/java/online/sharedtype/processor/domain/Constants.java

@@ -1,6 +1,8 @@
 package online.sharedtype.processor.domain;
 
 import online.sharedtype.SharedType;
+import online.sharedtype.processor.domain.type.ConcreteTypeInfo;
+import online.sharedtype.processor.domain.type.TypeInfo;
 
 import javax.lang.model.type.TypeKind;
 import java.util.HashMap;

internal/src/main/java/online/sharedtype/processor/domain/DependingKind.java

@@ -1,4 +1,6 @@
-package online.sharedtype.processor.domain;
+package online.sharedtype.processor.domain.component;
+
+import online.sharedtype.processor.domain.def.TypeDef;
 
 import java.io.Serializable;
 

…type/processor/domain/ComponentInfo.java …ssor/domain/component/ComponentInfo.javainternal/src/main/java/online/sharedtype/processor/domain/ComponentInfo.java renamed to internal/src/main/java/online/sharedtype/processor/domain/component/ComponentInfo.java internal/src/main/java/online/sharedtype/processor/domain/ComponentInfo.java renamed to internal/src/main/java/online/sharedtype/processor/domain/component/ComponentInfo.java

@@ -1,8 +1,9 @@
-package online.sharedtype.processor.domain;
+package online.sharedtype.processor.domain.component;
 
 import lombok.EqualsAndHashCode;
 import lombok.RequiredArgsConstructor;
-import lombok.Setter;
+import online.sharedtype.processor.domain.type.TypeInfo;
+import online.sharedtype.processor.domain.value.ValueHolder;
 
 /**
  * Represents a constant literal.
@@ -16,7 +17,7 @@ public final class ConstantField implements ComponentInfo {
     private static final long serialVersionUID = -155863067131290289L;
     private final String name;
     private final TypeInfo type;
-    private final Object value;
+    private final ValueHolder value;
 
     public String name() {
         return name;
@@ -26,7 +27,7 @@ public TypeInfo type() {
         return type;
     }
 
-    public Object value() {
+    public ValueHolder value() {
         return value;
     }
 

…type/processor/domain/ConstantField.java …ssor/domain/component/ConstantField.javainternal/src/main/java/online/sharedtype/processor/domain/ConstantField.java renamed to internal/src/main/java/online/sharedtype/processor/domain/component/ConstantField.java internal/src/main/java/online/sharedtype/processor/domain/ConstantField.java renamed to internal/src/main/java/online/sharedtype/processor/domain/component/ConstantField.java

@@ -1,8 +1,11 @@
-package online.sharedtype.processor.domain;
+package online.sharedtype.processor.domain.component;
 
 import lombok.EqualsAndHashCode;
 import lombok.RequiredArgsConstructor;
 import online.sharedtype.SharedType;
+import online.sharedtype.processor.domain.def.EnumDef;
+import online.sharedtype.processor.domain.type.TypeInfo;
+import online.sharedtype.processor.domain.value.EnumConstantValue;
 
 /**
  * Represents an enum value, which is the value in the target code that corresponds to an enum constant.
@@ -19,7 +22,7 @@ public final class EnumValueInfo implements ComponentInfo {
     private static final long serialVersionUID = 1117324458104635595L;
     private final String name;
     private final TypeInfo type;
-    private final Object value;
+    private final EnumConstantValue value;
 
     public String name() {
         return name;
@@ -29,7 +32,7 @@ public TypeInfo type() {
         return type;
     }
 
-    public Object value() {
+    public EnumConstantValue value() {
         return value;
     }
 

…type/processor/domain/EnumValueInfo.java …ssor/domain/component/EnumValueInfo.javainternal/src/main/java/online/sharedtype/processor/domain/EnumValueInfo.java renamed to internal/src/main/java/online/sharedtype/processor/domain/component/EnumValueInfo.java internal/src/main/java/online/sharedtype/processor/domain/EnumValueInfo.java renamed to internal/src/main/java/online/sharedtype/processor/domain/component/EnumValueInfo.java

@@ -1,7 +1,8 @@
-package online.sharedtype.processor.domain;
+package online.sharedtype.processor.domain.component;
 
 import lombok.Builder;
 import lombok.Setter;
+import online.sharedtype.processor.domain.type.TypeInfo;
 
 import javax.lang.model.element.Modifier;
 import java.util.Set;

…processor/domain/FieldComponentInfo.java …domain/component/FieldComponentInfo.javainternal/src/main/java/online/sharedtype/processor/domain/FieldComponentInfo.java renamed to internal/src/main/java/online/sharedtype/processor/domain/component/FieldComponentInfo.java internal/src/main/java/online/sharedtype/processor/domain/FieldComponentInfo.java renamed to internal/src/main/java/online/sharedtype/processor/domain/component/FieldComponentInfo.java

@@ -1,8 +1,12 @@
-package online.sharedtype.processor.domain;
+package online.sharedtype.processor.domain.def;
 
 import lombok.Builder;
 import lombok.EqualsAndHashCode;
 import lombok.experimental.SuperBuilder;
+import online.sharedtype.processor.domain.component.FieldComponentInfo;
+import online.sharedtype.processor.domain.type.ConcreteTypeInfo;
+import online.sharedtype.processor.domain.type.TypeInfo;
+import online.sharedtype.processor.domain.type.TypeVariableInfo;
 
 import java.util.ArrayList;
 import java.util.HashMap;

…haredtype/processor/domain/ClassDef.java …dtype/processor/domain/def/ClassDef.javainternal/src/main/java/online/sharedtype/processor/domain/ClassDef.java renamed to internal/src/main/java/online/sharedtype/processor/domain/def/ClassDef.java internal/src/main/java/online/sharedtype/processor/domain/ClassDef.java renamed to internal/src/main/java/online/sharedtype/processor/domain/def/ClassDef.java

@@ -1,8 +1,9 @@
-package online.sharedtype.processor.domain;
+package online.sharedtype.processor.domain.def;
 
 import lombok.Getter;
 import lombok.Setter;
 import lombok.experimental.SuperBuilder;
+import online.sharedtype.processor.domain.type.ConcreteTypeInfo;
 
 import javax.lang.model.element.Element;
 import java.util.Set;