feat(types): make Hono client's $url return the exact URL type

[miyaji255]

Summary

This pull request enhances the type safety and expressiveness of the client-side URL generation in the Hono framework. The main improvement is the introduction of a new TypedURL type, which allows the client to generate URLs with strongly-typed protocol, host, port, path, and query parameters based on the application's route schema and the provided base URL. Several generics and utility types are introduced to propagate this type information throughout the client, ensuring that URL generation is accurate and type-checked at compile time.

esbuild v0.15.18 doesn't support const type parameters, so I updated esbuild.

Motivation

I wanted to add types so that keys used with SWR would be easy to reuse in other parts of the codebase. However, $url did not preserve that type information, so I created this PR.

• Add tests
• Run tests
• bun run format:fix && bun run lint:fix to format the code
• Add TSDoc/JSDoc to document the code

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.47%. Comparing base (971106d) to head (372d90d).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #4502   +/-   ##
=======================================
  Coverage   91.47%   91.47%           
=======================================
  Files         172      172           
  Lines       11143    11143           
  Branches     3224     3224           
=======================================
  Hits        10193    10193           
  Misses        949      949           
  Partials        1        1           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[yusukebe]

Hi @miyaji255

This is super interesting. I'll look at it deeply later.

[yusukebe]

Sorry for being late. Anyway, this change is not a "fix", but a "feat". It's a new feature.

[yusukebe]

Can we go without the second argument like this?

const client = hc<typeof routes>('http://localhost/')

Or impossible caused by a TypeScript limitation?

[miyaji255]

TypeScript requires you to specify all other generics if you specify one generic. If you want to solve this problem, you can solve it by currying generics like this.

const hcStrict = <T extends Hono<any, any, any>>() =>
  <const Prefix extends>(prefix: Prefix, options?: ClientOptions) => hc<T, Prefix>(prefix, options)