1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630
use crate::type_expr::{
DefinedTypeInfo, Docs, Ident, IndexSignature, NativeTypeInfo, ObjectField,
TypeArray, TypeDefinition, TypeExpr, TypeInfo, TypeIntersection, TypeName,
TypeObject, TypeString, TypeTuple, TypeUnion,
};
use std::io;
/// A Rust type that has a corresponding TypeScript type definition.
///
/// For a Rust type `T`, the `TypeDef` trait defines a TypeScript type
/// which describes JavaScript value that are equivalents of Rust values of
/// type `T` as encoded to JSON using [`serde_json`](https://docs.rs/serde_json/). The
/// types are one-to-one, so decoding from TypeScript to JSON to Rust also
/// works.
///
/// ## Implementing
///
/// ### Local Types
///
/// To derive this trait for your own types, use the
/// [`#[derive(TypeDef)]`](macro@crate::TypeDef) macro.
///
/// ### Foreign Types
///
/// To use types from external crates in your own types, the recommended
/// approach is to create a newtype wrapper and use the `#[type_def(type_of =
/// "T")]` attribute to specify its type:
///
/// ```
/// use serde::{Deserialize, Serialize};
/// use typescript_type_def::{write_definition_file, TypeDef};
///
/// // The Uuid type from the uuid crate does not implement TypeDef
/// // But we know that it serializes to just a string
/// #[derive(
/// Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize, TypeDef,
/// )]
/// #[serde(transparent)]
/// pub struct Uuid(#[type_def(type_of = "String")] pub uuid::Uuid);
///
/// // We can now use our newtype in place of the foreign type
/// #[derive(Debug, Serialize, Deserialize, TypeDef)]
/// pub struct User {
/// pub id: Uuid,
/// pub name: String,
/// }
///
/// let ts_module = {
/// let mut buf = Vec::new();
/// write_definition_file::<_, User>(&mut buf, Default::default()).unwrap();
/// String::from_utf8(buf).unwrap()
/// };
/// assert_eq!(
/// ts_module,
/// r#"// AUTO-GENERATED by typescript-type-def
///
/// export default types;
/// export namespace types{
/// export type Uuid=string;
/// export type User={"id":types.Uuid;"name":string;};
/// }
/// "#
/// );
/// ```
///
/// The other option if you don't want to create a newtype is to use
/// `#[type_def(type_of = "T")]` everywhere you use the type:
///
/// ```
/// use serde::{Deserialize, Serialize};
/// use typescript_type_def::{write_definition_file, TypeDef};
///
/// #[derive(Debug, Serialize, Deserialize, TypeDef)]
/// pub struct User {
/// #[type_def(type_of = "String")]
/// pub id: uuid::Uuid,
/// pub name: String,
/// }
///
/// let ts_module = {
/// let mut buf = Vec::new();
/// write_definition_file::<_, User>(&mut buf, Default::default()).unwrap();
/// String::from_utf8(buf).unwrap()
/// };
/// assert_eq!(
/// ts_module,
/// r#"// AUTO-GENERATED by typescript-type-def
///
/// export default types;
/// export namespace types{
/// export type User={"id":string;"name":string;};
/// }
/// "#
/// );
/// ```
///
/// ### [`std`] Types
///
/// [`TypeDef`] is implemented for [`std`] types as follows:
///
/// | Rust type | TypeScript type |
/// |---|---|
/// | [`bool`] | `boolean` |
/// | [`String`] | `string` |
/// | [`str`] | `string` |
/// | numeric types | `number`[^number] |
/// | [`()`](unit) | `null` |
/// | [`(A, B, C)`](tuple) | `[A, B, C]` |
/// | [`[T; N]`](array) | `[T, T, ..., T]` (an `N`-tuple) |
// FIXME: https://github.com/rust-lang/rust/issues/86375
/// | [`Option<T>`] | <code>T \| null</code> |
/// | [`Vec<T>`] | `T[]` |
/// | [`[T]`](slice) | `T[]` |
/// | [`HashSet<T>`](std::collections::HashSet) | `T[]` |
/// | [`BTreeSet<T>`](std::collections::BTreeSet) | `T[]` |
/// | [`HashMap<K, V>`](std::collections::HashMap) | `Record<K, V>` |
/// | [`BTreeMap<K, V>`](std::collections::BTreeMap) | `Record<K, V>` |
/// | [`&'static T`](reference) | `T` |
/// | [`Box<T>`] | `T` |
/// | [`Cow<'static, T>`](std::borrow::Cow) | `T` |
/// | [`PhantomData<T>`](std::marker::PhantomData) | `T` |
/// | [`Result<T, E>`](std::result::Result) | <code>{ Ok: T } \| { Err: E }</code> |
///
/// ### [`serde_json`] Types
///
/// [`TypeDef`] is implemented for types from the [`serde_json`] crate (when the
/// `json_value` crate feature is enabled) as follows:
///
/// | Rust type | TypeScript type |
/// |---|---|
/// | [`Value`](serde_json::Value) | <code>null \|<br />boolean \|<br />number \|<br />string \|<br />JSONValue[] \|<br />{ [key: string]: JSONValue; }</code> |
/// | [`Map<K, V>`](serde_json::Map) | `Record<K, V>` |
/// | [`Number`](serde_json::Number) | `number` |
///
/// [^number]: `std` numeric types are emitted as named aliases converted to
/// PascalCase (e.g. `Usize`, `I32`, `F64`, `NonZeroI8`, etc.). Since they are
/// simple aliases, they do not enforce anything in TypeScript about the Rust
/// types' numeric bounds, but serve to document their intended range.
pub trait TypeDef: 'static {
/// A constant value describing the structure of this type.
///
/// This type information is used to emit a TypeScript type definition.
const INFO: TypeInfo;
}
pub(crate) struct EmitCtx<'ctx> {
w: &'ctx mut dyn io::Write,
root_namespace: Option<&'ctx str>,
stats: Stats,
}
pub(crate) trait Emit {
fn emit(&self, ctx: &mut EmitCtx<'_>) -> io::Result<()>;
}
/// Options for customizing the output of [`write_definition_file`].
///
/// The default options are:
/// ```
/// # use typescript_type_def::DefinitionFileOptions;
/// # let default =
/// DefinitionFileOptions {
/// header: Some("// AUTO-GENERATED by typescript-type-def\n"),
/// root_namespace: Some("types"),
/// }
/// # ;
/// # assert_eq!(default, Default::default());
/// ```
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct DefinitionFileOptions<'a> {
/// Text to be emitted at the start of the file.
///
/// If `Some`, the string should contain the exact content of the header as
/// TypeScript code (usually in the form of comments). If `None`, no header
/// will be added.
pub header: Option<&'a str>,
/// The name of the root namespace which the definitions will be placed
/// under.
///
/// By default, all exported types are wrapped in a root namespace `types`.
/// This gives all types an unambiguous fully-qualified name. When setting
/// the `root_namespace` to `None`, no outer namespace is added. This will
/// work fine in most situations, but it can however lead to errors in the
/// generated TypeScript code when using inner namespaces and types with the
/// same name. If you are using inner namespaces through the
/// `#[type_def(namespace = "x.y.z")]` attribute, it's recommended to have a
/// `root_namespace` as well. See
/// [this example](https://www.typescriptlang.org/play?#code/PTAEBUAsEsGdQPYFcAuBTATqFBPADmqJAIbwB2CoGCCKoZxAtmrHsQMZoA0osl0ddsTKIyAGxygARoQxoAZpjkATbJVKgAVklh0ABgDEaegHQBYAFBoAHngQY6uAqCOUAvKADk8mgFpk6BieANyWNnYO9EwsbJyg0GRkmKAA3pagGaAgEDDwCUlYToRw8WSw0MqExFHMrBzcvPwo8EIUZNBCYjXF8Hr5mCaupumZ4faO+ISuoB7efv1BoRaZWWBQJQvYk-HwKBg4CQDmalQKySiUKJCEAckISVwjGdlSqNjXoEhkAI5IxGLQeTQNCqBjMUCGYw7Uq6NDEVQJQJ4OToVQaOSKORkdhHJ6rd6EMQITpbZyQhB6GHoeGIeQEqg0FC+MRoABuaC69zQ5mWo1s41JhAAQsQsB4UqAfAgAFwuGjBUAAXyWisslmyAEF4NU5LAkGIUDwriVDtB2drBaAlPZpGghDpCHoRRgTFLKSRdts+okBkMeBR9EMeSy6FJRbKFiZnTNUpKaLK5gh-KhMJ4lUt1WAAJJ0-6culXQhFbVyT5kSpYHWM7p1Tg8NmYSRFIgaYRlphSaCHJDIeDyfUSXy-f6A4Gg6I8saRMExeqC+BpXkZKcTZzTWZS5OBEJ4lc12LFH1YRcrFZ75vrrybhY7pen7LrPJHy2tT6wIsfL4drs9nTdCHFoMUIXKcmInIWiAplgXI8qefIRKuwqijGEpSrKgGuAqyp4qqFi4ZmOQlAA7vYADW2rwOEdqosGaChqKABM6GTLAJiRtG4pxjKV5+LcQTpkAA)
/// of a situation where not having a root namespace can lead to errors.
pub root_namespace: Option<&'a str>,
}
/// Statistics about the type definitions produced by [`write_definition_file`].
#[derive(Debug, Clone)]
pub struct Stats {
/// The number of unique type definitions produced.
pub type_definitions: usize,
}
impl<'ctx> EmitCtx<'ctx> {
fn new(
w: &'ctx mut dyn io::Write,
root_namespace: Option<&'ctx str>,
) -> Self {
let stats = Stats {
type_definitions: 0,
};
Self {
w,
root_namespace,
stats,
}
}
}
struct SepList<'a, T>(&'a [T], &'static str);
impl<'a, T> Emit for SepList<'a, T>
where
T: Emit,
{
fn emit(&self, ctx: &mut EmitCtx<'_>) -> io::Result<()> {
let Self(elements, separator) = self;
let mut first = true;
for element in *elements {
if !first {
write!(ctx.w, "{}", separator)?;
}
element.emit(ctx)?;
first = false;
}
Ok(())
}
}
struct Generics<'a, T>(&'a [T]);
impl<'a, T> Emit for Generics<'a, T>
where
T: Emit,
{
fn emit(&self, ctx: &mut EmitCtx<'_>) -> io::Result<()> {
let Self(args) = self;
if !args.is_empty() {
write!(ctx.w, "<")?;
SepList(args, ",").emit(ctx)?;
write!(ctx.w, ">")?;
}
Ok(())
}
}
impl Emit for TypeExpr {
fn emit(&self, ctx: &mut EmitCtx<'_>) -> io::Result<()> {
match self {
TypeExpr::Ref(type_info) => ctx.emit_type_ref(type_info),
TypeExpr::Name(type_name) => type_name.emit(ctx),
TypeExpr::String(type_string) => type_string.emit(ctx),
TypeExpr::Tuple(type_tuple) => type_tuple.emit(ctx),
TypeExpr::Object(type_object) => type_object.emit(ctx),
TypeExpr::Array(type_array) => type_array.emit(ctx),
TypeExpr::Union(type_union) => type_union.emit(ctx),
TypeExpr::Intersection(type_intersection) => {
type_intersection.emit(ctx)
}
}
}
}
impl Emit for TypeName {
fn emit(&self, ctx: &mut EmitCtx<'_>) -> io::Result<()> {
let Self {
path,
name,
generic_args,
} = self;
for path_part in *path {
path_part.emit(ctx)?;
write!(ctx.w, ".")?;
}
name.emit(ctx)?;
Generics(generic_args).emit(ctx)?;
Ok(())
}
}
impl Emit for TypeString {
fn emit(&self, ctx: &mut EmitCtx<'_>) -> io::Result<()> {
let Self { docs, value } = self;
docs.emit(ctx)?;
write!(ctx.w, "{:?}", value)?;
Ok(())
}
}
impl Emit for TypeTuple {
fn emit(&self, ctx: &mut EmitCtx<'_>) -> io::Result<()> {
let Self { docs, elements } = self;
docs.emit(ctx)?;
write!(ctx.w, "[")?;
SepList(elements, ",").emit(ctx)?;
write!(ctx.w, "]")?;
Ok(())
}
}
impl Emit for TypeObject {
fn emit(&self, ctx: &mut EmitCtx<'_>) -> io::Result<()> {
let Self {
docs,
index_signature,
fields,
} = self;
docs.emit(ctx)?;
write!(ctx.w, "{{")?;
if let Some(IndexSignature { docs, name, value }) = index_signature {
docs.emit(ctx)?;
write!(ctx.w, "[")?;
name.emit(ctx)?;
write!(ctx.w, ":string]:")?;
value.emit(ctx)?;
write!(ctx.w, ";")?;
}
for ObjectField {
docs,
name,
optional,
r#type,
} in *fields
{
docs.emit(ctx)?;
name.emit(ctx)?;
if *optional {
write!(ctx.w, "?")?;
}
write!(ctx.w, ":")?;
r#type.emit(ctx)?;
write!(ctx.w, ";")?;
}
write!(ctx.w, "}}")?;
Ok(())
}
}
impl Emit for TypeArray {
fn emit(&self, ctx: &mut EmitCtx<'_>) -> io::Result<()> {
let Self { docs, item } = self;
docs.emit(ctx)?;
write!(ctx.w, "(")?;
item.emit(ctx)?;
write!(ctx.w, ")[]")?;
Ok(())
}
}
impl Emit for TypeUnion {
fn emit(&self, ctx: &mut EmitCtx<'_>) -> io::Result<()> {
let Self { docs, members } = self;
docs.emit(ctx)?;
if members.is_empty() {
write!(ctx.w, "never")?;
} else {
write!(ctx.w, "(")?;
SepList(members, "|").emit(ctx)?;
write!(ctx.w, ")")?;
}
Ok(())
}
}
impl Emit for TypeIntersection {
fn emit(&self, ctx: &mut EmitCtx<'_>) -> io::Result<()> {
let Self { docs, members } = self;
docs.emit(ctx)?;
if members.is_empty() {
write!(ctx.w, "any")?;
} else {
write!(ctx.w, "(")?;
SepList(members, "&").emit(ctx)?;
write!(ctx.w, ")")?;
}
Ok(())
}
}
impl Emit for Ident {
fn emit(&self, ctx: &mut EmitCtx<'_>) -> io::Result<()> {
let Self(name) = self;
write!(ctx.w, "{}", name)?;
Ok(())
}
}
impl Emit for Docs {
fn emit(&self, ctx: &mut EmitCtx<'_>) -> io::Result<()> {
let Self(docs) = self;
writeln!(ctx.w)?;
writeln!(ctx.w, "/**")?;
for line in docs.lines() {
writeln!(ctx.w, " * {}", line)?;
}
writeln!(ctx.w, " */")?;
Ok(())
}
}
impl<T> Emit for &T
where
T: Emit,
{
fn emit(&self, ctx: &mut EmitCtx<'_>) -> io::Result<()> {
T::emit(self, ctx)
}
}
impl<T> Emit for Option<T>
where
T: Emit,
{
fn emit(&self, ctx: &mut EmitCtx<'_>) -> io::Result<()> {
if let Some(inner) = self {
inner.emit(ctx)
} else {
Ok(())
}
}
}
impl EmitCtx<'_> {
fn emit_type_def(&mut self, infos: &[&'static TypeInfo]) -> io::Result<()> {
for TypeDefinition {
docs,
path,
name,
generic_vars,
def,
} in crate::iter_def_deps::IterDefDeps::new(infos)
{
self.stats.type_definitions += 1;
docs.emit(self)?;
if !path.is_empty() {
write!(self.w, "export namespace ")?;
SepList(path, ".").emit(self)?;
write!(self.w, "{{")?;
}
write!(self.w, "export type ")?;
name.emit(self)?;
Generics(generic_vars).emit(self)?;
write!(self.w, "=")?;
def.emit(self)?;
write!(self.w, ";")?;
if !path.is_empty() {
write!(self.w, "}}")?;
}
writeln!(self.w)?;
}
Ok(())
}
fn emit_type_ref(&mut self, info: &'static TypeInfo) -> io::Result<()> {
match info {
TypeInfo::Native(NativeTypeInfo { r#ref }) => r#ref.emit(self),
TypeInfo::Defined(DefinedTypeInfo {
def:
TypeDefinition {
docs: _,
path,
name,
generic_vars: _,
def: _,
},
generic_args,
}) => {
if let Some(root_namespace) = self.root_namespace {
write!(self.w, "{}.", root_namespace)?;
}
for path_part in *path {
path_part.emit(self)?;
write!(self.w, ".")?;
}
name.emit(self)?;
Generics(generic_args).emit(self)?;
Ok(())
}
}
}
}
impl Default for DefinitionFileOptions<'_> {
fn default() -> Self {
Self {
header: Some("// AUTO-GENERATED by typescript-type-def\n"),
root_namespace: Some("types"),
}
}
}
/// Writes a TypeScript definition file containing type definitions for `T` to
/// the given writer.
///
/// The resulting TypeScript module will define and export the type definition
/// for `T` and all of its transitive dependencies under a root namespace. The
/// name of the root namespace is configurable with the
/// [`root_namespace`](DefinitionFileOptions::root_namespace) option. Each type
/// definition may additionally have its own nested namespace under the root
/// namespace. The root namespace will also be the default export of the module.
///
/// If the root namespace is set to `None`, no root namespace and no default
/// export will be added. See the docs of
/// [`root_namespace`](DefinitionFileOptions::root_namespace) for an important
/// note about using no root namespace.
///
/// The file will also include a header comment indicating that it was
/// auto-generated by this library. This is configurable with the
/// [`header`](DefinitionFileOptions::header) option.
///
/// Note that the TypeScript code generated by this library is not very
/// human-readable. To make the code human-readable, use a TypeScript code
/// formatter (such as [Prettier](https://prettier.io/)) on the output.
pub fn write_definition_file<W, T: ?Sized>(
writer: W,
options: DefinitionFileOptions<'_>,
) -> io::Result<Stats>
where
W: io::Write,
T: TypeDef,
{
write_definition_file_from_type_infos(writer, options, &[&T::INFO])
}
/// Writes a TypeScript definition file containing type definitions for the
/// given list of type info values to the given writer.
///
/// The type info values can be obtained using [`TypeDef::INFO`] on a type.
///
/// The resulting TypeScript module will define and export the type definition
/// for each given type and all of thair transitive dependencies under a root
/// namespace. The name of the root namespace is configurable with the
/// [`root_namespace`](DefinitionFileOptions::root_namespace) option. Each type
/// definition may additionally have its own nested namespace under the root
/// namespace. The root namespace will also be the default export of the module.
///
/// If the root namespace is set to `None`, no root namespace and no default
/// export will be added. See the docs of
/// [`root_namespace`](DefinitionFileOptions::root_namespace) for an important
/// note about using no root namespace.
///
/// The file will also include a header comment indicating that it was
/// auto-generated by this library. This is configurable with the
/// [`header`](DefinitionFileOptions::header) option.
///
/// Note that the TypeScript code generated by this library is not very
/// human-readable. To make the code human-readable, use a TypeScript code
/// formatter (such as [Prettier](https://prettier.io/)) on the output.
pub fn write_definition_file_from_type_infos<W>(
mut writer: W,
options: DefinitionFileOptions<'_>,
type_infos: &[&'static TypeInfo],
) -> io::Result<Stats>
where
W: io::Write,
{
if let Some(header) = options.header {
writeln!(&mut writer, "{}", header)?;
}
if let Some(root_namespace) = options.root_namespace {
writeln!(&mut writer, "export default {};", root_namespace)?;
writeln!(&mut writer, "export namespace {}{{", root_namespace)?;
}
let mut ctx = EmitCtx::new(&mut writer, options.root_namespace);
ctx.emit_type_def(type_infos)?;
let stats = ctx.stats;
if options.root_namespace.is_some() {
writeln!(&mut writer, "}}")?;
}
Ok(stats)
}
impl TypeInfo {
/// Writes a Typescript type expression referencing this type to the given
/// writer.
///
/// This method is meant to be used in generated code referencing types
/// defined in a module created with [`write_definition_file`]. The
/// `root_namespace` option should be set to the qualified name of the
/// import of that module.
///
/// # Example
/// ```
/// use serde::Serialize;
/// use std::io::Write;
/// use typescript_type_def::{write_definition_file, TypeDef};
///
/// #[derive(Serialize, TypeDef)]
/// struct Foo<T> {
/// a: T,
/// }
///
/// let ts_module = {
/// let mut buf = Vec::new();
/// // types.ts contains type definitions written using write_definition_file
/// writeln!(&mut buf, "import * as types from './types';").unwrap();
/// writeln!(&mut buf).unwrap();
/// write!(&mut buf, "export function myAPI(foo: ").unwrap();
/// let foo_type_info = &<Foo<Vec<u8>> as TypeDef>::INFO;
/// foo_type_info.write_ref_expr(&mut buf, Some("types")).unwrap();
/// writeln!(&mut buf, ") {{}}").unwrap();
/// String::from_utf8(buf).unwrap()
/// };
/// assert_eq!(
/// ts_module,
/// r#"import * as types from './types';
///
/// export function myAPI(foo: types.Foo<(types.U8)[]>) {}
/// "#
/// );
/// ```
pub fn write_ref_expr<W>(
&'static self,
mut writer: W,
root_namespace: Option<&str>,
) -> io::Result<()>
where
W: io::Write,
{
let mut ctx = EmitCtx::new(&mut writer, root_namespace);
ctx.emit_type_ref(self)?;
Ok(())
}
}