Refine implementation

docs/code/example/example-enum-class-01.kt

@@ -2,8 +2,6 @@
 @file:Suppress("PackageDirectoryMismatch", "unused")
 package dev.adamko.kxstsgen.example.exampleEnumClass01
 
-import kotlinx.serialization.*
-import dev.adamko.kxstsgen.*
 import kotlinx.serialization.*
 import dev.adamko.kxstsgen.*
 

docs/code/example/example-enum-class-02.kt

@@ -2,8 +2,6 @@
 @file:Suppress("PackageDirectoryMismatch", "unused")
 package dev.adamko.kxstsgen.example.exampleEnumClass02
 
-import kotlinx.serialization.*
-import dev.adamko.kxstsgen.*
 import kotlinx.serialization.*
 import dev.adamko.kxstsgen.*
 

docs/code/example/example-tuple-01.kt

@@ -0,0 +1,46 @@
+// This file was automatically generated from tuples.md by Knit tool. Do not edit.
+@file:Suppress("PackageDirectoryMismatch", "unused")
+package dev.adamko.kxstsgen.example.exampleTuple01
+
+import dev.adamko.kxstsgen.*
+import dev.adamko.kxstsgen.core.experiments.TupleSerializer
+import kotlinx.serialization.*
+
+@Serializable(with = SimpleTypes.SimpleTypesSerializer::class)
+data class SimpleTypes(
+  val aString: String,
+  var anInt: Int,
+  val aDouble: Double?,
+  val bool: Boolean,
+  private val privateMember: String,
+) {
+  // Create `SimpleTypesSerializer` inside `SimpleTypes`, so it
+  // has access to the private property `privateMember`.
+  object SimpleTypesSerializer : TupleSerializer<SimpleTypes>(
+    "SimpleTypes",
+    {
+      // Provide all tuple elements, in order, using the 'elements' helper method.
+      element(SimpleTypes::aString)
+      element(SimpleTypes::anInt)
+      element(SimpleTypes::aDouble)
+      element(SimpleTypes::bool)
+      element(SimpleTypes::privateMember)
+    }
+  ) {
+    override fun tupleConstructor(elements: List<*>): SimpleTypes {
+      // When deserializing, the elements will be available as a list, in the order defined
+      return SimpleTypes(
+        elements[0] as String,
+        elements[1] as Int,
+        elements[2] as Double,
+        elements[3] as Boolean,
+        elements[4] as String,
+      )
+    }
+  }
+}
+
+fun main() {
+  val tsGenerator = KxsTsGenerator()
+  println(tsGenerator.generate(SimpleTypes.serializer()))
+}

docs/code/example/example-tuple-02.kt

@@ -0,0 +1,40 @@
+// This file was automatically generated from tuples.md by Knit tool. Do not edit.
+@file:Suppress("PackageDirectoryMismatch", "unused")
+package dev.adamko.kxstsgen.example.exampleTuple02
+
+import dev.adamko.kxstsgen.*
+import dev.adamko.kxstsgen.core.experiments.TupleSerializer
+import kotlinx.serialization.*
+
+@Serializable(with = OptionalFields.Serializer::class)
+data class OptionalFields(
+  val requiredString: String,
+  val optionalString: String = "",
+  val nullableString: String?,
+  val nullableOptionalString: String? = "",
+) {
+  object Serializer : TupleSerializer<OptionalFields>(
+    "OptionalFields",
+    {
+      element(OptionalFields::requiredString)
+      element(OptionalFields::optionalString)
+      element(OptionalFields::nullableString)
+      element(OptionalFields::nullableOptionalString)
+    }
+  ) {
+    override fun tupleConstructor(elements: List<*>): OptionalFields {
+      val iter = elements.iterator()
+      return OptionalFields(
+        iter.next() as String,
+        iter.next() as String,
+        iter.next() as String,
+        iter.next() as String,
+      )
+    }
+  }
+}
+
+fun main() {
+  val tsGenerator = KxsTsGenerator()
+  println(tsGenerator.generate(OptionalFields.serializer()))
+}

docs/code/example/example-tuple-03.kt

@@ -0,0 +1,36 @@
+// This file was automatically generated from tuples.md by Knit tool. Do not edit.
+@file:Suppress("PackageDirectoryMismatch", "unused")
+package dev.adamko.kxstsgen.example.exampleTuple03
+
+import dev.adamko.kxstsgen.*
+import dev.adamko.kxstsgen.core.experiments.TupleSerializer
+import kotlinx.serialization.*
+
+@Serializable(with = Coordinates.Serializer::class)
+data class Coordinates(
+  val x: Int,
+  val y: Int,
+  val z: Int,
+) {
+  object Serializer : TupleSerializer<Coordinates>(
+    "Coordinates",
+    {
+      element(Coordinates::x)
+      element(Coordinates::y)
+      element(Coordinates::z)
+    }
+  ) {
+    override fun tupleConstructor(elements: List<*>): Coordinates {
+      return Coordinates(
+        elements[0] as Int,
+        elements[1] as Int,
+        elements[2] as Int,
+      )
+    }
+  }
+}
+
+fun main() {
+  val tsGenerator = KxsTsGenerator()
+  println(tsGenerator.generate(Coordinates.serializer()))
+}

docs/code/example/example-tuple-04.kt

@@ -0,0 +1,21 @@
+// This file was automatically generated from tuples.md by Knit tool. Do not edit.
+@file:Suppress("PackageDirectoryMismatch", "unused")
+package dev.adamko.kxstsgen.example.exampleTuple04
+
+import dev.adamko.kxstsgen.*
+import dev.adamko.kxstsgen.core.experiments.TupleSerializer
+import kotlinx.serialization.*
+
+import dev.adamko.kxstsgen.example.exampleTuple03.Coordinates
+
+@Serializable
+class GameLocations(
+  val homeLocation: Coordinates,
+  val allLocations: List<Coordinates>,
+  val namedLocations: Map<String, Coordinates>,
+)
+
+fun main() {
+  val tsGenerator = KxsTsGenerator()
+  println(tsGenerator.generate(GameLocations.serializer()))
+}

docs/code/test/TuplesTest.kt

@@ -0,0 +1,72 @@
+// This file was automatically generated from tuples.md by Knit tool. Do not edit.
+@file:Suppress("JSUnusedLocalSymbols")
+package dev.adamko.kxstsgen.example.test
+
+import io.kotest.matchers.*
+import kotlinx.knit.test.*
+import org.junit.jupiter.api.Test
+import dev.adamko.kxstsgen.util.*
+
+class TuplesTest {
+  @Test
+  fun testExampleTuple01() {
+    captureOutput("ExampleTuple01") {
+      dev.adamko.kxstsgen.example.exampleTuple01.main()
+    }.normalizeJoin()
+      .shouldBe(
+        // language=TypeScript
+        """
+          |export type SimpleTypes = [string, number, number | null, boolean, string];
+        """.trimMargin()
+          .normalize()
+      )
+  }
+
+  @Test
+  fun testExampleTuple02() {
+    captureOutput("ExampleTuple02") {
+      dev.adamko.kxstsgen.example.exampleTuple02.main()
+    }.normalizeJoin()
+      .shouldBe(
+        // language=TypeScript
+        """
+          |export type OptionalFields = [string, string, string | null, string | null];
+        """.trimMargin()
+          .normalize()
+      )
+  }
+
+  @Test
+  fun testExampleTuple03() {
+    captureOutput("ExampleTuple03") {
+      dev.adamko.kxstsgen.example.exampleTuple03.main()
+    }.normalizeJoin()
+      .shouldBe(
+        // language=TypeScript
+        """
+          |export type Coordinates = [number, number, number];
+        """.trimMargin()
+          .normalize()
+      )
+  }
+
+  @Test
+  fun testExampleTuple04() {
+    captureOutput("ExampleTuple04") {
+      dev.adamko.kxstsgen.example.exampleTuple04.main()
+    }.normalizeJoin()
+      .shouldBe(
+        // language=TypeScript
+        """
+          |export interface GameLocations {
+          |  homeLocation: Coordinates;
+          |  allLocations: Coordinates[];
+          |  namedLocations: { [key: string]: Coordinates };
+          |}
+          |
+          |export type Coordinates = [number, number, number];
+        """.trimMargin()
+          .normalize()
+      )
+  }
+}

docs/enums.md

@@ -21,11 +21,6 @@ import dev.adamko.kxstsgen.*
 
 ### Simple enum
 
-<!--- INCLUDE .*\.kt
-import kotlinx.serialization.*
-import dev.adamko.kxstsgen.*
--->
-
 ```kotlin
 @Serializable
 enum class SomeType {