hono-openapi 0.2.0 → 0.2.1

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,240 +1,240 @@
-# 📜 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)
-
-> [!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"
-```
-
-### 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: process.env.NODE_ENV === "development",
-  }),
-  (c) => {
-    return c.text("Private Route");
-  }
-);
-```
-
-## 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)
+
+> [!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"
+```
+
+### 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: process.env.NODE_ENV === "development",
+  }),
+  (c) => {
+    return c.text("Private Route");
+  }
+);
+```
+
+## 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.d.ts

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

package/arktype.cjs.js

@@ -1 +1,11 @@
-"use strict";var e=require("@hono/arktype-validator"),r=require("@openapi-contrib/json-schema-to-openapi-schema"),a=require("./utils.cjs.js");function t(e){return{builder:async a=>({schema:await r(e.toJsonSchema())}),validator:r=>{e(r)}}}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))}})};
+'use strict';
+
+var arktypeValidator = require('@hono/arktype-validator');
+var index = require('./index.cjs2.js');
+var utils = require('./utils.cjs.js');
+require('json-schema-walker');
+
+function resolver(schema){return {builder:async options=>({schema:await index.convert(schema.toJsonSchema())}),validator:value=>{schema(value);}}}function validator(target,schema,hook){const middleware=arktypeValidator.arktypeValidator(target,schema,hook);return Object.assign(middleware,{[utils.uniqueSymbol]:{resolver:async config=>utils.generateValidatorDocs(target,await resolver(schema).builder(config))}})}
+
+exports.resolver = resolver;
+exports.validator = validator;

package/arktype.esm.d.ts

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

package/arktype.esm.js

@@ -1 +1,8 @@
-import{arktypeValidator as o}from"@hono/arktype-validator";import a from"@openapi-contrib/json-schema-to-openapi-schema";import{u as r,g as t}from"./utils.esm.js";function e(o){return{builder:async r=>({schema:await a(o.toJsonSchema())}),validator:a=>{o(a)}}}function i(a,i,n){const s=o(a,i,n);return Object.assign(s,{[r]:{resolver:async o=>t(a,await e(i).builder(o))}})}export{e as resolver,i as validator};
+import { arktypeValidator } from '@hono/arktype-validator';
+import { c as convert } from './index.esm2.js';
+import { u as uniqueSymbol, g as generateValidatorDocs } from './utils.esm.js';
+import 'json-schema-walker';
+
+function resolver(schema){return {builder:async options=>({schema:await convert(schema.toJsonSchema())}),validator:value=>{schema(value);}}}function validator(target,schema,hook){const middleware=arktypeValidator(target,schema,hook);return Object.assign(middleware,{[uniqueSymbol]:{resolver:async config=>generateValidatorDocs(target,await resolver(schema).builder(config))}})}
+
+export { resolver, validator };

package/index.cjs.d.ts

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

package/index.cjs.js

@@ -1 +1,13 @@
-"use strict";var e=require("hono/http-exception"),t=require("./utils.cjs.js");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];o.includes("{")&&(t.parameters||(t.parameters=[]),t.parameters=[...o.split("/").filter((e=>e.startsWith("{")&&!t.parameters.find((t=>"path"===t.in&&t.name===e.slice(1,e.length-1))))).map((e=>({schema:{type:"string"},in:"path",name:e.slice(1,e.length-1),required:!0}))),...t.parameters]),t.responses||(t.responses={200:{}})}s[o]=c}return s}exports.describeRoute=function(n){return Object.assign((async(t,s)=>{if(await s(),n.validateResponse&&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=c.content[o];if(n?.schema&&"validator"in n.schema)try{await n.schema.validator(t.res.body)}catch(t){throw new e.HTTPException(400,{message:"Response validation failed!"})}}}}}),{[t.uniqueSymbol]:{resolver:async e=>{const t={...n};let s={};if(t.responses)for(const n of Object.keys(t.responses)){const o=t.responses[n];if(!o||"content"in o)for(const t of Object.keys(o.content??{})){const n=o.content?.[t];if(n&&(n.schema&&"builder"in n.schema)){const t=await n.schema.builder(e);n.schema=t.schema,t.components&&(s={...s,...t.components})}}}return{docs:t,components:s}}}})},exports.openAPISpecs=function(e,{documentation:s={},excludeStaticFile:o=!0,exclude:a=[],excludeMethods:r=["OPTIONS"],excludeTags:l=[]}={documentation:{},excludeStaticFile:!0,exclude:[],excludeMethods:["OPTIONS"],excludeTags:[]}){const d={version:"3.1.0",components:{}},p={};let u=null;return async m=>{if(u)return m.json(u);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],{docs:i,components:a}=await e({...d,...o});if(d.components={...d.components,...a??{}},"ALL"===s.method)for(const e of n)c({path:s.path,data:i,method:e,schema:p});else c({method:s.method,path:s.path,data:i,schema:p})}for(const e in p)for(const t in p[e]){const n=p[e][t]?.hide;n&&("boolean"==typeof n?n:n(m))&&delete p[e][t]}return u={openapi:d.version,...{...s,tags:s.tags?.filter((e=>!l?.includes(e?.name))),info:{title:"Hono Documentation",description:"Development documentation",version:"0.0.0",...s.info},paths:{...i(p,{excludeStaticFile:o,exclude:Array.isArray(a)?a:[a]}),...s.paths},components:{...s.components,schemas:{...d.components,...s.components?.schemas}}}},m.json(u)}};
+'use strict';
+
+var httpException = require('hono/http-exception');
+var utils = require('./utils.cjs.js');
+
+function describeRoute(specs){const middleware=async(c,next)=>{await next();if(specs.validateResponse&&specs.responses){const status=c.res.status;const contentType=c.res.headers.get("content-type");if(status&&contentType){const response=specs.responses[status];if(response&&"content"in response&&response.content){const content=response.content[contentType];if(content?.schema&&"validator"in content.schema){try{await content.schema.validator(c.res.body);}catch(error){throw new httpException.HTTPException(400,{message:"Response validation failed!"})}}}}}};return Object.assign(middleware,{[utils.uniqueSymbol]:{resolver:async config=>{const docs={...specs};let components={};if(docs.responses){for(const key of Object.keys(docs.responses)){const response=docs.responses[key];if(response&&!("content"in response))continue;for(const contentKey of Object.keys(response.content??{})){const raw=response.content?.[contentKey];if(!raw)continue;if(raw.schema&&"builder"in raw.schema){const result=await raw.schema.builder(config);raw.schema=result.schema;if(result.components){components={...components,...result.components};}}}}}return {docs,components}}}})}
+
+const ALLOWED_METHODS=["GET","PUT","POST","DELETE","OPTIONS","HEAD","PATCH","TRACE"];const toOpenAPIPath=path=>path.split("/").map(x=>{let tmp=x;if(tmp.startsWith(":")){tmp=tmp.slice(1,tmp.length);if(tmp.endsWith("?"))tmp=tmp.slice(0,-1);tmp=`{${tmp}}`;}return tmp}).join("/");const capitalize=word=>word.charAt(0).toUpperCase()+word.slice(1);const generateOperationId=(method,paths)=>{let operationId=method;if(paths==="/")return `${operationId}Index`;for(const path of paths.split("/")){if(path.charCodeAt(0)===123){operationId+=`By${capitalize(path.slice(1,-1))}`;}else {operationId+=capitalize(path);}}return operationId};function registerSchemaPath({path,method:_method,data,schema}){path=toOpenAPIPath(path);const method=_method.toLowerCase();schema[path]={...schema[path]?schema[path]:{},[method]:{responses:{},...schema[path]?.[method]??{},operationId:generateOperationId(method,path),...data}};}function filterPaths(paths,{excludeStaticFile=true,exclude=[]}){const newPaths={};for(const[key,value]of Object.entries(paths)){if(!exclude.some(x=>{if(typeof x==="string")return key===x;return x.test(key)})&&!key.includes("*")&&(excludeStaticFile?!key.includes("."):true)){for(const method of Object.keys(value)){const schema=value[method];if(key.includes("{")){if(!schema.parameters)schema.parameters=[];schema.parameters=[...key.split("/").filter(x=>x.startsWith("{")&&!schema.parameters.find(params=>params.in==="path"&&params.name===x.slice(1,x.length-1))).map(x=>({schema:{type:"string"},in:"path",name:x.slice(1,x.length-1),required:true})),...schema.parameters];}if(!schema.responses)schema.responses={200:{}};}newPaths[key]=value;}}return newPaths}
+
+function openAPISpecs(hono,{documentation={},excludeStaticFile=true,exclude=[],excludeMethods=["OPTIONS"],excludeTags=[]}={documentation:{},excludeStaticFile:true,exclude:[],excludeMethods:["OPTIONS"],excludeTags:[]}){const config={version:"3.1.0",components:{}};const schema={};let specs=null;return async c=>{if(specs)return c.json(specs);for(const route of hono.routes){if(!(utils.uniqueSymbol in route.handler))continue;if(excludeMethods.includes(route.method))continue;if(ALLOWED_METHODS.includes(route.method)===false&&route.method!=="ALL")continue;const{resolver,metadata={}}=route.handler[utils.uniqueSymbol];const{docs,components}=await resolver({...config,...metadata});config.components={...config.components,...components??{}};if(route.method==="ALL"){for(const method of ALLOWED_METHODS){registerSchemaPath({path:route.path,data:docs,method,schema});}}else {registerSchemaPath({method:route.method,path:route.path,data:docs,schema});}}for(const path in schema){for(const method in schema[path]){const valueOrFunc=schema[path][method]?.hide;if(valueOrFunc&&(typeof valueOrFunc==="boolean"?valueOrFunc:valueOrFunc(c))){delete schema[path][method];}}}specs={openapi:config.version,...{...documentation,tags:documentation.tags?.filter(tag=>!excludeTags?.includes(tag?.name)),info:{title:"Hono Documentation",description:"Development documentation",version:"0.0.0",...documentation.info},paths:{...filterPaths(schema,{excludeStaticFile,exclude:Array.isArray(exclude)?exclude:[exclude]}),...documentation.paths},components:{...documentation.components,schemas:{...config.components,...documentation.components?.schemas}}}};return c.json(specs)}}
+
+exports.describeRoute = describeRoute;
+exports.openAPISpecs = openAPISpecs;

package/index.cjs2.js

@@ -0,0 +1,9 @@
+'use strict';
+
+var jsonSchemaWalker = require('json-schema-walker');
+
+const allowedKeywords=["$ref","definitions","title","multipleOf","maximum","exclusiveMaximum","minimum","exclusiveMinimum","maxLength","minLength","pattern","maxItems","minItems","uniqueItems","maxProperties","minProperties","required","enum","type","not","allOf","oneOf","anyOf","items","properties","additionalProperties","description","format","default","nullable","discriminator","readOnly","writeOnly","example","externalDocs","deprecated","xml"];
+
+let InvalidTypeError=class InvalidTypeError extends Error{constructor(message){super(message);this.name="InvalidTypeError";this.message=message;}};const oasExtensionPrefix="x-";const handleDefinition=async(def,schema)=>{if(typeof def!=="object"){return def}const type=def.type;if(type){const walker=new jsonSchemaWalker.Walker;await walker.loadSchema({definitions:schema["definitions"]||[],...def,$schema:schema["$schema"]},{dereference:true,cloneSchema:true,dereferenceOptions:{dereference:{circular:"ignore"}}});await walker.walk(convertSchema,walker.vocabularies.DRAFT_07);if("definitions"in walker.rootSchema){walker.rootSchema.definitions=undefined;}return walker.rootSchema}if(Array.isArray(def)){const typeArr=def;const hasNull=typeArr.includes("null");if(hasNull){const actualTypes=typeArr.filter(l=>l!=="null");return {type:actualTypes.length===1?actualTypes[0]:actualTypes,nullable:true}}}return def};const convert=async(schema,options)=>{const walker=new jsonSchemaWalker.Walker;await walker.loadSchema(schema,options);await walker.walk(convertSchema,walker.vocabularies.DRAFT_07);const rootSchema=walker.rootSchema;if(rootSchema?.definitions){for(const defName in rootSchema.definitions){const def=rootSchema.definitions[defName];rootSchema.definitions[defName]=await handleDefinition(def,schema);}}return rootSchema};function stripIllegalKeywords(schema){if(typeof schema!=="object"){return schema}schema["$schema"]=undefined;schema["$id"]=undefined;if("id"in schema){schema["id"]=undefined;}return schema}function convertSchema(schema){if(!schema){return schema}schema=stripIllegalKeywords(schema);schema=convertTypes(schema);schema=rewriteConst(schema);schema=convertDependencies(schema);schema=convertNullable(schema);schema=rewriteIfThenElse(schema);schema=rewriteExclusiveMinMax(schema);schema=convertExamples(schema);if(typeof schema["patternProperties"]==="object"){schema=convertPatternProperties(schema);}if(schema.type==="array"&&typeof schema.items==="undefined"){schema.items={};}schema=convertIllegalKeywordsAsExtensions(schema);return schema}const validTypes=new Set(["null","boolean","object","array","number","string","integer"]);function validateType(type){if(typeof type==="object"&&!Array.isArray(type)){if(type.$ref){return}if(type.properties){return}}const types=Array.isArray(type)?type:[type];for(const type of types){if(type&&!validTypes.has(type))throw new InvalidTypeError(`Type "${type}" is not a valid type`)}}function convertDependencies(schema){const deps=schema.dependencies;if(typeof deps!=="object"){return schema}schema.dependencies=undefined;if(!Array.isArray(schema.allOf)){schema.allOf=[];}for(const key in deps){const foo={oneOf:[{not:{required:[key]}},{required:[key,deps[key]].flat()}]};schema.allOf.push(foo);}return schema}function convertNullable(schema){for(const key of ["oneOf","anyOf"]){const schemas=schema[key];if(!schemas)continue;if(!Array.isArray(schemas)){return schema}const hasNullable=schemas.some(item=>item.type==="null");if(!hasNullable){return schema}const filtered=schemas.filter(l=>l.type!=="null");for(const schemaEntry of filtered){schemaEntry.nullable=true;}schema[key]=filtered;}return schema}function convertTypes(schema){if(typeof schema!=="object"){return schema}if(schema.type===undefined){return schema}validateType(schema.type);if(Array.isArray(schema.type)){if(schema.type.includes("null")){schema.nullable=true;}const typesWithoutNull=schema.type.filter(type=>type!=="null");if(typesWithoutNull.length===0){schema.type=undefined;}else if(typesWithoutNull.length===1){schema.type=typesWithoutNull[0];}else {schema.type=undefined;schema.anyOf=typesWithoutNull.map(type=>({type}));}}else if(schema.type==="null"){schema.type=undefined;schema.nullable=true;}return schema}function convertPatternProperties(schema){schema["x-patternProperties"]=schema.patternProperties;schema.patternProperties=undefined;schema.additionalProperties??=true;return schema}function convertIllegalKeywordsAsExtensions(schema){const keys=Object.keys(schema);for(const keyword of keys){if(!keyword.startsWith(oasExtensionPrefix)&&!allowedKeywords.includes(keyword)){const key=`${oasExtensionPrefix}${keyword}`;schema[key]=schema[keyword];schema[keyword]=undefined;}}return schema}function convertExamples(schema){if(schema["examples"]&&Array.isArray(schema["examples"])){schema["example"]=schema["examples"][0];schema["examples"]=undefined;}return schema}function rewriteConst(schema){if(Object.hasOwnProperty.call(schema,"const")){schema.enum=[schema.const];schema.const=undefined;}return schema}function rewriteIfThenElse(schema){if(typeof schema!=="object"){return schema}if("if"in schema&&schema.if&&schema.then){schema.oneOf=[{allOf:[schema.if,schema.then].filter(Boolean)},{allOf:[{not:schema.if},schema.else].filter(Boolean)}];schema.if=undefined;schema.then=undefined;schema.else=undefined;}return schema}function rewriteExclusiveMinMax(schema){if(typeof schema.exclusiveMaximum==="number"){schema.maximum=schema.exclusiveMaximum;schema.exclusiveMaximum=true;}if(typeof schema.exclusiveMinimum==="number"){schema.minimum=schema.exclusiveMinimum;schema.exclusiveMinimum=true;}return schema}
+
+exports.convert = convert;

package/index.esm.d.ts

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

package/index.esm.js

@@ -1 +1,10 @@
-import{HTTPException as e}from"hono/http-exception";import{u as t}from"./utils.esm.js";function n(n){return Object.assign((async(t,s)=>{if(await s(),n.validateResponse&&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=c.content[o];if(n?.schema&&"validator"in n.schema)try{await n.schema.validator(t.res.body)}catch(t){throw new e(400,{message:"Response validation failed!"})}}}}}),{[t]:{resolver:async e=>{const t={...n};let s={};if(t.responses)for(const n of Object.keys(t.responses)){const o=t.responses[n];if(!o||"content"in o)for(const t of Object.keys(o.content??{})){const n=o.content?.[t];if(n&&(n.schema&&"builder"in n.schema)){const t=await n.schema.builder(e);n.schema=t.schema,t.components&&(s={...s,...t.components})}}}return{docs:t,components:s}}}})}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];o.includes("{")&&(t.parameters||(t.parameters=[]),t.parameters=[...o.split("/").filter((e=>e.startsWith("{")&&!t.parameters.find((t=>"path"===t.in&&t.name===e.slice(1,e.length-1))))).map((e=>({schema:{type:"string"},in:"path",name:e.slice(1,e.length-1),required:!0}))),...t.parameters]),t.responses||(t.responses={200:{}})}s[o]=c}return s}function r(e,{documentation:n={},excludeStaticFile:o=!0,exclude:c=[],excludeMethods:r=["OPTIONS"],excludeTags:l=[]}={documentation:{},excludeStaticFile:!0,exclude:[],excludeMethods:["OPTIONS"],excludeTags:[]}){const d={version:"3.1.0",components:{}},m={};let p=null;return async h=>{if(p)return h.json(p);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],{docs:c,components:i}=await e({...d,...o});if(d.components={...d.components,...i??{}},"ALL"===n.method)for(const e of s)a({path:n.path,data:c,method:e,schema:m});else a({method:n.method,path:n.path,data:c,schema:m})}for(const e in m)for(const t in m[e]){const n=m[e][t]?.hide;n&&("boolean"==typeof n?n:n(h))&&delete m[e][t]}return p={openapi:d.version,...{...n,tags:n.tags?.filter((e=>!l?.includes(e?.name))),info:{title:"Hono Documentation",description:"Development documentation",version:"0.0.0",...n.info},paths:{...i(m,{excludeStaticFile:o,exclude:Array.isArray(c)?c:[c]}),...n.paths},components:{...n.components,schemas:{...d.components,...n.components?.schemas}}}},h.json(p)}}export{n as describeRoute,r as openAPISpecs};
+import { HTTPException } from 'hono/http-exception';
+import { u as uniqueSymbol } from './utils.esm.js';
+
+function describeRoute(specs){const middleware=async(c,next)=>{await next();if(specs.validateResponse&&specs.responses){const status=c.res.status;const contentType=c.res.headers.get("content-type");if(status&&contentType){const response=specs.responses[status];if(response&&"content"in response&&response.content){const content=response.content[contentType];if(content?.schema&&"validator"in content.schema){try{await content.schema.validator(c.res.body);}catch(error){throw new HTTPException(400,{message:"Response validation failed!"})}}}}}};return Object.assign(middleware,{[uniqueSymbol]:{resolver:async config=>{const docs={...specs};let components={};if(docs.responses){for(const key of Object.keys(docs.responses)){const response=docs.responses[key];if(response&&!("content"in response))continue;for(const contentKey of Object.keys(response.content??{})){const raw=response.content?.[contentKey];if(!raw)continue;if(raw.schema&&"builder"in raw.schema){const result=await raw.schema.builder(config);raw.schema=result.schema;if(result.components){components={...components,...result.components};}}}}}return {docs,components}}}})}
+
+const ALLOWED_METHODS=["GET","PUT","POST","DELETE","OPTIONS","HEAD","PATCH","TRACE"];const toOpenAPIPath=path=>path.split("/").map(x=>{let tmp=x;if(tmp.startsWith(":")){tmp=tmp.slice(1,tmp.length);if(tmp.endsWith("?"))tmp=tmp.slice(0,-1);tmp=`{${tmp}}`;}return tmp}).join("/");const capitalize=word=>word.charAt(0).toUpperCase()+word.slice(1);const generateOperationId=(method,paths)=>{let operationId=method;if(paths==="/")return `${operationId}Index`;for(const path of paths.split("/")){if(path.charCodeAt(0)===123){operationId+=`By${capitalize(path.slice(1,-1))}`;}else {operationId+=capitalize(path);}}return operationId};function registerSchemaPath({path,method:_method,data,schema}){path=toOpenAPIPath(path);const method=_method.toLowerCase();schema[path]={...schema[path]?schema[path]:{},[method]:{responses:{},...schema[path]?.[method]??{},operationId:generateOperationId(method,path),...data}};}function filterPaths(paths,{excludeStaticFile=true,exclude=[]}){const newPaths={};for(const[key,value]of Object.entries(paths)){if(!exclude.some(x=>{if(typeof x==="string")return key===x;return x.test(key)})&&!key.includes("*")&&(excludeStaticFile?!key.includes("."):true)){for(const method of Object.keys(value)){const schema=value[method];if(key.includes("{")){if(!schema.parameters)schema.parameters=[];schema.parameters=[...key.split("/").filter(x=>x.startsWith("{")&&!schema.parameters.find(params=>params.in==="path"&&params.name===x.slice(1,x.length-1))).map(x=>({schema:{type:"string"},in:"path",name:x.slice(1,x.length-1),required:true})),...schema.parameters];}if(!schema.responses)schema.responses={200:{}};}newPaths[key]=value;}}return newPaths}
+
+function openAPISpecs(hono,{documentation={},excludeStaticFile=true,exclude=[],excludeMethods=["OPTIONS"],excludeTags=[]}={documentation:{},excludeStaticFile:true,exclude:[],excludeMethods:["OPTIONS"],excludeTags:[]}){const config={version:"3.1.0",components:{}};const schema={};let specs=null;return async c=>{if(specs)return c.json(specs);for(const route of hono.routes){if(!(uniqueSymbol in route.handler))continue;if(excludeMethods.includes(route.method))continue;if(ALLOWED_METHODS.includes(route.method)===false&&route.method!=="ALL")continue;const{resolver,metadata={}}=route.handler[uniqueSymbol];const{docs,components}=await resolver({...config,...metadata});config.components={...config.components,...components??{}};if(route.method==="ALL"){for(const method of ALLOWED_METHODS){registerSchemaPath({path:route.path,data:docs,method,schema});}}else {registerSchemaPath({method:route.method,path:route.path,data:docs,schema});}}for(const path in schema){for(const method in schema[path]){const valueOrFunc=schema[path][method]?.hide;if(valueOrFunc&&(typeof valueOrFunc==="boolean"?valueOrFunc:valueOrFunc(c))){delete schema[path][method];}}}specs={openapi:config.version,...{...documentation,tags:documentation.tags?.filter(tag=>!excludeTags?.includes(tag?.name)),info:{title:"Hono Documentation",description:"Development documentation",version:"0.0.0",...documentation.info},paths:{...filterPaths(schema,{excludeStaticFile,exclude:Array.isArray(exclude)?exclude:[exclude]}),...documentation.paths},components:{...documentation.components,schemas:{...config.components,...documentation.components?.schemas}}}};return c.json(specs)}}
+
+export { describeRoute, openAPISpecs };

package/index.esm2.js

@@ -0,0 +1,7 @@
+import { Walker } from 'json-schema-walker';
+
+const allowedKeywords=["$ref","definitions","title","multipleOf","maximum","exclusiveMaximum","minimum","exclusiveMinimum","maxLength","minLength","pattern","maxItems","minItems","uniqueItems","maxProperties","minProperties","required","enum","type","not","allOf","oneOf","anyOf","items","properties","additionalProperties","description","format","default","nullable","discriminator","readOnly","writeOnly","example","externalDocs","deprecated","xml"];
+
+let InvalidTypeError=class InvalidTypeError extends Error{constructor(message){super(message);this.name="InvalidTypeError";this.message=message;}};const oasExtensionPrefix="x-";const handleDefinition=async(def,schema)=>{if(typeof def!=="object"){return def}const type=def.type;if(type){const walker=new Walker;await walker.loadSchema({definitions:schema["definitions"]||[],...def,$schema:schema["$schema"]},{dereference:true,cloneSchema:true,dereferenceOptions:{dereference:{circular:"ignore"}}});await walker.walk(convertSchema,walker.vocabularies.DRAFT_07);if("definitions"in walker.rootSchema){walker.rootSchema.definitions=undefined;}return walker.rootSchema}if(Array.isArray(def)){const typeArr=def;const hasNull=typeArr.includes("null");if(hasNull){const actualTypes=typeArr.filter(l=>l!=="null");return {type:actualTypes.length===1?actualTypes[0]:actualTypes,nullable:true}}}return def};const convert=async(schema,options)=>{const walker=new Walker;await walker.loadSchema(schema,options);await walker.walk(convertSchema,walker.vocabularies.DRAFT_07);const rootSchema=walker.rootSchema;if(rootSchema?.definitions){for(const defName in rootSchema.definitions){const def=rootSchema.definitions[defName];rootSchema.definitions[defName]=await handleDefinition(def,schema);}}return rootSchema};function stripIllegalKeywords(schema){if(typeof schema!=="object"){return schema}schema["$schema"]=undefined;schema["$id"]=undefined;if("id"in schema){schema["id"]=undefined;}return schema}function convertSchema(schema){if(!schema){return schema}schema=stripIllegalKeywords(schema);schema=convertTypes(schema);schema=rewriteConst(schema);schema=convertDependencies(schema);schema=convertNullable(schema);schema=rewriteIfThenElse(schema);schema=rewriteExclusiveMinMax(schema);schema=convertExamples(schema);if(typeof schema["patternProperties"]==="object"){schema=convertPatternProperties(schema);}if(schema.type==="array"&&typeof schema.items==="undefined"){schema.items={};}schema=convertIllegalKeywordsAsExtensions(schema);return schema}const validTypes=new Set(["null","boolean","object","array","number","string","integer"]);function validateType(type){if(typeof type==="object"&&!Array.isArray(type)){if(type.$ref){return}if(type.properties){return}}const types=Array.isArray(type)?type:[type];for(const type of types){if(type&&!validTypes.has(type))throw new InvalidTypeError(`Type "${type}" is not a valid type`)}}function convertDependencies(schema){const deps=schema.dependencies;if(typeof deps!=="object"){return schema}schema.dependencies=undefined;if(!Array.isArray(schema.allOf)){schema.allOf=[];}for(const key in deps){const foo={oneOf:[{not:{required:[key]}},{required:[key,deps[key]].flat()}]};schema.allOf.push(foo);}return schema}function convertNullable(schema){for(const key of ["oneOf","anyOf"]){const schemas=schema[key];if(!schemas)continue;if(!Array.isArray(schemas)){return schema}const hasNullable=schemas.some(item=>item.type==="null");if(!hasNullable){return schema}const filtered=schemas.filter(l=>l.type!=="null");for(const schemaEntry of filtered){schemaEntry.nullable=true;}schema[key]=filtered;}return schema}function convertTypes(schema){if(typeof schema!=="object"){return schema}if(schema.type===undefined){return schema}validateType(schema.type);if(Array.isArray(schema.type)){if(schema.type.includes("null")){schema.nullable=true;}const typesWithoutNull=schema.type.filter(type=>type!=="null");if(typesWithoutNull.length===0){schema.type=undefined;}else if(typesWithoutNull.length===1){schema.type=typesWithoutNull[0];}else {schema.type=undefined;schema.anyOf=typesWithoutNull.map(type=>({type}));}}else if(schema.type==="null"){schema.type=undefined;schema.nullable=true;}return schema}function convertPatternProperties(schema){schema["x-patternProperties"]=schema.patternProperties;schema.patternProperties=undefined;schema.additionalProperties??=true;return schema}function convertIllegalKeywordsAsExtensions(schema){const keys=Object.keys(schema);for(const keyword of keys){if(!keyword.startsWith(oasExtensionPrefix)&&!allowedKeywords.includes(keyword)){const key=`${oasExtensionPrefix}${keyword}`;schema[key]=schema[keyword];schema[keyword]=undefined;}}return schema}function convertExamples(schema){if(schema["examples"]&&Array.isArray(schema["examples"])){schema["example"]=schema["examples"][0];schema["examples"]=undefined;}return schema}function rewriteConst(schema){if(Object.hasOwnProperty.call(schema,"const")){schema.enum=[schema.const];schema.const=undefined;}return schema}function rewriteIfThenElse(schema){if(typeof schema!=="object"){return schema}if("if"in schema&&schema.if&&schema.then){schema.oneOf=[{allOf:[schema.if,schema.then].filter(Boolean)},{allOf:[{not:schema.if},schema.else].filter(Boolean)}];schema.if=undefined;schema.then=undefined;schema.else=undefined;}return schema}function rewriteExclusiveMinMax(schema){if(typeof schema.exclusiveMaximum==="number"){schema.maximum=schema.exclusiveMaximum;schema.exclusiveMaximum=true;}if(typeof schema.exclusiveMinimum==="number"){schema.minimum=schema.exclusiveMinimum;schema.exclusiveMinimum=true;}return schema}
+
+export { convert as c };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "hono-openapi",
   "description": "OpenAPI schema generator for Hono",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "license": "MIT",
   "keywords": [
     "hono",
@@ -24,7 +24,7 @@
     "url": "https://github.com/rhinobase/hono-openapi/issues"
   },
   "dependencies": {
-    "@openapi-contrib/json-schema-to-openapi-schema": "^3.0.3"
+    "json-schema-walker": "^2.0.0"
   },
   "optionalDependencies": {
     "@hono/arktype-validator": "^2.0.0",
@@ -41,7 +41,9 @@
     "zod-openapi": "^4.0.0"
   },
   "devDependencies": {
-    "@rollup/plugin-terser": "^0.4.4"
+    "@rollup/plugin-terser": "^0.4.4",
+    "@apidevtools/json-schema-ref-parser": "^11.7.2",
+    "@types/json-schema": "^7.0.15"
   },
   "exports": {
     ".": {

package/src/toOpenAPISchema/const.d.ts

@@ -0,0 +1 @@
+export declare const allowedKeywords: string[];

package/src/toOpenAPISchema/index.d.ts

@@ -0,0 +1,5 @@
+import type { JSONSchema4 } from "json-schema";
+import type { Options } from "./types";
+import type { OpenAPIV3 } from "openapi-types";
+declare const convert: <T extends object = JSONSchema4>(schema: T, options?: Options) => Promise<OpenAPIV3.Document>;
+export default convert;

package/src/toOpenAPISchema/types.d.ts

@@ -0,0 +1,18 @@
+import type { JSONSchema, ParserOptions } from "@apidevtools/json-schema-ref-parser";
+export type addPrefixToObject = {
+    [K in keyof JSONSchema as `x-${K}`]: JSONSchema[K];
+};
+export interface Options {
+    cloneSchema?: boolean;
+    dereference?: boolean;
+    convertUnreferencedDefinitions?: boolean;
+    dereferenceOptions?: ParserOptions | undefined;
+}
+type ExtendedJSONSchema = addPrefixToObject & JSONSchema;
+export type SchemaType = ExtendedJSONSchema & {
+    example?: JSONSchema["examples"][number];
+    "x-patternProperties"?: JSONSchema["patternProperties"];
+    nullable?: boolean;
+};
+export type SchemaTypeKeys = keyof SchemaType;
+export {};

package/typebox.cjs.d.ts

@@ -1 +1 @@
-export * from "./src\\typebox";
+export * from "./src/typebox";

package/typebox.cjs.js

@@ -1 +1,12 @@
-"use strict";var e=require("@hono/typebox-validator"),r=require("@openapi-contrib/json-schema-to-openapi-schema"),a=require("@sinclair/typebox/value"),i=require("./utils.cjs.js");function t(e){return{builder:async a=>({schema:await r(e)}),validator:r=>{a.Value.Parse(e,r)}}}exports.resolver=t,exports.validator=function(r,a,o){const s=e.tbValidator(r,a,o);return Object.assign(s,{[i.uniqueSymbol]:{resolver:async e=>i.generateValidatorDocs(r,await t(a).builder(e))}})};
+'use strict';
+
+var typeboxValidator = require('@hono/typebox-validator');
+var index = require('./index.cjs2.js');
+var value = require('@sinclair/typebox/value');
+var utils = require('./utils.cjs.js');
+require('json-schema-walker');
+
+function resolver(schema){return {builder:async options=>({schema:await index.convert(schema)}),validator:value$1=>{value.Value.Parse(schema,value$1);}}}function validator(target,schema,hook){const middleware=typeboxValidator.tbValidator(target,schema,hook);return Object.assign(middleware,{[utils.uniqueSymbol]:{resolver:async config=>utils.generateValidatorDocs(target,await resolver(schema).builder(config))}})}
+
+exports.resolver = resolver;
+exports.validator = validator;

package/typebox.esm.d.ts

@@ -1 +1 @@
-export * from "./src\\typebox";
+export * from "./src/typebox";

package/typebox.esm.js

@@ -1 +1,9 @@
-import{tbValidator as o}from"@hono/typebox-validator";import r from"@openapi-contrib/json-schema-to-openapi-schema";import{Value as a}from"@sinclair/typebox/value";import{u as t,g as i}from"./utils.esm.js";function e(o){return{builder:async a=>({schema:await r(o)}),validator:r=>{a.Parse(o,r)}}}function s(r,a,s){const n=o(r,a,s);return Object.assign(n,{[t]:{resolver:async o=>i(r,await e(a).builder(o))}})}export{e as resolver,s as validator};
+import { tbValidator } from '@hono/typebox-validator';
+import { c as convert } from './index.esm2.js';
+import { Value } from '@sinclair/typebox/value';
+import { u as uniqueSymbol, g as generateValidatorDocs } from './utils.esm.js';
+import 'json-schema-walker';
+
+function resolver(schema){return {builder:async options=>({schema:await convert(schema)}),validator:value=>{Value.Parse(schema,value);}}}function validator(target,schema,hook){const middleware=tbValidator(target,schema,hook);return Object.assign(middleware,{[uniqueSymbol]:{resolver:async config=>generateValidatorDocs(target,await resolver(schema).builder(config))}})}
+
+export { resolver, validator };

package/utils.cjs.js

@@ -1 +1,6 @@
-"use strict";const e=Symbol("openapi");exports.generateValidatorDocs=async function(e,s){const o=await s,n={};if("form"===e||"json"===e)n.requestBody={content:{["json"===e?"application/json":"application/x-www-form-urlencoded"]:{schema:o.schema}}};else{const s=[];if("$ref"in o.schema)s.push({in:e,name:o.schema.$ref,schema:o.schema});else for(const[n,c]of Object.entries(o.schema.properties??{}))s.push({in:e,name:n,schema:c});n.parameters=s}return{docs:n,components:o.components}},exports.uniqueSymbol=e;
+'use strict';
+
+const uniqueSymbol=Symbol("openapi");async function generateValidatorDocs(target,_result){const result=await _result;const docs={};if(target==="form"||target==="json"){docs.requestBody={content:{[target==="json"?"application/json":"application/x-www-form-urlencoded"]:{schema:result.schema}}};}else {const parameters=[];if("$ref"in result.schema){parameters.push({in:target,name:result.schema.$ref,schema:result.schema});}else {for(const[key,value]of Object.entries(result.schema.properties??{})){parameters.push({in:target,name:key,schema:value,required:result.schema.required?.includes(key)});}}docs.parameters=parameters;}return {docs,components:result.components}}
+
+exports.generateValidatorDocs = generateValidatorDocs;
+exports.uniqueSymbol = uniqueSymbol;

package/utils.esm.js

@@ -1 +1,3 @@
-const e=Symbol("openapi");async function s(e,s){const n=await s,o={};if("form"===e||"json"===e)o.requestBody={content:{["json"===e?"application/json":"application/x-www-form-urlencoded"]:{schema:n.schema}}};else{const s=[];if("$ref"in n.schema)s.push({in:e,name:n.schema.$ref,schema:n.schema});else for(const[o,a]of Object.entries(n.schema.properties??{}))s.push({in:e,name:o,schema:a});o.parameters=s}return{docs:o,components:n.components}}export{s as g,e as u};
+const uniqueSymbol=Symbol("openapi");async function generateValidatorDocs(target,_result){const result=await _result;const docs={};if(target==="form"||target==="json"){docs.requestBody={content:{[target==="json"?"application/json":"application/x-www-form-urlencoded"]:{schema:result.schema}}};}else {const parameters=[];if("$ref"in result.schema){parameters.push({in:target,name:result.schema.$ref,schema:result.schema});}else {for(const[key,value]of Object.entries(result.schema.properties??{})){parameters.push({in:target,name:key,schema:value,required:result.schema.required?.includes(key)});}}docs.parameters=parameters;}return {docs,components:result.components}}
+
+export { generateValidatorDocs as g, uniqueSymbol as u };

package/valibot.cjs.d.ts

@@ -1 +1 @@
-export * from "./src\\valibot";
+export * from "./src/valibot";

package/valibot.cjs.js

@@ -1 +1,13 @@
-"use strict";var e=require("@hono/valibot-validator"),a=require("@openapi-contrib/json-schema-to-openapi-schema"),r=require("@valibot/to-json-schema"),o=require("valibot"),i=require("./utils.cjs.js");function t(e){return{builder:async o=>({schema:await a(r.toJsonSchema(e))}),validator:async a=>{await o.parseAsync(e,a)}}}exports.resolver=t,exports.validator=function(a,r,o){const s=e.vValidator(a,r,o);return Object.assign(s,{[i.uniqueSymbol]:{resolver:async e=>i.generateValidatorDocs(a,await t(r).builder(e))}})};
+'use strict';
+
+var valibotValidator = require('@hono/valibot-validator');
+var index = require('./index.cjs2.js');
+var toJsonSchema = require('@valibot/to-json-schema');
+var valibot = require('valibot');
+var utils = require('./utils.cjs.js');
+require('json-schema-walker');
+
+function resolver(schema){return {builder:async options=>({schema:await index.convert(toJsonSchema.toJsonSchema(schema))}),validator:async value=>{await valibot.parseAsync(schema,value);}}}function validator(target,schema,hook){const middleware=valibotValidator.vValidator(target,schema,hook);return Object.assign(middleware,{[utils.uniqueSymbol]:{resolver:async config=>utils.generateValidatorDocs(target,await resolver(schema).builder(config))}})}
+
+exports.resolver = resolver;
+exports.validator = validator;

package/valibot.esm.d.ts

@@ -1 +1 @@
-export * from "./src\\valibot";
+export * from "./src/valibot";

package/valibot.esm.js

@@ -1 +1,10 @@
-import{vValidator as o}from"@hono/valibot-validator";import a from"@openapi-contrib/json-schema-to-openapi-schema";import{toJsonSchema as t}from"@valibot/to-json-schema";import{parseAsync as i}from"valibot";import{u as r,g as s}from"./utils.esm.js";function n(o){return{builder:async i=>({schema:await a(t(o))}),validator:async a=>{await i(o,a)}}}function e(a,t,i){const e=o(a,t,i);return Object.assign(e,{[r]:{resolver:async o=>s(a,await n(t).builder(o))}})}export{n as resolver,e as validator};
+import { vValidator } from '@hono/valibot-validator';
+import { c as convert } from './index.esm2.js';
+import { toJsonSchema } from '@valibot/to-json-schema';
+import { parseAsync } from 'valibot';
+import { u as uniqueSymbol, g as generateValidatorDocs } from './utils.esm.js';
+import 'json-schema-walker';
+
+function resolver(schema){return {builder:async options=>({schema:await convert(toJsonSchema(schema))}),validator:async value=>{await parseAsync(schema,value);}}}function validator(target,schema,hook){const middleware=vValidator(target,schema,hook);return Object.assign(middleware,{[uniqueSymbol]:{resolver:async config=>generateValidatorDocs(target,await resolver(schema).builder(config))}})}
+
+export { resolver, validator };

package/zod.cjs.d.ts

@@ -1 +1 @@
-export * from "./src\\zod";
+export * from "./src/zod";

package/zod.cjs.js

@@ -1 +1,10 @@
-"use strict";var e=require("@hono/zod-validator"),r=require("zod-openapi"),a=require("./utils.cjs.js");function t(e){return{builder:a=>{const{version:t,...o}=a??{};return r.createSchema(e,a?{openapi:t,...o}:void 0)},validator:e.parse}}exports.resolver=t,exports.validator=function(r,o,i){const n=e.zValidator(r,o,i);return Object.assign(n,{[a.uniqueSymbol]:{resolver:async e=>a.generateValidatorDocs(r,await t(o).builder(e)),metadata:{schemaType:"input"}}})};
+'use strict';
+
+var zodValidator = require('@hono/zod-validator');
+var zodOpenapi = require('zod-openapi');
+var utils = require('./utils.cjs.js');
+
+function resolver(schema){return {builder:options=>{const{version,...rest}=options??{};return zodOpenapi.createSchema(schema,options?{openapi:version,...rest}:undefined)},validator:schema.parse}}function validator(target,schema,hook){const middleware=zodValidator.zValidator(target,schema,hook);return Object.assign(middleware,{[utils.uniqueSymbol]:{resolver:async config=>utils.generateValidatorDocs(target,await resolver(schema).builder(config)),metadata:{schemaType:"input"}}})}
+
+exports.resolver = resolver;
+exports.validator = validator;

package/zod.esm.d.ts

@@ -1 +1 @@
-export * from "./src\\zod";
+export * from "./src/zod";

package/zod.esm.js

@@ -1 +1,7 @@
-import{zValidator as o}from"@hono/zod-validator";import{createSchema as r}from"zod-openapi";import{u as t,g as a}from"./utils.esm.js";function e(o){return{builder:t=>{const{version:a,...e}=t??{};return r(o,t?{openapi:a,...e}:void 0)},validator:o.parse}}function i(r,i,n){const s=o(r,i,n);return Object.assign(s,{[t]:{resolver:async o=>a(r,await e(i).builder(o)),metadata:{schemaType:"input"}}})}export{e as resolver,i as validator};
+import { zValidator } from '@hono/zod-validator';
+import { createSchema } from 'zod-openapi';
+import { u as uniqueSymbol, g as generateValidatorDocs } from './utils.esm.js';
+
+function resolver(schema){return {builder:options=>{const{version,...rest}=options??{};return createSchema(schema,options?{openapi:version,...rest}:undefined)},validator:schema.parse}}function validator(target,schema,hook){const middleware=zValidator(target,schema,hook);return Object.assign(middleware,{[uniqueSymbol]:{resolver:async config=>generateValidatorDocs(target,await resolver(schema).builder(config)),metadata:{schemaType:"input"}}})}
+
+export { resolver, validator };