Module

x/hono/types.ts

Fast, Lightweight, Web-standards
Extremely Popular
Go to Latest
File
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619
/* eslint-disable @typescript-eslint/no-unused-vars *//* eslint-disable @typescript-eslint/no-explicit-any *//* eslint-disable @typescript-eslint/ban-types */import type { Context } from './context.ts'import type { Hono } from './hono.ts'import type { StatusCode } from './utils/http-status.ts'import type { IntersectNonAnyTypes, UnionToIntersection } from './utils/types.ts'
////////////////////////////////////////////// //////////// Values //////////// //////////////////////////////////////////////
export type Bindings = Record<string, unknown>export type Variables = Record<string, unknown>
export type Env = { Bindings?: Bindings Variables?: Variables}
export type Next = () => Promise<void>
export type Input = { in?: Partial<ValidationTargets> out?: Partial<{ [K in keyof ValidationTargets]: unknown }>}
////////////////////////////////////////////// //////////// Handlers //////////// //////////////////////////////////////////////
type HandlerResponse<O> = Response | TypedResponse<O> | Promise<Response | TypedResponse<O>>
export type Handler< E extends Env = any, P extends string = any, I extends Input = Input, R extends HandlerResponse<any> = any> = (c: Context<E, P, I>, next: Next) => R
export type MiddlewareHandler< E extends Env = any, P extends string = string, I extends Input = {}> = (c: Context<E, P, I>, next: Next) => Promise<Response | void>
export type H< E extends Env = any, P extends string = any, I extends Input = {}, R extends HandlerResponse<any> = any> = Handler<E, P, I, R> | MiddlewareHandler<E, P, I>
export type NotFoundHandler<E extends Env = any> = (c: Context<E>) => Response | Promise<Response>export type ErrorHandler<E extends Env = any> = ( err: Error, c: Context<E>) => Response | Promise<Response>
////////////////////////////////////////////// //////////// HandlerInterface //////////// //////////////////////////////////////////////
export interface HandlerInterface< E extends Env = Env, M extends string = string, S extends Schema = {}, BasePath extends string = '/'> { //// app.get(...handlers[])
// app.get(handler) < P extends string = ExtractKey<S> extends never ? BasePath : ExtractKey<S>, I extends Input = {}, R extends HandlerResponse<any> = any, E2 extends Env = E >( handler: H<E2, P, I, R> ): Hono<E & E2, S & ToSchema<M, P, I['in'], MergeTypedResponseData<R>>, BasePath>
// app.get(handler, handler) < P extends string = ExtractKey<S> extends never ? BasePath : ExtractKey<S>, I extends Input = {}, R extends HandlerResponse<any> = any, E2 extends Env = E, E3 extends Env = IntersectNonAnyTypes<[E, E2]> >( ...handlers: [H<E2, P, I, R>, H<E3, P, I, R>] ): Hono<E & E2 & E3, S & ToSchema<M, P, I['in'], MergeTypedResponseData<R>>, BasePath>
// app.get(handler x 3) < P extends string = ExtractKey<S> extends never ? BasePath : ExtractKey<S>, R extends HandlerResponse<any> = any, I extends Input = {}, I2 extends Input = I, I3 extends Input = I & I2, E2 extends Env = E, E3 extends Env = E, E4 extends Env = IntersectNonAnyTypes<[E, E2, E3]> >( ...handlers: [H<E2, P, I, R>, H<E3, P, I2, R>, H<E4, P, I3, R>] ): Hono<E & E2 & E3 & E4, S & ToSchema<M, P, I3['in'], MergeTypedResponseData<R>>, BasePath>
// app.get(handler x 4) < P extends string = ExtractKey<S> extends never ? BasePath : ExtractKey<S>, R extends HandlerResponse<any> = any, I extends Input = {}, I2 extends Input = I, I3 extends Input = I & I2, I4 extends Input = I & I2 & I3, E2 extends Env = E, E3 extends Env = E, E4 extends Env = E, E5 extends Env = IntersectNonAnyTypes<[E, E2, E3, E4]> >( ...handlers: [H<E2, P, I, R>, H<E3, P, I2, R>, H<E4, P, I3, R>, H<E5, P, I4, R>] ): Hono<E & E2 & E3 & E4 & E5, S & ToSchema<M, P, I4['in'], MergeTypedResponseData<R>>, BasePath>
// app.get(handler x 5) < P extends string = ExtractKey<S> extends never ? BasePath : ExtractKey<S>, R extends HandlerResponse<any> = any, I extends Input = {}, I2 extends Input = I, I3 extends Input = I & I2, I4 extends Input = I2 & I3, I5 extends Input = I & I2 & I3 & I4, E2 extends Env = E, E3 extends Env = E, E4 extends Env = E, E5 extends Env = E, E6 extends Env = IntersectNonAnyTypes<[E, E2, E3, E4, E5]> >( ...handlers: [ H<E2, P, I, R>, H<E3, P, I2, R>, H<E4, P, I3, R>, H<E5, P, I3, R>, H<E6, P, I3, R> ] ): Hono< E & E2 & E3 & E4 & E5 & E6, S & ToSchema<M, P, I5['in'], MergeTypedResponseData<R>>, BasePath >
// app.get(...handlers[]) < P extends string = ExtractKey<S> extends never ? BasePath : ExtractKey<S>, I extends Input = {}, R extends HandlerResponse<any> = any >( ...handlers: H<E, P, I, R>[] ): Hono<E, S & ToSchema<M, P, I['in'], MergeTypedResponseData<R>>, BasePath>
//// app.get(path)
// app.get(path) <P extends string, R extends HandlerResponse<any> = any, I extends Input = {}>(path: P): Hono< E, S & ToSchema<M, MergePath<BasePath, P>, I['in'], MergeTypedResponseData<R>>, BasePath >
//// app.get(path, ...handlers[])
// app.get(path, handler) < P extends string, P2 extends string = P, R extends HandlerResponse<any> = any, I extends Input = {}, E2 extends Env = E >( path: P, handler: H<E2, MergePath<BasePath, P2>, I, R> ): Hono< E & E2, S & ToSchema<M, MergePath<BasePath, P>, I['in'], MergeTypedResponseData<R>>, BasePath >
// app.get(path, handler, handler) < P extends string, P2 extends string = P, P3 extends string = P, R extends HandlerResponse<any> = any, I extends Input = {}, E2 extends Env = E, E3 extends Env = IntersectNonAnyTypes<[E, E2]> >( path: P, ...handlers: [H<E2, MergePath<BasePath, P2>, I, R>, H<E3, MergePath<BasePath, P3>, I, R>] ): Hono< E & E2 & E3, S & ToSchema<M, MergePath<BasePath, P>, I['in'], MergeTypedResponseData<R>>, BasePath >
// app.get(path, handler x3) < P extends string, P2 extends string = P, P3 extends string = P, P4 extends string = P, R extends HandlerResponse<any> = any, I extends Input = {}, I2 extends Input = I, I3 extends Input = I & I2, E2 extends Env = E, E3 extends Env = E, E4 extends Env = IntersectNonAnyTypes<[E, E2, E3]> >( path: P, ...handlers: [ H<E2, MergePath<BasePath, P2>, I, R>, H<E3, MergePath<BasePath, P3>, I2, R>, H<E4, MergePath<BasePath, P4>, I3, R> ] ): Hono< E & E2 & E3 & E4, S & ToSchema<M, MergePath<BasePath, P>, I3['in'], MergeTypedResponseData<R>>, BasePath >
// app.get(path, handler x4) < P extends string, P2 extends string = P, P3 extends string = P, P4 extends string = P, P5 extends string = P, R extends HandlerResponse<any> = any, I extends Input = {}, I2 extends Input = I, I3 extends Input = I & I2, I4 extends Input = I & I2 & I3, E2 extends Env = E, E3 extends Env = E, E4 extends Env = E, E5 extends Env = IntersectNonAnyTypes<[E, E2, E3, E4]> >( path: P, ...handlers: [ H<E2, MergePath<BasePath, P2>, I, R>, H<E3, MergePath<BasePath, P3>, I2, R>, H<E4, MergePath<BasePath, P4>, I3, R>, H<E5, MergePath<BasePath, P5>, I4, R> ] ): Hono< E & E2 & E3 & E4 & E5, S & ToSchema<M, MergePath<BasePath, P>, I4['in'], MergeTypedResponseData<R>>, BasePath >
// app.get(path, handler x5) < P extends string, P2 extends string = P, P3 extends string = P, P4 extends string = P, P5 extends string = P, P6 extends string = P, R extends HandlerResponse<any> = any, I extends Input = {}, I2 extends Input = I, I3 extends Input = I & I2, I4 extends Input = I2 & I3, I5 extends Input = I & I2 & I3 & I4, E2 extends Env = E, E3 extends Env = E, E4 extends Env = E, E5 extends Env = E, E6 extends Env = IntersectNonAnyTypes<[E, E2, E3, E4, E5]> >( path: P, ...handlers: [ H<E2, MergePath<BasePath, P2>, I, R>, H<E3, MergePath<BasePath, P3>, I2, R>, H<E4, MergePath<BasePath, P4>, I3, R>, H<E5, MergePath<BasePath, P5>, I4, R>, H<E6, MergePath<BasePath, P6>, I5, R> ] ): Hono< E & E2 & E3 & E4 & E5 & E6, S & ToSchema<M, MergePath<BasePath, P>, I5['in'], MergeTypedResponseData<R>>, BasePath >
// app.get(path, ...handlers[]) <P extends string, I extends Input = {}, R extends HandlerResponse<any> = any>( path: P, ...handlers: H<E, MergePath<BasePath, P>, I, R>[] ): Hono<E, S & ToSchema<M, MergePath<BasePath, P>, I['in'], MergeTypedResponseData<R>>, BasePath>}
////////////////////////////////////////////// //////////// MiddlewareHandlerInterface //////////// //////////////////////////////////////////////
export interface MiddlewareHandlerInterface< E extends Env = Env, S extends Schema = {}, BasePath extends string = '/'> { //// app.get(...handlers[]) <E2 extends Env = E>( ...handlers: MiddlewareHandler<E2, MergePath<BasePath, ExtractKey<S>>>[] ): Hono<E, S, BasePath>
//// app.get(path, ...handlers[]) <P extends string, E2 extends Env = E>( path: P, ...handlers: MiddlewareHandler<E2, MergePath<BasePath, P>>[] ): Hono<E, S, BasePath>}
////////////////////////////////////////////// //////////// OnHandlerInterface //////////// //////////////////////////////////////////////
export interface OnHandlerInterface< E extends Env = Env, S extends Schema = {}, BasePath extends string = '/'> { // app.on(method, path, handler, handler) < M extends string, P extends string, P2 extends string = P, P3 extends string = P, R extends HandlerResponse<any> = any, I extends Input = {}, E2 extends Env = E, E3 extends Env = IntersectNonAnyTypes<[E, E2]> >( method: M, path: P, ...handlers: [H<E2, MergePath<BasePath, P2>, I, R>, H<E3, MergePath<BasePath, P3>, I, R>] ): Hono<E, S & ToSchema<M, MergePath<BasePath, P>, I['in'], MergeTypedResponseData<R>>, BasePath>
// app.get(method, path, handler x3) < M extends string, P extends string, P2 extends string = P, P3 extends string = P, P4 extends string = P, R extends HandlerResponse<any> = any, I extends Input = {}, I2 extends Input = I, I3 extends Input = I & I2, E2 extends Env = E, E3 extends Env = E, E4 extends Env = IntersectNonAnyTypes<[E, E2, E3]> >( method: M, path: P, ...handlers: [ H<E2, MergePath<BasePath, P2>, I, R>, H<E3, MergePath<BasePath, P3>, I2, R>, H<E4, MergePath<BasePath, P4>, I3, R> ] ): Hono<E, S & ToSchema<M, MergePath<BasePath, P>, I3['in'], MergeTypedResponseData<R>>, BasePath> // app.get(method, path, handler x4) < M extends string, P extends string, P2 extends string = P, P3 extends string = P, P4 extends string = P, P5 extends string = P, R extends HandlerResponse<any> = any, I extends Input = {}, I2 extends Input = I, I3 extends Input = I & I2, I4 extends Input = I & I2 & I3, E2 extends Env = E, E3 extends Env = E, E4 extends Env = E, E5 extends Env = IntersectNonAnyTypes<[E, E2, E3, E4]> >( method: M, path: P, ...handlers: [ H<E2, MergePath<BasePath, P2>, I, R>, H<E3, MergePath<BasePath, P3>, I2, R>, H<E4, MergePath<BasePath, P4>, I3, R>, H<E5, MergePath<BasePath, P5>, I4, R> ] ): Hono<E, S & ToSchema<M, MergePath<BasePath, P>, I4['in'], MergeTypedResponseData<R>>, BasePath>
// app.get(method, path, handler x5) < M extends string, P extends string, P2 extends string = P, P3 extends string = P, P4 extends string = P, P5 extends string = P, P6 extends string = P, R extends HandlerResponse<any> = any, I extends Input = {}, I2 extends Input = I, I3 extends Input = I & I2, I4 extends Input = I & I2 & I3, I5 extends Input = I & I2 & I3 & I4, E2 extends Env = E, E3 extends Env = E, E4 extends Env = E, E5 extends Env = E, E6 extends Env = IntersectNonAnyTypes<[E, E2, E3, E4, E5]> >( method: M, path: P, ...handlers: [ H<E2, MergePath<BasePath, P2>, I, R>, H<E3, MergePath<BasePath, P3>, I2, R>, H<E4, MergePath<BasePath, P4>, I3, R>, H<E5, MergePath<BasePath, P5>, I4, R>, H<E6, MergePath<BasePath, P6>, I5, R> ] ): Hono<E, S & ToSchema<M, MergePath<BasePath, P>, I5['in'], MergeTypedResponseData<R>>, BasePath>
<M extends string, P extends string, R extends HandlerResponse<any> = any, I extends Input = {}>( method: M, path: P, ...handlers: H<E, MergePath<BasePath, P>, I, R>[] ): Hono<E, S & ToSchema<M, MergePath<BasePath, P>, I['in'], MergeTypedResponseData<R>>, BasePath>
// app.on(method[], path, ...handler) <P extends string, R extends HandlerResponse<any> = any, I extends Input = {}>( methods: string[], path: P, ...handlers: H<E, MergePath<BasePath, P>, I, R>[] ): Hono< E, S & ToSchema<string, MergePath<BasePath, P>, I['in'], MergeTypedResponseData<R>>, BasePath >}
type ExtractKey<S> = S extends Record<infer Key, unknown> ? Key extends string ? Key : never : string
////////////////////////////////////////////// //////////// ToSchema //////////// //////////////////////////////////////////////
export type ToSchema<M extends string, P extends string, I extends Input['in'], O> = { [K in P]: { [K2 in M as AddDollar<K2>]: { input: unknown extends I ? AddParam<{}, P> : AddParam<I, P> output: unknown extends O ? {} : O } }}
export type Schema = { [Path: string]: { [Method: `$${Lowercase<string>}`]: { input: Partial<ValidationTargets> & { param?: Record<string, string> } output: {} } }}
export type MergeSchemaPath<OrigSchema, SubPath extends string> = { [K in keyof OrigSchema as `${MergePath<SubPath, K & string>}`]: OrigSchema[K]}
export type AddParam<I, P extends string> = ParamKeys<P> extends never ? I : I & { param: UnionToIntersection<ParamKeyToRecord<ParamKeys<P>>> }
type AddDollar<T extends string> = `$${Lowercase<T>}`
export type MergePath<A extends string, B extends string> = A extends '' ? B : A extends '/' ? B : A extends `${infer P}/` ? B extends `/${infer Q}` ? `${P}/${Q}` : `${P}/${B}` : B extends `/${infer Q}` ? Q extends '' ? A : `${A}/${Q}` : `${A}/${B}`
////////////////////////////////////////////// //////////// TypedResponse //////////// //////////////////////////////////////////////
export type TypedResponse<T = unknown> = { response: Response | Promise<Response> data: T format: 'json' // Currently, support only `json` with `c.jsonT()` status: StatusCode}
type ExtractResponseData<T> = T extends Promise<infer T2> ? T2 extends TypedResponse<infer U> ? U : {} : T extends TypedResponse<infer U> ? U : {}
type MergeTypedResponseData<T> = ExtractResponseData<T>
////////////////////////////////////////////// /////////// ValidationTargets /////////// /////////////////////////////////////////////
export type ValidationTargets = { json: any form: Record<string, string | File> query: Record<string, string | string[]> queries: Record<string, string[]> // Deprecated. Will be obsolete in v4. param: Record<string, string> header: Record<string, string> cookie: Record<string, string>}
////////////////////////////////////////////// //////////// Path parameters //////////// //////////////////////////////////////////////
type ParamKeyName<NameWithPattern> = NameWithPattern extends `${infer Name}{${infer Rest}` ? Rest extends `${infer _Pattern}?` ? `${Name}?` : Name : NameWithPattern
type ParamKey<Component> = Component extends `:${infer NameWithPattern}` ? ParamKeyName<NameWithPattern> : never
export type ParamKeys<Path> = Path extends `${infer Component}/${infer Rest}` ? ParamKey<Component> | ParamKeys<Rest> : ParamKey<Path>
export type ParamKeyToRecord<T extends string> = T extends `${infer R}?` ? Record<R, string | undefined> : { [K in T]: string }
////////////////////////////////////////////// /////////// For HonoRequest //////////// //////////////////////////////////////////////
export type InputToDataByTarget< T extends Input['out'], Target extends keyof ValidationTargets> = T extends { [K in Target]: infer R} ? R : never
export type RemoveQuestion<T> = T extends `${infer R}?` ? R : T
export type UndefinedIfHavingQuestion<T> = T extends `${infer _}?` ? string | undefined : string
////////////////////////////////////////////// //////////// Utilities //////////// //////////////////////////////////////////////
export type ExtractSchema<T> = UnionToIntersection< T extends Hono<infer _, infer S, any> ? S : never>
////////////////////////////////////////////// //////////// FetchEvent //////////// //////////////////////////////////////////////
export abstract class FetchEventLike { abstract readonly request: Request abstract respondWith(promise: Response | Promise<Response>): void abstract passThroughOnException(): void abstract waitUntil(promise: Promise<void>): void}