This is a Kotlin Multiplatform line-by-line transliteration port of Aleph-Alpha/ts-rs.

Original Project: This port is based on Aleph-Alpha/ts-rs. All design credit and project intent belong to the upstream authors; this repository is a faithful port to Kotlin Multiplatform with no behavioural changes intended.

This is an in-progress port. The goal is feature parity with the upstream Rust crate while providing a native Kotlin Multiplatform API. Every Kotlin file carries a // port-lint: source <path> header naming its upstream Rust counterpart so the AST-distance tool can track provenance.

The text below is reproduced and lightly edited from https://github.com/Aleph-Alpha/ts-rs. It is the upstream project's own description and remains under the upstream authors' authorship; links have been rewritten to absolute upstream URLs so they continue to resolve from this repository.

Generate typescript type declarations from rust types

When building a web application in rust, data structures have to be shared between backend and frontend. Using this library, you can easily generate TypeScript bindings to your rust structs & enums so that you can keep your types in one place.

ts-rs might also come in handy when working with webassembly.

ts-rs exposes a single trait, TS. Using a derive macro, you can implement this interface for your types. Then, you can use this trait to obtain the TypeScript bindings. We recommend doing this in your tests. See the example and the docs.

[dependencies]
ts-rs = "12.0"

#[derive(ts_rs::TS)]
#[ts(export)]
struct User {
    user_id: i32,
    first_name: String,
    last_name: String,
}

When running cargo test or cargo test export_bindings, the following TypeScript type will be exported to bindings/User.ts:

export type User = { user_id: number, first_name: string, last_name: string, };

• generate type declarations from rust structs
• generate union declarations from rust enums
• works with generic types
• compatible with serde
• generate necessary imports when exporting to multiple files
• precise control over generated types

If there's a type you're dealing with which doesn't implement TS, you can use either #[ts(as = "..")] or #[ts(type = "..")], enable the appropriate cargo feature, or open a PR.

When using #[ts(export)] on a type, ts-rs generates a test which writes the bindings for it to disk.
The following environment variables may be set to configure how and where:

We recommend putting this configuration in the project's config.toml to make it persistent:

# <project-root>/.cargo/config.toml
[env]
TS_RS_EXPORT_DIR = { value = "bindings", relative = true }
TS_RS_LARGE_INT = "number"

To export bindings programmatically without the use of tests, TS::export_all, TS::export, and TS::export_to_string can be used instead.

With the serde-compat feature (enabled by default), serde attributes are parsed for enums and structs.
Supported serde attributes: rename, rename-all, rename-all-fields, tag, content, untagged, skip, skip_serializing, skip_serializing_if, flatten, default

Note: skip_serializing and skip_serializing_if only have an effect when used together with #[serde(default)]. This ensures that the generated type is correct for both serialization and deserialization.

Note: skip_deserializing is ignored. If you wish to exclude a field from the generated type, but cannot use #[serde(skip)], use #[ts(skip)] instead.

When ts-rs encounters an unsupported serde attribute, a warning is emitted, unless the feature no-serde-warnings is enabled.
We are currently waiting for #54140, which will improve the ergonomics arund these diagnostics.

Contributions are always welcome! Feel free to open an issue, discuss using GitHub discussions or open a PR. See CONTRIBUTING.md

The Minimum Supported Rust Version for this crate is 1.88.0

License: MIT

dependencies {
    implementation("io.github.kotlinmania:ts-rs-kotlin:0.1.0")
}

./gradlew build
./gradlew test

• macOS arm64
• Linux x64
• Windows mingw-x64
• iOS arm64 / simulator-arm64 (Swift export + XCFramework)
• JS (browser + Node.js)
• Wasm-JS (browser + Node.js)
• Android (API 24+)

See AGENTS.md and CLAUDE.md for translator discipline, port-lint header convention, and Rust → Kotlin idiom mapping.

This Kotlin port is distributed under the same MIT license as the upstream Aleph-Alpha/ts-rs. See LICENSE (and any sibling LICENSE-* / NOTICE files mirrored from upstream) for the full text.

Original work copyrighted by the ts-rs authors.
Kotlin port: Copyright (c) 2026 Sydney Renee and The Solace Project.

Thanks to the Aleph-Alpha/ts-rs maintainers and contributors for the original Rust implementation. This port reproduces their work in Kotlin Multiplatform; bug reports about upstream design or behavior should go to the upstream repository.