@tahminator/sapling 2.0.5-beta.18ab8bae → 2.0.5-beta.18e683d9

package/dist/index.cjs

@@ -548,50 +548,70 @@ var OpenAPIGenerator = class {
 				const schemas = _getValidatorSchema(controllerClass, route.fnName);
 				const routeSchema = _getRouteSchema(controllerClass, route.fnName);
 				if (route.path instanceof RegExp) throw new Error(`You have a route with a regex path of ${route.path.source}. This is not compatible with OpenAPI.`);
-				const openApiPath = prefix + route.path;
+				const openApiPath = (prefix + route.path).replace(/:([A-Za-z0-9_]+)/g, "{$1}");
 				if (!paths[openApiPath]) paths[openApiPath] = {};
 				const responses = {};
-				if (schemas?.responseBody) responses["200"] = {
-					description: "Successful response",
-					content: { "application/json": { schema: this.toJsonSchema(schemas.responseBody) } }
-				};
-				else responses["200"] = { description: "Successful response" };
-				if (routeSchema?.responses) for (const resp of routeSchema.responses) responses[String(resp.statusCode)] = {
-					description: `Response ${resp.statusCode}`,
-					content: { "application/json": { schema: this.toJsonSchema(resp.schema) } }
-				};
+				if (schemas?.responseBody) {
+					const responseSchema = this.toJsonSchema(schemas.responseBody, "output");
+					responses["200"] = {
+						description: responseSchema.description ?? "Successful response",
+						content: { "application/json": { schema: responseSchema } }
+					};
+				} else responses["200"] = { description: "Successful response" };
+				if (routeSchema?.responses) for (const resp of routeSchema.responses) {
+					const statusCode = String(resp.statusCode);
+					const existingResponse = responses[statusCode];
+					const existingSchema = existingResponse && "content" in existingResponse ? existingResponse.content?.["application/json"]?.schema : void 0;
+					const responseSchema = resp.schema ? this.toJsonSchema(resp.schema, "output") : statusCode === "200" ? existingSchema : void 0;
+					responses[statusCode] = {
+						...existingResponse,
+						description: resp.description ?? responseSchema?.description ?? existingResponse?.description ?? `Response ${resp.statusCode}`,
+						...responseSchema ? { content: { "application/json": { schema: responseSchema } } } : {}
+					};
+				}
 				const operation = {
 					responses,
+					summary: routeSchema?.summary,
 					description: routeSchema?.description,
 					tags: controllerSchema?.title ? [controllerSchema.title] : void 0
 				};
 				const parameters = [];
 				if (schemas?.requestParam) {
-					const paramSchema = this.toJsonSchema(schemas.requestParam);
-					if (paramSchema.type === "object" && paramSchema.properties) for (const [name, schema] of Object.entries(paramSchema.properties)) parameters.push({
-						name,
-						in: "path",
-						required: true,
-						schema
-					});
+					const paramSchema = this.toJsonSchema(schemas.requestParam, "input");
+					if (paramSchema.type === "object" && paramSchema.properties) for (const [name, schema] of Object.entries(paramSchema.properties)) {
+						const parameterSchema = schema;
+						parameters.push({
+							name,
+							in: "path",
+							required: true,
+							description: parameterSchema.description,
+							schema: parameterSchema
+						});
+					}
 				}
 				if (schemas?.requestQuery) {
-					const querySchema = this.toJsonSchema(schemas.requestQuery);
+					const querySchema = this.toJsonSchema(schemas.requestQuery, "input");
 					if (querySchema.type === "object" && querySchema.properties) for (const [name, schema] of Object.entries(querySchema.properties)) {
 						const isRequired = Array.isArray(querySchema.required) && querySchema.required.includes(name);
+						const parameterSchema = schema;
 						parameters.push({
 							name,
 							in: "query",
 							required: isRequired,
-							schema
+							description: parameterSchema.description,
+							schema: parameterSchema
 						});
 					}
 				}
 				if (parameters.length > 0) operation.parameters = parameters;
-				if (schemas?.requestBody) operation.requestBody = {
-					required: true,
-					content: { "application/json": { schema: this.toJsonSchema(schemas.requestBody) } }
-				};
+				if (schemas?.requestBody) {
+					const requestSchema = this.toJsonSchema(schemas.requestBody, "input");
+					operation.requestBody = {
+						required: true,
+						description: requestSchema.description,
+						content: { "application/json": { schema: requestSchema } }
+					};
+				}
 				const method = route.method.toLowerCase();
 				paths[openApiPath][method] = operation;
 			}
@@ -607,9 +627,11 @@ var OpenAPIGenerator = class {
 			paths
 		};
 	}
-	toJsonSchema(schema) {
+	toJsonSchema(schema, direction = "output") {
 		try {
-			return schema["~standard"].jsonSchema.output({ target: "openapi-3.0" });
+			const jsonSchema = schema["~standard"].jsonSchema;
+			if (direction === "input" && jsonSchema.input) return jsonSchema.input({ target: "openapi-3.0" });
+			return jsonSchema.output({ target: "openapi-3.0" });
 		} catch (e) {
 			if (e instanceof Error && e.message.includes("Transforms cannot be represented in JSON Schema")) throw new Error(`${e.message}.\nIt appears that you are using z.transform() - it is highly recommended that you use z.codec instead - https://zod.dev/codecs`);
 			throw e;
@@ -800,7 +822,7 @@ function _getOrCreateSchemaDefinition(ctor, fnName) {
 async function _parseOrThrow(schema, input, kind) {
 	const result = await schema["~standard"].validate(input);
 	if (result.issues) {
-		console.debug(`Failed to parse a schema`);
+		console.debug(`Failed to parse ${schema["~standard"].vendor} schema\nissues: ${result.issues}`);
 		throw new ParserError(kind, result.issues, schema["~standard"].vendor);
 	}
 	return result.value;

package/dist/index.d.cts

@@ -892,9 +892,11 @@ declare function _setOnce(def: ValidatorSchema, key: keyof ValidatorSchema, sche
 //#region src/annotation/schema.d.ts
 type ResponseSchema = {
   statusCode: HttpStatus;
-  schema: StandardSchemaV1 & StandardJSONSchemaV1;
+  description?: string;
+  schema?: StandardSchemaV1 & StandardJSONSchemaV1;
 };
 type RouteSchemaDefinition = {
+  summary?: string;
   description?: string;
   responses?: ResponseSchema[];
 };
@@ -907,6 +909,7 @@ declare function ControllerSchema(options: {
   description?: string;
 }): ClassDecorator;
 declare function RouteSchema(options: {
+  summary?: string;
   description?: string;
   responses?: ResponseSchema[];
 }): MethodDecorator;

package/dist/index.d.mts

@@ -892,9 +892,11 @@ declare function _setOnce(def: ValidatorSchema, key: keyof ValidatorSchema, sche
 //#region src/annotation/schema.d.ts
 type ResponseSchema = {
   statusCode: HttpStatus;
-  schema: StandardSchemaV1 & StandardJSONSchemaV1;
+  description?: string;
+  schema?: StandardSchemaV1 & StandardJSONSchemaV1;
 };
 type RouteSchemaDefinition = {
+  summary?: string;
   description?: string;
   responses?: ResponseSchema[];
 };
@@ -907,6 +909,7 @@ declare function ControllerSchema(options: {
   description?: string;
 }): ClassDecorator;
 declare function RouteSchema(options: {
+  summary?: string;
   description?: string;
   responses?: ResponseSchema[];
 }): MethodDecorator;

package/dist/index.mjs

@@ -523,50 +523,70 @@ var OpenAPIGenerator = class {
 				const schemas = _getValidatorSchema(controllerClass, route.fnName);
 				const routeSchema = _getRouteSchema(controllerClass, route.fnName);
 				if (route.path instanceof RegExp) throw new Error(`You have a route with a regex path of ${route.path.source}. This is not compatible with OpenAPI.`);
-				const openApiPath = prefix + route.path;
+				const openApiPath = (prefix + route.path).replace(/:([A-Za-z0-9_]+)/g, "{$1}");
 				if (!paths[openApiPath]) paths[openApiPath] = {};
 				const responses = {};
-				if (schemas?.responseBody) responses["200"] = {
-					description: "Successful response",
-					content: { "application/json": { schema: this.toJsonSchema(schemas.responseBody) } }
-				};
-				else responses["200"] = { description: "Successful response" };
-				if (routeSchema?.responses) for (const resp of routeSchema.responses) responses[String(resp.statusCode)] = {
-					description: `Response ${resp.statusCode}`,
-					content: { "application/json": { schema: this.toJsonSchema(resp.schema) } }
-				};
+				if (schemas?.responseBody) {
+					const responseSchema = this.toJsonSchema(schemas.responseBody, "output");
+					responses["200"] = {
+						description: responseSchema.description ?? "Successful response",
+						content: { "application/json": { schema: responseSchema } }
+					};
+				} else responses["200"] = { description: "Successful response" };
+				if (routeSchema?.responses) for (const resp of routeSchema.responses) {
+					const statusCode = String(resp.statusCode);
+					const existingResponse = responses[statusCode];
+					const existingSchema = existingResponse && "content" in existingResponse ? existingResponse.content?.["application/json"]?.schema : void 0;
+					const responseSchema = resp.schema ? this.toJsonSchema(resp.schema, "output") : statusCode === "200" ? existingSchema : void 0;
+					responses[statusCode] = {
+						...existingResponse,
+						description: resp.description ?? responseSchema?.description ?? existingResponse?.description ?? `Response ${resp.statusCode}`,
+						...responseSchema ? { content: { "application/json": { schema: responseSchema } } } : {}
+					};
+				}
 				const operation = {
 					responses,
+					summary: routeSchema?.summary,
 					description: routeSchema?.description,
 					tags: controllerSchema?.title ? [controllerSchema.title] : void 0
 				};
 				const parameters = [];
 				if (schemas?.requestParam) {
-					const paramSchema = this.toJsonSchema(schemas.requestParam);
-					if (paramSchema.type === "object" && paramSchema.properties) for (const [name, schema] of Object.entries(paramSchema.properties)) parameters.push({
-						name,
-						in: "path",
-						required: true,
-						schema
-					});
+					const paramSchema = this.toJsonSchema(schemas.requestParam, "input");
+					if (paramSchema.type === "object" && paramSchema.properties) for (const [name, schema] of Object.entries(paramSchema.properties)) {
+						const parameterSchema = schema;
+						parameters.push({
+							name,
+							in: "path",
+							required: true,
+							description: parameterSchema.description,
+							schema: parameterSchema
+						});
+					}
 				}
 				if (schemas?.requestQuery) {
-					const querySchema = this.toJsonSchema(schemas.requestQuery);
+					const querySchema = this.toJsonSchema(schemas.requestQuery, "input");
 					if (querySchema.type === "object" && querySchema.properties) for (const [name, schema] of Object.entries(querySchema.properties)) {
 						const isRequired = Array.isArray(querySchema.required) && querySchema.required.includes(name);
+						const parameterSchema = schema;
 						parameters.push({
 							name,
 							in: "query",
 							required: isRequired,
-							schema
+							description: parameterSchema.description,
+							schema: parameterSchema
 						});
 					}
 				}
 				if (parameters.length > 0) operation.parameters = parameters;
-				if (schemas?.requestBody) operation.requestBody = {
-					required: true,
-					content: { "application/json": { schema: this.toJsonSchema(schemas.requestBody) } }
-				};
+				if (schemas?.requestBody) {
+					const requestSchema = this.toJsonSchema(schemas.requestBody, "input");
+					operation.requestBody = {
+						required: true,
+						description: requestSchema.description,
+						content: { "application/json": { schema: requestSchema } }
+					};
+				}
 				const method = route.method.toLowerCase();
 				paths[openApiPath][method] = operation;
 			}
@@ -582,9 +602,11 @@ var OpenAPIGenerator = class {
 			paths
 		};
 	}
-	toJsonSchema(schema) {
+	toJsonSchema(schema, direction = "output") {
 		try {
-			return schema["~standard"].jsonSchema.output({ target: "openapi-3.0" });
+			const jsonSchema = schema["~standard"].jsonSchema;
+			if (direction === "input" && jsonSchema.input) return jsonSchema.input({ target: "openapi-3.0" });
+			return jsonSchema.output({ target: "openapi-3.0" });
 		} catch (e) {
 			if (e instanceof Error && e.message.includes("Transforms cannot be represented in JSON Schema")) throw new Error(`${e.message}.\nIt appears that you are using z.transform() - it is highly recommended that you use z.codec instead - https://zod.dev/codecs`);
 			throw e;
@@ -775,7 +797,7 @@ function _getOrCreateSchemaDefinition(ctor, fnName) {
 async function _parseOrThrow(schema, input, kind) {
 	const result = await schema["~standard"].validate(input);
 	if (result.issues) {
-		console.debug(`Failed to parse a schema`);
+		console.debug(`Failed to parse ${schema["~standard"].vendor} schema\nissues: ${result.issues}`);
 		throw new ParserError(kind, result.issues, schema["~standard"].vendor);
 	}
 	return result.value;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tahminator/sapling",
-  "version": "2.0.5-beta.18ab8bae",
+  "version": "2.0.5-beta.18e683d9",
   "author": "Tahmid Ahmed",
   "description": "A library to help you write cleaner Express.js code",
   "repository": {