Merge pull request #1917 from Freddis/fixing_nullable_dates_in_transformers

Author: mrlubos

.changeset/red-days-camp.md

@@ -0,0 +1,5 @@
+---
+"@hey-api/openapi-ts": patch
+---
+
+fix: handle nullable dates in transformers

packages/openapi-ts-tests/test/__snapshots__/3.0.x/transformers-any-of-null/transformers.gen.ts

@@ -9,6 +9,9 @@ const fooSchemaResponseTransformer = (data: any) => {
     if (data.bar) {
         data.bar = new Date(data.bar);
     }
+    if (data.requiredBaz) {
+        data.requiredBaz = new Date(data.requiredBaz);
+    }
     return data;
 };
 

packages/openapi-ts-tests/test/__snapshots__/3.0.x/transformers-any-of-null/types.gen.ts

@@ -3,6 +3,7 @@
 export type Foo = {
     foo?: Date;
     bar?: Date | null;
+    requiredBaz: Date | null;
 };
 
 export type GetFooData = {

packages/openapi-ts-tests/test/__snapshots__/3.1.x/transformers-any-of-null/transformers.gen.ts

@@ -12,6 +12,9 @@ const fooSchemaResponseTransformer = (data: any) => {
     if (data.baz) {
         data.baz = new Date(data.baz);
     }
+    if (data.requiredQux) {
+        data.requiredQux = new Date(data.requiredQux);
+    }
     return data;
 };
 

packages/openapi-ts-tests/test/__snapshots__/3.1.x/transformers-any-of-null/types.gen.ts

@@ -13,6 +13,7 @@ export type Foo = {
     foo?: Date;
     bar?: Date | null;
     baz?: Date | null;
+    requiredQux: Date | null;
 };
 
 export type GetFooData = {

packages/openapi-ts-tests/test/spec/3.0.x/transformers-any-of-null.json

@@ -42,8 +42,18 @@
                 "format": "date-time"
               }
             ]
+          },
+          "requiredBaz": {
+            "anyOf": [
+              {
+                "type": "string",
+                "nullable": true,
+                "format": "date-time"
+              }
+            ]
           }
-        }
+        },
+        "required": ["requiredBaz"]
       }
     }
   }

packages/openapi-ts-tests/test/spec/3.1.x/transformers-any-of-null.json

@@ -84,8 +84,17 @@
                 "format": "date-time"
               }
             ]
+          },
+          "requiredQux": {
+            "anyOf": [
+              {
+                "type": ["string", "null"],
+                "format": "date-time"
+              }
+            ]
           }
-        }
+        },
+        "required": ["requiredQux"]
       }
     }
   }

packages/openapi-ts/src/plugins/@hey-api/transformers/plugin.ts

@@ -345,19 +345,29 @@ const processSchemaType = ({
         plugin,
         schema: property,
       });
-      if (propertyNodes.length) {
-        if (required.includes(name)) {
-          nodes = nodes.concat(propertyNodes);
-        } else {
-          nodes.push(
-            compiler.ifStatement({
-              expression: propertyAccessExpression,
-              thenStatement: compiler.block({
-                statements: ensureStatements(propertyNodes),
-              }),
+      if (!propertyNodes.length) {
+        continue;
+      }
+      const noNullableTypesInSchema = !property.items?.find(
+        (x) => x.type === 'null',
+      );
+      const requiredField = required.includes(name);
+      // Cannot fully rely on required fields
+      // Such value has to be present, but it doesn't guarantee that this value is not nullish
+      if (requiredField && noNullableTypesInSchema) {
+        nodes = nodes.concat(propertyNodes);
+      } else {
+        nodes.push(
+          // todo: Probably, it would make more sense to go with if(x !== undefined && x !== null) instead of if(x)
+          // this place influences all underlying transformers, while it's not exactly transformer itself
+          // Keep in mind that !!0 === false, so it already makes output for Bigint undesirable
+          compiler.ifStatement({
+            expression: propertyAccessExpression,
+            thenStatement: compiler.block({
+              statements: ensureStatements(propertyNodes),
             }),
-          );
-        }
+          }),
+        );
       }
     }