#26 named tuples

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

@@ -6,35 +6,33 @@ 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? = "",
+@Serializable(with = PostalAddressUSA.Serializer::class)
+data class PostalAddressUSA(
+  @SerialName("num") // 'SerialName' will be ignored in 'Tuple' form
+  val houseNumber: String,
+  val streetName: String,
+  val postcode: String,
 ) {
-  object Serializer : TupleSerializer<OptionalFields>(
-    "OptionalFields",
+  object Serializer : TupleSerializer<PostalAddressUSA>(
+    "PostalAddressUSA",
     {
-      element(OptionalFields::requiredString)
-      element(OptionalFields::optionalString)
-      element(OptionalFields::nullableString)
-      element(OptionalFields::nullableOptionalString)
+      element(PostalAddressUSA::houseNumber)
+      // custom labels for 'streetName', 'postcode'
+      element("street", PostalAddressUSA::streetName)
+      element("zip", PostalAddressUSA::postcode)
     }
   ) {
-    override fun tupleConstructor(elements: Iterator<*>): OptionalFields {
-      val iter = elements.iterator()
-      return OptionalFields(
-        iter.next() as String,
-        iter.next() as String,
-        iter.next() as String,
-        iter.next() as String,
+    override fun tupleConstructor(elements: Iterator<*>): PostalAddressUSA {
+      return PostalAddressUSA(
+        elements.next() as String,
+        elements.next() as String,
+        elements.next() as String,
       )
     }
   }
 }
 
 fun main() {
   val tsGenerator = KxsTsGenerator()
-  println(tsGenerator.generate(OptionalFields.serializer()))
+  println(tsGenerator.generate(PostalAddressUSA.serializer()))
 }

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

@@ -6,31 +6,35 @@ 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,
+@Serializable(with = OptionalFields.Serializer::class)
+data class OptionalFields(
+  val requiredString: String,
+  val optionalString: String = "",
+  val nullableString: String?,
+  val nullableOptionalString: String? = "",
 ) {
-  object Serializer : TupleSerializer<Coordinates>(
-    "Coordinates",
+  object Serializer : TupleSerializer<OptionalFields>(
+    "OptionalFields",
     {
-      element(Coordinates::x)
-      element(Coordinates::y)
-      element(Coordinates::z)
+      element(OptionalFields::requiredString)
+      element(OptionalFields::optionalString)
+      element(OptionalFields::nullableString)
+      element(OptionalFields::nullableOptionalString)
     }
   ) {
-    override fun tupleConstructor(elements: Iterator<*>): Coordinates {
-      return Coordinates(
-        elements.next() as Int,
-        elements.next() as Int,
-        elements.next() as Int,
+    override fun tupleConstructor(elements: Iterator<*>): 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(Coordinates.serializer()))
+  println(tsGenerator.generate(OptionalFields.serializer()))
 }

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

@@ -6,16 +6,31 @@ 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>,
-)
+@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: Iterator<*>): Coordinates {
+      return Coordinates(
+        elements.next() as Int,
+        elements.next() as Int,
+        elements.next() as Int,
+      )
+    }
+  }
+}
 
 fun main() {
   val tsGenerator = KxsTsGenerator()
-  println(tsGenerator.generate(GameLocations.serializer()))
+  println(tsGenerator.generate(Coordinates.serializer()))
 }

docs/code/example/example-tuple-05.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.exampleTuple05
+
+import dev.adamko.kxstsgen.*
+import dev.adamko.kxstsgen.core.experiments.TupleSerializer
+import kotlinx.serialization.*
+
+import dev.adamko.kxstsgen.example.exampleTuple04.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

@@ -20,7 +20,13 @@ class TuplesTest : FunSpec({
       actual.shouldBe(
         // language=TypeScript
         """
-          |export type SimpleTypes = [string, number, number | null, boolean, string];
+          |export type SimpleTypes = [
+          |  aString: string,
+          |  anInt: number,
+          |  aDouble: number | null,
+          |  bool: boolean,
+          |  privateMember: string,
+          |];
         """.trimMargin()
         .normalize()
       )
@@ -40,7 +46,11 @@ class TuplesTest : FunSpec({
       actual.shouldBe(
         // language=TypeScript
         """
-          |export type OptionalFields = [string, string, string | null, string | null];
+          |export type PostalAddressUSA = [
+          |  houseNumber: string, // @SerialName("num") was ignored
+          |  street: string, // custom name
+          |  zip: string, // custom name
+          |];
         """.trimMargin()
         .normalize()
       )
@@ -60,7 +70,12 @@ class TuplesTest : FunSpec({
       actual.shouldBe(
         // language=TypeScript
         """
-          |export type Coordinates = [number, number, number];
+          |export type OptionalFields = [
+          |  requiredString: string,
+          |  optionalString: string,
+          |  nullableString: string | null,
+          |  nullableOptionalString: string | null,
+          |];
         """.trimMargin()
         .normalize()
       )
@@ -76,6 +91,30 @@ class TuplesTest : FunSpec({
       dev.adamko.kxstsgen.example.exampleTuple04.main()
     }.normalizeJoin()
 
+    test("expect actual matches TypeScript") {
+      actual.shouldBe(
+        // language=TypeScript
+        """
+          |export type Coordinates = [
+          |  x: number,
+          |  y: number,
+          |  z: number,
+          |];
+        """.trimMargin()
+        .normalize()
+      )
+    }
+
+    test("expect actual compiles").config(tags = tsCompile) {
+      actual.shouldTypeScriptCompile()
+    }
+  }
+
+  context("ExampleTuple05") {
+    val actual = captureOutput("ExampleTuple05") {
+      dev.adamko.kxstsgen.example.exampleTuple05.main()
+    }.normalizeJoin()
+
     test("expect actual matches TypeScript") {
       actual.shouldBe(
         // language=TypeScript
@@ -86,7 +125,11 @@ class TuplesTest : FunSpec({
           |  namedLocations: { [key: string]: Coordinates };
           |}
           |
-          |export type Coordinates = [number, number, number];
+          |export type Coordinates = [
+          |  x: number,
+          |  y: number,
+          |  z: number,
+          |];
         """.trimMargin()
         .normalize()
       )