Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .changeset/full-flowers-carry.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@tanstack/router-core': patch
---

fix(router-core): properly handle serialization of readonly maps/sets at type level
19 changes: 13 additions & 6 deletions packages/router-core/src/ssr/serializer/transformer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -86,10 +86,10 @@ export type ValidateSerializable<T, TSerializable> = T extends TSerializable
? ValidateSerializablePromise<T, TSerializable>
: T extends ReadableStream<any>
? ValidateReadableStream<T, TSerializable>
: T extends Set<any>
? ValidateSerializableSet<T, TSerializable>
: T extends Map<any, any>
? ValidateSerializableMap<T, TSerializable>
: T extends ReadonlyMap<any, any>

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had to swap order of Set and Map detection since ReadonlyMap extends ReadonlySet depending on tsconfig stuff 😄

Image

? ValidateSerializableMap<T, TSerializable>
: T extends ReadonlySet<any>
? ValidateSerializableSet<T, TSerializable>
: T extends AsyncGenerator<any, any>
? ValidateSerializableAsyncGenerator<T, TSerializable>
: T extends object
Expand Down Expand Up @@ -118,15 +118,22 @@ export type ValidateReadableStream<T, TSerializable> =
export type ValidateSerializableSet<T, TSerializable> =
T extends Set<infer TItem>
? Set<ValidateSerializable<TItem, TSerializable>>
: never
: T extends ReadonlySet<infer TItem>
? ReadonlySet<ValidateSerializable<TItem, TSerializable>>
: never

export type ValidateSerializableMap<T, TSerializable> =
T extends Map<infer TKey, infer TValue>
? Map<
ValidateSerializable<TKey, TSerializable>,
ValidateSerializable<TValue, TSerializable>
>
: never
: T extends ReadonlyMap<infer TKey, infer TValue>
? ReadonlyMap<
ValidateSerializable<TKey, TSerializable>,
ValidateSerializable<TValue, TSerializable>
>
: never

export type ValidateSerializableArray<T, TSerializable> = T extends readonly [
any,
Expand Down
35 changes: 35 additions & 0 deletions packages/router-core/tests/serializer.test-d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,39 @@ describe('Serializer', () => {
ValidateSerializable<MyCustomType, Serializable>
>().toEqualTypeOf<MyCustomType>()
})

it('works for readonly sets containing serializable values', () => {
type Value = ReadonlySet<string>

expectTypeOf<
ValidateSerializable<Value, Serializable>
>().toEqualTypeOf<Value>()
})

it('fails for readonly sets containing unserializable values', () => {
type Value = ReadonlySet<() => void>

expectTypeOf<ValidateSerializable<Value, Serializable>>().toEqualTypeOf<
ReadonlySet<SerializationError<'Function may not be serializable'>>
>()
})

it('works for readonly maps containing serializable values', () => {
type Value = ReadonlyMap<string, number>

expectTypeOf<
ValidateSerializable<Value, Serializable>
>().toEqualTypeOf<Value>()
})

it('fails for readonly maps containing unserializable values', () => {
type Value = ReadonlyMap<string, () => void>

expectTypeOf<ValidateSerializable<Value, Serializable>>().toEqualTypeOf<
ReadonlyMap<
string,
SerializationError<'Function may not be serializable'>
>
>()
Comment thread
coderabbitai[bot] marked this conversation as resolved.
})
})