v0.5 #129

MathurAditya724 · 2025-06-29T08:09:07Z

Resolves #130, Resolves #125, Resolves #122, Resolves #116, Resolves #115, Resolves #114, Resolves #99, Resolves #97, Resolves #86, Resolves #82, Resolves #81, Resolves #78, Resolves #76, Resolves #67, Resolves #65, Resolves #61

Removed NX and made the package structure simpler
Support for Standard Schema
Add zod 4 Support
New response middleware for getting types in the handler
Optimisations

rawnly · 2025-07-06T00:55:20Z

Hey any plan to release an RC or Beta for this?

MathurAditya724 · 2025-07-06T01:14:11Z

Yeah, will release an RC today

vnphanquang · 2025-07-06T05:47:41Z

Would love if the RC can include #127 as well. Thanks a lot!

vladshcherbin · 2025-07-09T08:13:13Z

I'd also love to test the RC version

mstibbard · 2025-07-15T10:47:27Z

Also keen :)

MathurAditya724 · 2025-07-15T11:03:43Z

Sorry for the delay guys, just got busy. I will try to release a RC today for sure.

rawnly · 2025-07-16T21:14:20Z

So far no RC? I have a client project blocked by this atm :(, gotta rollback everything to older versions

MathurAditya724 · 2025-07-17T10:32:30Z

Hey Guys, I just released hono-openapi@0.5-rc.0(https://www.npmjs.com/package/hono-openapi/v/0.5.0-rc.0) check it out!

Here are the docs - https://rc.honohub.dev

mstibbard · 2025-07-17T10:47:33Z

Legend thank you! Was openAPIRouteHandler exported?

Dom-Mac · 2025-07-26T22:30:59Z

Hey mate, hope you had a nice weekend :)

Same error here, only the zod-to-json-schema error disappeared for me, effect and valibot errors are still there!

✘ [ERROR] Build failed with 2 errors:

  ✘ [ERROR] Could not resolve "effect"
  
      ../../node_modules/@standard-community/standard-json/dist/effect-BHXCUs57.js:4:48:
        4 │   const { JSONSchema } = await tryImport(import('effect'), "effect");
          ╵                                                 ~~~~~~~~
  
    You can mark the path "effect" as external to exclude it from the bundle, which will remove this
  error and leave the unresolved path in the bundle. You can also add ".catch()" here to handle this
  failure at run-time instead of bundle-time.
  
  
  ✘ [ERROR] Could not resolve "@valibot/to-json-schema"
  
      ../../node_modules/@standard-community/standard-json/dist/valibot-B3sSM057.js:5:11:
        5 │     import('@valibot/to-json-schema'),
          ╵            ~~~~~~~~~~~~~~~~~~~~~~~~~
  
    You can mark the path "@valibot/to-json-schema" as external to exclude it from the bundle, which
  will remove this error and leave the unresolved path in the bundle. You can also add ".catch()"
  here to handle this failure at run-time instead of bundle-time.

Thanks for the quick answer and for your work!

ImBIOS · 2025-07-28T03:45:04Z

@MathurAditya724 I noticed you do repetitive manual labor for RC publishing in PR, here you go I automate it for you and all the contributors:

feat: add automatic RC publishing for PRs #138

mstibbard · 2025-07-30T00:09:08Z

I still get all 3 errors when trying to run with wrangler on RC3.

 ✘ [ERROR] Could not resolve "effect"
...
  ✘ [ERROR] Could not resolve "@valibot/to-json-schema"
...
  ✘ [ERROR] Could not resolve "zod-to-json-schema"

It also does not like the way I've defined my ErrorResponse but that might be a zod v4 registry thing, or maybe even just a me-issue. Basically I have a shared error response schema for easy reuse, but using it causes the first hono route schema to not generate correctly... I know that's confusing, I'm happy to upload the simplest reproduction I can make if you are interested...

ayame113 · 2025-07-30T10:06:56Z

Thank you for this awesome project!

I am trying to use hono-openapi@0.5.0-rc.3 and zod v4. When I installed it, I got the following error.
~~Currently, peerDependency appears to only include zod v3. Would it be possible to include zod v4 in peer dependency?~~

Sorry, maybe standard-community/standard-openapi#2 is needed first to get zod v4 dependencies to work.
Anyway thanks for this project!

$ npm i hono-openapi@0.5.0-rc.3
npm error While resolving: undefined@undefined
npm error Found: zod@4.0.14
npm error node_modules/zod
npm error   zod@"^4.0.14" from the root project
npm error   peerOptional zod@"^3.25.0 || ^4.0.0" from @standard-community/standard-json@0.3.0-rc.3
npm error   node_modules/@standard-community/standard-json
npm error     peer @standard-community/standard-json@"^0.3.0-rc.3" from hono-openapi@0.5.0-rc.3
npm error     node_modules/hono-openapi
npm error       hono-openapi@"0.5.0-rc.3" from the root project
npm error     peer @standard-community/standard-json@"^0.3.0-rc.1" from @standard-community/standard-openapi@0.2.0-rc.1
npm error     node_modules/@standard-community/standard-openapi
npm error       peer @standard-community/standard-openapi@"^0.2.0-rc.1" from hono-openapi@0.5.0-rc.3
npm error       node_modules/hono-openapi
npm error         hono-openapi@"0.5.0-rc.3" from the root project
npm error   2 more (@standard-community/standard-openapi, zod-openapi)
npm error
npm error Could not resolve dependency:
npm error peerOptional zod@"^3.23.8" from hono-openapi@0.5.0-rc.3
npm error node_modules/hono-openapi
npm error   hono-openapi@"0.5.0-rc.3" from the root project

MathurAditya724 · 2025-07-31T08:48:08Z

Just released @standard-community/standard-json RC 4 can you try to install that and check does it now works in cloudflare?

MathurAditya724 · 2025-07-31T08:49:23Z

@MathurAditya724 I noticed you do repetitive manual labor for RC publishing in PR, here you go I automate it for you and all the contributors:

feat: add automatic RC publishing for PRs #138

Thanks for the initiative, really appreciate it. Just wanted to know, will it be better if we use pkg.new CI thing?

mstibbard · 2025-08-16T05:34:03Z

It also does not like the way I've defined my ErrorResponse but that might be a zod v4 registry thing, or maybe even just a me-issue. Basically I have a shared error response schema for easy reuse, but using it causes the first hono route schema to not generate correctly... I know that's confusing, I'm happy to upload the simplest reproduction I can make if you are interested...

Here's a reproduction for the:

imports issue ([ERROR] Could not resolve "effect" / "@valibot/to-json-schema" / "zod-to-json-schema"); and
unusual openapi schema generation behavior (to do with reusable ErrorResponse?)

MathurAditya724 · 2025-09-01T23:50:48Z

It also does not like the way I've defined my ErrorResponse but that might be a zod v4 registry thing, or maybe even just a me-issue. Basically I have a shared error response schema for easy reuse, but using it causes the first hono route schema to not generate correctly... I know that's confusing, I'm happy to upload the simplest reproduction I can make if you are interested...

Here's a reproduction for the:

imports issue ([ERROR] Could not resolve "effect" / "@valibot/to-json-schema" / "zod-to-json-schema"); and

unusual openapi schema generation behavior (to do with reusable ErrorResponse?)

I am not seeing this error, maybe it was happening previously because of cache. Can you try to do a clean install?

MathurAditya724 · 2025-09-04T07:36:03Z

I will be merging this in an hour, so if anyone can test it out before that or facing some issues let me know. I have already released RC 4 for testing.

This will be getting released as v1

Copilot

Pull Request Overview

This PR introduces a major v0.5 release that simplifies the package structure by removing NX, adds support for Standard Schema V1 and Zod v4, introduces response middleware for better type inference, and includes various optimizations.

Key changes include:

Complete architectural refactor from NX-based monorepo to simplified single package
Migration to Standard Schema V1 compliance for universal validation library support
New response middleware system for improved type safety

Reviewed Changes

Copilot reviewed 72 out of 75 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
src/handler.ts	Core OpenAPI spec generation logic with caching and improved path filtering
src/middlewares.ts	New validator and response description middleware with Standard Schema support
src/types.ts	Type definitions for the new architecture including response handlers
src/utils.ts	Utility functions for path conversion, operation ID generation, and schema merging
package.json	Updated to single package configuration with Standard Schema dependencies

Comments suppressed due to low confidence (2)

src/handler.ts:1

The @ts-expect-error comment indicates a type mismatch. Consider properly typing the mergeParameters function or adding appropriate type assertions to resolve this issue.

import type { Context, Env, Hono } from "hono";

src/handler.ts:1

The @ts-expect-error comment indicates a type issue with the paths object assignment. Consider properly typing the paths object structure or using appropriate type assertions.

import type { Context, Env, Hono } from "hono";

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

src/__tests__/zodv4.test.ts

Copilot · 2025-09-04T07:37:59Z

src/utils.ts

+      // @ts-expect-error
+      paths[path][method] = mergeSpecs(
+        route,
+        ...pathContext,
+        paths[path]?.[method],
+        specs,
+      );


The @ts-expect-error comment indicates a type issue that should be resolved. Consider properly typing the paths object or using a more specific type assertion to improve code maintainability and type safety.

Suggested change

// @ts-expect-error

paths[path][method] = mergeSpecs(

route,

...pathContext,

paths[path]?.[method],

specs,

);

(paths[path] as OpenAPIV3_1.PathItemObject)[method] = mergeSpecs(

route,

...pathContext,

paths[path]?.[method],

specs,

);

Copilot · 2025-09-04T07:38:00Z

src/middlewares.ts

+ */
+export function validator<
+  Schema extends StandardSchemaV1,
+  Target extends keyof ValidationTargets,
+  E extends Env,
+  P extends string,
+  In = StandardSchemaV1.InferInput<Schema>,
+  Out = StandardSchemaV1.InferOutput<Schema>,
+  I extends Input = {
+    in: HasUndefined<In> extends true
+      ? {
+          [K in Target]?: In extends ValidationTargets[K]
+            ? In
+            : { [K2 in keyof In]?: ValidationTargets[K][K2] };
+        }
+      : {
+          [K in Target]: In extends ValidationTargets[K]
+            ? In
+            : { [K2 in keyof In]: ValidationTargets[K][K2] };
+        };
+    out: { [K in Target]: Out };
+  },
+  V extends I = I,
+>(
+  target: Target,
+  schema: Schema,
+  hook?: Hook<StandardSchemaV1.InferOutput<Schema>, E, P, Target>,
+  options?: ResolverReturnType["options"],
+): MiddlewareHandler<E, P, V> {
+  const middleware = sValidator(target, schema, hook);
+
+  // @ts-expect-error not typed well
+  return Object.assign(middleware, {
+    [uniqueSymbol]: {
+      target,
+      ...resolver(schema, options),
+      options,
+    },
+  });
+}
+


The @ts-expect-error comment suggests incomplete typing. Consider properly typing the middleware return value or the Object.assign operation to improve type safety.

Suggested change

*/

export function validator<

Schema extends StandardSchemaV1,

Target extends keyof ValidationTargets,

E extends Env,

P extends string,

In = StandardSchemaV1.InferInput<Schema>,

Out = StandardSchemaV1.InferOutput<Schema>,

I extends Input = {

in: HasUndefined<In> extends true

? {

[K in Target]?: In extends ValidationTargets[K]

? In

: { [K2 in keyof In]?: ValidationTargets[K][K2] };

}

: {

[K in Target]: In extends ValidationTargets[K]

? In

: { [K2 in keyof In]: ValidationTargets[K][K2] };

};

out: { [K in Target]: Out };

},

V extends I = I,

>(

target: Target,

schema: Schema,

hook?: Hook<StandardSchemaV1.InferOutput<Schema>, E, P, Target>,

options?: ResolverReturnType["options"],

): MiddlewareHandler<E, P, V> {

const middleware = sValidator(target, schema, hook);

// @ts-expect-error not typed well

return Object.assign(middleware, {

[uniqueSymbol]: {

target,

...resolver(schema, options),

options,

},

});

}

*/

// Augmented middleware type with uniqueSymbol property

type AugmentedMiddlewareHandler<

E extends Env,

P extends string,

V extends Input,

Target extends keyof ValidationTargets,

Schema extends StandardSchemaV1

> = MiddlewareHandler<E, P, V> & {

[uniqueSymbol]: {

target: Target;

vendor: Schema["~standard"]["vendor"];

validate: Schema["~standard"]["validate"];

toJSONSchema: () => ReturnType<typeof toJsonSchema>;

toOpenAPISchema: () => ReturnType<typeof toOpenAPISchema>;

options?: ResolverReturnType["options"];

};

};

export function validator<

Schema extends StandardSchemaV1,

Target extends keyof ValidationTargets,

E extends Env,

P extends string,

In = StandardSchemaV1.InferInput<Schema>,

Out = StandardSchemaV1.InferOutput<Schema>,

I extends Input = {

in: HasUndefined<In> extends true

? {

[K in Target]?: In extends ValidationTargets[K]

? In

: { [K2 in keyof In]?: ValidationTargets[K][K2] };

}

: {

[K in Target]: In extends ValidationTargets[K]

? In

: { [K2 in keyof In]: ValidationTargets[K][K2] };

};

out: { [K in Target]: Out };

},

V extends I = I,

>(

target: Target,

schema: Schema,

hook?: Hook<StandardSchemaV1.InferOutput<Schema>, E, P, Target>,

options?: ResolverReturnType["options"],

): AugmentedMiddlewareHandler<E, P, V, Target, Schema> {

const middleware = sValidator(target, schema, hook);

return Object.assign(middleware, {

[uniqueSymbol]: {

target,

...resolver(schema, options),

options,

},

}) as AugmentedMiddlewareHandler<E, P, V, Target, Schema>;

}

Copilot · 2025-09-04T07:38:00Z

src/handler.ts

+    // @ts-expect-error
+    options: {
+      ...DEFAULT_OPTIONS,
+      ...options,
+    },


The @ts-expect-error comment suggests a type issue with the options object. Consider properly typing the DEFAULT_OPTIONS or the SpecContext options property.

Suggested change

// @ts-expect-error

options: {

...DEFAULT_OPTIONS,

...options,

},

options: {

...DEFAULT_OPTIONS,

...options,

} as Partial<GenerateSpecOptions>,

Copilot · 2025-09-04T07:38:01Z

src/handler.ts

+      // @ts-expect-error
+      schema: value,
+      required: schema.required?.includes(key),


The @ts-expect-error comment suggests a type mismatch when assigning the schema value. Consider properly typing the parameter definition or using appropriate type assertions.

Suggested change

// @ts-expect-error

schema: value,

required: schema.required?.includes(key),

schema: value as OpenAPIV3_1.SchemaObject | OpenAPIV3_1.ReferenceObject,

required: schema.required?.includes(key),

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

MathurAditya724 added 7 commits June 21, 2025 00:55

chore: basic cleanup

7e6fffc

chore: major rearragements

49cdb4c

chore: changed the folders

57e92e7

feat: major changes

ee20b81

chore: renamed openapi file to handler

9b1bdf7

chore: made some adjustments

4b6e90c

chore: minor changes

d25fc95

MathurAditya724 self-assigned this Jun 29, 2025

MathurAditya724 added 9 commits June 29, 2025 23:58

chore: wip

3401f37

chore: formatted the code

b0b5d75

wip

7583d15

wip

4093630

chore: added a basic test

428e150

feat: added more test and resolved issues

1c9d722

feat: added the route handler

5a7eaf0

feat: formated the code and corrected the entry file location

aabea71

chore: minor changes

18e2069

MathurAditya724 mentioned this pull request Jul 9, 2025

Using Effect Schema produces invalid OpenAPI specification #132

Open

MathurAditya724 added 3 commits July 17, 2025 15:12

chore: update @standard-community/standard-openapi package

71c1737

feat: corrected the metadata implmentation

4be8b45

chore: released rc 0

8a8a1bb

MathurAditya724 mentioned this pull request Sep 1, 2025

Component Schemas definition for routes with Valibot #61

Closed

MathurAditya724 added 2 commits September 2, 2025 06:00

fix: corrected the description position in the schema and minor changes

b0f8601

chore: minor change

36d5d68

MathurAditya724 mentioned this pull request Sep 2, 2025

Suggestion: Add tests for consistency across validation libraries #78

Closed

fix: passing option to the OpenAPI function

2a7083f

MathurAditya724 mentioned this pull request Sep 2, 2025

Type safety is not working well on responses #114

Closed

MathurAditya724 added 2 commits September 2, 2025 20:37

fix: added dynamic operationId and improved the hidden fn

5be5dad

chore: updated lockfile

71ab48c

MathurAditya724 mentioned this pull request Sep 2, 2025

[Feature]custom operationId #115

Closed

fix: improved the ref in params

c484087

This was referenced Sep 3, 2025

Using Queryparams as reference broke openapi generators #116

Closed

validateResponse is not respecting valibot object and returns everything #117

Closed

resolver does not generate full schema for nested z.object().nullable() fields #118

Closed

MathurAditya724 added 3 commits September 3, 2025 08:57

fix: added option for custom media type for request body

fe89e3f

chore: minor change

13897b5

releasing RC 4

070e836

MathurAditya724 requested a review from Copilot September 4, 2025 07:34

Copilot AI reviewed Sep 4, 2025

View reviewed changes

Update src/__tests__/zodv4.test.ts

990c19d

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

MathurAditya724 merged commit ed1827c into main Sep 4, 2025
2 checks passed

MathurAditya724 deleted the next branch September 4, 2025 07:52

v0.5 #129

v0.5 #129

Uh oh!

Conversation

MathurAditya724 commented Jun 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rawnly commented Jul 6, 2025

Uh oh!

MathurAditya724 commented Jul 6, 2025

Uh oh!

vnphanquang commented Jul 6, 2025

Uh oh!

vladshcherbin commented Jul 9, 2025

Uh oh!

mstibbard commented Jul 15, 2025

Uh oh!

MathurAditya724 commented Jul 15, 2025

Uh oh!

rawnly commented Jul 16, 2025

Uh oh!

MathurAditya724 commented Jul 17, 2025

Uh oh!

mstibbard commented Jul 17, 2025

Uh oh!

Dom-Mac commented Jul 26, 2025

Uh oh!

ImBIOS commented Jul 28, 2025

Uh oh!

mstibbard commented Jul 30, 2025

Uh oh!

ayame113 commented Jul 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MathurAditya724 commented Jul 31, 2025

Uh oh!

MathurAditya724 commented Jul 31, 2025

Uh oh!

mstibbard commented Aug 16, 2025

Uh oh!

MathurAditya724 commented Sep 1, 2025

Uh oh!

MathurAditya724 commented Sep 4, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Copilot AI Sep 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 4, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

12 participants

MathurAditya724 commented Jun 29, 2025 •

edited

Loading

ayame113 commented Jul 30, 2025 •

edited

Loading