Merge pull request #239 from AthennaIO/develop

feat: support zod transform on schemas

Author: jlenon7

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/http",
-  "version": "5.51.0",
+  "version": "5.52.0",
   "description": "The Athenna Http server. Built on top of fastify.",
   "license": "MIT",
   "author": "João Lenon <lenon@athenna.io>",

package.json

@@ -84,8 +84,14 @@ export class HttpKernel {
 
     if (swaggerPlugin) {
       const openapiConfig = Json.omit(Config.get('openapi', {}), ['paths'])
-      const pluginConfig = Json.omit(Config.get('http.swagger.configurations', {}), ['swagger'])
-      const swaggerConfig = Config.get('http.swagger.configurations.swagger', {})
+      const pluginConfig = Json.omit(
+        Config.get('http.swagger.configurations', {}),
+        ['swagger']
+      )
+      const swaggerConfig = Config.get(
+        'http.swagger.configurations.swagger',
+        {}
+      )
 
       await Server.plugin(swaggerPlugin, {
         ...pluginConfig,

src/kernels/HttpKernel.ts

@@ -145,17 +145,31 @@ async function parseSchema(schema: ZodAny, data: any) {
 }
 
 function toJsonSchema(schema: ZodAny, io: 'input' | 'output') {
-  const jsonSchemaMethod =
-    (schema as any)['~standard']?.jsonSchema?.[io] ||
-    (schema as any).toJSONSchema
+  const standardJsonSchemaMethod = (schema as any)['~standard']?.jsonSchema?.[
+    io
+  ]
+
+  if (standardJsonSchemaMethod) {
+    const jsonSchema = standardJsonSchemaMethod({
+      target: 'draft-07',
+      libraryOptions: { unrepresentable: 'any' }
+    })
+
+    delete jsonSchema.$schema
+
+    return jsonSchema
+  }
+
+  const jsonSchemaMethod = (schema as any).toJSONSchema
 
   if (!jsonSchemaMethod) {
     return {}
   }
 
   const jsonSchema = jsonSchemaMethod({
+    io,
     target: 'draft-07',
-    libraryOptions: { unrepresentable: 'any' }
+    unrepresentable: 'any'
   })
 
   delete jsonSchema.$schema

src/router/RouteSchema.ts

@@ -403,7 +403,7 @@ export class ServerImpl extends Macroable {
 
     const normalizedSchema = normalizeRouteSchema(automaticSchema)
     const currentConfig = { ...(fastifyOptions.config || {}) }
-   
+
     const currentSwaggerSchema =
       // eslint-disable-next-line @typescript-eslint/ban-ts-comment
       // @ts-ignore

src/server/ServerImpl.ts

@@ -143,6 +143,64 @@ export default class RouteTest {
     })
   }
 
+  @Test()
+  public async shouldBeAbleToUseZodTransformSchemasWithoutBreakingSwagger({ assert }: Context) {
+    Route.post('transform', async ctx => {
+      await ctx.response.status(201).send({
+        name: ctx.request.input('name')
+      })
+    }).schema({
+      body: z.object({
+        name: z.string().transform(value => value.toUpperCase())
+      }),
+      response: {
+        201: z.object({
+          name: z.string().transform(value => value.toUpperCase())
+        })
+      }
+    })
+
+    Route.register()
+
+    const response = await Server.request({
+      path: '/transform',
+      method: 'post',
+      payload: { name: 'lenon' }
+    })
+
+    assert.equal(response.statusCode, 201)
+    assert.deepEqual(response.json(), { name: 'LENON' })
+
+    const swagger = await Server.getSwagger()
+
+    assert.containSubset(swagger.paths['/transform'], {
+      post: {
+        responses: {
+          '201': {
+            schema: {
+              type: 'object',
+              properties: {
+                name: {}
+              }
+            }
+          }
+        },
+        parameters: [
+          {
+            in: 'body',
+            schema: {
+              type: 'object',
+              properties: {
+                name: { type: 'string' }
+              },
+              required: ['name']
+            }
+          }
+        ]
+      }
+    })
+  }
+
   @Test()
   public async shouldBeAbleToUseExplicitZodCoercionForQuerystringAndParams({ assert }: Context) {
     Route.get('users/:id', async ctx => {