Skip to content

We/ts sdk updates #138

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
WesleyEdwards wants to merge 7 commits into
base: version-5
Choose a base branch
from
Open

We/ts sdk updates #138

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
8efb75f
branded types for ids
WesleyEdwards Jun 27, 2026
12ced97
add namespace for value classes
WesleyEdwards Jun 27, 2026
4b380a1
correctly group namespaces
WesleyEdwards Jun 29, 2026
4d55fbe
ordered namespace grouping
WesleyEdwards Jun 29, 2026
d9ab485
regenerate sdks
WesleyEdwards Jun 29, 2026
daed925
Merge branch 'version-5' into we/ts-sdk-updates
WesleyEdwards Jul 17, 2026
ef7d670
update sdk generator for ts sdk
WesleyEdwards Jul 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
224 changes: 149 additions & 75 deletions typed/src/main/kotlin/com/lightningkite/lightningserver/typed/sdk/TypescriptFetcherSdk.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,9 +168,7 @@ public class TypescriptFetcherSdk(
fun Appendable.appendModelImports() =
appendLine(
"import type { ${
models.joinToString {
it.tsType().substringBefore('<')
}
models.map { it.tsTopLevelTypeName() }.distinct().joinToString()
} } from './${fileStructure.modelsFilename}'"
)

Expand Down Expand Up @@ -200,61 +198,109 @@ public class TypescriptFetcherSdk(
private fun Appendable.appendLsImports() =
appendLine("import type { ${fromLightningServerPackage.joinToString()} } from '@lightningkite/lightning-server-simplified'")


@OptIn(ExperimentalSerializationApi::class)
context(server: ServerRuntime)
private fun Appendable.writeTypeDefinitions(types: List<KSerializer<*>> = server.models()) {
val stringSerialNames = HashSet<String>()

for (type in types) {
if(type.descriptor.isInline) {
val name = type.descriptor.simpleSerialName
if (stringSerialNames.add(name)) {
if(name == "ServerFile") appendLine(
"export type ServerFile = string"
)
else appendLine(
"export type $name = ${type.innerElement().decontextualize().tsType()} // ${type.descriptor.serialName}"
)
// TypeScript merges declarations with the same exported name, so nested Kotlin types
// are emitted as namespace members next to their parent interface. We render first,
// collect members like TestModel.ID/Status, then flush each namespace immediately
// after the matching top-level declaration for readability and stable imports.
val namespaces = linkedMapOf<String, MutableList<String>>()
val topLevelDeclarations = ArrayList<Pair<String, String>>()

fun Appendable.appendDecl(
name: String,
emit: Appendable.(String, Int) -> Unit,
): Pair<String, String>? {
val namespace = name.substringBefore('.', "")

if (namespace.isNotEmpty()) {
namespaces.getOrPut(namespace) { ArrayList() } += buildString {
emit(name.substringAfter('.'), 1)
}
} else when (type.descriptor.kind) {
StructureKind.CLASS -> {
val genericMap: Map<String, String> = type
.getGenerics()
?.withIndex()
?.associate { (index, value) ->
value.tsType() to "T${if (index > 0) index else ""}"
}
?: emptyMap()

fun String.replaceGenerics(): String =
genericMap.entries.fold(this) { acc, (old, new) -> acc.replace(old, new) }
return null
}
// Top Level Declaration Name
return name.substringBefore('<').substringBefore('.') to buildString {
emit(name, 0)
}
}

appendLine("export interface ${type.tsType().replaceGenerics()} {")
fun Appendable.appendNamespace(namespace: String) {
val declarations = namespaces.remove(namespace) ?: return
appendLine("export namespace $namespace {")
declarations.forEachIndexed { index, declaration ->
if (index > 0) appendLine()
append(declaration)
}
appendLine('}')
appendLine()
}

fun renderType(type: KSerializer<*>): Pair<String, String>? = when (type.descriptor.kind) {
StructureKind.CLASS -> {
val genericMap: Map<String, String> = type
.getGenerics()
?.withIndex()
?.associate { (index, value) ->
value.tsType() to "T${if (index > 0) index else ""}"
}
?: emptyMap()

fun String.replaceGenerics(): String =
genericMap.entries
.sortedByDescending { it.key.length }
.fold(this) { acc, (old, new) -> acc.replace(old, new) }

if (type.descriptor.isInline) {
val valueType =
type.serializableProperties?.firstOrNull()?.serializer?.tsType()?.replaceGenerics()
val name = type.tsType().replaceGenerics()
appendDecl(name, { localName, depth ->
appendIdtLine(depth, "export type $localName = Brand<${valueType}, \"$name\">")
})
} else {
val properties = type
.serializableProperties?.map { it.serializer }
?: type.childSerializersOrNull()?.toList()
?: emptyList()

for ((idx, prop) in properties.withIndex()) {
appendLine("\t${type.descriptor.getElementName(idx)}: ${prop.tsType().replaceGenerics()}")
}
val name = type.tsType().replaceGenerics()

appendLine('}')
appendDecl(name, { localName, depth ->
appendIdtLine(depth, "export interface $localName {")
for ((idx, prop) in properties.withIndex()) {
appendIdtLine(
depth + 1,
"${type.descriptor.getElementName(idx)}: ${prop.tsType().replaceGenerics()}"
)
}

appendIdtLine(depth, "}")
})
}
}

SerialKind.ENUM -> {
if (erasableTypes) {
append("export type ${type.tsType()} = ")
SerialKind.ENUM -> {
val typeName = type.tsType()
if (erasableTypes) {
appendDecl(typeName, { localName, depth ->
appendIdt(depth)
append("export type $localName = ")
for (index in 0 until type.descriptor.elementsCount) {
val name = type.descriptor.getElementName(index)
append(if (index == 0) "\"$name\"" else "| \"$name\"")
}
appendLine()
} else {
appendLine("export enum ${type.tsType()} {")
})
} else {
val typeName = type.tsType();
appendDecl(typeName, { localName, depth ->
appendIdtLine(depth, "export enum $localName {")
for (index in 0 until type.descriptor.elementsCount) {
append('\t')
appendIdt(depth + 1)
val name = type.descriptor.getElementName(index)
name.forEachIndexed { idx, it ->
if ((idx == 0 && it.isJavaIdentifierStart()) || (idx != 0 && it.isJavaIdentifierPart()))
Expand All @@ -266,57 +312,75 @@ public class TypescriptFetcherSdk(
appendLine()
}

appendLine('}')
}
appendIdtLine(depth, "}")
})
}
}

PrimitiveKind.STRING -> {
val name = type.descriptor.simpleSerialName
if (name != "String" && stringSerialNames.add(name)) {
PrimitiveKind.STRING -> {
val name = type.descriptor.simpleSerialName
if (name != "String" && stringSerialNames.add(name)) {
name to buildString {
appendLine(
"export type $name = string // ${type.descriptor.serialName}"
)
}
}
} else null
}

is PolymorphicKind -> {
val options = type.sealedOptionsOrNull() ?: continue
is PolymorphicKind -> {
val options = type.sealedOptionsOrNull() ?: return null
val genericMap: Map<String, String> = type
.getGenerics()
?.withIndex()
?.associate { (index, value) ->
value.tsType() to "T${if (index > 0) index else ""}"
}
?: emptyMap()

val genericMap: Map<String, String> = type
.getGenerics()
?.withIndex()
?.associate { (index, value) ->
value.tsType() to "T${if (index > 0) index else ""}"
}
?: emptyMap()
fun String.replaceGenerics(): String =
genericMap.entries.fold(this) { acc, (old, new) -> acc.replace(old, new) }

fun String.replaceGenerics(): String =
genericMap.entries.fold(this) { acc, (old, new) -> acc.replace(old, new) }
// A discriminated union of the subtypes. App `@Serializable sealed` types serialize
// flat with a "type" discriminator ({ "type": "<name>", ...subtype fields }); framework
// wrapper types serialize as { "<name>": <subtype> }. Each subtype is emitted as its own
// interface, so the union just references those by name.

// A discriminated union of the subtypes. App `@Serializable sealed` types serialize
// flat with a "type" discriminator ({ "type": "<name>", ...subtype fields }); framework
// wrapper types serialize as { "<name>": <subtype> }. Each subtype is emitted as its own
// interface, so the union just references those by name.
val typeName = type.tsType().replaceGenerics()
appendDecl(typeName, { localName, depth ->
val wrapper = type.isWrapperSealed()
append("export type ${type.tsType().replaceGenerics()} =")
appendIdt(depth)
append("export type ${localName} =")
if (options.isEmpty()) {
appendLine(" never")
} else {
appendLine()
for (option in options) {
val sub = option.serializer.tsType().replaceGenerics()
if (wrapper) appendIdtLine(1, "| { \"${option.name}\": $sub }")
else appendIdtLine(1, "| ({ type: \"${option.name}\" } & $sub)")
if (wrapper) appendIdtLine(depth + 1, "| { \"${option.name}\": $sub }")
else appendIdtLine(depth + 1, "| ({ type: \"${option.name}\" } & $sub)")
}
}
}

else -> continue
})
}

else -> null
}

for (type in types) {
renderType(type)?.let { topLevelDeclarations += it }
}

for ((name, declaration) in topLevelDeclarations) {
append(declaration)
appendLine()
appendNamespace(name)
}

namespaces.keys.toList().forEach { appendNamespace(it) }
}


/**
* Generates the TypeScript interface definition for the API.
*
Expand Down Expand Up @@ -462,21 +526,22 @@ public class TypescriptFetcherSdk(
.sortedBy { it.descriptor.simpleSerialName }
.distinctBy { it.tsType().substringBefore("<") } // Distinct by generics
.filter {
if(it.descriptor.isInline) true
else when (it.descriptor.kind) {
when (it.descriptor.kind) {
SerialKind.ENUM -> true
// Inline value classes serialize as their underlying primitive (see tsType), so they get no
// standalone type definition and must not be emitted/imported as model types.
StructureKind.CLASS if (it !is MySealedClassSerializer && !it.descriptor.isInline) -> true
StructureKind.CLASS if (it !is MySealedClassSerializer) -> true
PrimitiveKind.STRING if (it.descriptor.simpleSerialName != "String") -> true
// Sealed/polymorphic types are emitted as TS discriminated unions (see writeTypeDefinitions).
is PolymorphicKind -> true

else -> false
}
}


context(runtime: ServerRuntime)
private fun KSerializer<*>.tsTopLevelTypeName(): String = tsType()
.substringBefore('<')
.substringBefore('.')

@OptIn(ExperimentalSerializationApi::class)
context(runtime: ServerRuntime)
private fun KSerializer<*>.tsType(): String = nullElement()?.let { it.tsType() + " | null | undefined" } ?: when {
Expand Down Expand Up @@ -525,7 +590,8 @@ public class TypescriptFetcherSdk(
if (descriptor.serialName == "com.lightningkite.serialization.Partial") {
append("DeepPartial")
} else {
append(descriptor.simpleSerialName)
val name = descriptor.simpleSerialName
append(descriptor.nestedTsTypeName ?: name)
}
typeParametersSerializersOrNull()
?.takeUnless { it.isEmpty() }
Expand All @@ -536,9 +602,16 @@ public class TypescriptFetcherSdk(
}

private val SerialDescriptor.simpleSerialName: String
get() = serialName.substringBefore('<').substringBefore('/').substringAfterLast('.').removeSuffix("?")

private val SerialDescriptor.nestedTsTypeName: String?
get() {
val fqn = serialName.substringBefore('<').substringBefore('/').removeSuffix("?")
return fqn.split('.').filter { it.first().isUpperCase() }.joinToString("")
val parts = serialName.substringBefore('<').substringBefore('/').split('.')
if (parts.size < 2) return null
val name = simpleSerialName
val parentName = parts[parts.size - 2]
if (parentName.firstOrNull()?.isUpperCase() != true) return null
return "$parentName.$name"
}

@OptIn(ExperimentalSerializationApi::class)
Expand Down Expand Up @@ -568,8 +641,9 @@ public class TypescriptFetcherSdk(
"DataClassPathPartial",
"QueryPartial",
"DeepPartial",
"Fetcher"
"Fetcher",
"Brand",
)

private val skipFromLsPackage = setOf("Partial") + fromLightningServerPackage
}
}
12 changes: 6 additions & 6 deletions typed/src/test/kotlin/com/lightningkite/lightningserver/typed/sdk/generated/kotlin/Api.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ interface Api {
}
val predefinedEndpoints: PredefinedEndpoints

interface ModuleApi : com.lightningkite.lightningserver.typed.ClientModelRestEndpoints<com.lightningkite.lightningserver.typed.sdk.TestModel, kotlin.uuid.Uuid> {
interface ModuleApi : com.lightningkite.lightningserver.typed.ClientModelRestEndpoints<com.lightningkite.lightningserver.typed.sdk.TestModel, com.lightningkite.lightningserver.typed.sdk.TestModel.ID> {
/**
* Test Endpoint
*
Expand All @@ -65,7 +65,7 @@ interface Api {
* */
suspend fun inlinedEndpoint2(id: kotlin.uuid.Uuid, category: kotlin.uuid.Uuid): kotlin.Int

interface DefaultEndpoints : com.lightningkite.lightningserver.typed.ClientModelRestEndpointsAndUpdatesWebsocket<com.lightningkite.lightningserver.typed.sdk.TestModel, kotlin.uuid.Uuid> {
interface DefaultEndpoints : com.lightningkite.lightningserver.typed.ClientModelRestEndpointsAndUpdatesWebsocket<com.lightningkite.lightningserver.typed.sdk.TestModel, com.lightningkite.lightningserver.typed.sdk.TestModel.ID> {
/**
* Test Endpoint
*
Expand All @@ -89,7 +89,7 @@ interface Api {
}
val default: DefaultEndpoints

interface DefaultEndpoints2 : com.lightningkite.lightningserver.typed.ClientModelRestEndpointsAndUpdatesWebsocket<com.lightningkite.lightningserver.typed.sdk.TestModel, kotlin.uuid.Uuid> {
interface DefaultEndpoints2 : com.lightningkite.lightningserver.typed.ClientModelRestEndpointsAndUpdatesWebsocket<com.lightningkite.lightningserver.typed.sdk.TestModel, com.lightningkite.lightningserver.typed.sdk.TestModel.ID> {
/**
* Test Endpoint
*
Expand All @@ -115,7 +115,7 @@ interface Api {
}
val module: ModuleApi

interface CustomEndpoints : com.lightningkite.lightningserver.typed.ClientModelRestEndpointsAndUpdatesWebsocket<com.lightningkite.lightningserver.typed.sdk.TestModel, kotlin.uuid.Uuid> {
interface CustomEndpoints : com.lightningkite.lightningserver.typed.ClientModelRestEndpointsAndUpdatesWebsocket<com.lightningkite.lightningserver.typed.sdk.TestModel, com.lightningkite.lightningserver.typed.sdk.TestModel.ID> {
/**
* Test Endpoint
*
Expand Down Expand Up @@ -157,9 +157,9 @@ interface Api {
* */
suspend fun inlinedEndpoint(id: kotlin.uuid.Uuid, category: kotlin.uuid.Uuid): kotlin.Int

val rest: com.lightningkite.lightningserver.typed.ClientModelRestEndpoints<com.lightningkite.lightningserver.typed.sdk.TestModel, kotlin.uuid.Uuid>
val rest: com.lightningkite.lightningserver.typed.ClientModelRestEndpoints<com.lightningkite.lightningserver.typed.sdk.TestModel, com.lightningkite.lightningserver.typed.sdk.TestModel.ID>

val rest2: com.lightningkite.lightningserver.typed.ClientModelRestEndpoints<com.lightningkite.lightningserver.typed.sdk.TestModel, kotlin.uuid.Uuid>
val rest2: com.lightningkite.lightningserver.typed.ClientModelRestEndpoints<com.lightningkite.lightningserver.typed.sdk.TestModel, com.lightningkite.lightningserver.typed.sdk.TestModel.ID>
}
val other: OtherEndpoints
}
Loading
Loading