hono-openapi 0.2.0 → 0.3.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,240 +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)
-
-> [!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)
+- [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.d.ts

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

package/arktype.cjs.js

@@ -1 +1 @@
-"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 e=require("@hono/arktype-validator"),r=require("./index.cjs2.js"),a=require("./utils.cjs.js");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,s,i){const o=e.arktypeValidator(r,s,i);return Object.assign(o,{[a.uniqueSymbol]:{resolver:async e=>a.generateValidatorDocs(r,await t(s).builder(e))}})};

package/arktype.esm.d.ts

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

package/arktype.esm.js

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

package/effect.cjs.d.ts

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

package/effect.cjs.js

@@ -0,0 +1 @@
+"use strict";var e=require("@hono/effect-validator"),r=require("effect"),a=require("./index.cjs2.js"),t=require("./utils.cjs.js");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 s=e.effectValidator(r,a);return Object.assign(s,{[t.uniqueSymbol]:{resolver:async e=>t.generateValidatorDocs(r,await i(a).builder(e))}})};

package/effect.esm.d.ts

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

package/effect.esm.js

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

package/index.cjs.d.ts

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

package/index.cjs.js

@@ -1 +1 @@
-"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 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];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(n)}}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=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: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 p={version:"3.1.0",components:{}},d={};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({...p,...o});if(p.components={...p.components,...a??{}},"ALL"===s.method)for(const e of n)c({path:s.path,data:i,method:e,schema:d});else c({method:s.method,path:s.path,data:i,schema:d})}for(const e in d)for(const t in d[e]){const n=d[e][t]?.hide;n&&("boolean"==typeof n?n:n(m))&&delete d[e][t]}return u={openapi:p.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(d,{excludeStaticFile:o,exclude:Array.isArray(a)?a:[a]}),...s.paths},components:{...s.components,schemas:{...p.components,...s.components?.schemas}}}},m.json(u)}};

package/index.cjs2.js

@@ -0,0 +1 @@
+"use strict";var e=require("json-schema-walker");const t=["$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 n=class extends Error{constructor(e){super(e),this.name="InvalidTypeError",this.message=e}};const i="x-",r=async(t,n)=>{if("object"!=typeof t)return t;if(t.type){const i=new e.Walker;return await i.loadSchema({definitions:n.definitions||[],...t,$schema:n.$schema},{dereference:!0,cloneSchema:!0,dereferenceOptions:{dereference:{circular:"ignore"}}}),await i.walk(o,i.vocabularies.DRAFT_07),"definitions"in i.rootSchema&&(i.rootSchema.definitions=void 0),i.rootSchema}if(Array.isArray(t)){const e=t;if(e.includes("null")){const t=e.filter((e=>"null"!==e));return{type:1===t.length?t[0]:t,nullable:!0}}}return t};function o(e){let r=e;return r?(r=function(e){return"object"!=typeof e||(e.$schema=void 0,e.$id=void 0,"id"in e&&(e.id=void 0)),e}(r),r=function(e){if("object"!=typeof e)return e;if(void 0===e.type)return e;if(function(e){if("object"==typeof e&&!Array.isArray(e)){if(e&&"$ref"in e&&e.$ref)return;if(e&&"properties"in e&&e.properties)return}const t=Array.isArray(e)?e:[e];for(const e of t)if(e&&!a.has(e))throw new n(`Type "${e}" is not a valid type`)}(e.type),Array.isArray(e.type)){e.type.includes("null")&&(e.nullable=!0);const t=e.type.filter((e=>"null"!==e));0===t.length?e.type=void 0:1===t.length?e.type=t[0]:(e.type=void 0,e.anyOf=t.map((e=>({type:e}))))}else"null"===e.type&&(e.type=void 0,e.nullable=!0);return e}(r),r=function(e){Object.hasOwnProperty.call(e,"const")&&(e.enum=[e.const],e.const=void 0);return e}(r),r=function(e){const t=e.dependencies;if("object"!=typeof t)return e;e.dependencies=void 0,Array.isArray(e.allOf)||(e.allOf=[]);for(const n in t){const i={oneOf:[{not:{required:[n]}},{required:[n,t[n]].flat()}]};e.allOf.push(i)}return e}(r),r=function(e){for(const t of["oneOf","anyOf"]){const n=e[t];if(!n)continue;if(!Array.isArray(n))return e;if(!n.some((e=>"null"===e.type)))return e;const i=n.filter((e=>"null"!==e.type));for(const e of i)e.nullable=!0;e[t]=i}return e}(r),r=function(e){if("object"!=typeof e)return e;"if"in e&&e.if&&e.then&&(e.oneOf=[{allOf:[e.if,e.then].filter(Boolean)},{allOf:[{not:e.if},e.else].filter(Boolean)}],e.if=void 0,e.then=void 0,e.else=void 0);return e}(r),r=function(e){"number"==typeof e.exclusiveMaximum&&(e.maximum=e.exclusiveMaximum,e.exclusiveMaximum=!0);"number"==typeof e.exclusiveMinimum&&(e.minimum=e.exclusiveMinimum,e.exclusiveMinimum=!0);return e}(r),r=function(e){e.examples&&Array.isArray(e.examples)&&(e.example=e.examples[0],e.examples=void 0);return e}(r),"object"==typeof r.patternProperties&&(r=function(e){return e["x-patternProperties"]=e.patternProperties,e.patternProperties=void 0,e.additionalProperties??=!0,e}(r)),"array"===r.type&&void 0===r.items&&(r.items={}),r=function(e){const n=Object.keys(e);for(const r of n)if(!r.startsWith(i)&&!t.includes(r)){e[`${i}${r}`]=e[r],e[r]=void 0}return e}(r),r):r}const a=new Set(["null","boolean","object","array","number","string","integer"]);exports.convert=async(t,n)=>{const i=new e.Walker;await i.loadSchema(t,n),await i.walk(o,i.vocabularies.DRAFT_07);const a=i.rootSchema;if(a?.definitions)for(const e in a.definitions){const n=a.definitions[e];a.definitions[e]=await r(n,t)}return a};

package/index.esm.d.ts

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

package/index.esm.js

@@ -1 +1 @@
-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 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=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: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];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(n)}}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 p={version:"3.1.0",components:{}},d={};let m=null;return async h=>{if(m)return h.json(m);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({...p,...o});if(p.components={...p.components,...i??{}},"ALL"===n.method)for(const e of s)a({path:n.path,data:c,method:e,schema:d});else a({method:n.method,path:n.path,data:c,schema:d})}for(const e in d)for(const t in d[e]){const n=d[e][t]?.hide;n&&("boolean"==typeof n?n:n(h))&&delete d[e][t]}return m={openapi:p.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(d,{excludeStaticFile:o,exclude:Array.isArray(c)?c:[c]}),...n.paths},components:{...n.components,schemas:{...p.components,...n.components?.schemas}}}},h.json(m)}}export{n as describeRoute,r as openAPISpecs};

package/index.esm2.js

@@ -0,0 +1 @@
+import{Walker as e}from"json-schema-walker";const t=["$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 n=class extends Error{constructor(e){super(e),this.name="InvalidTypeError",this.message=e}};const i="x-",r=async(t,n)=>{if("object"!=typeof t)return t;if(t.type){const i=new e;return await i.loadSchema({definitions:n.definitions||[],...t,$schema:n.$schema},{dereference:!0,cloneSchema:!0,dereferenceOptions:{dereference:{circular:"ignore"}}}),await i.walk(a,i.vocabularies.DRAFT_07),"definitions"in i.rootSchema&&(i.rootSchema.definitions=void 0),i.rootSchema}if(Array.isArray(t)){const e=t;if(e.includes("null")){const t=e.filter((e=>"null"!==e));return{type:1===t.length?t[0]:t,nullable:!0}}}return t},o=async(t,n)=>{const i=new e;await i.loadSchema(t,n),await i.walk(a,i.vocabularies.DRAFT_07);const o=i.rootSchema;if(o?.definitions)for(const e in o.definitions){const n=o.definitions[e];o.definitions[e]=await r(n,t)}return o};function a(e){let r=e;return r?(r=function(e){return"object"!=typeof e||(e.$schema=void 0,e.$id=void 0,"id"in e&&(e.id=void 0)),e}(r),r=function(e){if("object"!=typeof e)return e;if(void 0===e.type)return e;if(function(e){if("object"==typeof e&&!Array.isArray(e)){if(e&&"$ref"in e&&e.$ref)return;if(e&&"properties"in e&&e.properties)return}const t=Array.isArray(e)?e:[e];for(const e of t)if(e&&!s.has(e))throw new n(`Type "${e}" is not a valid type`)}(e.type),Array.isArray(e.type)){e.type.includes("null")&&(e.nullable=!0);const t=e.type.filter((e=>"null"!==e));0===t.length?e.type=void 0:1===t.length?e.type=t[0]:(e.type=void 0,e.anyOf=t.map((e=>({type:e}))))}else"null"===e.type&&(e.type=void 0,e.nullable=!0);return e}(r),r=function(e){Object.hasOwnProperty.call(e,"const")&&(e.enum=[e.const],e.const=void 0);return e}(r),r=function(e){const t=e.dependencies;if("object"!=typeof t)return e;e.dependencies=void 0,Array.isArray(e.allOf)||(e.allOf=[]);for(const n in t){const i={oneOf:[{not:{required:[n]}},{required:[n,t[n]].flat()}]};e.allOf.push(i)}return e}(r),r=function(e){for(const t of["oneOf","anyOf"]){const n=e[t];if(!n)continue;if(!Array.isArray(n))return e;if(!n.some((e=>"null"===e.type)))return e;const i=n.filter((e=>"null"!==e.type));for(const e of i)e.nullable=!0;e[t]=i}return e}(r),r=function(e){if("object"!=typeof e)return e;"if"in e&&e.if&&e.then&&(e.oneOf=[{allOf:[e.if,e.then].filter(Boolean)},{allOf:[{not:e.if},e.else].filter(Boolean)}],e.if=void 0,e.then=void 0,e.else=void 0);return e}(r),r=function(e){"number"==typeof e.exclusiveMaximum&&(e.maximum=e.exclusiveMaximum,e.exclusiveMaximum=!0);"number"==typeof e.exclusiveMinimum&&(e.minimum=e.exclusiveMinimum,e.exclusiveMinimum=!0);return e}(r),r=function(e){e.examples&&Array.isArray(e.examples)&&(e.example=e.examples[0],e.examples=void 0);return e}(r),"object"==typeof r.patternProperties&&(r=function(e){return e["x-patternProperties"]=e.patternProperties,e.patternProperties=void 0,e.additionalProperties??=!0,e}(r)),"array"===r.type&&void 0===r.items&&(r.items={}),r=function(e){const n=Object.keys(e);for(const r of n)if(!r.startsWith(i)&&!t.includes(r)){e[`${i}${r}`]=e[r],e[r]=void 0}return e}(r),r):r}const s=new Set(["null","boolean","object","array","number","string","integer"]);export{o as c};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "hono-openapi",
   "description": "OpenAPI schema generator for Hono",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "license": "MIT",
   "keywords": [
     "hono",
@@ -9,7 +9,8 @@
     "zod",
     "valibot",
     "typebox",
-    "arktype"
+    "arktype",
+    "effect"
   ],
   "homepage": "https://github.com/rhinobase/hono-openapi",
   "publishConfig": {
@@ -24,24 +25,28 @@
     "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",
+    "@hono/effect-validator": "^1.2.0",
     "@hono/typebox-validator": "^0.2.6",
     "@hono/valibot-validator": "^0.5.1",
     "@hono/zod-validator": "^0.4.1",
     "@sinclair/typebox": "^0.34.9",
     "@valibot/to-json-schema": "^1.0.0-beta.3",
     "arktype": "2.0.0-rc.25",
-    "hono": "^4.6.4",
+    "effect": "^3.11.3",
+    "hono": "^4.6.13",
     "openapi-types": "^12.1.3",
     "valibot": "^1.0.0-beta.9",
     "zod": "^3.23.8",
     "zod-openapi": "^4.0.0"
   },
   "devDependencies": {
-    "@rollup/plugin-terser": "^0.4.4"
+    "@apidevtools/json-schema-ref-parser": "^11.7.2",
+    "@rollup/plugin-terser": "^0.4.4",
+    "@types/json-schema": "^7.0.15"
   },
   "exports": {
     ".": {
@@ -93,6 +98,16 @@
         "default": "./arktype.cjs.js",
         "types": "./arktype.cjs.d.ts"
       }
+    },
+    "./effect": {
+      "import": {
+        "default": "./effect.esm.js",
+        "types": "./effect.esm.d.ts"
+      },
+      "require": {
+        "default": "./effect.cjs.js",
+        "types": "./effect.cjs.d.ts"
+      }
     }
   },
   "module": "./index.esm.js",

package/src/effect.d.ts

@@ -0,0 +1,22 @@
+import { Schema } from "effect";
+import type { Env, Input as HonoInput, MiddlewareHandler, ValidationTargets } from "hono";
+import type { HasUndefined, ResolverResult } from "./types";
+export declare function resolver<Type, Context>(schema: Schema.Schema<Type, Context, never>): ResolverResult;
+export declare function validator<Type, Context, Target extends keyof ValidationTargets, E extends Env, P extends string, In = Schema.Schema<Type, Context, never>["Encoded"], Out = Schema.Schema<Type, Context, never>["Type"], I extends HonoInput = {
+    in: HasUndefined<In> extends true ? {
+        [K in Target]?: K extends "json" ? In : HasUndefined<keyof ValidationTargets[K]> extends true ? {
+            [K2 in keyof In]?: ValidationTargets[K][K2];
+        } : {
+            [K2 in keyof In]: ValidationTargets[K][K2];
+        };
+    } : {
+        [K in Target]: K extends "json" ? In : HasUndefined<keyof ValidationTargets[K]> extends true ? {
+            [K2 in keyof In]?: ValidationTargets[K][K2];
+        } : {
+            [K2 in keyof In]: ValidationTargets[K][K2];
+        };
+    };
+    out: {
+        [K in Target]: Out;
+    };
+}, V extends I = I>(target: Target, schema: Schema.Schema<Type, Context, never>): MiddlewareHandler<E, P, V>;

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 { OpenAPIV3 } from "openapi-types";
+import type { Options } from "./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 @@
-"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 e=require("@hono/typebox-validator"),r=require("./index.cjs2.js"),a=require("@sinclair/typebox/value"),i=require("./utils.cjs.js");function t(e){return{builder:async a=>({schema:await r.convert(e)}),validator:r=>{a.Value.Parse(e,r)}}}require("json-schema-walker"),exports.resolver=t,exports.validator=function(r,a,s){const o=e.tbValidator(r,a,s);return Object.assign(o,{[i.uniqueSymbol]:{resolver:async e=>i.generateValidatorDocs(r,await t(a).builder(e))}})};

package/typebox.esm.d.ts

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

package/typebox.esm.js

@@ -1 +1 @@
-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 as r}from"@hono/typebox-validator";import{c as o}from"./index.esm2.js";import{Value as a}from"@sinclair/typebox/value";import{u as s,g as t}from"./utils.esm.js";import"json-schema-walker";function e(r){return{builder:async a=>({schema:await o(r)}),validator:o=>{a.Parse(r,o)}}}function i(o,a,i){const n=r(o,a,i);return Object.assign(n,{[s]:{resolver:async r=>t(o,await e(a).builder(r))}})}export{e as resolver,i as validator};

package/utils.cjs.js

@@ -1 +1 @@
-"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 e=Symbol("openapi");exports.generateValidatorDocs=async function(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,c]of Object.entries(n.schema.properties??{}))s.push({in:e,name:o,schema:c,required:n.schema.required?.includes(o)});o.parameters=s}return{docs:o,components:n.components}},exports.uniqueSymbol=e;

package/utils.esm.js

@@ -1 +1 @@
-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 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,c]of Object.entries(n.schema.properties??{}))s.push({in:e,name:o,schema:c,required:n.schema.required?.includes(o)});o.parameters=s}return{docs:o,components:n.components}}export{s as g,e as u};

package/valibot.cjs.d.ts

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

package/valibot.cjs.js

@@ -1 +1 @@
-"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 e=require("@hono/valibot-validator"),r=require("./index.cjs2.js"),a=require("@valibot/to-json-schema"),i=require("valibot"),s=require("./utils.cjs.js");function t(e){return{builder:async i=>({schema:await r.convert(a.toJsonSchema(e))}),validator:async r=>{await i.parseAsync(e,r)}}}require("json-schema-walker"),exports.resolver=t,exports.validator=function(r,a,i){const o=e.vValidator(r,a,i);return Object.assign(o,{[s.uniqueSymbol]:{resolver:async e=>s.generateValidatorDocs(r,await t(a).builder(e))}})};

package/valibot.esm.d.ts

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

package/valibot.esm.js

@@ -1 +1 @@
-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 as o}from"@hono/valibot-validator";import{c as a}from"./index.esm2.js";import{toJsonSchema as r}from"@valibot/to-json-schema";import{parseAsync as t}from"valibot";import{u as i,g as s}from"./utils.esm.js";import"json-schema-walker";function m(o){return{builder:async t=>({schema:await a(r(o))}),validator:async a=>{await t(o,a)}}}function e(a,r,t){const e=o(a,r,t);return Object.assign(e,{[i]:{resolver:async o=>s(a,await m(r).builder(o))}})}export{m as resolver,e as validator};

package/zod.cjs.d.ts

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

package/zod.esm.d.ts

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