zValidator types not working with rpc client query

[wststone]

As shown in the screenshots above, the rpc client query paramters should have the correct inferred number type.

package version: "hono": "^4.5.4" "@hono/zod-validator": "^0.2.2"

[cybercoder-naj]

Bump! I have the same issue.

[yusukebe]

Hi @wststone @cybercoder-naj

The Zod Validator uses z.input to infer a query using the request type. With it, the value with z.coerce will have undefined and optional:

This means the value defined z.coerce can be optional or undefined. On the other hand, if you specify the value with z.number(), it can not allow undefined.

[Pyakz]

bump, what to do?

[ambergristle]

@yusukebe i may be wrong here, but i think OP was asking about how the input is inferred client side.

while (i expect) values are typed correctly in the request handler, param and query options are typed as strings in the client arguments.

while i'm not sure how this happens type-wise, i assume it's because param and query values are necessarily stringified when going over the wire. is this correct?

_edit: specifically, i'm guessing it's the typing of ValidationTargets

// server
const ZQuery = z.object({
  page: z.coerce.number(),
})

const app = new Hono()
  .get('/',  zValidator('query', ZQuery), async (c) => {
      const { page } = c.req.valid('query') // number
      // ...
   })

// client
const client = hc<typeof app>('')
const response = await client.index.$get({
  page: 1, // expects string
})

parenthetically, i'm a little confused by what you said about z.coerce: as far as i can tell, it results in a number type, which makes sense because i think even undefined gets coerced to 0.

[yusukebe]

Hi @ambergristle

I'm not sure what the problem 100%, but the page in the client being string is correct behavior because it is already "string" in the client request.

[ambergristle]

hey @yusukebe! i'm not sure i understand what you meant by this

the page in the client being string is correct behavior because it is already "string" in the client request

do you mean that the client types param and query values as string because they have to be converted to strings when making the request?

[yusukebe]

do you mean that the client types param and query values as string because they have to be converted to strings when making the request?

Yes, yes!

[ambergristle]

sounds like this isn't an issue then, maybe just an opportunity to add some detail to the docs. i'll open a pr next week

edit

• opened a PR to document this behavior: https://github.com/honojs/website/pull/775
• i found a rejected proposal to have the RPC client stringify query data. thought it might be helpful context: https://github.com/honojs/hono/issues/3495