hono-openapi 0.3.1 → 0.4.1-rc.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2024 Rhinobase
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2024 Rhinobase
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,252 +1,252 @@
-# 📜 Hono OpenAPI
-
-[![npm version](https://img.shields.io/npm/v/hono-openapi.svg)](https://npmjs.org/package/hono-openapi "View this project on NPM")
-[![npm downloads](https://img.shields.io/npm/dm/hono-openapi)](https://www.npmjs.com/package/hono-openapi)
-[![license](https://img.shields.io/npm/l/hono-openapi)](LICENSE)
-
-This can automatically generate the OpenAPI specification for the Hono API using your validation schema, which can be used to generate client libraries, documentation, and more.
-
-Supported Validation Libraries:
-
-- [x] [Zod](https://zod.dev/)
-- [x] [Valibot](https://valibot.dev/)
-- [x] [ArkType](https://arktype.io/)
-- [x] [TypeBox](https://github.com/sinclairzx81/typebox)
-- [x] [Effect](https://effect.website/docs/schema/introduction/)
-
-> [!Note]
-> This package is still in development and your feedback is highly appreciated. If you have any suggestions or issues, please let us know by creating an issue on GitHub.
-
-## Usage
-
-### Installation
-
-You can install the package using favorite package manager.
-
-#### For Zod
-
-```bash
-pnpm add hono-openapi @hono/zod-validator zod zod-openapi
-```
-
-#### For Valibot
-
-```bash
-pnpm add hono-openapi @hono/valibot-validator valibot @valibot/to-json-schema
-```
-
-#### For ArkType
-
-```bash
-pnpm add hono-openapi @hono/arktype-validator arktype
-```
-
-#### For TypeBox
-
-```bash
-pnpm add hono-openapi @hono/typebox-validator @sinclair/typebox"
-```
-
-#### For Effect
-
-```bash
-pnpm add hono-openapi @hono/effect-validator effect
-```
-
-> [!IMPORTANT]
->
-> Requires `effect@^3.10.0`.
-> Also, use the `Schema` class from the `effect` package, as `@effect/schema` is not supported.
-
-### Basic Usage
-
-#### Setting up your application
-
-First, define your schemas, here is an example using Zod:
-
-```ts
-import z from "zod";
-
-// For extending the Zod schema with OpenAPI properties
-import "zod-openapi/extend";
-
-const querySchema = z
-  .object({
-    name: z.string().optional().openapi({ example: "Steven" }),
-  })
-  .openapi({ ref: "Query" });
-
-const responseSchema = z.string().openapi({ example: "Hello Steven!" });
-```
-
-Extending the Zod schema with OpenAPI properties is optional, but it will help you generate the OpenAPI specification. You can learn more about it here - [https://github.com/samchungy/zod-openapi](https://github.com/samchungy/zod-openapi).
-
-> [!Tip]
-> The `querySchema` schema will be registered as "#/components/schemas/Query" refs in the OpenAPI document. If you want to register the schema as referenced components, use .openapi() method.
-
-Next, create your route -
-
-```ts
-import { Hono } from "hono";
-import { describeRoute } from "hono-openapi";
-import { resolver, validator as zValidator } from "hono-openapi/zod";
-
-const app = new Hono();
-
-app.get(
-  "/",
-  describeRoute({
-    description: "Say hello to the user",
-    responses: {
-      200: {
-        description: "Successful greeting response",
-        content: {
-          "text/plain": {
-            schema: resolver(responseSchema),
-          },
-        },
-      },
-    },
-  }),
-  zValidator("query", querySchema),
-  (c) => {
-    const query = c.req.valid("query");
-    return c.text(`Hello ${query?.name ?? "Hono"}!`);
-  }
-);
-```
-
-You might be wondering why are we importing `validator` from `hono-openapi/zod` instead of `@hono/zod-validator` and as `zValidator`? This is because `hono-openapi` provides a wrapper around the `@hono/zod-validator` to make it easier to use. The idea is if you are already using `@hono/zod-validator` to validate your schemas, you can easily switch to `hono-openapi` without changing much of your code.
-
-Finally, generate the OpenAPI specification -
-
-```ts
-app.get(
-  "/openapi",
-  openAPISpecs(app, {
-    documentation: {
-      info: {
-        title: "Hono",
-        version: "1.0.0",
-        description: "API for greeting users",
-      },
-      servers: [
-        {
-          url: "http://localhost:3000",
-          description: "Local server",
-        },
-      ],
-    },
-  })
-);
-```
-
-Now, you can access the OpenAPI specification by visiting `http://localhost:3000/openapi`, and you can use this specification to generate client libraries, documentation, and more. Some tools that I used to generate documentation are -
-
-- [Swagger UI](https://github.com/honojs/middleware/tree/main/packages/swagger-ui)
-- [Scalar](https://github.com/scalar/scalar/tree/main/packages/hono-api-reference)
-
-##### Scalar Example
-
-```ts
-app.get(
-  "/docs",
-  apiReference({
-    theme: "saturn",
-    spec: {
-      url: "/openapi",
-    },
-  })
-);
-```
-
-And that's it! You have successfully generated the OpenAPI specification for your Hono API.
-
-### Advanced Usage
-
-#### Adding Security Definitions
-
-You can add security definitions to your OpenAPI specification by using the `security` property in the `openAPISpecs` function.
-
-```ts
-app.get(
-  "/openapi",
-  openAPISpecs(appRouter, {
-    documentation: {
-      info: {
-        title: "Rhinobase Cloud",
-        version: "1.0.0",
-        description: "API Documentation",
-      },
-      components: {
-        securitySchemes: {
-          bearerAuth: {
-            type: "http",
-            scheme: "bearer",
-            bearerFormat: "JWT",
-          },
-        },
-      },
-      security: [
-        {
-          bearerAuth: [],
-        },
-      ],
-      servers: [
-        {
-          url: "http://localhost:3004",
-          description: "Local server",
-        },
-      ],
-    },
-  })
-);
-```
-
-#### Conditionaly Hiding Routes
-
-You can conditionally hide routes from the OpenAPI specification by using the `hide` property in the `describeRoute` function.
-
-```ts
-app.get(
-  "/",
-  describeRoute({
-    // ...
-    hide: process.env.NODE_ENV === "production",
-  }),
-  (c) => {
-    return c.text("Private Route");
-  }
-);
-```
-
-#### Validating Responses
-
-> [!Warning]
-> Experimental
-
-You can validate the responses using the `validateResponse` property in the `describeRoute` function. This will validate the response against the schema and return an error if the response is invalid.
-
-```ts
-app.get(
-  "/",
-  describeRoute({
-    // ...
-    validateResponse: true,
-  }),
-  (c) => {
-    return c.json({ message: "This response will be validated" });
-  }
-);
-```
-
-## Contributing
-
-We would love to have more contributors involved!
-
-To get started, please read our [Contributing Guide](https://github.com/rhinobase/hono-openapi/blob/main/CONTRIBUTING.md).
-
-## Credits
-
-- The idea for this project was inspired by [ElysiaJS](https://elysiajs.com/) and their amazing work on generating [OpenAPI](https://elysiajs.com/recipe/openapi.html) specifications.
-- This project would not have been possible without the work of [Sam Chung](https://github.com/samchungy) and his [Zod OpenAPI](https://github.com/samchungy/zod-openapi) package.
+# 📜 Hono OpenAPI
+
+[![npm version](https://img.shields.io/npm/v/hono-openapi.svg)](https://npmjs.org/package/hono-openapi "View this project on NPM")
+[![npm downloads](https://img.shields.io/npm/dm/hono-openapi)](https://www.npmjs.com/package/hono-openapi)
+[![license](https://img.shields.io/npm/l/hono-openapi)](LICENSE)
+
+This can automatically generate the OpenAPI specification for the Hono API using your validation schema, which can be used to generate client libraries, documentation, and more.
+
+Supported Validation Libraries:
+
+- [x] [Zod](https://zod.dev/)
+- [x] [Valibot](https://valibot.dev/)
+- [x] [ArkType](https://arktype.io/)
+- [x] [TypeBox](https://github.com/sinclairzx81/typebox)
+- [x] [Effect](https://effect.website/docs/schema/introduction/)
+
+> [!Note]
+> This package is still in development and your feedback is highly appreciated. If you have any suggestions or issues, please let us know by creating an issue on GitHub.
+
+## Usage
+
+### Installation
+
+You can install the package using favorite package manager.
+
+#### For Zod
+
+```bash
+pnpm add hono-openapi @hono/zod-validator zod zod-openapi
+```
+
+#### For Valibot
+
+```bash
+pnpm add hono-openapi @hono/valibot-validator valibot @valibot/to-json-schema
+```
+
+#### For ArkType
+
+```bash
+pnpm add hono-openapi @hono/arktype-validator arktype
+```
+
+#### For TypeBox
+
+```bash
+pnpm add hono-openapi @hono/typebox-validator @sinclair/typebox"
+```
+
+#### For Effect
+
+```bash
+pnpm add hono-openapi @hono/effect-validator effect
+```
+
+> [!IMPORTANT]
+>
+> Requires `effect@^3.10.0`.
+> Also, use the `Schema` class from the `effect` package, as `@effect/schema` is not supported.
+
+### Basic Usage
+
+#### Setting up your application
+
+First, define your schemas, here is an example using Zod:
+
+```ts
+import z from "zod";
+
+// For extending the Zod schema with OpenAPI properties
+import "zod-openapi/extend";
+
+const querySchema = z
+  .object({
+    name: z.string().optional().openapi({ example: "Steven" }),
+  })
+  .openapi({ ref: "Query" });
+
+const responseSchema = z.string().openapi({ example: "Hello Steven!" });
+```
+
+Extending the Zod schema with OpenAPI properties is optional, but it will help you generate the OpenAPI specification. You can learn more about it here - [https://github.com/samchungy/zod-openapi](https://github.com/samchungy/zod-openapi).
+
+> [!Tip]
+> The `querySchema` schema will be registered as "#/components/schemas/Query" refs in the OpenAPI document. If you want to register the schema as referenced components, use .openapi() method.
+
+Next, create your route -
+
+```ts
+import { Hono } from "hono";
+import { describeRoute } from "hono-openapi";
+import { resolver, validator as zValidator } from "hono-openapi/zod";
+
+const app = new Hono();
+
+app.get(
+  "/",
+  describeRoute({
+    description: "Say hello to the user",
+    responses: {
+      200: {
+        description: "Successful greeting response",
+        content: {
+          "text/plain": {
+            schema: resolver(responseSchema),
+          },
+        },
+      },
+    },
+  }),
+  zValidator("query", querySchema),
+  (c) => {
+    const query = c.req.valid("query");
+    return c.text(`Hello ${query?.name ?? "Hono"}!`);
+  }
+);
+```
+
+You might be wondering why are we importing `validator` from `hono-openapi/zod` instead of `@hono/zod-validator` and as `zValidator`? This is because `hono-openapi` provides a wrapper around the `@hono/zod-validator` to make it easier to use. The idea is if you are already using `@hono/zod-validator` to validate your schemas, you can easily switch to `hono-openapi` without changing much of your code.
+
+Finally, generate the OpenAPI specification -
+
+```ts
+app.get(
+  "/openapi",
+  openAPISpecs(app, {
+    documentation: {
+      info: {
+        title: "Hono",
+        version: "1.0.0",
+        description: "API for greeting users",
+      },
+      servers: [
+        {
+          url: "http://localhost:3000",
+          description: "Local server",
+        },
+      ],
+    },
+  })
+);
+```
+
+Now, you can access the OpenAPI specification by visiting `http://localhost:3000/openapi`, and you can use this specification to generate client libraries, documentation, and more. Some tools that I used to generate documentation are -
+
+- [Swagger UI](https://github.com/honojs/middleware/tree/main/packages/swagger-ui)
+- [Scalar](https://github.com/scalar/scalar/tree/main/packages/hono-api-reference)
+
+##### Scalar Example
+
+```ts
+app.get(
+  "/docs",
+  apiReference({
+    theme: "saturn",
+    spec: {
+      url: "/openapi",
+    },
+  })
+);
+```
+
+And that's it! You have successfully generated the OpenAPI specification for your Hono API.
+
+### Advanced Usage
+
+#### Adding Security Definitions
+
+You can add security definitions to your OpenAPI specification by using the `security` property in the `openAPISpecs` function.
+
+```ts
+app.get(
+  "/openapi",
+  openAPISpecs(appRouter, {
+    documentation: {
+      info: {
+        title: "Rhinobase Cloud",
+        version: "1.0.0",
+        description: "API Documentation",
+      },
+      components: {
+        securitySchemes: {
+          bearerAuth: {
+            type: "http",
+            scheme: "bearer",
+            bearerFormat: "JWT",
+          },
+        },
+      },
+      security: [
+        {
+          bearerAuth: [],
+        },
+      ],
+      servers: [
+        {
+          url: "http://localhost:3004",
+          description: "Local server",
+        },
+      ],
+    },
+  })
+);
+```
+
+#### Conditionaly Hiding Routes
+
+You can conditionally hide routes from the OpenAPI specification by using the `hide` property in the `describeRoute` function.
+
+```ts
+app.get(
+  "/",
+  describeRoute({
+    // ...
+    hide: process.env.NODE_ENV === "production",
+  }),
+  (c) => {
+    return c.text("Private Route");
+  }
+);
+```
+
+#### Validating Responses
+
+> [!Warning]
+> Experimental
+
+You can validate the responses using the `validateResponse` property in the `describeRoute` function. This will validate the response against the schema and return an error if the response is invalid.
+
+```ts
+app.get(
+  "/",
+  describeRoute({
+    // ...
+    validateResponse: true,
+  }),
+  (c) => {
+    return c.json({ message: "This response will be validated" });
+  }
+);
+```
+
+## Contributing
+
+We would love to have more contributors involved!
+
+To get started, please read our [Contributing Guide](https://github.com/rhinobase/hono-openapi/blob/main/CONTRIBUTING.md).
+
+## Credits
+
+- The idea for this project was inspired by [ElysiaJS](https://elysiajs.com/) and their amazing work on generating [OpenAPI](https://elysiajs.com/recipe/openapi.html) specifications.
+- This project would not have been possible without the work of [Sam Chung](https://github.com/samchungy) and his [Zod OpenAPI](https://github.com/samchungy/zod-openapi) package.

package/arktype.cjs

@@ -0,0 +1 @@
+"use strict";var e=require("@hono/arktype-validator"),r=require("./toOpenAPISchema.cjs"),a=require("./utils.cjs");function t(e){return{builder:async a=>({schema:await r.convert(e.toJsonSchema())}),validator:r=>{e(r)}}}require("json-schema-walker"),exports.resolver=t,exports.validator=function(r,o,i){const s=e.arktypeValidator(r,o,i);return Object.assign(s,{[a.uniqueSymbol]:{resolver:async e=>a.generateValidatorDocs(r,await t(o).builder(e))}})};

package/arktype.d.cts

@@ -0,0 +1 @@
+export * from "./src/arktype";

package/arktype.d.ts

@@ -0,0 +1 @@
+export * from "./src/arktype.js";

package/arktype.js

@@ -0,0 +1 @@
+import{arktypeValidator as a}from"@hono/arktype-validator";import{c as o}from"./toOpenAPISchema.js";import{u as r,g as t}from"./utils.js";import"json-schema-walker";function s(a){return{builder:async r=>({schema:await o(a.toJsonSchema())}),validator:o=>{a(o)}}}function e(o,e,i){const n=a(o,e,i);return Object.assign(n,{[r]:{resolver:async a=>t(o,await s(e).builder(a))}})}export{s as resolver,e as validator};

package/effect.cjs

@@ -0,0 +1 @@
+"use strict";var e=require("@hono/effect-validator"),r=require("effect"),a=require("./toOpenAPISchema.cjs"),t=require("./utils.cjs");function i(e){return{builder:async t=>({schema:await a.convert(r.JSONSchema.make(e))}),validator:async a=>{await r.Schema.decodeUnknownPromise(e)(a)}}}require("json-schema-walker"),exports.resolver=i,exports.validator=function(r,a){const o=e.effectValidator(r,a);return Object.assign(o,{[t.uniqueSymbol]:{resolver:async e=>t.generateValidatorDocs(r,await i(a).builder(e))}})};

package/effect.d.cts

@@ -0,0 +1 @@
+export * from "./src/effect";

package/effect.d.ts

@@ -0,0 +1 @@
+export * from "./src/effect.js";

package/effect.js

@@ -0,0 +1 @@
+import{effectValidator as o}from"@hono/effect-validator";import{JSONSchema as a,Schema as r}from"effect";import{c as e}from"./toOpenAPISchema.js";import{u as t,g as i}from"./utils.js";import"json-schema-walker";function n(o){return{builder:async r=>({schema:await e(a.make(o))}),validator:async a=>{await r.decodeUnknownPromise(o)(a)}}}function s(a,r){const e=o(a,r);return Object.assign(e,{[t]:{resolver:async o=>i(a,await n(r).builder(o))}})}export{n as resolver,s as validator};

package/index.cjs

@@ -0,0 +1 @@
+"use strict";var e=require("hono/http-exception"),t=require("./utils.cjs");const n=["GET","PUT","POST","DELETE","OPTIONS","HEAD","PATCH","TRACE"],s=e=>e.charAt(0).toUpperCase()+e.slice(1),o=(e,t)=>{let n=e;if("/"===t)return`${n}Index`;for(const e of t.split("/"))123===e.charCodeAt(0)?n+=`By${s(e.slice(1,-1))}`:n+=s(e);return n};function c({path:e,method:t,data:n,schema:s}){e=(e=>e.split("/").map((e=>{let t=e;return t.startsWith(":")&&(t=t.slice(1,t.length),t.endsWith("?")&&(t=t.slice(0,-1)),t=`{${t}}`),t})).join("/"))(e);const c=t.toLowerCase();s[e]={...s[e]?s[e]:{},[c]:{responses:{},...s[e]?.[c]??{},operationId:o(c,e),...n}}}function i(e,{excludeStaticFile:t=!0,exclude:n=[]}){const s={};for(const[o,c]of Object.entries(e))if(!(n.some((e=>"string"==typeof e?o===e:e.test(o)))||o.includes("*")||t&&o.includes("."))){for(const e of Object.keys(c)){const t=c[e];if(o.includes("{")){t.parameters||(t.parameters=[]);const e=o.split("/").filter((e=>e.startsWith("{")&&!t.parameters.find((t=>"path"===t.in&&t.name===e.slice(1,e.length-1)))));for(const n of e){const e=n.slice(1,n.length-1),s=t.parameters.findIndex((t=>"param"===t.in&&t.name===e));-1!==s?t.parameters[s].in="path":t.parameters.push({schema:{type:"string"},in:"path",name:e,required:!0})}}t.responses||(t.responses={200:{}})}s[o]=c}return s}async function a(e,{documentation:s={},excludeStaticFile:o=!0,exclude:a=[],excludeMethods:r=["OPTIONS"],excludeTags:p=[],defaultOptions:l}={documentation:{},excludeStaticFile:!0,exclude:[],excludeMethods:["OPTIONS"],excludeTags:[]},{version:d="3.1.0",components:m={}}={version:"3.1.0",components:{}},u){const h={version:d,components:m},f={};for(const s of e.routes){if(!(t.uniqueSymbol in s.handler))continue;if(r.includes(s.method))continue;if(!1===n.includes(s.method)&&"ALL"!==s.method)continue;const{resolver:e,metadata:o={}}=s.handler[t.uniqueSymbol],i=l?.[s.method],{docs:a,components:p}=await e({...h,...o},i);if(h.components={...h.components,...p??{}},"ALL"===s.method)for(const e of n)c({path:s.path,data:a,method:e,schema:f});else c({method:s.method,path:s.path,data:a,schema:f})}for(const e in f)for(const t in f[e]){const n=f[e][t]?.hide;n&&("boolean"==typeof n?n:u&&n(u))&&delete f[e][t]}return{openapi:h.version,...{...s,tags:s.tags?.filter((e=>!p?.includes(e?.name))),info:{title:"Hono Documentation",description:"Development documentation",version:"0.0.0",...s.info},paths:{...i(f,{excludeStaticFile:o,exclude:Array.isArray(a)?a:[a]}),...s.paths},components:{...s.components,schemas:{...h.components,...s.components?.schemas}}}}}exports.describeRoute=function(n){const{validateResponse:s,...o}=n;return Object.assign((async(t,o)=>{if(await o(),s&&n.responses){const s=t.res.status,o=t.res.headers.get("content-type");if(s&&o){const c=n.responses[s];if(c&&"content"in c&&c.content){const n=o.split(";")[0],s=c.content[n];if(s?.schema&&"validator"in s.schema)try{let e;if("application/json"===n?e=await t.res.json():"text/plain"===n&&(e=await t.res.text()),!e)throw new Error("No data to validate!");await s.schema.validator(e)}catch(t){throw new e.HTTPException(400,{message:"Response validation failed!"})}}}}}),{[t.uniqueSymbol]:{resolver:(e,t)=>async function(e,t,n={}){let s={};const o={...n,...t,responses:{...n?.responses,...t.responses}};for(const t of Object.keys(o.responses)){const n=o.responses[t];if(n&&"content"in n)for(const t of Object.keys(n.content??{})){const o=n.content?.[t];if(o&&(o.schema&&"builder"in o.schema)){const t=await o.schema.builder(e);o.schema=t.schema,t.components&&(s={...s,...t.components})}}}return{docs:o,components:s}}(e,o,t)}})},exports.generateSpecs=a,exports.openAPISpecs=function(e,t){const n={version:"3.1.0",components:{}};let s=null;return async o=>(s||(s=await a(e,t,n,o)),o.json(s))};

package/index.d.cts

@@ -0,0 +1 @@
+export * from "./src/index";

package/index.d.ts

@@ -0,0 +1 @@
+export * from "./src/index.js";

package/index.js

@@ -0,0 +1 @@
+import{HTTPException as e}from"hono/http-exception";import{u as t}from"./utils.js";function n(n){const{validateResponse:s,...o}=n;return Object.assign((async(t,o)=>{if(await o(),s&&n.responses){const s=t.res.status,o=t.res.headers.get("content-type");if(s&&o){const c=n.responses[s];if(c&&"content"in c&&c.content){const n=o.split(";")[0],s=c.content[n];if(s?.schema&&"validator"in s.schema)try{let e;if("application/json"===n?e=await t.res.json():"text/plain"===n&&(e=await t.res.text()),!e)throw new Error("No data to validate!");await s.schema.validator(e)}catch(t){throw new e(400,{message:"Response validation failed!"})}}}}}),{[t]:{resolver:(e,t)=>async function(e,t,n={}){let s={};const o={...n,...t,responses:{...n?.responses,...t.responses}};for(const t of Object.keys(o.responses)){const n=o.responses[t];if(n&&"content"in n)for(const t of Object.keys(n.content??{})){const o=n.content?.[t];if(o&&(o.schema&&"builder"in o.schema)){const t=await o.schema.builder(e);o.schema=t.schema,t.components&&(s={...s,...t.components})}}}return{docs:o,components:s}}(e,o,t)}})}const s=["GET","PUT","POST","DELETE","OPTIONS","HEAD","PATCH","TRACE"],o=e=>e.charAt(0).toUpperCase()+e.slice(1),c=(e,t)=>{let n=e;if("/"===t)return`${n}Index`;for(const e of t.split("/"))123===e.charCodeAt(0)?n+=`By${o(e.slice(1,-1))}`:n+=o(e);return n};function a({path:e,method:t,data:n,schema:s}){e=(e=>e.split("/").map((e=>{let t=e;return t.startsWith(":")&&(t=t.slice(1,t.length),t.endsWith("?")&&(t=t.slice(0,-1)),t=`{${t}}`),t})).join("/"))(e);const o=t.toLowerCase();s[e]={...s[e]?s[e]:{},[o]:{responses:{},...s[e]?.[o]??{},operationId:c(o,e),...n}}}function i(e,{excludeStaticFile:t=!0,exclude:n=[]}){const s={};for(const[o,c]of Object.entries(e))if(!(n.some((e=>"string"==typeof e?o===e:e.test(o)))||o.includes("*")||t&&o.includes("."))){for(const e of Object.keys(c)){const t=c[e];if(o.includes("{")){t.parameters||(t.parameters=[]);const e=o.split("/").filter((e=>e.startsWith("{")&&!t.parameters.find((t=>"path"===t.in&&t.name===e.slice(1,e.length-1)))));for(const n of e){const e=n.slice(1,n.length-1),s=t.parameters.findIndex((t=>"param"===t.in&&t.name===e));-1!==s?t.parameters[s].in="path":t.parameters.push({schema:{type:"string"},in:"path",name:e,required:!0})}}t.responses||(t.responses={200:{}})}s[o]=c}return s}function r(e,t){const n={version:"3.1.0",components:{}};let s=null;return async o=>(s||(s=await p(e,t,n,o)),o.json(s))}async function p(e,{documentation:n={},excludeStaticFile:o=!0,exclude:c=[],excludeMethods:r=["OPTIONS"],excludeTags:p=[],defaultOptions:l}={documentation:{},excludeStaticFile:!0,exclude:[],excludeMethods:["OPTIONS"],excludeTags:[]},{version:d="3.1.0",components:m={}}={version:"3.1.0",components:{}},h){const f={version:d,components:m},u={};for(const n of e.routes){if(!(t in n.handler))continue;if(r.includes(n.method))continue;if(!1===s.includes(n.method)&&"ALL"!==n.method)continue;const{resolver:e,metadata:o={}}=n.handler[t],c=l?.[n.method],{docs:i,components:p}=await e({...f,...o},c);if(f.components={...f.components,...p??{}},"ALL"===n.method)for(const e of s)a({path:n.path,data:i,method:e,schema:u});else a({method:n.method,path:n.path,data:i,schema:u})}for(const e in u)for(const t in u[e]){const n=u[e][t]?.hide;n&&("boolean"==typeof n?n:h&&n(h))&&delete u[e][t]}return{openapi:f.version,...{...n,tags:n.tags?.filter((e=>!p?.includes(e?.name))),info:{title:"Hono Documentation",description:"Development documentation",version:"0.0.0",...n.info},paths:{...i(u,{excludeStaticFile:o,exclude:Array.isArray(c)?c:[c]}),...n.paths},components:{...n.components,schemas:{...f.components,...n.components?.schemas}}}}}export{n as describeRoute,p as generateSpecs,r as openAPISpecs};