hono-openapi 0.3.0 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (61) hide show
  1. package/arktype.cjs +1 -0
  2. package/arktype.d.ts +1 -0
  3. package/arktype.js +1 -0
  4. package/effect.cjs +1 -0
  5. package/effect.d.ts +1 -0
  6. package/effect.js +1 -0
  7. package/index.cjs +1 -0
  8. package/index.d.ts +1 -0
  9. package/index.js +1 -0
  10. package/package.json +77 -32
  11. package/src/arktype.d.ts +13 -1
  12. package/src/effect.d.ts +12 -1
  13. package/src/helper.d.ts +1 -1
  14. package/src/index.d.ts +3 -3
  15. package/src/openapi.d.ts +200 -3
  16. package/src/route.d.ts +43 -3
  17. package/src/{toOpenAPISchema/types.d.ts → toOpenAPISchema.d.ts} +4 -1
  18. package/src/typebox.d.ts +13 -1
  19. package/src/types.d.ts +8 -5
  20. package/src/utils.d.ts +1 -1
  21. package/src/valibot.d.ts +13 -1
  22. package/src/zod.d.ts +13 -1
  23. package/typebox.cjs +1 -0
  24. package/typebox.d.ts +1 -0
  25. package/typebox.js +1 -0
  26. package/valibot.cjs +1 -0
  27. package/valibot.d.ts +1 -0
  28. package/valibot.js +1 -0
  29. package/zod.cjs +1 -0
  30. package/zod.d.ts +1 -0
  31. package/zod.js +1 -0
  32. package/arktype.cjs.js +0 -1
  33. package/arktype.esm.d.ts +0 -1
  34. package/arktype.esm.js +0 -1
  35. package/effect.cjs.js +0 -1
  36. package/effect.esm.d.ts +0 -1
  37. package/effect.esm.js +0 -1
  38. package/index.cjs.js +0 -1
  39. package/index.esm.d.ts +0 -1
  40. package/index.esm.js +0 -1
  41. package/src/toOpenAPISchema/const.d.ts +0 -1
  42. package/src/toOpenAPISchema/index.d.ts +0 -5
  43. package/typebox.cjs.js +0 -1
  44. package/typebox.esm.d.ts +0 -1
  45. package/typebox.esm.js +0 -1
  46. package/valibot.cjs.js +0 -1
  47. package/valibot.esm.d.ts +0 -1
  48. package/valibot.esm.js +0 -1
  49. package/zod.cjs.js +0 -1
  50. package/zod.esm.d.ts +0 -1
  51. package/zod.esm.js +0 -1
  52. /package/{arktype.cjs.d.ts → arktype.d.cts} +0 -0
  53. /package/{effect.cjs.d.ts → effect.d.cts} +0 -0
  54. /package/{index.cjs.d.ts → index.d.cts} +0 -0
  55. /package/{index.cjs2.js → toOpenAPISchema.cjs} +0 -0
  56. /package/{index.esm2.js → toOpenAPISchema.js} +0 -0
  57. /package/{typebox.cjs.d.ts → typebox.d.cts} +0 -0
  58. /package/{utils.cjs.js → utils.cjs} +0 -0
  59. /package/{utils.esm.js → utils.js} +0 -0
  60. /package/{valibot.cjs.d.ts → valibot.d.cts} +0 -0
  61. /package/{zod.cjs.d.ts → zod.d.cts} +0 -0
package/arktype.cjs ADDED
@@ -0,0 +1 @@
1
+ "use strict";var e=require("@hono/arktype-validator"),r=require("./toOpenAPISchema.cjs"),a=require("./utils.cjs");function t(e){return{builder:async a=>({schema:await r.convert(e.toJsonSchema())}),validator:r=>{e(r)}}}require("json-schema-walker"),exports.resolver=t,exports.validator=function(r,o,i){const s=e.arktypeValidator(r,o,i);return Object.assign(s,{[a.uniqueSymbol]:{resolver:async e=>a.generateValidatorDocs(r,await t(o).builder(e))}})};
package/arktype.d.ts ADDED
@@ -0,0 +1 @@
1
+ export type * from "./src/arktype.js";
package/arktype.js ADDED
@@ -0,0 +1 @@
1
+ import{arktypeValidator as a}from"@hono/arktype-validator";import{c as o}from"./toOpenAPISchema.js";import{u as r,g as t}from"./utils.js";import"json-schema-walker";function s(a){return{builder:async r=>({schema:await o(a.toJsonSchema())}),validator:o=>{a(o)}}}function e(o,e,i){const n=a(o,e,i);return Object.assign(n,{[r]:{resolver:async a=>t(o,await s(e).builder(a))}})}export{s as resolver,e as validator};
package/effect.cjs ADDED
@@ -0,0 +1 @@
1
+ "use strict";var e=require("@hono/effect-validator"),r=require("effect"),a=require("./toOpenAPISchema.cjs"),t=require("./utils.cjs");function i(e){return{builder:async t=>({schema:await a.convert(r.JSONSchema.make(e))}),validator:async a=>{await r.Schema.decodeUnknownPromise(e)(a)}}}require("json-schema-walker"),exports.resolver=i,exports.validator=function(r,a){const o=e.effectValidator(r,a);return Object.assign(o,{[t.uniqueSymbol]:{resolver:async e=>t.generateValidatorDocs(r,await i(a).builder(e))}})};
package/effect.d.ts ADDED
@@ -0,0 +1 @@
1
+ export type * from "./src/effect.js";
package/effect.js ADDED
@@ -0,0 +1 @@
1
+ import{effectValidator as o}from"@hono/effect-validator";import{JSONSchema as a,Schema as r}from"effect";import{c as e}from"./toOpenAPISchema.js";import{u as t,g as i}from"./utils.js";import"json-schema-walker";function n(o){return{builder:async r=>({schema:await e(a.make(o))}),validator:async a=>{await r.decodeUnknownPromise(o)(a)}}}function s(a,r){const e=o(a,r);return Object.assign(e,{[t]:{resolver:async o=>i(a,await n(r).builder(o))}})}export{n as resolver,s as validator};
package/index.cjs ADDED
@@ -0,0 +1 @@
1
+ "use strict";var e=require("hono/http-exception"),t=require("./utils.cjs");const n=["GET","PUT","POST","DELETE","OPTIONS","HEAD","PATCH","TRACE"],s=e=>e.charAt(0).toUpperCase()+e.slice(1),o=(e,t)=>{let n=e;if("/"===t)return`${n}Index`;for(const e of t.split("/"))123===e.charCodeAt(0)?n+=`By${s(e.slice(1,-1))}`:n+=s(e);return n};function c({path:e,method:t,data:n,schema:s}){e=(e=>e.split("/").map((e=>{let t=e;return t.startsWith(":")&&(t=t.slice(1,t.length),t.endsWith("?")&&(t=t.slice(0,-1)),t=`{${t}}`),t})).join("/"))(e);const c=t.toLowerCase();s[e]={...s[e]?s[e]:{},[c]:{responses:{},...s[e]?.[c]??{},operationId:o(c,e),...n}}}function i(e,{excludeStaticFile:t=!0,exclude:n=[]}){const s={};for(const[o,c]of Object.entries(e))if(!(n.some((e=>"string"==typeof e?o===e:e.test(o)))||o.includes("*")||t&&o.includes("."))){for(const e of Object.keys(c)){const t=c[e];if(o.includes("{")){t.parameters||(t.parameters=[]);const e=o.split("/").filter((e=>e.startsWith("{")&&!t.parameters.find((t=>"path"===t.in&&t.name===e.slice(1,e.length-1)))));for(const n of e){const e=n.slice(1,n.length-1),s=t.parameters.findIndex((t=>"param"===t.in&&t.name===e));-1!==s?t.parameters[s].in="path":t.parameters.push({schema:{type:"string"},in:"path",name:e,required:!0})}}t.responses||(t.responses={200:{}})}s[o]=c}return s}async function a(e,{documentation:s={},excludeStaticFile:o=!0,exclude:a=[],excludeMethods:r=["OPTIONS"],excludeTags:p=[],defaultOptions:l}={documentation:{},excludeStaticFile:!0,exclude:[],excludeMethods:["OPTIONS"],excludeTags:[]},{version:d="3.1.0",components:m={}}={version:"3.1.0",components:{}},u){const h={version:d,components:m},f={};for(const s of e.routes){if(!(t.uniqueSymbol in s.handler))continue;if(r.includes(s.method))continue;if(!1===n.includes(s.method)&&"ALL"!==s.method)continue;const{resolver:e,metadata:o={}}=s.handler[t.uniqueSymbol],i=l?.[s.method],{docs:a,components:p}=await e({...h,...o},i);if(h.components={...h.components,...p??{}},"ALL"===s.method)for(const e of n)c({path:s.path,data:a,method:e,schema:f});else c({method:s.method,path:s.path,data:a,schema:f})}for(const e in f)for(const t in f[e]){const n=f[e][t]?.hide;n&&("boolean"==typeof n?n:u&&n(u))&&delete f[e][t]}return{openapi:h.version,...{...s,tags:s.tags?.filter((e=>!p?.includes(e?.name))),info:{title:"Hono Documentation",description:"Development documentation",version:"0.0.0",...s.info},paths:{...i(f,{excludeStaticFile:o,exclude:Array.isArray(a)?a:[a]}),...s.paths},components:{...s.components,schemas:{...h.components,...s.components?.schemas}}}}}exports.describeRoute=function(n){const{validateResponse:s,...o}=n;return Object.assign((async(t,o)=>{if(await o(),s&&n.responses){const s=t.res.status,o=t.res.headers.get("content-type");if(s&&o){const c=n.responses[s];if(c&&"content"in c&&c.content){const n=o.split(";")[0],s=c.content[n];if(s?.schema&&"validator"in s.schema)try{let e;if("application/json"===n?e=await t.res.json():"text/plain"===n&&(e=await t.res.text()),!e)throw new Error("No data to validate!");await s.schema.validator(e)}catch(t){throw new e.HTTPException(400,{message:"Response validation failed!"})}}}}}),{[t.uniqueSymbol]:{resolver:(e,t)=>async function(e,t,n={}){let s={};const o={...n,...t,responses:{...n?.responses,...t.responses}};for(const t of Object.keys(o.responses)){const n=o.responses[t];if(n&&"content"in n)for(const t of Object.keys(n.content??{})){const o=n.content?.[t];if(o&&(o.schema&&"builder"in o.schema)){const t=await o.schema.builder(e);o.schema=t.schema,t.components&&(s={...s,...t.components})}}}return{docs:o,components:s}}(e,o,t)}})},exports.generateSpecs=a,exports.openAPISpecs=function(e,t){const n={version:"3.1.0",components:{}};let s=null;return async o=>(s||(s=await a(e,t,n,o)),o.json(s))};
package/index.d.ts ADDED
@@ -0,0 +1 @@
1
+ export type * from "./src/index.js";
package/index.js ADDED
@@ -0,0 +1 @@
1
+ import{HTTPException as e}from"hono/http-exception";import{u as t}from"./utils.js";function n(n){const{validateResponse:s,...o}=n;return Object.assign((async(t,o)=>{if(await o(),s&&n.responses){const s=t.res.status,o=t.res.headers.get("content-type");if(s&&o){const c=n.responses[s];if(c&&"content"in c&&c.content){const n=o.split(";")[0],s=c.content[n];if(s?.schema&&"validator"in s.schema)try{let e;if("application/json"===n?e=await t.res.json():"text/plain"===n&&(e=await t.res.text()),!e)throw new Error("No data to validate!");await s.schema.validator(e)}catch(t){throw new e(400,{message:"Response validation failed!"})}}}}}),{[t]:{resolver:(e,t)=>async function(e,t,n={}){let s={};const o={...n,...t,responses:{...n?.responses,...t.responses}};for(const t of Object.keys(o.responses)){const n=o.responses[t];if(n&&"content"in n)for(const t of Object.keys(n.content??{})){const o=n.content?.[t];if(o&&(o.schema&&"builder"in o.schema)){const t=await o.schema.builder(e);o.schema=t.schema,t.components&&(s={...s,...t.components})}}}return{docs:o,components:s}}(e,o,t)}})}const s=["GET","PUT","POST","DELETE","OPTIONS","HEAD","PATCH","TRACE"],o=e=>e.charAt(0).toUpperCase()+e.slice(1),c=(e,t)=>{let n=e;if("/"===t)return`${n}Index`;for(const e of t.split("/"))123===e.charCodeAt(0)?n+=`By${o(e.slice(1,-1))}`:n+=o(e);return n};function a({path:e,method:t,data:n,schema:s}){e=(e=>e.split("/").map((e=>{let t=e;return t.startsWith(":")&&(t=t.slice(1,t.length),t.endsWith("?")&&(t=t.slice(0,-1)),t=`{${t}}`),t})).join("/"))(e);const o=t.toLowerCase();s[e]={...s[e]?s[e]:{},[o]:{responses:{},...s[e]?.[o]??{},operationId:c(o,e),...n}}}function i(e,{excludeStaticFile:t=!0,exclude:n=[]}){const s={};for(const[o,c]of Object.entries(e))if(!(n.some((e=>"string"==typeof e?o===e:e.test(o)))||o.includes("*")||t&&o.includes("."))){for(const e of Object.keys(c)){const t=c[e];if(o.includes("{")){t.parameters||(t.parameters=[]);const e=o.split("/").filter((e=>e.startsWith("{")&&!t.parameters.find((t=>"path"===t.in&&t.name===e.slice(1,e.length-1)))));for(const n of e){const e=n.slice(1,n.length-1),s=t.parameters.findIndex((t=>"param"===t.in&&t.name===e));-1!==s?t.parameters[s].in="path":t.parameters.push({schema:{type:"string"},in:"path",name:e,required:!0})}}t.responses||(t.responses={200:{}})}s[o]=c}return s}function r(e,t){const n={version:"3.1.0",components:{}};let s=null;return async o=>(s||(s=await p(e,t,n,o)),o.json(s))}async function p(e,{documentation:n={},excludeStaticFile:o=!0,exclude:c=[],excludeMethods:r=["OPTIONS"],excludeTags:p=[],defaultOptions:l}={documentation:{},excludeStaticFile:!0,exclude:[],excludeMethods:["OPTIONS"],excludeTags:[]},{version:d="3.1.0",components:m={}}={version:"3.1.0",components:{}},h){const f={version:d,components:m},u={};for(const n of e.routes){if(!(t in n.handler))continue;if(r.includes(n.method))continue;if(!1===s.includes(n.method)&&"ALL"!==n.method)continue;const{resolver:e,metadata:o={}}=n.handler[t],c=l?.[n.method],{docs:i,components:p}=await e({...f,...o},c);if(f.components={...f.components,...p??{}},"ALL"===n.method)for(const e of s)a({path:n.path,data:i,method:e,schema:u});else a({method:n.method,path:n.path,data:i,schema:u})}for(const e in u)for(const t in u[e]){const n=u[e][t]?.hide;n&&("boolean"==typeof n?n:h&&n(h))&&delete u[e][t]}return{openapi:f.version,...{...n,tags:n.tags?.filter((e=>!p?.includes(e?.name))),info:{title:"Hono Documentation",description:"Development documentation",version:"0.0.0",...n.info},paths:{...i(u,{excludeStaticFile:o,exclude:Array.isArray(c)?c:[c]}),...n.paths},components:{...n.components,schemas:{...f.components,...n.components?.schemas}}}}}export{n as describeRoute,p as generateSpecs,r as openAPISpecs};
package/package.json CHANGED
@@ -1,7 +1,10 @@
1
1
  {
2
2
  "name": "hono-openapi",
3
3
  "description": "OpenAPI schema generator for Hono",
4
- "version": "0.3.0",
4
+ "version": "0.4.0",
5
+ "types": "./index.d.ts",
6
+ "main": "./index.js",
7
+ "type": "module",
5
8
  "license": "MIT",
6
9
  "keywords": [
7
10
  "hono",
@@ -27,15 +30,15 @@
27
30
  "dependencies": {
28
31
  "json-schema-walker": "^2.0.0"
29
32
  },
30
- "optionalDependencies": {
33
+ "peerDependencies": {
31
34
  "@hono/arktype-validator": "^2.0.0",
32
35
  "@hono/effect-validator": "^1.2.0",
33
- "@hono/typebox-validator": "^0.2.6",
36
+ "@hono/typebox-validator": "^0.2.0 || ^0.3.0",
34
37
  "@hono/valibot-validator": "^0.5.1",
35
38
  "@hono/zod-validator": "^0.4.1",
36
39
  "@sinclair/typebox": "^0.34.9",
37
40
  "@valibot/to-json-schema": "^1.0.0-beta.3",
38
- "arktype": "2.0.0-rc.25",
41
+ "arktype": "^2.0.0-rc.25",
39
42
  "effect": "^3.11.3",
40
43
  "hono": "^4.6.13",
41
44
  "openapi-types": "^12.1.3",
@@ -43,74 +46,116 @@
43
46
  "zod": "^3.23.8",
44
47
  "zod-openapi": "^4.0.0"
45
48
  },
49
+ "peerDependenciesMeta": {
50
+ "@hono/arktype-validator": {
51
+ "optional": true
52
+ },
53
+ "@hono/effect-validator": {
54
+ "optional": true
55
+ },
56
+ "@hono/typebox-validator": {
57
+ "optional": true
58
+ },
59
+ "@hono/valibot-validator": {
60
+ "optional": true
61
+ },
62
+ "@hono/zod-validator": {
63
+ "optional": true
64
+ },
65
+ "@sinclair/typebox": {
66
+ "optional": true
67
+ },
68
+ "@valibot/to-json-schema": {
69
+ "optional": true
70
+ },
71
+ "arktype": {
72
+ "optional": true
73
+ },
74
+ "effect": {
75
+ "optional": true
76
+ },
77
+ "hono": {
78
+ "optional": true
79
+ },
80
+ "openapi-types": {
81
+ "optional": true
82
+ },
83
+ "valibot": {
84
+ "optional": true
85
+ },
86
+ "zod": {
87
+ "optional": true
88
+ },
89
+ "zod-openapi": {
90
+ "optional": true
91
+ }
92
+ },
46
93
  "devDependencies": {
47
- "@apidevtools/json-schema-ref-parser": "^11.7.2",
94
+ "@apidevtools/json-schema-ref-parser": "^11.7.3",
48
95
  "@rollup/plugin-terser": "^0.4.4",
49
96
  "@types/json-schema": "^7.0.15"
50
97
  },
51
98
  "exports": {
52
99
  ".": {
53
100
  "import": {
54
- "default": "./index.esm.js",
55
- "types": "./index.esm.d.ts"
101
+ "types": "./index.d.ts",
102
+ "default": "./index.js"
56
103
  },
57
104
  "require": {
58
- "default": "./index.cjs.js",
59
- "types": "./index.cjs.d.ts"
105
+ "types": "./index.d.cts",
106
+ "default": "./index.cjs"
60
107
  }
61
108
  },
62
109
  "./zod": {
63
110
  "import": {
64
- "default": "./zod.esm.js",
65
- "types": "./zod.esm.d.ts"
111
+ "types": "./zod.d.ts",
112
+ "default": "./zod.js"
66
113
  },
67
114
  "require": {
68
- "default": "./zod.cjs.js",
69
- "types": "./zod.cjs.d.ts"
115
+ "types": "./zod.d.cts",
116
+ "default": "./zod.cjs"
70
117
  }
71
118
  },
72
119
  "./valibot": {
73
120
  "import": {
74
- "default": "./valibot.esm.js",
75
- "types": "./valibot.esm.d.ts"
121
+ "types": "./valibot.d.ts",
122
+ "default": "./valibot.js"
76
123
  },
77
124
  "require": {
78
- "default": "./valibot.cjs.js",
79
- "types": "./valibot.cjs.d.ts"
125
+ "types": "./valibot.d.cts",
126
+ "default": "./valibot.cjs"
80
127
  }
81
128
  },
82
129
  "./typebox": {
83
130
  "import": {
84
- "default": "./typebox.esm.js",
85
- "types": "./typebox.esm.d.ts"
131
+ "types": "./typebox.d.ts",
132
+ "default": "./typebox.js"
86
133
  },
87
134
  "require": {
88
- "default": "./typebox.cjs.js",
89
- "types": "./typebox.cjs.d.ts"
135
+ "types": "./typebox.d.cts",
136
+ "default": "./typebox.cjs"
90
137
  }
91
138
  },
92
139
  "./arktype": {
93
140
  "import": {
94
- "default": "./arktype.esm.js",
95
- "types": "./arktype.esm.d.ts"
141
+ "types": "./arktype.d.ts",
142
+ "default": "./arktype.js"
96
143
  },
97
144
  "require": {
98
- "default": "./arktype.cjs.js",
99
- "types": "./arktype.cjs.d.ts"
145
+ "types": "./arktype.d.cts",
146
+ "default": "./arktype.cjs"
100
147
  }
101
148
  },
102
149
  "./effect": {
103
150
  "import": {
104
- "default": "./effect.esm.js",
105
- "types": "./effect.esm.d.ts"
151
+ "types": "./effect.d.ts",
152
+ "default": "./effect.js"
106
153
  },
107
154
  "require": {
108
- "default": "./effect.cjs.js",
109
- "types": "./effect.cjs.d.ts"
155
+ "types": "./effect.d.cts",
156
+ "default": "./effect.cjs"
110
157
  }
111
158
  }
112
159
  },
113
- "module": "./index.esm.js",
114
- "main": "./index.cjs.js",
115
- "types": "./index.esm.d.ts"
160
+ "module": "./index.esm.js"
116
161
  }
package/src/arktype.d.ts CHANGED
@@ -1,8 +1,20 @@
1
1
  import { type Hook } from "@hono/arktype-validator";
2
2
  import type { Type } from "arktype";
3
3
  import type { Env, MiddlewareHandler, ValidationTargets } from "hono";
4
- import type { HasUndefined, ResolverResult } from "./types";
4
+ import type { HasUndefined, ResolverResult } from "./types.js";
5
+ /**
6
+ * Generate a resolver for an Arktype schema
7
+ * @param schema Arktype schema
8
+ * @returns Resolver result
9
+ */
5
10
  export declare function resolver<T extends Type>(schema: T): ResolverResult;
11
+ /**
12
+ * Create a validator middleware
13
+ * @param target Target for validation
14
+ * @param schema Arktype schema
15
+ * @param hook Hook for validation
16
+ * @returns Middleware handler
17
+ */
6
18
  export declare function validator<T extends Type, Target extends keyof ValidationTargets, E extends Env, P extends string, I = T["inferIn"], O = T["infer"], V extends {
7
19
  in: HasUndefined<I> extends true ? {
8
20
  [K in Target]?: I;
package/src/effect.d.ts CHANGED
@@ -1,7 +1,18 @@
1
1
  import { Schema } from "effect";
2
2
  import type { Env, Input as HonoInput, MiddlewareHandler, ValidationTargets } from "hono";
3
- import type { HasUndefined, ResolverResult } from "./types";
3
+ import type { HasUndefined, ResolverResult } from "./types.js";
4
+ /**
5
+ * Generate a resolver for an Effect schema
6
+ * @param schema Effect schema
7
+ * @returns Resolver result
8
+ */
4
9
  export declare function resolver<Type, Context>(schema: Schema.Schema<Type, Context, never>): ResolverResult;
10
+ /**
11
+ * Create a validator middleware
12
+ * @param target Target for validation
13
+ * @param schema Effect schema
14
+ * @returns Middleware handler
15
+ */
5
16
  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 = {
6
17
  in: HasUndefined<In> extends true ? {
7
18
  [K in Target]?: K extends "json" ? In : HasUndefined<keyof ValidationTargets[K]> extends true ? {
package/src/helper.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import type { OpenAPIV3 } from "openapi-types";
2
- import type { OpenAPIRoute } from "./types";
2
+ import type { OpenAPIRoute } from "./types.js";
3
3
  export declare const ALLOWED_METHODS: readonly ["GET", "PUT", "POST", "DELETE", "OPTIONS", "HEAD", "PATCH", "TRACE"];
4
4
  export declare const toOpenAPIPath: (path: string) => string;
5
5
  export declare const capitalize: (word: string) => string;
package/src/index.d.ts CHANGED
@@ -1,3 +1,3 @@
1
- export { describeRoute } from "./route";
2
- export { openAPISpecs } from "./openapi";
3
- export type * from "./types";
1
+ export { describeRoute } from "./route.js";
2
+ export { openAPISpecs, generateSpecs } from "./openapi.js";
3
+ export type * from "./types.js";
package/src/openapi.d.ts CHANGED
@@ -1,4 +1,201 @@
1
1
  import type { Context, Env, Hono, Input, Schema } from "hono";
2
- import type { BlankSchema } from "hono/types";
3
- import type { OpenApiSpecsOptions } from "./types";
4
- export declare function openAPISpecs<E extends Env = Env, P extends string = string, I extends Input = Input, S extends Schema = BlankSchema>(hono: Hono<E, S, P>, { documentation, excludeStaticFile, exclude, excludeMethods, excludeTags, }?: OpenApiSpecsOptions): (c: Context<E, P, I>) => Promise<any>;
2
+ import type { BlankEnv, BlankInput, BlankSchema, MiddlewareHandler } from "hono/types";
3
+ import type { OpenAPIV3 } from "openapi-types";
4
+ import type { OpenAPIRouteHandlerConfig, OpenApiSpecsOptions } from "./types.js";
5
+ /**
6
+ * Route handler for OpenAPI specs
7
+ * @param hono Instance of Hono
8
+ * @param options Options for generating OpenAPI specs
9
+ * @returns Middleware handler for OpenAPI specs
10
+ */
11
+ export declare function openAPISpecs<E extends Env = BlankEnv, P extends string = string, I extends Input = BlankInput, S extends Schema = BlankSchema>(hono: Hono<E, S, P>, options?: OpenApiSpecsOptions): MiddlewareHandler<E, P, I>;
12
+ /**
13
+ * Generate OpenAPI specs for the given Hono instance
14
+ * @param hono Instance of Hono
15
+ * @param options Options for generating OpenAPI specs
16
+ * @param config Configuration for OpenAPI route handler
17
+ * @param Context Route context for hiding routes
18
+ * @returns OpenAPI specs
19
+ */
20
+ export declare function generateSpecs<E extends Env = BlankEnv, P extends string = string, I extends Input = BlankInput, S extends Schema = BlankSchema>(hono: Hono<E, S, P>, { documentation, excludeStaticFile, exclude, excludeMethods, excludeTags, defaultOptions, }?: OpenApiSpecsOptions, { version, components }?: OpenAPIRouteHandlerConfig, c?: Context<E, P, I>): Promise<{
21
+ tags: OpenAPIV3.TagObject[] | undefined;
22
+ info: {
23
+ title: string;
24
+ description: string;
25
+ termsOfService?: string;
26
+ contact?: OpenAPIV3.ContactObject;
27
+ license?: OpenAPIV3.LicenseObject;
28
+ version: string;
29
+ };
30
+ paths: {
31
+ [x: string]: ({
32
+ $ref?: string;
33
+ summary?: string;
34
+ description?: string;
35
+ servers?: OpenAPIV3.ServerObject[];
36
+ parameters?: (OpenAPIV3.ReferenceObject | OpenAPIV3.ParameterObject)[];
37
+ } & {
38
+ get?: {
39
+ tags?: string[];
40
+ summary?: string;
41
+ description?: string;
42
+ externalDocs?: OpenAPIV3.ExternalDocumentationObject;
43
+ operationId?: string;
44
+ parameters?: (OpenAPIV3.ReferenceObject | OpenAPIV3.ParameterObject)[];
45
+ requestBody?: OpenAPIV3.ReferenceObject | OpenAPIV3.RequestBodyObject;
46
+ responses: OpenAPIV3.ResponsesObject;
47
+ callbacks?: {
48
+ [callback: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.CallbackObject;
49
+ };
50
+ deprecated?: boolean;
51
+ security?: OpenAPIV3.SecurityRequirementObject[];
52
+ servers?: OpenAPIV3.ServerObject[];
53
+ } | undefined;
54
+ put?: {
55
+ tags?: string[];
56
+ summary?: string;
57
+ description?: string;
58
+ externalDocs?: OpenAPIV3.ExternalDocumentationObject;
59
+ operationId?: string;
60
+ parameters?: (OpenAPIV3.ReferenceObject | OpenAPIV3.ParameterObject)[];
61
+ requestBody?: OpenAPIV3.ReferenceObject | OpenAPIV3.RequestBodyObject;
62
+ responses: OpenAPIV3.ResponsesObject;
63
+ callbacks?: {
64
+ [callback: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.CallbackObject;
65
+ };
66
+ deprecated?: boolean;
67
+ security?: OpenAPIV3.SecurityRequirementObject[];
68
+ servers?: OpenAPIV3.ServerObject[];
69
+ } | undefined;
70
+ post?: {
71
+ tags?: string[];
72
+ summary?: string;
73
+ description?: string;
74
+ externalDocs?: OpenAPIV3.ExternalDocumentationObject;
75
+ operationId?: string;
76
+ parameters?: (OpenAPIV3.ReferenceObject | OpenAPIV3.ParameterObject)[];
77
+ requestBody?: OpenAPIV3.ReferenceObject | OpenAPIV3.RequestBodyObject;
78
+ responses: OpenAPIV3.ResponsesObject;
79
+ callbacks?: {
80
+ [callback: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.CallbackObject;
81
+ };
82
+ deprecated?: boolean;
83
+ security?: OpenAPIV3.SecurityRequirementObject[];
84
+ servers?: OpenAPIV3.ServerObject[];
85
+ } | undefined;
86
+ delete?: {
87
+ tags?: string[];
88
+ summary?: string;
89
+ description?: string;
90
+ externalDocs?: OpenAPIV3.ExternalDocumentationObject;
91
+ operationId?: string;
92
+ parameters?: (OpenAPIV3.ReferenceObject | OpenAPIV3.ParameterObject)[];
93
+ requestBody?: OpenAPIV3.ReferenceObject | OpenAPIV3.RequestBodyObject;
94
+ responses: OpenAPIV3.ResponsesObject;
95
+ callbacks?: {
96
+ [callback: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.CallbackObject;
97
+ };
98
+ deprecated?: boolean;
99
+ security?: OpenAPIV3.SecurityRequirementObject[];
100
+ servers?: OpenAPIV3.ServerObject[];
101
+ } | undefined;
102
+ options?: {
103
+ tags?: string[];
104
+ summary?: string;
105
+ description?: string;
106
+ externalDocs?: OpenAPIV3.ExternalDocumentationObject;
107
+ operationId?: string;
108
+ parameters?: (OpenAPIV3.ReferenceObject | OpenAPIV3.ParameterObject)[];
109
+ requestBody?: OpenAPIV3.ReferenceObject | OpenAPIV3.RequestBodyObject;
110
+ responses: OpenAPIV3.ResponsesObject;
111
+ callbacks?: {
112
+ [callback: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.CallbackObject;
113
+ };
114
+ deprecated?: boolean;
115
+ security?: OpenAPIV3.SecurityRequirementObject[];
116
+ servers?: OpenAPIV3.ServerObject[];
117
+ } | undefined;
118
+ head?: {
119
+ tags?: string[];
120
+ summary?: string;
121
+ description?: string;
122
+ externalDocs?: OpenAPIV3.ExternalDocumentationObject;
123
+ operationId?: string;
124
+ parameters?: (OpenAPIV3.ReferenceObject | OpenAPIV3.ParameterObject)[];
125
+ requestBody?: OpenAPIV3.ReferenceObject | OpenAPIV3.RequestBodyObject;
126
+ responses: OpenAPIV3.ResponsesObject;
127
+ callbacks?: {
128
+ [callback: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.CallbackObject;
129
+ };
130
+ deprecated?: boolean;
131
+ security?: OpenAPIV3.SecurityRequirementObject[];
132
+ servers?: OpenAPIV3.ServerObject[];
133
+ } | undefined;
134
+ patch?: {
135
+ tags?: string[];
136
+ summary?: string;
137
+ description?: string;
138
+ externalDocs?: OpenAPIV3.ExternalDocumentationObject;
139
+ operationId?: string;
140
+ parameters?: (OpenAPIV3.ReferenceObject | OpenAPIV3.ParameterObject)[];
141
+ requestBody?: OpenAPIV3.ReferenceObject | OpenAPIV3.RequestBodyObject;
142
+ responses: OpenAPIV3.ResponsesObject;
143
+ callbacks?: {
144
+ [callback: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.CallbackObject;
145
+ };
146
+ deprecated?: boolean;
147
+ security?: OpenAPIV3.SecurityRequirementObject[];
148
+ servers?: OpenAPIV3.ServerObject[];
149
+ } | undefined;
150
+ trace?: {
151
+ tags?: string[];
152
+ summary?: string;
153
+ description?: string;
154
+ externalDocs?: OpenAPIV3.ExternalDocumentationObject;
155
+ operationId?: string;
156
+ parameters?: (OpenAPIV3.ReferenceObject | OpenAPIV3.ParameterObject)[];
157
+ requestBody?: OpenAPIV3.ReferenceObject | OpenAPIV3.RequestBodyObject;
158
+ responses: OpenAPIV3.ResponsesObject;
159
+ callbacks?: {
160
+ [callback: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.CallbackObject;
161
+ };
162
+ deprecated?: boolean;
163
+ security?: OpenAPIV3.SecurityRequirementObject[];
164
+ servers?: OpenAPIV3.ServerObject[];
165
+ } | undefined;
166
+ }) | undefined;
167
+ };
168
+ components: {
169
+ schemas: {
170
+ [x: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.SchemaObject;
171
+ };
172
+ responses?: {
173
+ [key: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.ResponseObject;
174
+ };
175
+ parameters?: {
176
+ [key: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.ParameterObject;
177
+ };
178
+ examples?: {
179
+ [key: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.ExampleObject;
180
+ };
181
+ requestBodies?: {
182
+ [key: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.RequestBodyObject;
183
+ };
184
+ headers?: {
185
+ [key: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.HeaderObject;
186
+ };
187
+ securitySchemes?: {
188
+ [key: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.SecuritySchemeObject;
189
+ };
190
+ links?: {
191
+ [key: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.LinkObject;
192
+ };
193
+ callbacks?: {
194
+ [key: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.CallbackObject;
195
+ };
196
+ };
197
+ openapi: string;
198
+ servers?: OpenAPIV3.ServerObject[] | undefined;
199
+ security?: OpenAPIV3.SecurityRequirementObject[] | undefined;
200
+ externalDocs?: OpenAPIV3.ExternalDocumentationObject | undefined;
201
+ }>;
package/src/route.d.ts CHANGED
@@ -1,3 +1,43 @@
1
- import type { Env, Input, MiddlewareHandler } from "hono/types";
2
- import type { DescribeRouteOptions } from "./types";
3
- export declare function describeRoute<E extends Env = Env, P extends string = string, I extends Input = Input>(specs: DescribeRouteOptions<E, P, I>): MiddlewareHandler<E, P, I>;
1
+ import type { MiddlewareHandler } from "hono/types";
2
+ import type { DescribeRouteOptions, OpenAPIRouteHandlerConfig } from "./types.js";
3
+ /**
4
+ * Describe a route with OpenAPI specs.
5
+ * @param specs Options for describing a route
6
+ * @returns Middleware handler
7
+ */
8
+ export declare function describeRoute(specs: DescribeRouteOptions): MiddlewareHandler;
9
+ /**
10
+ * Generate OpenAPI specs for the given route
11
+ * @param config Route handler configuration
12
+ * @param docs Route description in OpenAPI specs
13
+ * @param defaultOptions Default options for describing a route
14
+ */
15
+ export declare function generateRouteSpecs(config: OpenAPIRouteHandlerConfig, docs: DescribeRouteOptions, defaultOptions?: DescribeRouteOptions): Promise<{
16
+ docs: {
17
+ responses: {
18
+ [x: string]: import("openapi-types").OpenAPIV3.ReferenceObject | (import("openapi-types").OpenAPIV3.ResponseObject & {
19
+ content?: {
20
+ [key: string]: Omit<import("openapi-types").OpenAPIV3.MediaTypeObject, "schema"> & {
21
+ schema?: import("openapi-types").OpenAPIV3.ReferenceObject | import("openapi-types").OpenAPIV3.SchemaObject | import("./types.js").ResolverResult;
22
+ };
23
+ };
24
+ });
25
+ };
26
+ tags?: string[];
27
+ summary?: string;
28
+ description?: string;
29
+ externalDocs?: import("openapi-types").OpenAPIV3.ExternalDocumentationObject;
30
+ operationId?: string;
31
+ parameters?: (import("openapi-types").OpenAPIV3.ReferenceObject | import("openapi-types").OpenAPIV3.ParameterObject)[];
32
+ requestBody?: import("openapi-types").OpenAPIV3.ReferenceObject | import("openapi-types").OpenAPIV3.RequestBodyObject;
33
+ callbacks?: {
34
+ [callback: string]: import("openapi-types").OpenAPIV3.ReferenceObject | import("openapi-types").OpenAPIV3.CallbackObject;
35
+ };
36
+ deprecated?: boolean;
37
+ security?: import("openapi-types").OpenAPIV3.SecurityRequirementObject[];
38
+ servers?: import("openapi-types").OpenAPIV3.ServerObject[];
39
+ hide?: boolean | (<E extends import("hono").Env = import("hono").Env, P extends string = string, I extends import("hono").Input = import("hono/types").BlankInput>(c: import("hono").Context<E, P, I>) => boolean);
40
+ validateResponse?: boolean;
41
+ };
42
+ components: {};
43
+ }>;
@@ -1,4 +1,6 @@
1
1
  import type { JSONSchema, ParserOptions } from "@apidevtools/json-schema-ref-parser";
2
+ import type { JSONSchema4 } from "json-schema";
3
+ import type { OpenAPIV3 } from "openapi-types";
2
4
  export type addPrefixToObject = {
3
5
  [K in keyof JSONSchema as `x-${K}`]: JSONSchema[K];
4
6
  };
@@ -15,4 +17,5 @@ export type SchemaType = ExtendedJSONSchema & {
15
17
  nullable?: boolean;
16
18
  };
17
19
  export type SchemaTypeKeys = keyof SchemaType;
18
- export {};
20
+ declare const convert: <T extends object = JSONSchema4>(schema: T, options?: Options) => Promise<OpenAPIV3.Document>;
21
+ export default convert;
package/src/typebox.d.ts CHANGED
@@ -1,8 +1,20 @@
1
1
  import { type Hook } from "@hono/typebox-validator";
2
2
  import type { Static, TSchema } from "@sinclair/typebox";
3
3
  import type { Env, MiddlewareHandler, ValidationTargets } from "hono";
4
- import type { ResolverResult } from "./types";
4
+ import type { ResolverResult } from "./types.js";
5
+ /**
6
+ * Generate a resolver for a TypeBox schema
7
+ * @param schema TypeBox schema
8
+ * @returns Resolver result
9
+ */
5
10
  export declare function resolver<T extends TSchema>(schema: T): ResolverResult;
11
+ /**
12
+ * Create a validator middleware
13
+ * @param target Target for validation
14
+ * @param schema TypeBox schema
15
+ * @param hook Hook for validation
16
+ * @returns Middleware handler
17
+ */
6
18
  export declare function validator<T extends TSchema, Target extends keyof ValidationTargets, E extends Env, P extends string, V extends {
7
19
  in: {
8
20
  [K in Target]: Static<T>;
package/src/types.d.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  import type { Context, Env, Input } from "hono";
2
2
  import type { BlankInput } from "hono/types";
3
3
  import type { OpenAPIV3 } from "openapi-types";
4
- import type { ALLOWED_METHODS } from "./helper";
4
+ import type { ALLOWED_METHODS } from "./helper.js";
5
5
  export type HasUndefined<T> = undefined extends T ? true : false;
6
6
  export type PromiseOr<T> = T | Promise<T>;
7
7
  export type OpenAPIRouteHandlerConfig = {
@@ -18,20 +18,19 @@ export type ResolverResult = {
18
18
  validator: (values: unknown) => PromiseOr<void>;
19
19
  };
20
20
  export type HandlerResponse = {
21
- resolver: (config: OpenAPIRouteHandlerConfig) => PromiseOr<{
21
+ resolver: (config: OpenAPIRouteHandlerConfig, defaultOptions?: DescribeRouteOptions) => PromiseOr<{
22
22
  docs: OpenAPIV3.OperationObject;
23
23
  components?: OpenAPIV3.ComponentsObject["schemas"];
24
24
  }>;
25
25
  metadata?: Record<string, unknown>;
26
26
  };
27
- export type DescribeRouteOptions<E extends Env = Env, P extends string = string, I extends Input = BlankInput> = Omit<OpenAPIV3.OperationObject, "responses" | "requestBody" | "parameters"> & {
27
+ export type DescribeRouteOptions = Omit<OpenAPIV3.OperationObject, "responses"> & {
28
28
  /**
29
29
  * Pass `true` to hide route from OpenAPI/swagger document
30
30
  */
31
- hide?: boolean | ((c: Context<E, P, I>) => boolean);
31
+ hide?: boolean | (<E extends Env = Env, P extends string = string, I extends Input = BlankInput>(c: Context<E, P, I>) => boolean);
32
32
  /**
33
33
  * Validate response of the route
34
- * @experimental
35
34
  */
36
35
  validateResponse?: boolean;
37
36
  /**
@@ -79,4 +78,8 @@ export type OpenApiSpecsOptions = {
79
78
  * Exclude tags from OpenAPI
80
79
  */
81
80
  excludeTags?: string[];
81
+ /**
82
+ * Default options for `describeRoute` method
83
+ */
84
+ defaultOptions?: Partial<Record<(typeof ALLOWED_METHODS)[number] | "ALL", DescribeRouteOptions>>;
82
85
  };
package/src/utils.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import type { ValidationTargets } from "hono";
2
2
  import type { OpenAPIV3 } from "openapi-types";
3
- import type { ResolverResult } from "./types";
3
+ import type { ResolverResult } from "./types.js";
4
4
  export declare const uniqueSymbol: unique symbol;
5
5
  export declare function generateValidatorDocs<Target extends keyof ValidationTargets>(target: Target, _result: ReturnType<ResolverResult["builder"]>): Promise<{
6
6
  docs: Pick<{
package/src/valibot.d.ts CHANGED
@@ -1,8 +1,20 @@
1
1
  import { type Hook } from "@hono/valibot-validator";
2
2
  import type { Env, Input as HonoInput, MiddlewareHandler, ValidationTargets } from "hono";
3
3
  import { type BaseIssue, type BaseSchema, type GenericSchema, type GenericSchemaAsync, type InferInput, type InferOutput } from "valibot";
4
- import type { HasUndefined, ResolverResult } from "./types";
4
+ import type { HasUndefined, ResolverResult } from "./types.js";
5
+ /**
6
+ * Generate a resolver for a Valibot schema
7
+ * @param schema Valibot schema
8
+ * @returns Resolver result
9
+ */
5
10
  export declare function resolver<T extends BaseSchema<unknown, unknown, BaseIssue<unknown>>>(schema: T): ResolverResult;
11
+ /**
12
+ * Create a validator middleware
13
+ * @param target Target for validation
14
+ * @param schema Valibot schema
15
+ * @param hook Hook for validation
16
+ * @returns Middleware handler
17
+ */
6
18
  export declare function validator<T extends GenericSchema | GenericSchemaAsync, Target extends keyof ValidationTargets, E extends Env, P extends string, In = InferInput<T>, Out = InferOutput<T>, I extends HonoInput = {
7
19
  in: HasUndefined<In> extends true ? {
8
20
  [K in Target]?: K extends "json" ? In : HasUndefined<keyof ValidationTargets[K]> extends true ? {
package/src/zod.d.ts CHANGED
@@ -1,8 +1,20 @@
1
1
  import { type Hook } from "@hono/zod-validator";
2
2
  import type { Env, Input, MiddlewareHandler, ValidationTargets } from "hono";
3
3
  import type { ZodSchema, z } from "zod";
4
- import type { HasUndefined, ResolverResult } from "./types";
4
+ import type { HasUndefined, ResolverResult } from "./types.js";
5
+ /**
6
+ * Generate a resolver for a Zod schema
7
+ * @param schema Zod schema
8
+ * @returns Resolver result
9
+ */
5
10
  export declare function resolver<T extends ZodSchema>(schema: T): ResolverResult;
11
+ /**
12
+ * Create a validator middleware
13
+ * @param target Target for validation
14
+ * @param schema Zod schema
15
+ * @param hook Hook for validation
16
+ * @returns Middleware handler
17
+ */
6
18
  export declare function validator<T extends ZodSchema, Target extends keyof ValidationTargets, E extends Env, P extends string, In = z.input<T>, Out = z.output<T>, I extends Input = {
7
19
  in: HasUndefined<In> extends true ? {
8
20
  [K in Target]?: In extends ValidationTargets[K] ? In : {
package/typebox.cjs ADDED
@@ -0,0 +1 @@
1
+ "use strict";var e=require("@hono/typebox-validator"),r=require("@sinclair/typebox/value"),a=require("./toOpenAPISchema.cjs"),t=require("./utils.cjs");function i(e){return{builder:async r=>({schema:await a.convert(e)}),validator:a=>{r.Value.Parse(e,a)}}}require("json-schema-walker"),exports.resolver=i,exports.validator=function(r,a,o){const s=e.tbValidator(r,a,o);return Object.assign(s,{[t.uniqueSymbol]:{resolver:async e=>t.generateValidatorDocs(r,await i(a).builder(e))}})};
package/typebox.d.ts ADDED
@@ -0,0 +1 @@
1
+ export type * from "./src/typebox.js";
package/typebox.js ADDED
@@ -0,0 +1 @@
1
+ import{tbValidator as r}from"@hono/typebox-validator";import{Value as o}from"@sinclair/typebox/value";import{c as a}from"./toOpenAPISchema.js";import{u as t,g as e}from"./utils.js";import"json-schema-walker";function i(r){return{builder:async o=>({schema:await a(r)}),validator:a=>{o.Parse(r,a)}}}function s(o,a,s){const n=r(o,a,s);return Object.assign(n,{[t]:{resolver:async r=>e(o,await i(a).builder(r))}})}export{i as resolver,s as validator};
package/valibot.cjs ADDED
@@ -0,0 +1 @@
1
+ "use strict";var e=require("@hono/valibot-validator"),r=require("@valibot/to-json-schema"),a=require("valibot"),t=require("./toOpenAPISchema.cjs"),o=require("./utils.cjs");function i(e){return{builder:async a=>({schema:await t.convert(r.toJsonSchema(e))}),validator:async r=>{await a.parseAsync(e,r)}}}require("json-schema-walker"),exports.resolver=i,exports.validator=function(r,a,t){const s=e.vValidator(r,a,t);return Object.assign(s,{[o.uniqueSymbol]:{resolver:async e=>o.generateValidatorDocs(r,await i(a).builder(e))}})};
package/valibot.d.ts ADDED
@@ -0,0 +1 @@
1
+ export type * from "./src/valibot.js";
package/valibot.js ADDED
@@ -0,0 +1 @@
1
+ import{vValidator as o}from"@hono/valibot-validator";import{toJsonSchema as a}from"@valibot/to-json-schema";import{parseAsync as t}from"valibot";import{c as r}from"./toOpenAPISchema.js";import{u as i,g as s}from"./utils.js";import"json-schema-walker";function m(o){return{builder:async t=>({schema:await r(a(o))}),validator:async a=>{await t(o,a)}}}function n(a,t,r){const n=o(a,t,r);return Object.assign(n,{[i]:{resolver:async o=>s(a,await m(t).builder(o))}})}export{m as resolver,n as validator};
package/zod.cjs ADDED
@@ -0,0 +1 @@
1
+ "use strict";var e=require("@hono/zod-validator"),r=require("zod-openapi"),a=require("./utils.cjs");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"}}})};
package/zod.d.ts ADDED
@@ -0,0 +1 @@
1
+ export type * from "./src/zod.js";
package/zod.js ADDED
@@ -0,0 +1 @@
1
+ import{zValidator as o}from"@hono/zod-validator";import{createSchema as r}from"zod-openapi";import{u as t,g as a}from"./utils.js";function i(o){return{builder:t=>{const{version:a,...i}=t??{};return r(o,t?{openapi:a,...i}:void 0)},validator:o.parse}}function e(r,e,n){const s=o(r,e,n);return Object.assign(s,{[t]:{resolver:async o=>a(r,await i(e).builder(o)),metadata:{schemaType:"input"}}})}export{i as resolver,e as validator};
package/arktype.cjs.js DELETED
@@ -1 +0,0 @@
1
- "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 DELETED
@@ -1 +0,0 @@
1
- export * from "./src/arktype";
package/arktype.esm.js DELETED
@@ -1 +0,0 @@
1
- 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.js DELETED
@@ -1 +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 DELETED
@@ -1 +0,0 @@
1
- export * from "./src/effect";
package/effect.esm.js DELETED
@@ -1 +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.js DELETED
@@ -1 +0,0 @@
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];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.esm.d.ts DELETED
@@ -1 +0,0 @@
1
- export * from "./src/index";
package/index.esm.js DELETED
@@ -1 +0,0 @@
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=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};
@@ -1 +0,0 @@
1
- export declare const allowedKeywords: string[];
@@ -1,5 +0,0 @@
1
- import type { JSONSchema4 } from "json-schema";
2
- import type { OpenAPIV3 } from "openapi-types";
3
- import type { Options } from "./types";
4
- declare const convert: <T extends object = JSONSchema4>(schema: T, options?: Options) => Promise<OpenAPIV3.Document>;
5
- export default convert;
package/typebox.cjs.js DELETED
@@ -1 +0,0 @@
1
- "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 DELETED
@@ -1 +0,0 @@
1
- export * from "./src/typebox";
package/typebox.esm.js DELETED
@@ -1 +0,0 @@
1
- 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/valibot.cjs.js DELETED
@@ -1 +0,0 @@
1
- "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 DELETED
@@ -1 +0,0 @@
1
- export * from "./src/valibot";
package/valibot.esm.js DELETED
@@ -1 +0,0 @@
1
- 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.js DELETED
@@ -1 +0,0 @@
1
- "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"}}})};
package/zod.esm.d.ts DELETED
@@ -1 +0,0 @@
1
- export * from "./src/zod";
package/zod.esm.js DELETED
@@ -1 +0,0 @@
1
- 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};
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes