@hono/zod-openapi 0.0.1

package/README.md

@@ -0,0 +1,129 @@
+# Zod OpenAPI Hono
+
+A wrapper class for Hono that supports OpenAPI. With it, you can validate values and types using [Zod](https://zod.dev/) and generate OpenAPI Swagger documentation.
+This is based on [Zod to OpenAPI](https://github.com/asteasolutions/zod-to-openapi).
+For details on creating schemas and defining routes, please refer to this resource.
+
+_This is not a middleware but hosted on this monorepo_
+
+## Usage
+
+### Install
+
+```
+npm i hono zod @hono/zod-openapi
+```
+
+### Write your application
+
+Define schemas:
+
+```ts
+import { z } from '@hono/zod-openapi'
+
+const ParamsSchema = z.object({
+  id: z
+    .string()
+    .min(3)
+    .openapi({
+      param: {
+        name: 'id',
+        in: 'path',
+      },
+      example: '1212121',
+    }),
+})
+
+const UserSchema = z
+  .object({
+    id: z.number().openapi({
+      example: 123,
+    }),
+    name: z.string().openapi({
+      example: 'John Doe',
+    }),
+    age: z.number().openapi({
+      example: 42,
+    }),
+  })
+  .openapi('User')
+```
+
+Create routes:
+
+```ts
+import { createRoute } from '@hono/zod-openapi'
+
+const route = createRoute({
+  method: 'get',
+  path: '/users/:id',
+  request: {
+    params: ParamsSchema,
+  },
+  responses: {
+    200: {
+      content: {
+        'application/json': {
+          schema: UserSchema,
+        },
+      },
+      description: 'Get the user',
+    },
+    400: {
+      content: {
+        'application/json': {
+          schema: ErrorSchema,
+        },
+      },
+      description: 'Error!',
+    },
+  },
+})
+```
+
+Create the App:
+
+```ts
+import { OpenAPIHono } from '@hono/zod-openapi'
+
+const app = new OpenAPIHono()
+
+app.openapi(
+  route,
+  (c) => {
+    const { id } = c.req.valid('param')
+    return c.jsonT({
+      id: Number(id),
+      age: 20,
+      name: 'Ultra-man',
+    })
+  },
+  (result, c) => {
+    if (!result.success) {
+      const res = c.jsonT(
+        {
+          ok: false,
+        },
+        400
+      )
+      return res
+    }
+  }
+)
+
+app.doc('/doc', {
+  openapi: '3.0.0',
+  info: {
+    version: '1.0.0',
+    title: 'My API',
+  },
+})
+```
+
+## Author
+
+Yusuke Wada <https://github.com/yusukebe>
+
+## License
+
+MIT

package/dist/index.cjs

@@ -0,0 +1,111 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var __accessCheck = (obj, member, msg) => {
+  if (!member.has(obj))
+    throw TypeError("Cannot " + msg);
+};
+var __privateGet = (obj, member, getter) => {
+  __accessCheck(obj, member, "read from private field");
+  return getter ? getter.call(obj) : member.get(obj);
+};
+var __privateAdd = (obj, member, value) => {
+  if (member.has(obj))
+    throw TypeError("Cannot add the same private member more than once");
+  member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
+};
+var __privateSet = (obj, member, value, setter) => {
+  __accessCheck(obj, member, "write to private field");
+  setter ? setter.call(obj, value) : member.set(obj, value);
+  return value;
+};
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  OpenAPIHono: () => OpenAPIHono,
+  createRoute: () => createRoute,
+  z: () => import_zod.z
+});
+module.exports = __toCommonJS(src_exports);
+var import_zod_to_openapi = require("@asteasolutions/zod-to-openapi");
+var import_zod_to_openapi2 = require("@asteasolutions/zod-to-openapi");
+var import_zod_validator = require("@hono/zod-validator");
+var import_hono = require("hono");
+var import_zod = require("zod");
+var _registry;
+var OpenAPIHono = class extends import_hono.Hono {
+  constructor() {
+    super();
+    __privateAdd(this, _registry, void 0);
+    this.openapi = (route, handler, hook) => {
+      __privateGet(this, _registry).registerPath(route);
+      const validators = [];
+      if (route.request?.query) {
+        const validator = (0, import_zod_validator.zValidator)("query", route.request.query, hook);
+        validators.push(validator);
+      }
+      if (route.request?.params) {
+        const validator = (0, import_zod_validator.zValidator)("param", route.request.params, hook);
+        validators.push(validator);
+      }
+      const bodyContent = route.request?.body?.content;
+      if (bodyContent) {
+        for (const mediaType of Object.keys(bodyContent)) {
+          if (mediaType.startsWith("application/json")) {
+            const schema = bodyContent[mediaType]["schema"];
+            if (schema instanceof import_zod.ZodType) {
+              const validator = (0, import_zod_validator.zValidator)("json", schema, hook);
+              validators.push(validator);
+            }
+          }
+          if (mediaType.startsWith("multipart/form-data") || mediaType.startsWith("application/x-www-form-urlencoded")) {
+            const schema = bodyContent[mediaType]["schema"];
+            if (schema instanceof import_zod.ZodType) {
+              const validator = (0, import_zod_validator.zValidator)("form", schema, hook);
+              validators.push(validator);
+            }
+          }
+        }
+      }
+      this.on([route.method], route.path, ...validators, handler);
+      return this;
+    };
+    this.getOpenAPIDocument = (config) => {
+      const generator = new import_zod_to_openapi.OpenApiGeneratorV3(__privateGet(this, _registry).definitions);
+      const document = generator.generateDocument(config);
+      return document;
+    };
+    this.doc = (path, config) => {
+      this.get(path, (c) => {
+        const document = this.getOpenAPIDocument(config);
+        return c.json(document);
+      });
+    };
+    __privateSet(this, _registry, new import_zod_to_openapi.OpenAPIRegistry());
+  }
+};
+_registry = new WeakMap();
+var createRoute = (routeConfig) => routeConfig;
+(0, import_zod_to_openapi2.extendZodWithOpenApi)(import_zod.z);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  OpenAPIHono,
+  createRoute,
+  z
+});

package/dist/index.d.cts

@@ -0,0 +1,52 @@
+import * as openapi3_ts_oas30 from 'openapi3-ts/oas30';
+import { RouteConfig, ZodRequestBody, ZodContentObject, ResponseConfig } from '@asteasolutions/zod-to-openapi';
+import { OpenAPIObjectConfig } from '@asteasolutions/zod-to-openapi/dist/v3.0/openapi-generator';
+import { Env, Hono, Input, Handler, Context, TypedResponse } from 'hono';
+import { AnyZodObject, z, ZodSchema, ZodError, ZodType } from 'zod';
+export { z } from 'zod';
+
+type RequestTypes = {
+    body?: ZodRequestBody;
+    params?: AnyZodObject;
+    query?: AnyZodObject;
+    cookies?: AnyZodObject;
+    headers?: AnyZodObject | ZodType<unknown>[];
+};
+type IsJson<T> = T extends string ? T extends `application/json${infer _Rest}` ? 'json' : never : never;
+type IsForm<T> = T extends string ? T extends `multipart/form-data${infer _Rest}` | `application/x-www-form-urlencoded${infer _Rest}` ? 'form' : never : never;
+type RequestPart<R extends RouteConfig, Part extends string> = Part extends keyof R['request'] ? R['request'][Part] : never;
+type InputTypeBase<R extends RouteConfig, Part extends string, Type extends string> = R['request'] extends RequestTypes ? RequestPart<R, Part> extends AnyZodObject ? {
+    out: {
+        [K in Type]: z.input<RequestPart<R, Part>>;
+    };
+} : {} : {};
+type InputTypeJson<R extends RouteConfig> = R['request'] extends RequestTypes ? R['request']['body'] extends ZodRequestBody ? R['request']['body']['content'] extends ZodContentObject ? IsJson<keyof R['request']['body']['content']> extends never ? {} : R['request']['body']['content'][keyof R['request']['body']['content']]['schema'] extends ZodSchema<any> ? {
+    out: {
+        json: z.input<R['request']['body']['content'][keyof R['request']['body']['content']]['schema']>;
+    };
+} : {} : {} : {} : {};
+type InputTypeForm<R extends RouteConfig> = R['request'] extends RequestTypes ? R['request']['body'] extends ZodRequestBody ? R['request']['body']['content'] extends ZodContentObject ? IsForm<keyof R['request']['body']['content']> extends never ? {} : R['request']['body']['content'][keyof R['request']['body']['content']]['schema'] extends ZodSchema<any> ? {
+    out: {
+        form: z.input<R['request']['body']['content'][keyof R['request']['body']['content']]['schema']>;
+    };
+} : {} : {} : {} : {};
+type OutputType<R extends RouteConfig> = R['responses'] extends Record<infer _, infer C> ? C extends ResponseConfig ? C['content'] extends ZodContentObject ? IsJson<keyof C['content']> extends never ? {} : C['content'][keyof C['content']]['schema'] extends ZodSchema ? z.infer<C['content'][keyof C['content']]['schema']> : {} : {} : {} : {};
+type Hook<T, E extends Env, P extends string, O> = (result: {
+    success: true;
+    data: T;
+} | {
+    success: false;
+    error: ZodError;
+}, c: Context<E, P>) => TypedResponse<O> | Promise<TypedResponse<T>> | void;
+declare class OpenAPIHono<E extends Env = Env, S = {}, BasePath extends string = '/'> extends Hono<E, S, BasePath> {
+    #private;
+    constructor();
+    openapi: <R extends RouteConfig, I extends Input = InputTypeBase<R, "params", "param"> & InputTypeBase<R, "query", "query"> & InputTypeForm<R> & InputTypeJson<R>>(route: R, handler: Handler<E, R["path"], I, OutputType<R>>, hook?: Hook<I, E, R["path"], OutputType<R>> | undefined) => this;
+    getOpenAPIDocument: (config: OpenAPIObjectConfig) => openapi3_ts_oas30.OpenAPIObject;
+    doc: (path: string, config: OpenAPIObjectConfig) => void;
+}
+declare const createRoute: <P extends string, R extends Omit<RouteConfig, "path"> & {
+    path: P;
+}>(routeConfig: R) => R;
+
+export { OpenAPIHono, createRoute };

package/dist/index.d.ts

@@ -0,0 +1,52 @@
+import * as openapi3_ts_oas30 from 'openapi3-ts/oas30';
+import { RouteConfig, ZodRequestBody, ZodContentObject, ResponseConfig } from '@asteasolutions/zod-to-openapi';
+import { OpenAPIObjectConfig } from '@asteasolutions/zod-to-openapi/dist/v3.0/openapi-generator';
+import { Env, Hono, Input, Handler, Context, TypedResponse } from 'hono';
+import { AnyZodObject, z, ZodSchema, ZodError, ZodType } from 'zod';
+export { z } from 'zod';
+
+type RequestTypes = {
+    body?: ZodRequestBody;
+    params?: AnyZodObject;
+    query?: AnyZodObject;
+    cookies?: AnyZodObject;
+    headers?: AnyZodObject | ZodType<unknown>[];
+};
+type IsJson<T> = T extends string ? T extends `application/json${infer _Rest}` ? 'json' : never : never;
+type IsForm<T> = T extends string ? T extends `multipart/form-data${infer _Rest}` | `application/x-www-form-urlencoded${infer _Rest}` ? 'form' : never : never;
+type RequestPart<R extends RouteConfig, Part extends string> = Part extends keyof R['request'] ? R['request'][Part] : never;
+type InputTypeBase<R extends RouteConfig, Part extends string, Type extends string> = R['request'] extends RequestTypes ? RequestPart<R, Part> extends AnyZodObject ? {
+    out: {
+        [K in Type]: z.input<RequestPart<R, Part>>;
+    };
+} : {} : {};
+type InputTypeJson<R extends RouteConfig> = R['request'] extends RequestTypes ? R['request']['body'] extends ZodRequestBody ? R['request']['body']['content'] extends ZodContentObject ? IsJson<keyof R['request']['body']['content']> extends never ? {} : R['request']['body']['content'][keyof R['request']['body']['content']]['schema'] extends ZodSchema<any> ? {
+    out: {
+        json: z.input<R['request']['body']['content'][keyof R['request']['body']['content']]['schema']>;
+    };
+} : {} : {} : {} : {};
+type InputTypeForm<R extends RouteConfig> = R['request'] extends RequestTypes ? R['request']['body'] extends ZodRequestBody ? R['request']['body']['content'] extends ZodContentObject ? IsForm<keyof R['request']['body']['content']> extends never ? {} : R['request']['body']['content'][keyof R['request']['body']['content']]['schema'] extends ZodSchema<any> ? {
+    out: {
+        form: z.input<R['request']['body']['content'][keyof R['request']['body']['content']]['schema']>;
+    };
+} : {} : {} : {} : {};
+type OutputType<R extends RouteConfig> = R['responses'] extends Record<infer _, infer C> ? C extends ResponseConfig ? C['content'] extends ZodContentObject ? IsJson<keyof C['content']> extends never ? {} : C['content'][keyof C['content']]['schema'] extends ZodSchema ? z.infer<C['content'][keyof C['content']]['schema']> : {} : {} : {} : {};
+type Hook<T, E extends Env, P extends string, O> = (result: {
+    success: true;
+    data: T;
+} | {
+    success: false;
+    error: ZodError;
+}, c: Context<E, P>) => TypedResponse<O> | Promise<TypedResponse<T>> | void;
+declare class OpenAPIHono<E extends Env = Env, S = {}, BasePath extends string = '/'> extends Hono<E, S, BasePath> {
+    #private;
+    constructor();
+    openapi: <R extends RouteConfig, I extends Input = InputTypeBase<R, "params", "param"> & InputTypeBase<R, "query", "query"> & InputTypeForm<R> & InputTypeJson<R>>(route: R, handler: Handler<E, R["path"], I, OutputType<R>>, hook?: Hook<I, E, R["path"], OutputType<R>> | undefined) => this;
+    getOpenAPIDocument: (config: OpenAPIObjectConfig) => openapi3_ts_oas30.OpenAPIObject;
+    doc: (path: string, config: OpenAPIObjectConfig) => void;
+}
+declare const createRoute: <P extends string, R extends Omit<RouteConfig, "path"> & {
+    path: P;
+}>(routeConfig: R) => R;
+
+export { OpenAPIHono, createRoute };

package/dist/index.js

@@ -0,0 +1,85 @@
+var __accessCheck = (obj, member, msg) => {
+  if (!member.has(obj))
+    throw TypeError("Cannot " + msg);
+};
+var __privateGet = (obj, member, getter) => {
+  __accessCheck(obj, member, "read from private field");
+  return getter ? getter.call(obj) : member.get(obj);
+};
+var __privateAdd = (obj, member, value) => {
+  if (member.has(obj))
+    throw TypeError("Cannot add the same private member more than once");
+  member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
+};
+var __privateSet = (obj, member, value, setter) => {
+  __accessCheck(obj, member, "write to private field");
+  setter ? setter.call(obj, value) : member.set(obj, value);
+  return value;
+};
+
+// src/index.ts
+import { OpenApiGeneratorV3, OpenAPIRegistry } from "@asteasolutions/zod-to-openapi";
+import { extendZodWithOpenApi } from "@asteasolutions/zod-to-openapi";
+import { zValidator } from "@hono/zod-validator";
+import { Hono } from "hono";
+import { z, ZodType } from "zod";
+var _registry;
+var OpenAPIHono = class extends Hono {
+  constructor() {
+    super();
+    __privateAdd(this, _registry, void 0);
+    this.openapi = (route, handler, hook) => {
+      __privateGet(this, _registry).registerPath(route);
+      const validators = [];
+      if (route.request?.query) {
+        const validator = zValidator("query", route.request.query, hook);
+        validators.push(validator);
+      }
+      if (route.request?.params) {
+        const validator = zValidator("param", route.request.params, hook);
+        validators.push(validator);
+      }
+      const bodyContent = route.request?.body?.content;
+      if (bodyContent) {
+        for (const mediaType of Object.keys(bodyContent)) {
+          if (mediaType.startsWith("application/json")) {
+            const schema = bodyContent[mediaType]["schema"];
+            if (schema instanceof ZodType) {
+              const validator = zValidator("json", schema, hook);
+              validators.push(validator);
+            }
+          }
+          if (mediaType.startsWith("multipart/form-data") || mediaType.startsWith("application/x-www-form-urlencoded")) {
+            const schema = bodyContent[mediaType]["schema"];
+            if (schema instanceof ZodType) {
+              const validator = zValidator("form", schema, hook);
+              validators.push(validator);
+            }
+          }
+        }
+      }
+      this.on([route.method], route.path, ...validators, handler);
+      return this;
+    };
+    this.getOpenAPIDocument = (config) => {
+      const generator = new OpenApiGeneratorV3(__privateGet(this, _registry).definitions);
+      const document = generator.generateDocument(config);
+      return document;
+    };
+    this.doc = (path, config) => {
+      this.get(path, (c) => {
+        const document = this.getOpenAPIDocument(config);
+        return c.json(document);
+      });
+    };
+    __privateSet(this, _registry, new OpenAPIRegistry());
+  }
+};
+_registry = new WeakMap();
+var createRoute = (routeConfig) => routeConfig;
+extendZodWithOpenApi(z);
+export {
+  OpenAPIHono,
+  createRoute,
+  z
+};

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@hono/zod-openapi",
+  "version": "0.0.1",
+  "description": "A wrapper class of Hono which supports OpenAPI.",
+  "type": "module",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "test": "vitest run",
+    "build": "tsup ./src/index.ts --format esm,cjs --dts",
+    "publint": "publint",
+    "release": "yarn build && yarn test && yarn publint && yarn publish"
+  },
+  "license": "MIT",
+  "private": false,
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org",
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/honojs/middleware.git"
+  },
+  "homepage": "https://github.com/honojs/middleware",
+  "peerDependencies": {
+    "hono": "*",
+    "zod": "3.*"
+  },
+  "devDependencies": {
+    "hono": "^3.4.3",
+    "zod": "^3.22.1"
+  },
+  "dependencies": {
+    "@asteasolutions/zod-to-openapi": "^5.5.0",
+    "@hono/zod-validator": "^0.1.7"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  }
+}