fix(ast/estree): fix optional field of TSMappedType in TS-ESTree AST (#10874)

Part of #9705.

Recent changes in TS-ESLint made `TSMappedType`'s `optional` field default to `false` instead of `null`. Update our TS-ESTree AST to match it.

Author: overlookmotel

crates/oxc_ast/src/ast/ts.rs

@@ -1447,6 +1447,7 @@ pub struct TSMappedType<'a> {
     /// type Qux = { [P in keyof T]: T[P] }
     /// //                         ^  None
     /// ```
+    #[estree(via = TSMappedTypeOptional)]
     pub optional: Option<TSMappedTypeModifierOperator>,
     /// Readonly modifier before keyed index signature
     ///

crates/oxc_ast/src/generated/derive_estree.rs

@@ -3166,7 +3166,7 @@ impl ESTree for TSMappedType<'_> {
         state.serialize_field("end", &self.span.end);
         state.serialize_field("nameType", &self.name_type);
         state.serialize_field("typeAnnotation", &self.type_annotation);
-        state.serialize_field("optional", &self.optional);
+        state.serialize_field("optional", &crate::serialize::TSMappedTypeOptional(self));
         state.serialize_field("readonly", &self.readonly);
         state.serialize_field("key", &crate::serialize::TSMappedTypeKey(self));
         state.serialize_field("constraint", &crate::serialize::TSMappedTypeConstraint(self));

crates/oxc_ast/src/serialize.rs

@@ -1286,6 +1286,30 @@ impl ESTree for TSModuleDeclarationGlobal<'_, '_> {
     }
 }
 
+/// Serializer for `optional` field of `TSMappedType`.
+///
+/// `None` is serialized as `false`.
+#[ast_meta]
+#[estree(
+    ts_type = "TSMappedTypeModifierOperator | false",
+    raw_deser = "
+        let optional = DESER[Option<TSMappedTypeModifierOperator>](POS_OFFSET.optional) || false;
+        if (optional === null) optional = false;
+        optional
+    "
+)]
+pub struct TSMappedTypeOptional<'a, 'b>(pub &'b TSMappedType<'a>);
+
+impl ESTree for TSMappedTypeOptional<'_, '_> {
+    fn serialize<S: Serializer>(&self, serializer: S) {
+        if let Some(optional) = self.0.optional {
+            optional.serialize(serializer);
+        } else {
+            False(()).serialize(serializer);
+        }
+    }
+}
+
 /// Serializer for `key` and `constraint` field of `TSMappedType`.
 #[ast_meta]
 #[estree(

napi/parser/generated/deserialize/js.js

@@ -1897,14 +1897,16 @@ function deserializeTSConstructorType(pos) {
 }
 
 function deserializeTSMappedType(pos) {
+  let optional = deserializeOptionTSMappedTypeModifierOperator(pos + 48) || false;
+  if (optional === null) optional = false;
   const typeParameter = deserializeBoxTSTypeParameter(pos + 8);
   return {
     type: 'TSMappedType',
     start: deserializeU32(pos),
     end: deserializeU32(pos + 4),
     nameType: deserializeOptionTSType(pos + 16),
     typeAnnotation: deserializeOptionTSType(pos + 32),
-    optional: deserializeOptionTSMappedTypeModifierOperator(pos + 48),
+    optional,
     readonly: deserializeOptionTSMappedTypeModifierOperator(pos + 49),
     key: typeParameter.name,
     constraint: typeParameter.constraint,

napi/parser/generated/deserialize/ts.js

@@ -2049,14 +2049,16 @@ function deserializeTSConstructorType(pos) {
 }
 
 function deserializeTSMappedType(pos) {
+  let optional = deserializeOptionTSMappedTypeModifierOperator(pos + 48) || false;
+  if (optional === null) optional = false;
   const typeParameter = deserializeBoxTSTypeParameter(pos + 8);
   return {
     type: 'TSMappedType',
     start: deserializeU32(pos),
     end: deserializeU32(pos + 4),
     nameType: deserializeOptionTSType(pos + 16),
     typeAnnotation: deserializeOptionTSType(pos + 32),
-    optional: deserializeOptionTSMappedTypeModifierOperator(pos + 48),
+    optional,
     readonly: deserializeOptionTSMappedTypeModifierOperator(pos + 49),
     key: typeParameter.name,
     constraint: typeParameter.constraint,

npm/oxc-types/types.d.ts

@@ -1375,7 +1375,7 @@ export interface TSMappedType extends Span {
   type: 'TSMappedType';
   nameType: TSType | null;
   typeAnnotation: TSType | null;
-  optional: TSMappedTypeModifierOperator | null;
+  optional: TSMappedTypeModifierOperator | false;
   readonly: TSMappedTypeModifierOperator | null;
   key: TSTypeParameter['name'];
   constraint: TSTypeParameter['constraint'];