feat: handle ReturnedSchema

Savory · Nov 7, 2024 · 4c64c85 · 4c64c85
1 parent 4add3ec
commit 4c64c85
Show file tree

Hide file tree

Showing 4 changed files with 74 additions and 23 deletions.
diff --git a/deno.json b/deno.json
@@ -35,7 +35,7 @@
   },
   "compilerOptions": {
    "emitDecoratorMetadata": true,
-		"experimentalDecorators": true
+	"experimentalDecorators": true
   },
   "tasks": {
     "test": "deno test --unstable spec --allow-env --allow-read --allow-net",

diff --git a/example/app.ts b/example/app.ts
@@ -21,7 +21,7 @@ import {
 } from '@danet/core';
 import { Module } from '@danet/core';
 import { DanetApplication } from '@danet/core';
-import { Query as ZodQuery, Body as ZodBody } from '@danet/zod';
+import { Query as ZodQuery, Body as ZodBody, ReturnedSchema } from '@danet/zod';
 import { z } from 'zod';
 import { extendZodWithOpenApi } from 'zod-openapi';
 
@@ -136,6 +136,12 @@ class ZodController {
 	posZodSomething(@ZodBody(ZodTodo) todo: ZodTodo): number {
 		return 1;
 	}
+
+	@ReturnedSchema(ZodCat, true)
+	@Get()
+	getZodSomething() {
+		return [new Cat()]
+	}
 }
 
 @Controller('my-endpoint')

diff --git a/method-definer.ts b/method-definer.ts
@@ -19,6 +19,7 @@ import Parameter = Swagger.Parameter;
 import { zodQuerySchemaKey, zodBodySchemaKey } from '@danet/zod';
 import { ZodSchema } from 'npm:zod';
 import { generateSchema, type OpenApiZodAny } from 'zod-openapi';
+import { RETURNED_SCHEMA_KEY } from '../danet-zod/decorators.ts';
 
 const primitiveTypes = [
 	'string',
@@ -251,14 +252,14 @@ export class MethodDefiner {
 	}
 
 	private addResponse(actualPath: Operation) {
-		const returnedValue = MetadataHelper.getMetadata(
+		let returnedValue = MetadataHelper.getMetadata<{
+			returnedType: Constructor;
+			isArray: boolean | undefined;
+		}>(
 			RETURNED_TYPE_KEY,
 			this.Controller.prototype,
 			this.methodName,
-		) as {
-			returnedType: Constructor;
-			isArray: boolean | undefined;
-		};
+		);
 		if (returnedValue) {
 			if (isPrimitive(returnedValue.returnedType.name.toLowerCase())) {
 				if (returnedValue.isArray) {
@@ -268,27 +269,53 @@ export class MethodDefiner {
 							type: returnedValue.returnedType.name.toLowerCase() as DataType,
 						},
 					}).setDescription('').get();
-				} else {
-					actualPath.responses[200] = new ResponseBuilder().jsonContent({
-						type: returnedValue.returnedType.name.toLowerCase() as DataType,
-					}).setDescription('').get();
+					return;
 				}
-			} else {
-				if (returnedValue.isArray) {
-					actualPath.responses[200] = new ResponseBuilder().jsonContent({
-						type: 'array',
-						items: {
-							'$ref': `#/components/schemas/${returnedValue.returnedType.name}`,
-						},
+				actualPath.responses[200] = new ResponseBuilder().jsonContent({
+						type: returnedValue.returnedType.name.toLowerCase() as DataType,
 					}).setDescription('').get();
-				} else {
-					actualPath.responses[200] = new ResponseBuilder().jsonContent({
+				return;
+			}
+			if (returnedValue.isArray) {
+				actualPath.responses[200] = new ResponseBuilder().jsonContent({
+					type: 'array',
+					items: {
 						'$ref': `#/components/schemas/${returnedValue.returnedType.name}`,
-					}).setDescription('').get();
-				}
-				this.generateTypeSchema(returnedValue.returnedType);
+					},
+				}).setDescription('').get();
+			} else {
+				actualPath.responses[200] = new ResponseBuilder().jsonContent({
+					'$ref': `#/components/schemas/${returnedValue.returnedType.name}`,
+				}).setDescription('').get();
+			}
+			this.generateTypeSchema(returnedValue.returnedType);
+			return;
+		}
+		const returnedSchema = MetadataHelper.getMetadata<{
+			returnedSchema: OpenApiZodAny;
+			isArray: boolean | undefined;
+		}>(
+			RETURNED_SCHEMA_KEY,
+			this.Controller.prototype,
+			this.methodName
+		);
+		console.log('returnedSchema', returnedSchema);
+		if (returnedSchema) {
+			const openApiSchema = this.generateZodSchema(returnedSchema.returnedSchema);
+			if (returnedSchema.isArray) {
+				actualPath.responses[200] = new ResponseBuilder().jsonContent({
+					type: 'array',
+					items: {
+						'$ref': `#/components/schemas/${openApiSchema.title}`,
+					},
+				}).setDescription('').get();
+			} else {
+				actualPath.responses[200] = new ResponseBuilder().jsonContent({
+					'$ref': `#/components/schemas/${openApiSchema.title}`,
+				}).setDescription('').get();
 			}
 		}
+
 		return null;
 	}
 

diff --git a/spec/generate-schemas.test.ts b/spec/generate-schemas.test.ts
@@ -141,6 +141,24 @@ const expectedSpec = {
 					'description': '',
 				},
 			},
+			'get': {
+				'operationId': 'getZodSomething',
+				'responses': {
+					'200': {
+						'description': '',
+						'content': {
+							'application/json': {
+								'schema': {
+									'type': 'array',
+									'items': {
+										'$ref': '#/components/schemas/ZodCat',
+									},
+								},
+							},
+						},
+					},
+				},
+			},
 		},
 		'/my-endpoint': {
 			'get': {