Merge pull request #482 from stepchowfun/optional-undefined

Require optional struct fields to be explicitly set to `undefined` in TypeScript to avoid setting them

CHANGELOG.md

@@ -5,6 +5,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.11.0] - 2024-06-18
+
+### Changed
+- Typical now requires optional struct fields to be explicitly set to `undefined` in TypeScript to avoid setting them. Previously, such fields could be omitted entirely, but that meant typos in optional field names could go unnoticed.
+
 ## [0.10.0] - 2024-06-13
 
 ### Added

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "typical"
-version = "0.10.0"
+version = "0.11.0"
 authors = ["Stephan Boyer <[email protected]>"]
 edition = "2021"
 description = "Data interchange with algebraic data types."

src/generate_typescript.rs

@@ -1367,20 +1367,20 @@ fn write_struct<T: Write>(
     for field in fields {
         write_indentation(buffer, indentation + 1)?;
         write_identifier(buffer, &field.name, Camel, None)?;
+        write!(buffer, ": ")?;
+        write_type(buffer, imports, namespace, &field.r#type.variant, direction)?;
         match field.rule {
             schema::Rule::Asymmetric => match direction {
                 Direction::Atlas | Direction::Out => {}
                 Direction::In => {
-                    write!(buffer, "?")?;
+                    write!(buffer, " | undefined")?;
                 }
             },
             schema::Rule::Optional => {
-                write!(buffer, "?")?;
+                write!(buffer, " | undefined")?;
             }
             schema::Rule::Required => {}
         }
-        write!(buffer, ": ")?;
-        write_type(buffer, imports, namespace, &field.r#type.variant, direction)?;
         writeln!(buffer, ";")?;
     }