Using Typebox in v1 doesn't work without installing @valibot/to-json-schema

[Andrew-Chen-Wang]

Upgrading to hono-openapi, you need to install @hono/standard-validator. IIRC, you mentioned I needed to use Typemap, but I don't see it listed as a peer dependency in the package.json?

Additionally, I apparently need to install @valibot/to-json-schema otherwise I get:

I'm not sure why I would need to install it though

[Andrew-Chen-Wang]

Actually it seems like you need to install all peer dependencies like effect as well

[Andrew-Chen-Wang]

I've just resolved to the fact that hono-openapi can't really give TypeBox first class support. I will make a fork of the previous version but solely for TypeBox. I tried using TypeMap and converting my TypeBox types to valibot, but things have started dropping unfortunately. TypeBox also hasn't really been feature complete in hono-openapi ever, really, too, so I think it makes sense to start a fork.

just created the fork here https://www.npmjs.com/package/hono-typebox-openapi: it solely focuses on TypeBox and uses the <v1 syntax. Thanks sm for this library; it's been super useful! I do think that TypeBox has kind of been put on the back burner in this library though with many issues not being addressed in both the main hono library and here. The new standard schema implementation is great for the other validation libraries, but it makes using TypeBox with hono-openapi very repetitive and prone to errors with the conversion from TypeBox to Valibot.

[MathurAditya724]

I am adding a new loader function which might help with this, that will also help with add more lib which supports standard schema but I don't have the implmentation.

Will create a PR soon

[MathurAditya724]

Checkout this commit - 37ee30d#diff-5b4ca70b6087291c7dfb41bfc399d5caf440f38fda7155d4244220cf36868699

This add's a new function loadVendor, which you can use to add TypeBox support

[Andrew-Chen-Wang]

Thanks @MathurAditya724. At the moment, I'm primarily concerned with the TypeBox to Valibot conversion via TypeMap and the possibilities of losing some properties.

Also I'm not entirely sure how to use this new function loadVendor, do you have an example? I noticed there were no TypeBox tests, so it was hard figuring out what to do initially. It would be great if the docs detailed more TypeBox related mechanisms! Thank you!

[MathurAditya724]

Check this out - https://honohub.dev/docs/openapi/helpers#vendor-loading

Let me know if you have any ideas on improving the docs for this, maybe an example or something similar. Happy to take a look at a PR

[jsanchezba]

Tried to use typemap as written in the docs but I got an error. I guess this part of the docs is a bit outdated:

16 | case "arktype":
17 | case "effect":
18 | vendorFn = (await import('./default-u_dwuiYb.js')).default();
19 | break;
20 | default:
21 | throw new Error(
^
error: standard-openapi: Unsupported schema vendor "@sinclair/typemap".

I cannot figure out how to use the vendor function with typebox to make it work with hono-openapi.

With Valibot does work, but indeed requires to install @valibot/to-json-schema

[Andrew-Chen-Wang]

@jsanchezba I found this to work:

import { Valibot } from '@sinclair/typemap'


const app = new Hono().use(authMiddleware).delete(
  "/me/delete",
  describeRoute({
    responses: {
      204: {
        description: "User successfully deleted",
        content: {
          "application/json": {
            schema: resolver(
              Valibot((Type.Object({ success: Type.Boolean() }))))
          }
        }
      },

[jsanchezba]

@jsanchezba I found this to work:

import { Valibot } from '@sinclair/typemap'

const app = new Hono().use(authMiddleware).delete(
"/me/delete",
describeRoute({
responses: {
204: {
description: "User successfully deleted",
content: {
"application/json": {
schema: resolver(
Valibot((Type.Object({ success: Type.Boolean() }))))
}
}
},

Actually the problem seems to come from the validator, does it work for you? If I remove the validator part it does work but obviously without the params documentation.

controller.post(
    '/signin',
    describeRoute({
        description: 'User sign in',
        responses: {
            200: {
                description: 'Successful response',
                content: {
                    'text/plain': { schema: resolver(UserSchema) },
                },
            },
        },
    }),
    validator('json', Valibot(Type.Object({ success: Type.Boolean() }))),
    async (c) => {
...

[Andrew-Chen-Wang]

That was the only code I wrote before migrating to a fork of pre-v1 (package here https://www.npmjs.com/package/hono-typebox-openapi). I think for v1, that might be a bug and @MathurAditya724 can probably fix that. current v1 doesn't include tests for TypeBox, so I just gave up

[sinclairzx81]

@Andrew-Chen-Wang @MathurAditya724 @jsanchezba Hi,

I've just resolved to the fact that hono-openapi can't really give TypeBox first class support. I will make a fork of the previous version but solely for TypeBox. I tried using TypeMap and converting my TypeBox types to valibot, but things have started dropping unfortunately. TypeBox also hasn't really been feature complete in hono-openapi ever, really, too, so I think it makes sense to start a fork.

It is unfortunate to hear TypeBox is given low priority here, especially as it is the only project trying to provide first class schema generation for OpenAPI. This said, there have been some major updates recently that may be relevant to this and other issues.

---

TypeBox v1

Version 1.0 was just released and provides universal validation and inference for BOTH Json Schema and Standard Schema.

Standard Schema Embedding | Standard Schema + Json Schema Compile

.. as well as a Syntax Translation Engine for TypeScript to Json Schema

TypeScript Engine for Json Schema

... and a Standard Schema compiler (which also compiles Standard Schema)

TypeBox Validator | Standard Schema V1

import { Compile } from 'typebox/compile'
import { Type } from 'typebox'

import * as v from 'valibot'
import * as z from 'zod'

// Compile Everything

const T = Compile(Type.Object({
  x: Type.Number(),     // typebox
  y: v.number(),        // valibot: standard schema
  z: z.number()         // zod: standard schema
}))

// Version | Vendor Information

T['~standard'].vendor               // 'typebox'
T['~standard'].version              // 1
T['~standard'].validate(null)       // TResult<{
                                    //   x: number;
                                    //   y: number;
                                    //   z: number;
                                    // }>

The features in v1 are designed specifically for systems that need better integration for OpenAPI, while simultaneously trying to smooth over the incompatibilities introduced by Standard Schema.

TypeBox V1 Documentation

---

@hono/typebox-validator

I was made aware of this issue honojs/middleware#1477 via https://github.com/sinclairzx81/typebox/issues/1355 the other day. I am not sure who is managing the validators for hono, but upgrading @hono/typebox-validator to v1 should mean.

• TypeBox 0.34.x (backwards compatibility)
• TypeBox 1.0 validation + inference
• Json Schema validation + inference
• Standard Schema validation + inference

Note: TypeBox can provide validation support for Standard Schema, however Json Schema translation will either need to be handled by the Standard Schema spec authors (50/50 on that one), a third party library or failing that I will write library translations myself with TypeMap. At this stage, I am waiting on v1 adoption before making a call on what to do with TypeMap, but the hope is Standard Schema will provide adapters to Json Schema which means TypeBox could offer accelerated validation for Standard Schema implementations.

Refer to https://moltar.github.io/typescript-runtime-type-benchmarks/ for TypeMap performance benchmarks

---

@Andrew-Chen-Wang With respect to forking, the mentioned updates would be in support of a fork (or entirely new project) to deal with the inherent compatibility / translation problems caused by Standard Schema. If you are thinking of forking and fixing up some of these issues, feel free to ping me on the TB repo. I may be able to help

Cheers!
S

[MathurAditya724]

@sinclairzx81 Thanks for bring the new updates to my attention, just created a PR #184 for first class support in hono-openapi. @Andrew-Chen-Wang It would be a great help if you can test it out and share your opinions and suggestions.

Regarding the @hono/typebox-validator, I have already comment there that they can now use the @hono/standard-validator till someone updates the validator.

As for low priority, I am not really biased to any validation lib, I am trying to support as many as I can (One of the reasons why I shifted to Standard Schema) 😃

Sorry you felt like that