Merge pull request #3646 from codercms/fix/transformers-additional-properties

fix(transformers): prevent additionalProperties transforms from affecting declared object properties

Author: mrlubos

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/transformers-additional-properties/transformers.gen.ts

@@ -9,9 +9,14 @@ const fooSchemaResponseTransformer = (data: any) => {
 
 const barSchemaResponseTransformer = (data: any) => {
     data.bar = new Date(data.bar);
-    if (data.baz) {
-        for (const key of Object.keys(data.baz)) {
-            data.baz[key] = fooSchemaResponseTransformer(data.baz[key]);
+    for (const key of Object.keys(data.baz)) {
+        data.baz[key] = fooSchemaResponseTransformer(data.baz[key]);
+    }
+    if (data.qux) {
+        for (const key of Object.keys(data.qux)) {
+            if (!['quux'].includes(key)) {
+                data.qux[key] = new Date(data.qux[key]);
+            }
         }
     }
     return data;

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/transformers-additional-properties/types.gen.ts

@@ -10,9 +10,13 @@ export type Foo = {
 
 export type Bar = {
     bar: Date;
-    baz?: {
+    baz: {
         [key: string]: Foo;
     };
+    qux?: {
+        quux?: string;
+        [key: string]: Date | string | undefined;
+    };
 };
 
 export type PostFooData = {

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

@@ -202,10 +202,24 @@ function processSchemaType({
       });
 
       if (entryValueNodes.length) {
+        const properties = Object.keys(schema.properties ?? {});
         nodes.push(
           $.for($.const('key'))
             .of($('Object').attr('keys').call(dataExpression))
-            .do(...entryValueNodes),
+            .$if(
+              properties.length,
+              (f) =>
+                f.do(
+                  $.if(
+                    $.not(
+                      $.array(...properties)
+                        .attr('includes')
+                        .call('key'),
+                    ),
+                  ).do(...entryValueNodes),
+                ),
+              (f) => f.do(...entryValueNodes),
+            ),
         );
       }
     }

packages/openapi-ts/src/ts-dsl/expr/array.ts

@@ -4,10 +4,11 @@ import ts from 'typescript';
 import type { MaybeTsDsl } from '../base';
 import { TsDsl } from '../base';
 import { AsMixin } from '../mixins/as';
+import { ExprMixin } from '../mixins/expr';
 import { LayoutMixin } from '../mixins/layout';
 import { LiteralTsDsl } from './literal';
 
-const Mixed = AsMixin(LayoutMixin(TsDsl<ts.ArrayLiteralExpression>));
+const Mixed = AsMixin(ExprMixin(LayoutMixin(TsDsl<ts.ArrayLiteralExpression>)));
 
 export class ArrayTsDsl extends Mixed {
   readonly '~dsl' = 'ArrayTsDsl';

specs/3.1.x/transformers-additional-properties.yaml

@@ -26,6 +26,7 @@ components:
       type: object
       required:
         - bar
+        - baz
       properties:
         bar:
           type: string
@@ -34,3 +35,11 @@ components:
           type: object
           additionalProperties:
             $ref: '#/components/schemas/Foo'
+        qux:
+          type: object
+          properties:
+            quux:
+              type: string
+          additionalProperties:
+            type: string
+            format: date-time