Skip to content

fix: better handling for empty header and query types #221

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+160 −39
Open

fix: better handling for empty header and query types #221

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ea75908
fix: better handling for empty header and query types
KurtGokhan Oct 25, 2025
b3b249b
revert whitespace changes
KurtGokhan Oct 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
150 changes: 62 additions & 88 deletions src/treaty2/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
import type { Elysia, ELYSIA_FORM_DATA } from 'elysia'

import { EdenWS } from './ws'
import type { IsNever, Not, Prettify } from '../types'
import type { IsNever, MaybeEmptyObject, Not, Prettify } from '../types'

// type Files = File | FileList

Expand All @@ -24,20 +24,20 @@ type ReplaceGeneratorWithAsyncGenerator<
[K in keyof RecordType]: IsNever<RecordType[K]> extends true
? RecordType[K]
: RecordType[K] extends Generator<infer A, infer B, infer C>
? void extends B
? AsyncGenerator<A, B, C>
: And<IsNever<A>, void extends B ? false : true> extends true
? B
: AsyncGenerator<A, B, C> | B
: RecordType[K] extends AsyncGenerator<infer A, infer B, infer C>
? And<Not<IsNever<A>>, void extends B ? true : false> extends true
? AsyncGenerator<A, B, C>
: And<IsNever<A>, void extends B ? false : true> extends true
? B
: AsyncGenerator<A, B, C> | B
: RecordType[K] extends ReadableStream<infer A>
? AsyncGenerator<A, void, unknown>
: RecordType[K]
? void extends B
? AsyncGenerator<A, B, C>
: And<IsNever<A>, void extends B ? false : true> extends true
? B
: AsyncGenerator<A, B, C> | B
: RecordType[K] extends AsyncGenerator<infer A, infer B, infer C>
? And<Not<IsNever<A>>, void extends B ? true : false> extends true
? AsyncGenerator<A, B, C>
: And<IsNever<A>, void extends B ? false : true> extends true
? B
: AsyncGenerator<A, B, C> | B
: RecordType[K] extends ReadableStream<infer A>
? AsyncGenerator<A, void, unknown>
: RecordType[K]
} & {}

type Enumerate<N extends number, Acc extends number[] = []> =
Expand Down Expand Up @@ -67,118 +67,92 @@ export namespace Treaty {
[K in keyof Route as K extends `:${string}`
? never
: K]: K extends 'subscribe' // ? Websocket route
? ({} extends Route['subscribe']['headers']
? { headers?: Record<string, unknown> }
: undefined extends Route['subscribe']['headers']
? { headers?: Record<string, unknown> }
: {
headers: Route['subscribe']['headers']
}) &
({} extends Route['subscribe']['query']
? { query?: Record<string, unknown> }
: undefined extends Route['subscribe']['query']
? { query?: Record<string, unknown> }
: {
query: Route['subscribe']['query']
}) extends infer Param
? MaybeEmptyObject<Route['subscribe']['headers'], 'headers'> &
MaybeEmptyObject<Route['subscribe']['query'], 'query'> extends infer Param
? (options?: Param) => EdenWS<Route['subscribe']>
: never
: Route[K] extends {
body: infer Body
headers: infer Headers
params: any
query: infer Query
response: infer Res extends Record<number, unknown>
}
? ({} extends Headers
? {
headers?: Record<string, unknown>
}
: undefined extends Headers
? { headers?: Record<string, unknown> }
: {
headers: Headers
}) &
({} extends Query
? {
query?: Record<string, unknown>
}
: undefined extends Query
? { query?: Record<string, unknown> }
: { query: Query }) extends infer Param
? {} extends Param
? undefined extends Body
? K extends 'get' | 'head'
? (
options?: Prettify<Param & TreatyParam>
) => Promise<
TreatyResponse<
ReplaceGeneratorWithAsyncGenerator<Res>
>
>
: (
body?: Body,
options?: Prettify<Param & TreatyParam>
) => Promise<
TreatyResponse<
ReplaceGeneratorWithAsyncGenerator<Res>
>
>
: {} extends Body
body: infer Body
headers: infer Headers
params: any
query: infer Query
response: infer Res extends Record<number, unknown>
}
? MaybeEmptyObject<Headers, 'headers'> &
MaybeEmptyObject<Query, 'query'> extends infer Param
? {} extends Param
? undefined extends Body
? K extends 'get' | 'head'
? (
body?: Body,
options?: Prettify<Param & TreatyParam>
) => Promise<
TreatyResponse<
ReplaceGeneratorWithAsyncGenerator<Res>
>
>
: (
body: Body,
body?: Body,
options?: Prettify<Param & TreatyParam>
) => Promise<
TreatyResponse<
ReplaceGeneratorWithAsyncGenerator<Res>
>
>
: K extends 'get' | 'head'
: {} extends Body
? (
options: Prettify<Param & TreatyParam>
body?: Body,
options?: Prettify<Param & TreatyParam>
) => Promise<
TreatyResponse<
ReplaceGeneratorWithAsyncGenerator<Res>
>
>
: (
body: Body,
options: Prettify<Param & TreatyParam>
options?: Prettify<Param & TreatyParam>
) => Promise<
TreatyResponse<
ReplaceGeneratorWithAsyncGenerator<Res>
>
>
: never
: CreateParams<Route[K]>
: K extends 'get' | 'head'
? (
options: Prettify<Param & TreatyParam>
) => Promise<
TreatyResponse<
ReplaceGeneratorWithAsyncGenerator<Res>
>
>
: (
body: Body,
options: Prettify<Param & TreatyParam>
) => Promise<
TreatyResponse<
ReplaceGeneratorWithAsyncGenerator<Res>
>
>
: never
: CreateParams<Route[K]>
}

type CreateParams<Route extends Record<string, any>> =
Extract<keyof Route, `:${string}`> extends infer Path extends string
? IsNever<Path> extends true
? Prettify<Sign<Route>>
: // ! DO NOT USE PRETTIFY ON THIS LINE, OTHERWISE FUNCTION CALLING WILL BE OMITTED
(((params: {
[param in Path extends `:${infer Param}`
? Param extends `${infer Param}?`
? Param
: Param
: never]: string | number
? IsNever<Path> extends true
? Prettify<Sign<Route>>
: // ! DO NOT USE PRETTIFY ON THIS LINE, OTHERWISE FUNCTION CALLING WILL BE OMITTED
(((params: {
[param in Path extends `:${infer Param}`
? Param extends `${infer Param}?`
? Param
: Param
: never]: string | number
}) => Prettify<Sign<Route[Path]>> &
CreateParams<Route[Path]>) &
Prettify<Sign<Route>>) &
Prettify<Sign<Route>>) &
(Path extends `:${string}?`
? CreateParams<Route[Path]>
: {})
: never
: never

export interface Config {
fetch?: Omit<RequestInit, 'headers' | 'method'>
Expand Down
30 changes: 30 additions & 0 deletions src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,36 @@ export type IsUnknown<T> = IsAny<T> extends true
? true
: false

type IsExactlyUnknown<T> = [T] extends [unknown]
? [unknown] extends [T]
? true
: false
: false;

type IsUndefined<T> = [T] extends [undefined] ? true : false

type IsMatchingEmptyObject<T> = [T] extends [{}]
? [{}] extends [T]
? true
: false
: false

export type MaybeEmptyObject<
TObj,
TKey extends PropertyKey,
TFallback = Record<string, unknown>
> = IsUndefined<TObj> extends true
? { [K in TKey]?: TFallback }
: IsExactlyUnknown<TObj> extends true
? { [K in TKey]?: TFallback }
: IsMatchingEmptyObject<TObj> extends true
? { [K in TKey]?: TObj }
: undefined extends TObj
? { [K in TKey]?: TObj }
: null extends TObj
? { [K in TKey]?: TObj }
: { [K in TKey]: TObj }

export type AnyTypedRoute = {
body?: unknown
headers?: unknown
Expand Down
56 changes: 55 additions & 1 deletion test/treaty2.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { Elysia, form, sse, t } from 'elysia'
import { Treaty, treaty } from '../src'

import { describe, expect, it, beforeAll, afterAll, mock } from 'bun:test'
import { describe, expect, it, beforeAll, afterAll, mock, test } from 'bun:test'

const randomObject = {
a: 'a',
Expand Down Expand Up @@ -92,6 +92,44 @@ const app = new Elysia()
alias: t.Literal('Kristen')
})
})
.group('/empty-test', (g) => g
.get('/with-maybe-empty', ({ query, headers }) => ({ query, headers }), {
query: t.MaybeEmpty(t.Object({ alias: t.String() })),
headers: t.MaybeEmpty(t.Object({ username: t.String() }))
})
.get('/with-unknown', ({ query, headers }) => ({ query, headers }), {
query: t.Unknown(),
headers: t.Unknown(),
})
.get('/with-empty-record', ({ query, headers }) => ({ query, headers }), {
query: t.Record(t.String(), t.Never()),
headers: t.Record(t.String(), t.Never()),
})
.get('/with-empty-obj', ({ query, headers }) => ({ query, headers }), {
query: t.Object({}),
headers: t.Object({}),
})
.get('/with-partial', ({ query, headers }) => ({ query, headers }), {
query: t.Partial(t.Object({ alias: t.String() })),
headers: t.Partial(t.Object({ username: t.String() })),
})
.get('/with-optional', ({ query, headers }) => ({ query, headers }), {
query: t.Optional(t.Object({ alias: t.String() })),
headers: t.Optional(t.Object({ username: t.String() })),
})
.get('/with-union-undefined', ({ query, headers }) => ({ query, headers }), {
query: t.Union([t.Object({ alias: t.String() }), t.Undefined()]),
headers: t.Union([t.Object({ username: t.String() }), t.Undefined()])
})
.get('/with-union-empty-obj', ({ query, headers }) => ({ query, headers }), {
query: t.Union([t.Object({ alias: t.String() }), t.Object({})]),
headers: t.Union([t.Object({ username: t.String() }), t.Object({})]),
})
.get('/with-union-empty-record', ({ query, headers }) => ({ query, headers }), {
query: t.Union([t.Object({ alias: t.String() }), t.Record(t.String(), t.Never())]),
headers: t.Union([t.Object({ username: t.String() }), t.Record(t.String(), t.Never())]),
})
)
.post('/queries', ({ query }) => query, {
query: t.Object({
username: t.String(),
Expand Down Expand Up @@ -354,6 +392,22 @@ describe('Treaty2', () => {
expect(error?.value.type).toBe('validation')
})

test.each([
'with-empty-obj',
'with-partial',
'with-unknown',
'with-empty-record',
'with-union-empty-obj',
'with-union-empty-record',
// 'with-maybe-empty',
// 'with-optional',
// 'with-union-undefined',
] as const)('type test for case: %s', async (caseName) => {
const { data, error } = await client['empty-test'][caseName].get()
expect(error, JSON.stringify(error, null, 2)).toBeNull()
expect(data).toEqual({ query: {}, headers: {} })
})

it('post queries', async () => {
const query = { username: 'A', alias: 'Kristen' } as const

Expand Down
Loading