@tanstack/router-core 1.132.2 → 1.132.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/router.cjs.map +1 -1
- package/dist/cjs/router.d.cts +3 -0
- package/dist/cjs/ssr/serializer/transformer.cjs.map +1 -1
- package/dist/cjs/ssr/serializer/transformer.d.cts +11 -6
- package/dist/esm/router.d.ts +3 -0
- package/dist/esm/router.js.map +1 -1
- package/dist/esm/ssr/serializer/transformer.d.ts +11 -6
- package/dist/esm/ssr/serializer/transformer.js.map +1 -1
- package/package.json +1 -1
- package/src/router.ts +6 -0
- package/src/ssr/serializer/transformer.ts +70 -33
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"transformer.js","sources":["../../../../src/ssr/serializer/transformer.ts"],"sourcesContent":["import { createPlugin } from 'seroval'\nimport { GLOBAL_TSR } from '../constants'\nimport type { Plugin, SerovalNode } from 'seroval'\nimport type {
|
|
1
|
+
{"version":3,"file":"transformer.js","sources":["../../../../src/ssr/serializer/transformer.ts"],"sourcesContent":["import { createPlugin } from 'seroval'\nimport { GLOBAL_TSR } from '../constants'\nimport type { Plugin, SerovalNode } from 'seroval'\nimport type {\n RegisteredConfigType,\n RegisteredSsr,\n SSROption,\n} from '../../router'\nimport type { LooseReturnType } from '../../utils'\nimport type { AnyRoute, ResolveAllSSR } from '../../route'\n\nexport type Serializable =\n | number\n | string\n | boolean\n | null\n | undefined\n | bigint\n | Date\n\nexport function createSerializationAdapter<\n TInput = unknown,\n TOutput = unknown /* we need to check that this type is actually serializable taking into account all seroval native types and any custom plugin WE=router/start add!!! */,\n>(\n opts: CreateSerializationAdapterOptions<TInput, TOutput>,\n): SerializationAdapter<TInput, TOutput> {\n return opts as unknown as SerializationAdapter<TInput, TOutput>\n}\n\nexport interface CreateSerializationAdapterOptions<TInput, TOutput> {\n key: string\n test: (value: unknown) => value is TInput\n toSerializable: (value: TInput) => ValidateSerializable<TOutput, Serializable>\n fromSerializable: (value: TOutput) => TInput\n}\n\nexport type ValidateSerializable<T, TSerializable> =\n T extends ReadonlyArray<unknown>\n ? ResolveArrayShape<T, TSerializable, 'input'>\n : T extends TSerializable\n ? T\n : T extends (...args: Array<any>) => any\n ? 'Function is not serializable'\n : T extends Promise<any>\n ? ValidateSerializablePromise<T, TSerializable>\n : T extends ReadableStream<any>\n ? ValidateReadableStream<T, TSerializable>\n : T extends Set<any>\n ? ValidateSerializableSet<T, TSerializable>\n : T extends Map<any, any>\n ? ValidateSerializableMap<T, TSerializable>\n : { [K in keyof T]: ValidateSerializable<T[K], TSerializable> }\n\nexport type ValidateSerializablePromise<T, TSerializable> =\n T extends Promise<infer TAwaited>\n ? Promise<ValidateSerializable<TAwaited, TSerializable>>\n : never\n\nexport type ValidateReadableStream<T, TSerializable> =\n T extends ReadableStream<infer TStreamed>\n ? ReadableStream<ValidateSerializable<TStreamed, TSerializable>>\n : never\n\nexport type ValidateSerializableSet<T, TSerializable> =\n T extends Set<infer TItem>\n ? Set<ValidateSerializable<TItem, TSerializable>>\n : never\n\nexport type ValidateSerializableMap<T, TSerializable> =\n T extends Map<infer TKey, infer TValue>\n ? Map<\n ValidateSerializable<TKey, TSerializable>,\n ValidateSerializable<TValue, TSerializable>\n >\n : never\n\nexport type RegisteredReadableStream =\n unknown extends SerializerExtensions['ReadableStream']\n ? never\n : SerializerExtensions['ReadableStream']\n\nexport interface DefaultSerializerExtensions {\n ReadableStream: unknown\n}\n\nexport interface SerializerExtensions extends DefaultSerializerExtensions {}\n\nexport interface SerializationAdapter<TInput, TOutput> {\n '~types': SerializationAdapterTypes<TInput, TOutput>\n key: string\n test: (value: unknown) => value is TInput\n toSerializable: (value: TInput) => TOutput\n fromSerializable: (value: TOutput) => TInput\n makePlugin: (options: { didRun: boolean }) => Plugin<TInput, SerovalNode>\n}\n\nexport interface SerializationAdapterTypes<TInput, TOutput> {\n input: TInput\n output: TOutput\n}\n\nexport type AnySerializationAdapter = SerializationAdapter<any, any>\n\nexport function makeSsrSerovalPlugin<TInput, TOutput>(\n serializationAdapter: SerializationAdapter<TInput, TOutput>,\n options: { didRun: boolean },\n) {\n return createPlugin<TInput, SerovalNode>({\n tag: '$TSR/t/' + serializationAdapter.key,\n test: serializationAdapter.test,\n parse: {\n stream(value, ctx) {\n return ctx.parse(serializationAdapter.toSerializable(value))\n },\n },\n serialize(node, ctx) {\n options.didRun = true\n return (\n GLOBAL_TSR +\n '.t.get(\"' +\n serializationAdapter.key +\n '\")(' +\n ctx.serialize(node) +\n ')'\n )\n },\n // we never deserialize on the server during SSR\n deserialize: undefined as never,\n })\n}\n\nexport function makeSerovalPlugin<TInput, TOutput>(\n serializationAdapter: SerializationAdapter<TInput, TOutput>,\n) {\n return createPlugin<TInput, SerovalNode>({\n tag: '$TSR/t/' + serializationAdapter.key,\n test: serializationAdapter.test,\n parse: {\n sync(value, ctx) {\n return ctx.parse(serializationAdapter.toSerializable(value))\n },\n async async(value, ctx) {\n return await ctx.parse(serializationAdapter.toSerializable(value))\n },\n stream(value, ctx) {\n return ctx.parse(serializationAdapter.toSerializable(value))\n },\n },\n // we don't generate JS code outside of SSR (for now)\n serialize: undefined as never,\n deserialize(node, ctx) {\n return serializationAdapter.fromSerializable(\n ctx.deserialize(node) as TOutput,\n )\n },\n })\n}\n\nexport type ValidateSerializableInput<TRegister, T> = ValidateSerializable<\n T,\n RegisteredSerializableInput<TRegister>\n>\n\nexport type RegisteredSerializableInput<TRegister> =\n | (unknown extends RegisteredSerializationAdapters<TRegister>\n ? never\n : RegisteredSerializationAdapters<TRegister> extends ReadonlyArray<AnySerializationAdapter>\n ? RegisteredSerializationAdapters<TRegister>[number]['~types']['input']\n : never)\n | Serializable\n\nexport type RegisteredSerializationAdapters<TRegister> = RegisteredConfigType<\n TRegister,\n 'serializationAdapters'\n>\n\nexport type ValidateSerializableInputResult<TRegister, T> =\n ValidateSerializableResult<T, RegisteredSerializableInput<TRegister>>\n\nexport type ValidateSerializableResult<T, TSerializable> =\n T extends ReadonlyArray<unknown>\n ? ResolveArrayShape<T, TSerializable, 'result'>\n : T extends TSerializable\n ? T\n : unknown extends SerializerExtensions['ReadableStream']\n ? { [K in keyof T]: ValidateSerializableResult<T[K], TSerializable> }\n : T extends SerializerExtensions['ReadableStream']\n ? ReadableStream\n : { [K in keyof T]: ValidateSerializableResult<T[K], TSerializable> }\n\nexport type RegisteredSSROption<TRegister> =\n unknown extends RegisteredConfigType<TRegister, 'defaultSsr'>\n ? SSROption\n : RegisteredConfigType<TRegister, 'defaultSsr'>\n\nexport type ValidateSerializableLifecycleResult<\n TRegister,\n TParentRoute extends AnyRoute,\n TSSR,\n TFn,\n> =\n false extends RegisteredSsr<TRegister>\n ? any\n : ValidateSerializableLifecycleResultSSR<\n TRegister,\n TParentRoute,\n TSSR,\n TFn\n > extends infer TInput\n ? TInput\n : never\n\nexport type ValidateSerializableLifecycleResultSSR<\n TRegister,\n TParentRoute extends AnyRoute,\n TSSR,\n TFn,\n> =\n ResolveAllSSR<TParentRoute, TSSR> extends false\n ? any\n : RegisteredSSROption<TRegister> extends false\n ? any\n : ValidateSerializableInput<TRegister, LooseReturnType<TFn>>\n\ntype ResolveArrayShape<\n T extends ReadonlyArray<unknown>,\n TSerializable,\n TMode extends 'input' | 'result',\n> = number extends T['length']\n ? T extends Array<infer U>\n ? Array<ArrayModeResult<TMode, U, TSerializable>>\n : ReadonlyArray<ArrayModeResult<TMode, T[number], TSerializable>>\n : ResolveTupleShape<T, TSerializable, TMode>\n\ntype ResolveTupleShape<\n T extends ReadonlyArray<unknown>,\n TSerializable,\n TMode extends 'input' | 'result',\n> = T extends readonly [infer THead, ...infer TTail]\n ? readonly [\n ArrayModeResult<TMode, THead, TSerializable>,\n ...ResolveTupleShape<Readonly<TTail>, TSerializable, TMode>,\n ]\n : T\n\ntype ArrayModeResult<\n TMode extends 'input' | 'result',\n TValue,\n TSerializable,\n> = TMode extends 'input'\n ? ValidateSerializable<TValue, TSerializable>\n : ValidateSerializableResult<TValue, TSerializable>\n"],"names":[],"mappings":";;AAoBO,SAAS,2BAId,MACuC;AACvC,SAAO;AACT;AA4EO,SAAS,qBACd,sBACA,SACA;AACA,SAAO,aAAkC;AAAA,IACvC,KAAK,YAAY,qBAAqB;AAAA,IACtC,MAAM,qBAAqB;AAAA,IAC3B,OAAO;AAAA,MACL,OAAO,OAAO,KAAK;AACjB,eAAO,IAAI,MAAM,qBAAqB,eAAe,KAAK,CAAC;AAAA,MAC7D;AAAA,IAAA;AAAA,IAEF,UAAU,MAAM,KAAK;AACnB,cAAQ,SAAS;AACjB,aACE,aACA,aACA,qBAAqB,MACrB,QACA,IAAI,UAAU,IAAI,IAClB;AAAA,IAEJ;AAAA;AAAA,IAEA,aAAa;AAAA,EAAA,CACd;AACH;AAEO,SAAS,kBACd,sBACA;AACA,SAAO,aAAkC;AAAA,IACvC,KAAK,YAAY,qBAAqB;AAAA,IACtC,MAAM,qBAAqB;AAAA,IAC3B,OAAO;AAAA,MACL,KAAK,OAAO,KAAK;AACf,eAAO,IAAI,MAAM,qBAAqB,eAAe,KAAK,CAAC;AAAA,MAC7D;AAAA,MACA,MAAM,MAAM,OAAO,KAAK;AACtB,eAAO,MAAM,IAAI,MAAM,qBAAqB,eAAe,KAAK,CAAC;AAAA,MACnE;AAAA,MACA,OAAO,OAAO,KAAK;AACjB,eAAO,IAAI,MAAM,qBAAqB,eAAe,KAAK,CAAC;AAAA,MAC7D;AAAA,IAAA;AAAA;AAAA,IAGF,WAAW;AAAA,IACX,YAAY,MAAM,KAAK;AACrB,aAAO,qBAAqB;AAAA,QAC1B,IAAI,YAAY,IAAI;AAAA,MAAA;AAAA,IAExB;AAAA,EAAA,CACD;AACH;"}
|
package/package.json
CHANGED
package/src/router.ts
CHANGED
|
@@ -101,6 +101,12 @@ export interface Register {
|
|
|
101
101
|
// ssr
|
|
102
102
|
}
|
|
103
103
|
|
|
104
|
+
export type RegisteredSsr<TRegister = Register> = TRegister extends {
|
|
105
|
+
ssr: infer TSSR
|
|
106
|
+
}
|
|
107
|
+
? TSSR
|
|
108
|
+
: false
|
|
109
|
+
|
|
104
110
|
export type RegisteredRouter<TRegister = Register> = TRegister extends {
|
|
105
111
|
router: infer TRouter
|
|
106
112
|
}
|
|
@@ -1,7 +1,11 @@
|
|
|
1
1
|
import { createPlugin } from 'seroval'
|
|
2
2
|
import { GLOBAL_TSR } from '../constants'
|
|
3
3
|
import type { Plugin, SerovalNode } from 'seroval'
|
|
4
|
-
import type {
|
|
4
|
+
import type {
|
|
5
|
+
RegisteredConfigType,
|
|
6
|
+
RegisteredSsr,
|
|
7
|
+
SSROption,
|
|
8
|
+
} from '../../router'
|
|
5
9
|
import type { LooseReturnType } from '../../utils'
|
|
6
10
|
import type { AnyRoute, ResolveAllSSR } from '../../route'
|
|
7
11
|
|
|
@@ -30,21 +34,22 @@ export interface CreateSerializationAdapterOptions<TInput, TOutput> {
|
|
|
30
34
|
fromSerializable: (value: TOutput) => TInput
|
|
31
35
|
}
|
|
32
36
|
|
|
33
|
-
export type ValidateSerializable<T, TSerializable> =
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
37
|
+
export type ValidateSerializable<T, TSerializable> =
|
|
38
|
+
T extends ReadonlyArray<unknown>
|
|
39
|
+
? ResolveArrayShape<T, TSerializable, 'input'>
|
|
40
|
+
: T extends TSerializable
|
|
41
|
+
? T
|
|
42
|
+
: T extends (...args: Array<any>) => any
|
|
43
|
+
? 'Function is not serializable'
|
|
44
|
+
: T extends Promise<any>
|
|
45
|
+
? ValidateSerializablePromise<T, TSerializable>
|
|
46
|
+
: T extends ReadableStream<any>
|
|
47
|
+
? ValidateReadableStream<T, TSerializable>
|
|
48
|
+
: T extends Set<any>
|
|
49
|
+
? ValidateSerializableSet<T, TSerializable>
|
|
50
|
+
: T extends Map<any, any>
|
|
51
|
+
? ValidateSerializableMap<T, TSerializable>
|
|
52
|
+
: { [K in keyof T]: ValidateSerializable<T[K], TSerializable> }
|
|
48
53
|
|
|
49
54
|
export type ValidateSerializablePromise<T, TSerializable> =
|
|
50
55
|
T extends Promise<infer TAwaited>
|
|
@@ -173,13 +178,15 @@ export type ValidateSerializableInputResult<TRegister, T> =
|
|
|
173
178
|
ValidateSerializableResult<T, RegisteredSerializableInput<TRegister>>
|
|
174
179
|
|
|
175
180
|
export type ValidateSerializableResult<T, TSerializable> =
|
|
176
|
-
T extends
|
|
177
|
-
? T
|
|
178
|
-
:
|
|
179
|
-
?
|
|
180
|
-
:
|
|
181
|
-
?
|
|
182
|
-
:
|
|
181
|
+
T extends ReadonlyArray<unknown>
|
|
182
|
+
? ResolveArrayShape<T, TSerializable, 'result'>
|
|
183
|
+
: T extends TSerializable
|
|
184
|
+
? T
|
|
185
|
+
: unknown extends SerializerExtensions['ReadableStream']
|
|
186
|
+
? { [K in keyof T]: ValidateSerializableResult<T[K], TSerializable> }
|
|
187
|
+
: T extends SerializerExtensions['ReadableStream']
|
|
188
|
+
? ReadableStream
|
|
189
|
+
: { [K in keyof T]: ValidateSerializableResult<T[K], TSerializable> }
|
|
183
190
|
|
|
184
191
|
export type RegisteredSSROption<TRegister> =
|
|
185
192
|
unknown extends RegisteredConfigType<TRegister, 'defaultSsr'>
|
|
@@ -191,16 +198,17 @@ export type ValidateSerializableLifecycleResult<
|
|
|
191
198
|
TParentRoute extends AnyRoute,
|
|
192
199
|
TSSR,
|
|
193
200
|
TFn,
|
|
194
|
-
> =
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
201
|
+
> =
|
|
202
|
+
false extends RegisteredSsr<TRegister>
|
|
203
|
+
? any
|
|
204
|
+
: ValidateSerializableLifecycleResultSSR<
|
|
205
|
+
TRegister,
|
|
206
|
+
TParentRoute,
|
|
207
|
+
TSSR,
|
|
208
|
+
TFn
|
|
209
|
+
> extends infer TInput
|
|
210
|
+
? TInput
|
|
211
|
+
: never
|
|
204
212
|
|
|
205
213
|
export type ValidateSerializableLifecycleResultSSR<
|
|
206
214
|
TRegister,
|
|
@@ -213,3 +221,32 @@ export type ValidateSerializableLifecycleResultSSR<
|
|
|
213
221
|
: RegisteredSSROption<TRegister> extends false
|
|
214
222
|
? any
|
|
215
223
|
: ValidateSerializableInput<TRegister, LooseReturnType<TFn>>
|
|
224
|
+
|
|
225
|
+
type ResolveArrayShape<
|
|
226
|
+
T extends ReadonlyArray<unknown>,
|
|
227
|
+
TSerializable,
|
|
228
|
+
TMode extends 'input' | 'result',
|
|
229
|
+
> = number extends T['length']
|
|
230
|
+
? T extends Array<infer U>
|
|
231
|
+
? Array<ArrayModeResult<TMode, U, TSerializable>>
|
|
232
|
+
: ReadonlyArray<ArrayModeResult<TMode, T[number], TSerializable>>
|
|
233
|
+
: ResolveTupleShape<T, TSerializable, TMode>
|
|
234
|
+
|
|
235
|
+
type ResolveTupleShape<
|
|
236
|
+
T extends ReadonlyArray<unknown>,
|
|
237
|
+
TSerializable,
|
|
238
|
+
TMode extends 'input' | 'result',
|
|
239
|
+
> = T extends readonly [infer THead, ...infer TTail]
|
|
240
|
+
? readonly [
|
|
241
|
+
ArrayModeResult<TMode, THead, TSerializable>,
|
|
242
|
+
...ResolveTupleShape<Readonly<TTail>, TSerializable, TMode>,
|
|
243
|
+
]
|
|
244
|
+
: T
|
|
245
|
+
|
|
246
|
+
type ArrayModeResult<
|
|
247
|
+
TMode extends 'input' | 'result',
|
|
248
|
+
TValue,
|
|
249
|
+
TSerializable,
|
|
250
|
+
> = TMode extends 'input'
|
|
251
|
+
? ValidateSerializable<TValue, TSerializable>
|
|
252
|
+
: ValidateSerializableResult<TValue, TSerializable>
|