@clov-std/elysia-openapi 1.1.0 → 1.2.0

package/README.md

@@ -40,6 +40,10 @@ The reference is at `http://localhost:3000/openapi`, the JSON at `http://localho
 
 Each operation gets an `operationId` derived from the method and path (`get` + `/users/:id` gives `getUsersById`), unique across the document.
 
+### Validation errors
+
+Every operation that validates params, query, headers, cookies or a body documents Elysia's `422`, a `validation` problem document (`application/problem+json`) added to `components.schemas`. A route that declares its own `422` keeps it.
+
 ### Response headers
 
 ```ts

package/dist/index.js

@@ -284,6 +284,41 @@ var mergeRequestBody = (generated, override) => {
   }
   return { ...generated, ...override, content };
 };
+var VALIDATION_PROBLEM = "validation";
+var validationProblemSchema = {
+  type: "object",
+  description: "The request failed validation.",
+  required: ["type", "title", "status", "detail"],
+  properties: {
+    type: { type: "string", const: VALIDATION_PROBLEM },
+    code: { type: "string", const: VALIDATION_PROBLEM },
+    title: { type: "string", example: "Validation Error" },
+    status: { type: "integer", const: 422 },
+    detail: { type: "string", description: "The first validation error, in words." },
+    on: {
+      type: "string",
+      enum: ["params", "query", "headers", "cookie", "body"],
+      description: "The part of the request that failed."
+    },
+    property: { type: "string", description: "Path of the first invalid property." },
+    found: { description: "The value received." },
+    expected: { description: "A value of the expected shape." },
+    errors: {
+      type: "array",
+      description: "Every validation error.",
+      items: { type: "object" }
+    }
+  }
+};
+var validationResponse = {
+  description: "Unprocessable Content",
+  content: {
+    "application/problem+json": {
+      schema: { $ref: `#/components/schemas/${VALIDATION_PROBLEM}` }
+    }
+  }
+};
+var validationComponent = (operations) => operations.some((operation) => operation.responses?.["422"] === validationResponse) ? { [VALIDATION_PROBLEM]: validationProblemSchema } : {};
 var toOperation = (route, models, method) => {
   const { hooks } = route;
   const parameters = new Map;
@@ -306,6 +341,8 @@ var toOperation = (route, models, method) => {
   const allParameters = mergeParameters([...parameters.values()], parameterOverrides);
   const requestBody = mergeRequestBody(toRequestBody(hooks, models, method), requestBodyOverride);
   const responses = mergeResponses(toResponses(route, models), responseOverrides);
+  if ((parameters.size > 0 || requestBody) && !responses["422"])
+    responses["422"] = validationResponse;
   return {
     ...allParameters.length > 0 && { parameters: allParameters },
     ...requestBody && { requestBody },
@@ -474,6 +511,7 @@ var buildDocument = (app, base = {}) => {
       ...base.components,
       schemas: {
         ...base.components?.schemas,
+        ...validationComponent([...generated.keys()]),
         ...Object.fromEntries(Object.entries(models).map(([name, model]) => [
           name,
           toSchema(model)

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@clov-std/elysia-openapi",
-	"version": "1.1.0",
+	"version": "1.2.0",
 	"description": "OpenAPI 3.2 document and Scalar reference for Elysia, generated from your route schemas.",
 	"keywords": [
 		"elysia",
@@ -36,10 +36,10 @@
 		"test": "bun test --pass-with-no-tests --coverage"
 	},
 	"devDependencies": {
-		"@types/bun": "^1.4.2",
-		"oxfmt": "0.74.0",
-		"oxlint": "1.89.0",
-		"oxlint-tsgolint": "7.0.2004",
+		"@types/bun": "^1.4.4",
+		"oxfmt": "0.75.0",
+		"oxlint": "1.90.0",
+		"oxlint-tsgolint": "7.0.2005",
 		"typescript": "^7.0.2"
 	},
 	"peerDependencies": {