Support typealias of supported types(primitive types, String, ByteArray etc) in generated tables.

Author: qiaoyuang

CHANGELOG.md

@@ -1,6 +1,12 @@
 # SQLlin Change Log
 
 - Date format: YYYY-MM-dd
+- 
+## 2.1.0 / 2025-11-xx
+
+### sqllin-processor
+
+* Support typealias of supported types(primitive types, String, ByteArray etc) in generated tables
 
 ## 2.0.0 / 2025-10-23
 
@@ -255,7 +261,7 @@ a runtime exception. Thanks for [@nbransby](https://github.com/nbransby).
 
 * Add the new JVM target
 * **Breaking change**: Remove the public property: `DatabaseConnection#closed`
-* The Android (< 9) target supports to set the `journalMode` and `synchronousMode` now
+* The Android(< 9) target supports to set the `journalMode` and `synchronousMode` now
 
 ## v1.1.1 / 2023-08-12
 

ROADMAP.md

@@ -5,7 +5,6 @@
 * Support the key word REFERENCE
 * Support JOIN sub-query
 * Support Enum type
-* Support typealias for primitive types
 
 ## Medium Priority
 

sample/src/androidMain/AndroidManifest.xml

@@ -19,6 +19,7 @@ package com.ctrip.sqllin.sample
 import com.ctrip.sqllin.dsl.DSLDBConfiguration
 import com.ctrip.sqllin.dsl.Database
 import com.ctrip.sqllin.dsl.annotation.DBRow
+import com.ctrip.sqllin.dsl.annotation.ExperimentalDSLDatabaseAPI
 import com.ctrip.sqllin.dsl.annotation.PrimaryKey
 import com.ctrip.sqllin.dsl.sql.clause.*
 import com.ctrip.sqllin.dsl.sql.clause.OrderByWay.DESC
@@ -36,6 +37,7 @@ import kotlinx.serialization.Serializable
 
 object Sample {
 
+    @OptIn(ExperimentalDSLDatabaseAPI::class)
     private val db by lazy {
         Database(
             DSLDBConfiguration(
@@ -110,11 +112,13 @@ object Sample {
     }
 }
 
+typealias MyInt = Int
+
 @DBRow("person")
 @Serializable
 data class Person(
     @PrimaryKey val id: Long?,
-    val age: Int?,
+    val age: MyInt?,
     val name: String?,
 )
 
@@ -130,7 +134,7 @@ data class Transcript(
 @Serializable
 data class Student(
     val name: String?,
-    val age: Int?,
+    val age: MyInt?,
     val math: Int,
     val english: Int,
 )

sample/src/commonMain/kotlin/com/ctrip/sqllin/sample/Sample.kt

@@ -21,6 +21,17 @@ import com.ctrip.sqllin.dsl.annotation.DBRow
 import com.ctrip.sqllin.dsl.annotation.PrimaryKey
 import kotlinx.serialization.Serializable
 
+/**
+ * Type aliases for testing typealias support in sqllin-processor
+ */
+typealias Price = Double
+typealias PageCount = Int
+typealias Age = Int
+typealias Grade = Int
+typealias StudentId = Long
+typealias CourseId = Long
+typealias Code = Int
+
 /**
  * Book entity
  * @author Yuang Qiao
@@ -31,15 +42,15 @@ import kotlinx.serialization.Serializable
 data class Book(
     val name: String,
     val author: String,
-    val price: Double,
-    val pages: Int,
+    val price: Price,
+    val pages: PageCount,
 )
 
 @DBRow("category")
 @Serializable
 data class Category(
     val name: String,
-    val code: Int,
+    val code: Code,
 )
 
 @Serializable
@@ -72,30 +83,30 @@ data class NullTester(
 data class PersonWithId(
     @PrimaryKey val id: Long?,
     val name: String,
-    val age: Int,
+    val age: Age,
 )
 
 @DBRow("product")
 @Serializable
 data class Product(
     @PrimaryKey val sku: String?,
     val name: String,
-    val price: Double,
+    val price: Price,
 )
 
 @DBRow("student_with_autoincrement")
 @Serializable
 data class StudentWithAutoincrement(
     @PrimaryKey(isAutoincrement = true) val id: Long?,
     val studentName: String,
-    val grade: Int,
+    val grade: Grade,
 )
 
 @DBRow("enrollment")
 @Serializable
 data class Enrollment(
-    @CompositePrimaryKey val studentId: Long,
-    @CompositePrimaryKey val courseId: Long,
+    @CompositePrimaryKey val studentId: StudentId,
+    @CompositePrimaryKey val courseId: CourseId,
     val semester: String,
 )
 

sqllin-dsl-test/src/androidMain/AndroidManifest.xml

@@ -36,6 +36,7 @@ import java.io.OutputStreamWriter
  * - Mutable properties for UPDATE SET clauses
  * - Primary key metadata extraction from [@PrimaryKey][com.ctrip.sqllin.dsl.annotation.PrimaryKey]
  *   and [@CompositePrimaryKey][com.ctrip.sqllin.dsl.annotation.CompositePrimaryKey] annotations
+ * - Support for typealias of primitive types (resolves typealiases to their underlying types)
  *
  * The generated code provides compile-time safety for SQL DSL operations.
  *
@@ -164,7 +165,7 @@ class ClauseProcessor(
                     }
                     writer.write(nullableSymbol)
                     writer.write("        get() = ${getSetClauseGetterValue(property)}\n")
-                    writer.write("        set(value) = ${appendFunction(elementName, property, isNotNull)}\n\n")
+                    writer.write("        set(value) = ${appendFunction(elementName, property)}\n\n")
                 }
 
                 // Write the override instance for property `primaryKeyInfo`.
@@ -199,12 +200,27 @@ class ClauseProcessor(
 
     /**
      * Maps a property's Kotlin type to the corresponding clause element type name.
+     * Supports typealiases by resolving them to their underlying types.
      *
      * @return The clause type name (ClauseNumber, ClauseString, ClauseBoolean, ClauseBlob), or null if unsupported
      */
-    private fun getClauseElementTypeStr(property: KSPropertyDeclaration): String? = when (
-        property.typeName
-    ) {
+    private fun getClauseElementTypeStr(property: KSPropertyDeclaration): String? {
+        val declaration = property.type.resolve().declaration
+        return getClauseElementTypeStrByTypeName(declaration.typeName) ?: kotlin.run {
+            if (declaration is KSTypeAlias)
+                getClauseElementTypeStrByTypeName(declaration.typeName)
+            else
+                null
+        }
+    }
+
+    /**
+     * Maps a fully qualified type name to its corresponding clause element type.
+     *
+     * @param typeName The fully qualified type name to map
+     * @return The clause type name (ClauseNumber, ClauseString, ClauseBoolean, ClauseBlob), or null if unsupported
+     */
+    private fun getClauseElementTypeStrByTypeName(typeName: String?): String? = when (typeName) {
         Int::class.qualifiedName,
         Long::class.qualifiedName,
         Short::class.qualifiedName,
@@ -228,12 +244,27 @@ class ClauseProcessor(
 
     /**
      * Generates the default getter value for SetClause properties based on type.
+     * Supports typealiases by resolving them to their underlying types.
      *
      * @return The default value string for the property type, or null if unsupported
      */
-    private fun getSetClauseGetterValue(property: KSPropertyDeclaration): String? = when (
-        property.typeName
-    ) {
+    private fun getSetClauseGetterValue(property: KSPropertyDeclaration): String? {
+        val declaration = property.type.resolve().declaration
+        return getDefaultValueByType(declaration.typeName) ?: kotlin.run {
+            if (declaration is KSTypeAlias)
+                getDefaultValueByType(declaration.typeName)
+            else
+                null
+        }
+    }
+
+    /**
+     * Returns the default value string for a given type name.
+     *
+     * @param typeName The fully qualified type name
+     * @return The default value string (e.g., "0" for Int, "false" for Boolean), or null if unsupported
+     */
+    private fun getDefaultValueByType(typeName: String?): String? = when (typeName) {
         Int::class.qualifiedName -> "0"
         Long::class.qualifiedName -> "0L"
         Short::class.qualifiedName -> "0"
@@ -256,13 +287,30 @@ class ClauseProcessor(
 
     /**
      * Generates the appropriate append function call for SetClause setters.
+     * Supports typealiases by resolving them to their underlying types.
      *
      * @param elementName The serialized element name
      * @param property The property declaration
-     * @param isNotNull Whether the property is non-nullable
      * @return The append function call string, or null if unsupported type
      */
-    private fun appendFunction(elementName: String, property: KSPropertyDeclaration, isNotNull: Boolean): String? = when (property.typeName) {
+    private fun appendFunction(elementName: String, property: KSPropertyDeclaration): String? {
+        val declaration = property.type.resolve().declaration
+        return appendFunctionByTypeName(elementName, declaration.typeName) ?: kotlin.run {
+            if (declaration is KSTypeAlias)
+                appendFunctionByTypeName(elementName, declaration.typeName)
+            else
+                null
+        }
+    }
+
+    /**
+     * Generates the append function call for a given type name.
+     *
+     * @param elementName The serialized element name
+     * @param typeName The fully qualified type name
+     * @return The append function call string, or null if unsupported type
+     */
+    private fun appendFunctionByTypeName(elementName: String, typeName: String?): String? = when (typeName) {
         Int::class.qualifiedName,
         Long::class.qualifiedName,
         Short::class.qualifiedName,
@@ -285,4 +333,16 @@ class ClauseProcessor(
      */
     private inline val KSPropertyDeclaration.typeName
         get() = type.resolve().declaration.qualifiedName?.asString()
+
+    /**
+     * Extension property that resolves a type alias to its underlying fully qualified type name.
+     */
+    private inline val KSTypeAlias.typeName
+        get() = type.resolve().declaration.qualifiedName?.asString()
+
+    /**
+     * Extension property that retrieves a declaration's fully qualified type name.
+     */
+    private inline val KSDeclaration.typeName
+        get() = qualifiedName?.asString()
 }