hono-openapi 0.1.0

package/LICENSE

@@ -0,0 +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.

package/README.md

@@ -0,0 +1,86 @@
+# Hono OpenAPI
+
+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/)
+- [ ] [TypeBox](https://github.com/sinclairzx81/typebox) (coming soon)
+- [ ] [Valibot](https://valibot.dev/) (coming soon)
+
+> [!Note]
+> This package doesn't validate the responses schema, it only generates the OpenAPI specification from it. You should use the validation library to validate your response data, if you wanna do it.
+
+## Usage
+
+To generate the OpenAPI specification, run the following command:
+
+```bash
+pnpm add hono-openapi
+```
+
+And you can now start defining your routes and generating the OpenAPI specification. Here is an example using Zod:
+
+```ts
+// For extending the Zod schema with OpenAPI properties
+import "zod-openapi/extend";
+
+import z from "zod";
+import { Hono } from "hono";
+import { zodResolver } from "hono-openapi/zod";
+import { zValidator } from "@hono/zod-validator";
+import { describeRoute, openAPISpecs } from "hono-openapi";
+
+const app = new Hono();
+
+const schema = z.object({
+  name: z.string().optional().openapi({ example: "Steven", ref: "name" }),
+});
+
+const nameValidation = z.object({
+  name: z
+    .string()
+    .optional()
+    .openapi({ example: "Steven", description: "User Name", ref: "name" }),
+});
+
+app.get(
+  "/",
+  describeRoute({
+    description: "Say hello to the user",
+    responses: {
+      200: {
+        description: "Successful greeting response",
+        content: {
+          "text/plain": {
+            schema: {
+              type: "string",
+              example: "Hello Steven!",
+            },
+          },
+        },
+      },
+    },
+  }),
+  zValidator("query", nameValidation),
+  (c) => {
+    const query = c.req.valid("query");
+    return c.text(`Hello ${query?.name ?? "Hono"}!`);
+  }
+);
+
+app.get(
+  "/openapi",
+  openAPISpecs(app, {
+    documentation: {
+      info: { title: "Hono", version: "1.0.0" },
+      servers: [
+        {
+          url: "http://localhost:3000",
+          description: "Local server",
+        },
+      ],
+    },
+  })
+);
+```

package/index.cjs.js

@@ -0,0 +1 @@
+"use strict";var e=require("./utils.cjs.js");exports.describeRoute=function(t){return Object.assign((async(e,t)=>{await t()}),{[e.uniqueSymbol]:{resolver:e=>{const o={...t};let n={};if(o.responses)for(const t of Object.keys(o.responses)){const s=o.responses[t];if(!s||"content"in s)for(const t of Object.keys(s.content??{})){const o=s.content?.[t];if(o&&(o.schema&&"builder"in o.schema)){const t=o.schema.builder(e);o.schema=t.schema,t.components&&(n={...n,...t.components})}}}return{docs:o,components:n}}}})},exports.openAPISpecs=function(t,{documentation:o={},excludeStaticFile:n=!0,exclude:s=[],excludeMethods:c=["OPTIONS"],excludeTags:i=[]}={documentation:{},excludeStaticFile:!0,exclude:[],excludeMethods:["OPTIONS"],excludeTags:[]}){const a={version:"3.0.3",components:{}},r={};for(const o of t.routes){if(!(e.uniqueSymbol in o.handler))continue;if(c.includes(o.method))continue;if(!1===e.ALLOWED_METHODS.includes(o.method)&&"ALL"!==o.method)continue;const{resolver:t,metadata:n={}}=o.handler[e.uniqueSymbol],{docs:s,components:i}=t({...a,...n});if(a.components={...a.components,...i??{}},"ALL"===o.method)for(const t of e.ALLOWED_METHODS)e.registerSchemaPath({path:o.path,data:s,method:t,schema:r});else e.registerSchemaPath({method:o.method,path:o.path,data:s,schema:r})}for(const e in r)for(const t in r[e])r[e][t].hide&&delete r[e][t];const m={openapi:a.version,...{...o,tags:o.tags?.filter((e=>!i?.includes(e?.name))),info:{title:"Hono Documentation",description:"Development documentation",version:"0.0.0",...o.info},paths:{...e.filterPaths(r,{excludeStaticFile:n,exclude:Array.isArray(s)?s:[s]}),...o.paths},components:{...o.components,schemas:{...a.components,...o.components?.schemas}}}};return e=>e.json(m)};

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "hono-openapi",
+  "description": "OpenAPI schema generator for Hono",
+  "version": "0.1.0",
+  "license": "MIT",
+  "keywords": [
+    "hono",
+    "openapi"
+  ],
+  "homepage": "https://github.com/rhinobase/hono-openapi",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/rhinobase/hono-openapi.git",
+    "directory": "packages/ui"
+  },
+  "bugs": {
+    "url": "https://github.com/rhinobase/hono-openapi/issues"
+  },
+  "dependencies": {},
+  "main": "./index.cjs.js",
+  "module": "./index.esm.js",
+  "files": [
+    "dist",
+    "!**/*.tsbuildinfo"
+  ],
+  "peerDependencies": {
+    "hono": "^4.6.4"
+  },
+  "optionalDependencies": {
+    "@hono/zod-validator": "^0.4.1",
+    "zod": "^3.23.8",
+    "zod-openapi": "^3.1.1"
+  },
+  "devDependencies": {
+    "@rollup/plugin-terser": "^0.4.4",
+    "openapi-types": "^12.1.3"
+  },
+  "exports": {
+    ".": {
+      "import": "./index.esm.js",
+      "require": "./index.cjs.js",
+      "types": "./index.cjs.d.ts"
+    },
+    "./zod": {
+      "import": "./zod.esm.js",
+      "require": "./zod.cjs.js",
+      "types": "./zod.cjs.d.ts"
+    }
+  },
+  "types": "./index.esm.d.ts"
+}