Add support for typescript

Run `cargo test -p nym-vpn-lib-types -F typescript-bindings` to generate bindings under ./bindings

Author: pronebird

nym-vpn-core/Cargo.lock

@@ -180,6 +180,7 @@ tonic = "0.14.2"
 tonic-prost = "0.14.2"
 tonic-prost-build = "0.14.2"
 typed-builder = "0.21"
+ts-rs = "11.0.1"
 tower = "0.5.2"
 tracing = "0.1"
 tracing-appender = "0.2.3"

nym-vpn-core/Cargo.toml

@@ -26,12 +26,15 @@ nym-type-conversions = [
     "dep:nym-vpn-network-config",
 ]
 uniffi-bindings = ["dep:uniffi", "ipnetwork"]
+typescript-bindings = ["dep:ts-rs", "serde"]
+serde = ["dep:serde"]
 
 [dependencies]
-serde = { workspace = true, features = ["derive"] }
+time = { workspace = true, features = ["serde", "parsing", "formatting"] }
+serde = { workspace = true, features = ["derive"], optional = true }
 si-scale.workspace = true
 thiserror.workspace = true
-time.workspace = true
+ts-rs = { workspace = true, optional = true }
 zeroize.workspace = true
 ipnetwork = { workspace = true, optional = true }
 uniffi = { workspace = true, features = ["tokio"], optional = true }

nym-vpn-core/crates/nym-vpn-lib-types/Cargo.toml

@@ -1,10 +1,17 @@
 // Copyright 2025 - Nym Technologies SA <[email protected]>
 // SPDX-License-Identifier: GPL-3.0-only
 
+#[cfg(feature = "serde")]
+use serde::{Deserialize, Serialize};
+#[cfg(feature = "typescript-bindings")]
+use ts_rs::TS;
+
 // todo: rename this type back to ErrorStateReason once support for renaming uniffi structs is released
 //       see: https://github.com/mozilla/uniffi-rs/issues/2212
 #[derive(Debug, Clone, Eq, PartialEq)]
 #[cfg_attr(feature = "uniffi-bindings", derive(uniffi::Enum))]
+#[cfg_attr(feature = "typescript-bindings", derive(TS), ts(export))]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 pub enum AccountControllerErrorStateReason {
     /// Error due to storage
     Storage { context: String },

nym-vpn-core/crates/nym-vpn-lib-types/src/account/controller_error.rs

@@ -3,11 +3,17 @@
 
 use std::fmt;
 
+#[cfg(feature = "serde")]
+use serde::{Deserialize, Serialize};
+#[cfg(feature = "typescript-bindings")]
+use ts_rs::TS;
+
 use crate::AccountControllerErrorStateReason;
 
-// Public enum describing the tunnel state
 #[derive(Debug, Clone, Eq, PartialEq)]
 #[cfg_attr(feature = "uniffi-bindings", derive(uniffi::Enum))]
+#[cfg_attr(feature = "typescript-bindings", derive(TS), ts(export))]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 pub enum AccountControllerState {
     /// We don't have network
     Offline,

nym-vpn-core/crates/nym-vpn-lib-types/src/account/controller_state.rs

@@ -1,9 +1,16 @@
 // Copyright 2025 - Nym Technologies SA <[email protected]>
 // SPDX-License-Identifier: GPL-3.0-only
 
+#[cfg(feature = "serde")]
+use serde::{Deserialize, Serialize};
+#[cfg(feature = "typescript-bindings")]
+use ts_rs::TS;
+
 // todo: this type is not used anywhere in the codebase for some reason
 #[derive(Clone, Debug)]
 #[cfg_attr(feature = "uniffi-bindings", derive(uniffi::Record))]
+#[cfg_attr(feature = "typescript-bindings", derive(TS), ts(export))]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 pub struct AvailableTickets {
     pub mixnet_entry_tickets: u64,
     pub mixnet_entry_data: u64,

nym-vpn-core/crates/nym-vpn-lib-types/src/account/ticketbooks.rs

@@ -6,13 +6,19 @@ use std::{
     net::{IpAddr, Ipv4Addr, Ipv6Addr, SocketAddr},
 };
 
+#[cfg(feature = "serde")]
+use serde::{Deserialize, Serialize};
 use time::OffsetDateTime;
+#[cfg(feature = "typescript-bindings")]
+use ts_rs::TS;
 
 use crate::TunnelType;
 
 // Represents the identity of a gateway
 #[derive(Debug, Clone, Eq, PartialEq)]
 #[cfg_attr(feature = "uniffi-bindings", derive(uniffi::Record))]
+#[cfg_attr(feature = "typescript-bindings", derive(TS), ts(export))]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 pub struct GatewayId {
     pub id: String,
 }
@@ -32,6 +38,8 @@ impl From<nym_gateway_directory::Gateway> for GatewayId {
 
 #[derive(Clone, Debug, Eq, PartialEq)]
 #[cfg_attr(feature = "uniffi-bindings", derive(uniffi::Record))]
+#[cfg_attr(feature = "typescript-bindings", derive(TS), ts(export))]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 pub struct EstablishConnectionData {
     /// Mixnet entry gateway.
     pub entry_gateway: GatewayId,
@@ -47,6 +55,8 @@ pub struct EstablishConnectionData {
 /// Describes the current state when establishing connection.
 #[derive(Clone, Debug, Eq, PartialEq)]
 #[cfg_attr(feature = "uniffi-bindings", derive(uniffi::Enum))]
+#[cfg_attr(feature = "typescript-bindings", derive(TS), ts(export))]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 pub enum EstablishConnectionState {
     /// Resolving API IP addresses
     ResolvingApiAddresses,
@@ -82,6 +92,8 @@ impl fmt::Display for EstablishConnectionState {
 
 #[derive(Clone, Debug, Eq, PartialEq)]
 #[cfg_attr(feature = "uniffi-bindings", derive(uniffi::Record))]
+#[cfg_attr(feature = "typescript-bindings", derive(TS), ts(export))]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 pub struct ConnectionData {
     /// Mixnet entry gateway.
     pub entry_gateway: GatewayId,
@@ -90,6 +102,8 @@ pub struct ConnectionData {
     pub exit_gateway: GatewayId,
 
     /// When the tunnel connection was last established.
+    #[cfg_attr(feature = "typescript-bindings", ts(as = "String"))]
+    #[cfg_attr(feature = "serde", serde(with = "time::serde::iso8601"))]
     pub connected_at: OffsetDateTime,
 
     /// Tunnel connection data.
@@ -98,6 +112,8 @@ pub struct ConnectionData {
 
 #[derive(Debug, Clone, Eq, PartialEq)]
 #[cfg_attr(feature = "uniffi-bindings", derive(uniffi::Enum))]
+#[cfg_attr(feature = "typescript-bindings", derive(TS), ts(export))]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 pub enum TunnelConnectionData {
     Mixnet(MixnetConnectionData),
     Wireguard(WireguardConnectionData),
@@ -115,6 +131,8 @@ impl TunnelConnectionData {
 // Represents a nym-address of the form id.enc@gateway
 #[derive(Debug, Clone, Eq, PartialEq)]
 #[cfg_attr(feature = "uniffi-bindings", derive(uniffi::Record))]
+#[cfg_attr(feature = "typescript-bindings", derive(TS), ts(export))]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 pub struct NymAddress {
     pub nym_address: String,
     pub gateway_id: String,
@@ -155,6 +173,8 @@ impl From<nym_gateway_directory::IpPacketRouterAddress> for NymAddress {
 
 #[derive(Debug, Clone, Eq, PartialEq)]
 #[cfg_attr(feature = "uniffi-bindings", derive(uniffi::Record))]
+#[cfg_attr(feature = "typescript-bindings", derive(TS), ts(export))]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 pub struct MixnetConnectionData {
     pub nym_address: NymAddress,
     pub exit_ipr: NymAddress,
@@ -166,6 +186,8 @@ pub struct MixnetConnectionData {
 
 #[derive(Debug, Clone, Eq, PartialEq)]
 #[cfg_attr(feature = "uniffi-bindings", derive(uniffi::Record))]
+#[cfg_attr(feature = "typescript-bindings", derive(TS), ts(export))]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 pub struct WireguardConnectionData {
     pub entry_bridge_addr: Option<SocketAddr>,
     pub entry: WireguardNode,
@@ -174,6 +196,8 @@ pub struct WireguardConnectionData {
 
 #[derive(Debug, Clone, Eq, PartialEq)]
 #[cfg_attr(feature = "uniffi-bindings", derive(uniffi::Record))]
+#[cfg_attr(feature = "typescript-bindings", derive(TS), ts(export))]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 pub struct WireguardNode {
     pub endpoint: SocketAddr,
     pub public_key: String,

nym-vpn-core/crates/nym-vpn-lib-types/src/connection_data.rs

@@ -1,8 +1,15 @@
 // Copyright 2024 - Nym Technologies SA <[email protected]>
 // SPDX-License-Identifier: GPL-3.0-only
 
+#[cfg(feature = "serde")]
+use serde::{Deserialize, Serialize};
+#[cfg(feature = "typescript-bindings")]
+use ts_rs::TS;
+
 #[derive(Clone, Debug, PartialEq, Eq)]
 #[cfg_attr(feature = "uniffi-bindings", derive(uniffi::Record))]
+#[cfg_attr(feature = "typescript-bindings", derive(TS), ts(export))]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 pub struct NymVpnDevice {
     pub created_on_utc: String,
     pub last_updated_utc: String,
@@ -12,6 +19,8 @@ pub struct NymVpnDevice {
 
 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
 #[cfg_attr(feature = "uniffi-bindings", derive(uniffi::Enum))]
+#[cfg_attr(feature = "typescript-bindings", derive(TS), ts(export))]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 pub enum NymVpnDeviceStatus {
     Active,
     Inactive,
@@ -20,6 +29,8 @@ pub enum NymVpnDeviceStatus {
 
 #[derive(Debug, Clone, PartialEq)]
 #[cfg_attr(feature = "uniffi-bindings", derive(uniffi::Record))]
+#[cfg_attr(feature = "typescript-bindings", derive(TS), ts(export))]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 pub struct NymVpnUsage {
     pub created_on_utc: String,
     pub last_updated_utc: String,