@hexclave/next 1.0.122 → 1.0.125
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/{admin-app-impl-CLF79SVd.d.ts → admin-app-impl-Bxad6t8m.d.ts} +7 -7
- package/dist/{admin-app-impl-CLF79SVd.d.ts.map → admin-app-impl-Bxad6t8m.d.ts.map} +1 -1
- package/dist/esm/generated/quetzal-translations.d.ts +2 -2
- package/dist/esm/lib/hexclave-app/apps/implementations/admin-app-impl.d.ts +4 -4
- package/dist/esm/lib/hexclave-app/apps/implementations/client-app-impl.d.ts +2 -2
- package/dist/esm/lib/hexclave-app/apps/implementations/common.js +2 -2
- package/dist/generated/quetzal-translations.d.ts +1 -1
- package/dist/{hexclave-provider-HWoM-7yD.d.ts → hexclave-provider-w8nX8KDv.d.ts} +2 -2
- package/dist/{hexclave-provider-HWoM-7yD.d.ts.map → hexclave-provider-w8nX8KDv.d.ts.map} +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/lib/hexclave-app/apps/implementations/admin-app-impl.d.ts +1 -1
- package/dist/lib/hexclave-app/apps/implementations/client-app-impl.d.ts +1 -1
- package/dist/lib/hexclave-app/apps/implementations/common.js +2 -2
- package/dist/lib/hexclave-app/apps/implementations/index.d.ts +1 -1
- package/dist/lib/hexclave-app/apps/implementations/server-app-impl.d.ts +1 -1
- package/dist/providers/hexclave-provider.d.ts +1 -1
- package/dist/providers/translation-provider.d.ts +1 -1
- package/dist/{quetzal-translations-DVNj-zsr.d.ts → quetzal-translations-XeH3zQ9l.d.ts} +3 -3
- package/dist/{quetzal-translations-DVNj-zsr.d.ts.map → quetzal-translations-XeH3zQ9l.d.ts.map} +1 -1
- package/dist/tanstack-start-server-context.d.ts +804 -485
- package/dist/tanstack-start-server-context.d.ts.map +1 -1
- package/dist/{translation-provider-DPFkLbrw.d.ts → translation-provider-WOaZXqAz.d.ts} +2 -2
- package/dist/{translation-provider-DPFkLbrw.d.ts.map → translation-provider-WOaZXqAz.d.ts.map} +1 -1
- package/package.json +4 -4
|
@@ -1,9 +1,79 @@
|
|
|
1
|
-
import { ReadableStream as ReadableStream$1 } from "node:stream/web";
|
|
2
1
|
import { Readable } from "node:stream";
|
|
2
|
+
import { ReadableStream as ReadableStream$1 } from "node:stream/web";
|
|
3
3
|
|
|
4
4
|
//#region \0rolldown/runtime.js
|
|
5
5
|
//#endregion
|
|
6
|
-
//#region ../../node_modules/.pnpm/@tanstack+
|
|
6
|
+
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.171.34/node_modules/@tanstack/router-core/dist/esm/sieve-cache.d.ts
|
|
7
|
+
type SieveCache<TKey, TValue> = {
|
|
8
|
+
get: (key: TKey) => TValue | undefined;
|
|
9
|
+
set: (key: TKey, value: TValue) => void;
|
|
10
|
+
clear: () => void;
|
|
11
|
+
};
|
|
12
|
+
//#endregion
|
|
13
|
+
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.171.34/node_modules/@tanstack/router-core/dist/esm/validators.d.ts
|
|
14
|
+
interface StandardSchemaValidatorProps<TInput, TOutput> {
|
|
15
|
+
readonly types?: StandardSchemaValidatorTypes<TInput, TOutput> | undefined;
|
|
16
|
+
readonly validate: AnyStandardSchemaValidate;
|
|
17
|
+
}
|
|
18
|
+
interface StandardSchemaValidator<TInput, TOutput> {
|
|
19
|
+
readonly '~standard': StandardSchemaValidatorProps<TInput, TOutput>;
|
|
20
|
+
}
|
|
21
|
+
type AnyStandardSchemaValidator = StandardSchemaValidator<any, any>;
|
|
22
|
+
interface StandardSchemaValidatorTypes<TInput, TOutput> {
|
|
23
|
+
readonly input: TInput;
|
|
24
|
+
readonly output: TOutput;
|
|
25
|
+
}
|
|
26
|
+
interface AnyStandardSchemaValidateSuccess {
|
|
27
|
+
readonly value: any;
|
|
28
|
+
readonly issues?: undefined;
|
|
29
|
+
}
|
|
30
|
+
interface AnyStandardSchemaValidateFailure {
|
|
31
|
+
readonly issues: ReadonlyArray<AnyStandardSchemaValidateIssue>;
|
|
32
|
+
}
|
|
33
|
+
interface AnyStandardSchemaValidateIssue {
|
|
34
|
+
readonly message: string;
|
|
35
|
+
}
|
|
36
|
+
type AnyStandardSchemaValidate = (value: unknown) => (AnyStandardSchemaValidateSuccess | AnyStandardSchemaValidateFailure) | Promise<AnyStandardSchemaValidateSuccess | AnyStandardSchemaValidateFailure>;
|
|
37
|
+
interface ValidatorObj<TInput, TOutput> {
|
|
38
|
+
parse: ValidatorFn<TInput, TOutput>;
|
|
39
|
+
}
|
|
40
|
+
type AnyValidatorObj = ValidatorObj<any, any>;
|
|
41
|
+
interface ValidatorAdapter<TInput, TOutput> {
|
|
42
|
+
types: {
|
|
43
|
+
input: TInput;
|
|
44
|
+
output: TOutput;
|
|
45
|
+
};
|
|
46
|
+
parse: (input: unknown) => TOutput;
|
|
47
|
+
}
|
|
48
|
+
type AnyValidatorAdapter = ValidatorAdapter<any, any>;
|
|
49
|
+
type ValidatorFn<TInput, TOutput> = (input: TInput) => TOutput;
|
|
50
|
+
type Validator<TInput, TOutput> = ValidatorObj<TInput, TOutput> | ValidatorFn<TInput, TOutput> | ValidatorAdapter<TInput, TOutput> | StandardSchemaValidator<TInput, TOutput> | undefined;
|
|
51
|
+
type AnyValidator = Validator<any, any>;
|
|
52
|
+
type AnySchema = {};
|
|
53
|
+
type DefaultValidator = Validator<Record<string, unknown>, AnySchema>;
|
|
54
|
+
type ResolveSearchValidatorInputFn<TValidator> = TValidator extends ((input: infer TSchemaInput) => any) ? TSchemaInput extends SearchSchemaInput ? Omit<TSchemaInput, keyof SearchSchemaInput> : ResolveValidatorOutputFn<TValidator> : AnySchema;
|
|
55
|
+
type ResolveSearchValidatorInput<TValidator> = TValidator extends AnyStandardSchemaValidator ? NonNullable<TValidator['~standard']['types']>['input'] : TValidator extends AnyValidatorAdapter ? TValidator['types']['input'] : TValidator extends AnyValidatorObj ? ResolveSearchValidatorInputFn<TValidator['parse']> : ResolveSearchValidatorInputFn<TValidator>;
|
|
56
|
+
type ResolveValidatorOutputFn<TValidator> = TValidator extends ((...args: any) => infer TSchema) ? TSchema : AnySchema;
|
|
57
|
+
type ResolveValidatorOutput<TValidator> = unknown extends TValidator ? TValidator : TValidator extends AnyStandardSchemaValidator ? NonNullable<TValidator['~standard']['types']>['output'] : TValidator extends AnyValidatorAdapter ? TValidator['types']['output'] : TValidator extends AnyValidatorObj ? ResolveValidatorOutputFn<TValidator['parse']> : ResolveValidatorOutputFn<TValidator>;
|
|
58
|
+
//#endregion
|
|
59
|
+
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.171.34/node_modules/@tanstack/router-core/dist/esm/fileRoute.d.ts
|
|
60
|
+
interface FileRouteTypes {
|
|
61
|
+
fileRoutesByFullPath: any;
|
|
62
|
+
fullPaths: any;
|
|
63
|
+
to: any;
|
|
64
|
+
fileRoutesByTo: any;
|
|
65
|
+
id: any;
|
|
66
|
+
fileRoutesById: any;
|
|
67
|
+
}
|
|
68
|
+
type InferFileRouteTypes<TRouteTree extends AnyRoute> = unknown extends TRouteTree['types']['fileRouteTypes'] ? never : TRouteTree['types']['fileRouteTypes'] extends FileRouteTypes ? TRouteTree['types']['fileRouteTypes'] : never;
|
|
69
|
+
type LazyRouteOptions = Pick<UpdatableRouteOptions<AnyRoute, string, string, AnyPathParams, AnyValidator, {}, AnyContext, AnyContext, AnyContext, AnyContext>, 'component' | 'errorComponent' | 'pendingComponent' | 'notFoundComponent'>;
|
|
70
|
+
interface LazyRoute<in out TRoute extends AnyRoute> {
|
|
71
|
+
options: {
|
|
72
|
+
id: string;
|
|
73
|
+
} & LazyRouteOptions;
|
|
74
|
+
}
|
|
75
|
+
//#endregion
|
|
76
|
+
//#region ../../node_modules/.pnpm/@tanstack+history@1.162.4/node_modules/@tanstack/history/dist/esm/index.d.ts
|
|
7
77
|
interface NavigateOptions$1 {
|
|
8
78
|
ignoreBlocker?: boolean;
|
|
9
79
|
}
|
|
@@ -33,7 +103,9 @@ interface RouterHistory {
|
|
|
33
103
|
flush: () => void;
|
|
34
104
|
destroy: () => void;
|
|
35
105
|
notify: (action: SubscriberHistoryAction) => void;
|
|
106
|
+
_getBlockers: () => Array<NavigationBlocker>;
|
|
36
107
|
_ignoreSubscribers?: boolean;
|
|
108
|
+
_ignoreNextBeforeUnload?: (href: string) => void;
|
|
37
109
|
}
|
|
38
110
|
interface HistoryLocation extends ParsedPath {
|
|
39
111
|
state: ParsedHistoryState;
|
|
@@ -63,26 +135,9 @@ type NavigationBlocker = {
|
|
|
63
135
|
enableBeforeUnload?: (() => boolean) | boolean;
|
|
64
136
|
};
|
|
65
137
|
//#endregion
|
|
66
|
-
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.
|
|
67
|
-
interface FileRouteTypes {
|
|
68
|
-
fileRoutesByFullPath: any;
|
|
69
|
-
fullPaths: any;
|
|
70
|
-
to: any;
|
|
71
|
-
fileRoutesByTo: any;
|
|
72
|
-
id: any;
|
|
73
|
-
fileRoutesById: any;
|
|
74
|
-
}
|
|
75
|
-
type InferFileRouteTypes<TRouteTree extends AnyRoute> = unknown extends TRouteTree['types']['fileRouteTypes'] ? never : TRouteTree['types']['fileRouteTypes'] extends FileRouteTypes ? TRouteTree['types']['fileRouteTypes'] : never;
|
|
76
|
-
type LazyRouteOptions = Pick<UpdatableRouteOptions<AnyRoute, string, string, AnyPathParams, AnyValidator, {}, AnyContext, AnyContext, AnyContext, AnyContext>, 'component' | 'errorComponent' | 'pendingComponent' | 'notFoundComponent'>;
|
|
77
|
-
interface LazyRoute<in out TRoute extends AnyRoute> {
|
|
78
|
-
options: {
|
|
79
|
-
id: string;
|
|
80
|
-
} & LazyRouteOptions;
|
|
81
|
-
}
|
|
82
|
-
//#endregion
|
|
83
|
-
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.166.6/node_modules/@tanstack/router-core/dist/esm/utils.d.ts
|
|
138
|
+
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.171.34/node_modules/@tanstack/router-core/dist/esm/utils.d.ts
|
|
84
139
|
type Awaitable<T> = T | Promise<T>;
|
|
85
|
-
type NoInfer
|
|
140
|
+
type NoInfer<T> = [T][T extends any ? 0 : never];
|
|
86
141
|
type PickAsRequired<TValue, TKey extends keyof TValue> = Omit<TValue, TKey> & Required<Pick<TValue, TKey>>;
|
|
87
142
|
type Expand<T> = T extends object ? T extends infer O ? O extends Function ? O : { [K in keyof O]: O[K] } : never : T;
|
|
88
143
|
type MakeDifferenceOptional<TLeft, TRight> = keyof TLeft & keyof TRight extends never ? TRight : Omit<TRight, keyof TLeft & keyof TRight> & { [K in keyof TLeft & keyof TRight]?: TRight[K] };
|
|
@@ -100,14 +155,58 @@ type Constrain<T, TConstraint, TDefault = TConstraint> = (T extends TConstraint
|
|
|
100
155
|
type ConstrainLiteral<T, TConstraint, TDefault = TConstraint> = (T & TConstraint) | TDefault;
|
|
101
156
|
type LooseReturnType<T> = T extends ((...args: Array<any>) => infer TReturn) ? TReturn : never;
|
|
102
157
|
type LooseAsyncReturnType<T> = T extends ((...args: Array<any>) => infer TReturn) ? TReturn extends Promise<infer TReturn> ? TReturn : TReturn : never;
|
|
103
|
-
type ControlledPromise<T> = Promise<T> & {
|
|
104
|
-
resolve: (value: T) => void;
|
|
105
|
-
reject: (value: any) => void;
|
|
106
|
-
status: 'pending' | 'resolved' | 'rejected';
|
|
107
|
-
value?: T;
|
|
108
|
-
};
|
|
109
158
|
//#endregion
|
|
110
|
-
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.
|
|
159
|
+
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.171.34/node_modules/@tanstack/router-core/dist/esm/location.d.ts
|
|
160
|
+
interface ParsedLocation<TSearchObj extends AnySchema = {}> {
|
|
161
|
+
/**
|
|
162
|
+
* The full path of the location, including pathname, search, and hash.
|
|
163
|
+
* Does not include the origin. Is the equivalent of calling
|
|
164
|
+
* `url.replace(url.origin, '')`
|
|
165
|
+
*/
|
|
166
|
+
href: string;
|
|
167
|
+
/**
|
|
168
|
+
* @description The pathname of the location, including the leading slash.
|
|
169
|
+
*/
|
|
170
|
+
pathname: string;
|
|
171
|
+
/**
|
|
172
|
+
* The parsed search parameters of the location in object form.
|
|
173
|
+
*/
|
|
174
|
+
search: TSearchObj;
|
|
175
|
+
/**
|
|
176
|
+
* The search string of the location, including the leading question mark.
|
|
177
|
+
*/
|
|
178
|
+
searchStr: string;
|
|
179
|
+
/**
|
|
180
|
+
* The in-memory state of the location as it *may* exist in the browser's history.
|
|
181
|
+
*/
|
|
182
|
+
state: ParsedHistoryState;
|
|
183
|
+
/**
|
|
184
|
+
* The hash of the location, excluding the leading hash character.
|
|
185
|
+
* (e.g., '123' instead of '#123')
|
|
186
|
+
*/
|
|
187
|
+
hash: string;
|
|
188
|
+
/**
|
|
189
|
+
* The masked location of the location.
|
|
190
|
+
*/
|
|
191
|
+
maskedLocation?: ParsedLocation<TSearchObj>;
|
|
192
|
+
/**
|
|
193
|
+
* Whether to unmask the location on reload.
|
|
194
|
+
*/
|
|
195
|
+
unmaskOnReload?: boolean;
|
|
196
|
+
/**
|
|
197
|
+
* @private
|
|
198
|
+
* @description The public href of the location.
|
|
199
|
+
* If a rewrite is applied, the `href` property will be the rewritten URL.
|
|
200
|
+
*/
|
|
201
|
+
publicHref: string;
|
|
202
|
+
/**
|
|
203
|
+
* @private
|
|
204
|
+
* @description Whether the publicHref is external (different origin from rewrite).
|
|
205
|
+
*/
|
|
206
|
+
external: boolean;
|
|
207
|
+
}
|
|
208
|
+
//#endregion
|
|
209
|
+
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.171.34/node_modules/@tanstack/router-core/dist/esm/link.d.ts
|
|
111
210
|
type IsRequiredParams<TParams> = Record<never, never> extends TParams ? never : true;
|
|
112
211
|
interface ParsePathParamsResult<in out TRequired, in out TOptional, in out TRest> {
|
|
113
212
|
required: TRequired;
|
|
@@ -258,10 +357,10 @@ interface MakeRequiredSearchParams<in out TRouter extends AnyRouter, in out TFro
|
|
|
258
357
|
type IsRequired<TRouter extends AnyRouter, TParamVariant extends ParamVariant, TFrom, TTo> = ResolveRelativePath<TFrom, TTo> extends infer TPath ? undefined extends TPath ? never : TPath extends CatchAllPaths<TRouter> ? never : IsRequiredParams<ResolveRelativeToParams<TRouter, TParamVariant, TFrom, TTo>> : never;
|
|
259
358
|
type SearchParamOptions<TRouter extends AnyRouter, TFrom, TTo> = IsRequired<TRouter, 'SEARCH', TFrom, TTo> extends never ? MakeOptionalSearchParams<TRouter, TFrom, TTo> : MakeRequiredSearchParams<TRouter, TFrom, TTo>;
|
|
260
359
|
type PathParamOptions<TRouter extends AnyRouter, TFrom, TTo> = IsRequired<TRouter, 'PATH', TFrom, TTo> extends never ? MakeOptionalPathParams<TRouter, TFrom, TTo> : MakeRequiredPathParams<TRouter, TFrom, TTo>;
|
|
261
|
-
type ToPathOption<TRouter extends AnyRouter = AnyRouter, TFrom extends string = string, TTo extends string | undefined = string> = ConstrainLiteral<TTo, RelativeToPathAutoComplete<TRouter, NoInfer
|
|
360
|
+
type ToPathOption<TRouter extends AnyRouter = AnyRouter, TFrom extends string = string, TTo extends string | undefined = string> = ConstrainLiteral<TTo, RelativeToPathAutoComplete<TRouter, NoInfer<TFrom> extends string ? NoInfer<TFrom> : '', NoInfer<TTo> & string>>;
|
|
262
361
|
type FromPathOption<TRouter extends AnyRouter, TFrom> = ConstrainLiteral<TFrom, RoutePaths<TRouter['routeTree']>>;
|
|
263
362
|
//#endregion
|
|
264
|
-
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.
|
|
363
|
+
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.171.34/node_modules/@tanstack/router-core/dist/esm/routeInfo.d.ts
|
|
265
364
|
type ParseRoute<TRouteTree, TAcc = TRouteTree> = TRouteTree extends {
|
|
266
365
|
types: {
|
|
267
366
|
children: infer TChildren;
|
|
@@ -271,6 +370,8 @@ type ParseRouteWithoutBranches<TRouteTree> = ParseRoute<TRouteTree> extends infe
|
|
|
271
370
|
type CodeRoutesById<TRouteTree extends AnyRoute> = ParseRoute<TRouteTree> extends infer TRoutes extends AnyRoute ? { [K in TRoutes as K['id']]: K } : never;
|
|
272
371
|
type RoutesById<TRouteTree extends AnyRoute> = InferFileRouteTypes<TRouteTree> extends never ? CodeRoutesById<TRouteTree> : InferFileRouteTypes<TRouteTree>['fileRoutesById'];
|
|
273
372
|
type RouteById<TRouteTree extends AnyRoute, TId> = Extract<RoutesById<TRouteTree>[TId & keyof RoutesById<TRouteTree>], AnyRoute>;
|
|
373
|
+
type CodeRouteIds<TRouteTree extends AnyRoute> = ParseRoute<TRouteTree> extends infer TRoutes extends AnyRoute ? TRoutes['id'] : never;
|
|
374
|
+
type RouteIds<TRouteTree extends AnyRoute> = InferFileRouteTypes<TRouteTree> extends never ? CodeRouteIds<TRouteTree> : InferFileRouteTypes<TRouteTree>['id'];
|
|
274
375
|
type ParentPath<TRouter extends AnyRouter> = TrailingSlashOptionByRouter<TRouter> extends 'always' ? '../' : TrailingSlashOptionByRouter<TRouter> extends 'never' ? '..' : '../' | '..';
|
|
275
376
|
type CurrentPath<TRouter extends AnyRouter> = TrailingSlashOptionByRouter<TRouter> extends 'always' ? './' : TrailingSlashOptionByRouter<TRouter> extends 'never' ? '.' : './' | '.';
|
|
276
377
|
type ToPath<TRouter extends AnyRouter, TTo extends string> = TrailingSlashOptionByRouter<TRouter> extends 'always' ? AddTrailingSlash<TTo> : TrailingSlashOptionByRouter<TRouter> extends 'never' ? RemoveTrailingSlashes<TTo> : AddTrailingSlash<TTo> | RemoveTrailingSlashes<TTo>;
|
|
@@ -301,15 +402,34 @@ type RouteByToPath<TRouter extends AnyRouter, TTo> = InferFileRouteTypes<TRouter
|
|
|
301
402
|
type FullSearchSchema<TRouteTree extends AnyRoute> = ParseRoute<TRouteTree> extends infer TRoutes extends AnyRoute ? PartialMergeAll<TRoutes['types']['fullSearchSchema']> : never;
|
|
302
403
|
type FullSearchSchemaInput<TRouteTree extends AnyRoute> = ParseRoute<TRouteTree> extends infer TRoutes extends AnyRoute ? PartialMergeAll<TRoutes['types']['fullSearchSchemaInput']> : never;
|
|
303
404
|
type AllParams<TRouteTree extends AnyRoute> = ParseRoute<TRouteTree> extends infer TRoutes extends AnyRoute ? PartialMergeAll<TRoutes['types']['allParams']> : never;
|
|
405
|
+
type AllContext<TRouteTree extends AnyRoute> = ParseRoute<TRouteTree> extends infer TRoutes extends AnyRoute ? PartialMergeAll<TRoutes['types']['allContext']> : never;
|
|
406
|
+
type AllLoaderData<TRouteTree extends AnyRoute> = ParseRoute<TRouteTree> extends infer TRoutes extends AnyRoute ? PartialMergeAll<TRoutes['types']['loaderData']> : never;
|
|
407
|
+
//#endregion
|
|
408
|
+
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.171.34/node_modules/@tanstack/router-core/dist/esm/not-found.d.ts
|
|
409
|
+
type NotFoundError = {
|
|
410
|
+
/**
|
|
411
|
+
@deprecated
|
|
412
|
+
Use `routeId: rootRouteId` instead
|
|
413
|
+
*/
|
|
414
|
+
global?: boolean;
|
|
415
|
+
/**
|
|
416
|
+
@private
|
|
417
|
+
Do not use this. It's used internally to indicate a path matching error
|
|
418
|
+
*/
|
|
419
|
+
_global?: boolean;
|
|
420
|
+
data?: any;
|
|
421
|
+
throw?: boolean;
|
|
422
|
+
routeId?: RouteIds<RegisteredRouter['routeTree']>;
|
|
423
|
+
headers?: HeadersInit;
|
|
424
|
+
};
|
|
304
425
|
//#endregion
|
|
305
|
-
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.
|
|
426
|
+
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.171.34/node_modules/@tanstack/router-core/dist/esm/redirect.d.ts
|
|
306
427
|
type AnyRedirect = Redirect<any, any, any, any, any>;
|
|
307
428
|
/**
|
|
308
429
|
* @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RedirectType)
|
|
309
430
|
*/
|
|
310
431
|
type Redirect<TRouter extends AnyRouter = RegisteredRouter, TFrom extends string = string, TTo extends string | undefined = undefined, TMaskFrom extends string = TFrom, TMaskTo extends string = '.'> = Response & {
|
|
311
|
-
options: NavigateOptions<TRouter, TFrom, TTo, TMaskFrom, TMaskTo
|
|
312
|
-
redirectHandled?: boolean;
|
|
432
|
+
options: NavigateOptions<TRouter, TFrom, TTo, TMaskFrom, TMaskTo>;
|
|
313
433
|
};
|
|
314
434
|
type RedirectOptions<TRouter extends AnyRouter = RegisteredRouter, TFrom extends string = string, TTo extends string | undefined = undefined, TMaskFrom extends string = TFrom, TMaskTo extends string = '.'> = {
|
|
315
435
|
href?: string;
|
|
@@ -347,7 +467,7 @@ interface RedirectFnRoute<in out TDefaultFrom extends string = string> {
|
|
|
347
467
|
<TRouter extends AnyRouter = RegisteredRouter, const TTo extends string | undefined = undefined, const TMaskTo extends string = ''>(opts: RedirectOptionsRoute<TDefaultFrom, TRouter, TTo, TMaskTo>): Redirect<TRouter, TDefaultFrom, TTo, TDefaultFrom, TMaskTo>;
|
|
348
468
|
}
|
|
349
469
|
//#endregion
|
|
350
|
-
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.
|
|
470
|
+
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.171.34/node_modules/@tanstack/router-core/dist/esm/Matches.d.ts
|
|
351
471
|
interface DefaultRouteMatchExtensions {
|
|
352
472
|
scripts?: unknown;
|
|
353
473
|
links?: unknown;
|
|
@@ -364,35 +484,26 @@ interface RouteMatch$1<out TRouteId, out TFullPath, out TAllParams, out TFullSea
|
|
|
364
484
|
pathname: string;
|
|
365
485
|
params: TAllParams;
|
|
366
486
|
_strictParams: TAllParams;
|
|
367
|
-
status: 'pending' | 'success' | 'error' | '
|
|
487
|
+
status: 'pending' | 'success' | 'error' | 'notFound';
|
|
368
488
|
isFetching: false | 'beforeLoad' | 'loader';
|
|
369
489
|
error: unknown;
|
|
370
490
|
paramsError: unknown;
|
|
371
491
|
searchError: unknown;
|
|
372
492
|
updatedAt: number;
|
|
373
|
-
_nonReactive: {
|
|
374
|
-
loadPromise?: ControlledPromise<void>;
|
|
375
|
-
displayPendingPromise?: Promise<void>;
|
|
376
|
-
minPendingPromise?: ControlledPromise<void>;
|
|
377
|
-
dehydrated?: boolean;
|
|
378
|
-
};
|
|
379
493
|
loaderData?: TLoaderData;
|
|
380
494
|
context: TAllContext;
|
|
381
495
|
search: TFullSearchSchema;
|
|
382
496
|
_strictSearch: TFullSearchSchema;
|
|
383
|
-
fetchCount: number;
|
|
384
497
|
abortController: AbortController;
|
|
385
498
|
cause: 'preload' | 'enter' | 'stay';
|
|
386
499
|
loaderDeps: TLoaderDeps;
|
|
387
500
|
preload: boolean;
|
|
388
501
|
invalid: boolean;
|
|
389
502
|
headers?: Record<string, string>;
|
|
390
|
-
|
|
503
|
+
_notFound?: boolean;
|
|
391
504
|
staticData: StaticDataRouteOption;
|
|
392
505
|
/** This attribute is not reactive */
|
|
393
506
|
ssr?: SSROption;
|
|
394
|
-
_forcePending?: boolean;
|
|
395
|
-
_displayPending?: boolean;
|
|
396
507
|
}
|
|
397
508
|
interface PreValidationErrorHandlingRouteMatch<TRouteId, TFullPath, TAllParams, TFullSearchSchema> {
|
|
398
509
|
id: string;
|
|
@@ -419,6 +530,7 @@ interface PreValidationErrorHandlingRouteMatch<TRouteId, TFullPath, TAllParams,
|
|
|
419
530
|
}
|
|
420
531
|
type MakePreValidationErrorHandlingRouteMatchUnion<TRouter extends AnyRouter = RegisteredRouter, TRoute extends AnyRoute = ParseRoute<TRouter['routeTree']>> = TRoute extends any ? PreValidationErrorHandlingRouteMatch<TRoute['id'], TRoute['fullPath'], TRoute['types']['allParams'], TRoute['types']['fullSearchSchema']> : never;
|
|
421
532
|
type MakeRouteMatchFromRoute<TRoute extends AnyRoute> = RouteMatch$1<TRoute['types']['id'], TRoute['types']['fullPath'], TRoute['types']['allParams'], TRoute['types']['fullSearchSchema'], TRoute['types']['loaderData'], TRoute['types']['allContext'], TRoute['types']['loaderDeps']>;
|
|
533
|
+
type MakeRouteMatch<TRouteTree extends AnyRoute = RegisteredRouter['routeTree'], TRouteId = RouteIds<TRouteTree>, TStrict extends boolean = true> = RouteMatch$1<TRouteId, RouteById<TRouteTree, TRouteId>['types']['fullPath'], TStrict extends false ? AllParams<TRouteTree> : RouteById<TRouteTree, TRouteId>['types']['allParams'], TStrict extends false ? FullSearchSchema<TRouteTree> : RouteById<TRouteTree, TRouteId>['types']['fullSearchSchema'], TStrict extends false ? AllLoaderData<TRouteTree> : RouteById<TRouteTree, TRouteId>['types']['loaderData'], TStrict extends false ? AllContext<TRouteTree> : RouteById<TRouteTree, TRouteId>['types']['allContext'], RouteById<TRouteTree, TRouteId>['types']['loaderDeps']>;
|
|
422
534
|
type AnyRouteMatch = RouteMatch$1<any, any, any, any, any, any, any>;
|
|
423
535
|
type MakeRouteMatchUnion<TRouter extends AnyRouter = RegisteredRouter, TRoute extends AnyRoute = ParseRoute<TRouter['routeTree']>> = TRoute extends any ? RouteMatch$1<TRoute['id'], TRoute['fullPath'], TRoute['types']['allParams'], TRoute['types']['fullSearchSchema'], TRoute['types']['loaderData'], TRoute['types']['allContext'], TRoute['types']['loaderDeps']> : never;
|
|
424
536
|
/**
|
|
@@ -455,12 +567,12 @@ interface MatchRouteOptions {
|
|
|
455
567
|
fuzzy?: boolean;
|
|
456
568
|
}
|
|
457
569
|
//#endregion
|
|
458
|
-
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.
|
|
570
|
+
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.171.34/node_modules/@tanstack/router-core/dist/esm/root.d.ts
|
|
459
571
|
/** Stable identifier used for the root route in a route tree. */
|
|
460
572
|
declare const rootRouteId = "__root__";
|
|
461
573
|
type RootRouteId = typeof rootRouteId;
|
|
462
574
|
//#endregion
|
|
463
|
-
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.
|
|
575
|
+
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.171.34/node_modules/@tanstack/router-core/dist/esm/RouterProvider.d.ts
|
|
464
576
|
interface CommitLocationOptions {
|
|
465
577
|
replace?: boolean;
|
|
466
578
|
resetScroll?: boolean;
|
|
@@ -479,19 +591,11 @@ type BuildLocationFn = <TRouter extends RegisteredRouter, TTo extends string | u
|
|
|
479
591
|
_isNavigate?: boolean;
|
|
480
592
|
}) => ParsedLocation;
|
|
481
593
|
//#endregion
|
|
482
|
-
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.
|
|
483
|
-
/**
|
|
484
|
-
* Hint for RawStream encoding strategy during SSR serialization.
|
|
485
|
-
* - 'binary': Always use base64 encoding (best for binary data like files, images)
|
|
486
|
-
* - 'text': Try UTF-8 first, fallback to base64 (best for text-heavy data like RSC payloads)
|
|
487
|
-
*/
|
|
594
|
+
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.171.34/node_modules/@tanstack/router-core/dist/esm/ssr/serializer/RawStream.d.ts
|
|
488
595
|
type RawStreamHint = 'binary' | 'text';
|
|
489
|
-
/**
|
|
490
|
-
* Options for RawStream configuration.
|
|
491
|
-
*/
|
|
492
596
|
interface RawStreamOptions {
|
|
493
597
|
/**
|
|
494
|
-
* Encoding hint for SSR serialization.
|
|
598
|
+
* Encoding hint for JSON and SSR serialization.
|
|
495
599
|
* - 'binary' (default): Always use base64 encoding
|
|
496
600
|
* - 'text': Try UTF-8 first, fallback to base64 for invalid UTF-8 chunks
|
|
497
601
|
*/
|
|
@@ -499,7 +603,8 @@ interface RawStreamOptions {
|
|
|
499
603
|
}
|
|
500
604
|
/**
|
|
501
605
|
* Marker class for ReadableStream<Uint8Array> that should be serialized
|
|
502
|
-
* with base64 encoding (SSR) or binary framing
|
|
606
|
+
* with base64/text encoding (JSON and SSR) or binary framing
|
|
607
|
+
* (server-function responses).
|
|
503
608
|
*
|
|
504
609
|
* Wrap your binary streams with this to get efficient serialization:
|
|
505
610
|
* ```ts
|
|
@@ -509,6 +614,13 @@ interface RawStreamOptions {
|
|
|
509
614
|
* // For text-heavy data (RSC payloads, etc.)
|
|
510
615
|
* return { data: new RawStream(rscStream, { hint: 'text' }) }
|
|
511
616
|
* ```
|
|
617
|
+
*
|
|
618
|
+
* RawStreams returned from one server function share one ordered response.
|
|
619
|
+
* Arbitrary or sequential consumption can require potentially unbounded client
|
|
620
|
+
* buffering for unread data. Cancelling one RawStream discards it locally;
|
|
621
|
+
* abort the whole server-function call to cancel the response and server work.
|
|
622
|
+
* Consume streams concurrently, cancel unused streams promptly, or use separate
|
|
623
|
+
* calls when independent backpressure is required.
|
|
512
624
|
*/
|
|
513
625
|
declare class RawStream {
|
|
514
626
|
readonly stream: ReadableStream<Uint8Array>;
|
|
@@ -516,7 +628,7 @@ declare class RawStream {
|
|
|
516
628
|
constructor(stream: ReadableStream<Uint8Array>, options?: RawStreamOptions);
|
|
517
629
|
}
|
|
518
630
|
//#endregion
|
|
519
|
-
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.
|
|
631
|
+
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.171.34/node_modules/@tanstack/router-core/dist/esm/ssr/serializer/transformer.d.ts
|
|
520
632
|
declare const TSR_SERIALIZABLE: unique symbol;
|
|
521
633
|
type TSR_SERIALIZABLE = typeof TSR_SERIALIZABLE;
|
|
522
634
|
type TsrSerializable = {
|
|
@@ -533,20 +645,23 @@ interface DefaultSerializable {
|
|
|
533
645
|
Uint8Array: Uint8Array;
|
|
534
646
|
RawStream: RawStream;
|
|
535
647
|
TsrSerializable: TsrSerializable;
|
|
648
|
+
void: void;
|
|
536
649
|
}
|
|
537
650
|
interface SerializableExtensions extends DefaultSerializable {}
|
|
538
651
|
type Serializable = SerializableExtensions[keyof SerializableExtensions];
|
|
539
652
|
type UnionizeSerializationAdaptersInput<TAdapters extends ReadonlyArray<AnySerializationAdapter>> = TAdapters[number]['~types']['input'];
|
|
540
|
-
type ValidateSerializable<T, TSerializable> = T extends
|
|
653
|
+
type ValidateSerializable<T, TSerializable> = T extends TSerializable ? T : T extends ((...args: Array<any>) => any) ? SerializationError<'Function may not be serializable'> : T extends RegisteredReadableStream ? SerializationError<'JSX is not be serializable'> : T extends ReadonlyArray<any> ? ValidateSerializableArray<T, TSerializable> : T extends Promise<any> ? 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 AsyncGenerator<any, any> ? ValidateSerializableAsyncGenerator<T, TSerializable> : T extends object ? ValidateSerializableMapped<T, TSerializable> : SerializationError<'Type may not be serializable'>;
|
|
541
654
|
type ValidateSerializableAsyncGenerator<T, TSerializable> = T extends AsyncGenerator<infer T, infer TReturn, infer TNext> ? AsyncGenerator<ValidateSerializable<T, TSerializable>, ValidateSerializable<TReturn, TSerializable>, TNext> : never;
|
|
542
655
|
type ValidateSerializablePromise<T, TSerializable> = T extends Promise<infer TAwaited> ? Promise<ValidateSerializable<TAwaited, TSerializable>> : never;
|
|
543
656
|
type ValidateReadableStream<T, TSerializable> = T extends ReadableStream<infer TStreamed> ? ReadableStream<ValidateSerializable<TStreamed, TSerializable>> : never;
|
|
544
657
|
type ValidateSerializableSet<T, TSerializable> = T extends Set<infer TItem> ? Set<ValidateSerializable<TItem, TSerializable>> : never;
|
|
545
658
|
type ValidateSerializableMap<T, TSerializable> = T extends Map<infer TKey, infer TValue> ? Map<ValidateSerializable<TKey, TSerializable>, ValidateSerializable<TValue, TSerializable>> : never;
|
|
546
|
-
|
|
547
|
-
|
|
659
|
+
type ValidateSerializableArray<T, TSerializable> = T extends readonly [any, ...Array<any>] ? ValidateSerializableMapped<T, TSerializable> : T extends Array<infer U> ? Array<ValidateSerializable<U, TSerializable>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<ValidateSerializable<U, TSerializable>> : never;
|
|
660
|
+
type ValidateSerializableMapped<T, TSerializable> = { [K in keyof T]: ValidateSerializable<T[K], TSerializable> };
|
|
661
|
+
declare const SERIALIZATION_ERROR: unique symbol;
|
|
662
|
+
interface SerializationError<in out TMessage extends string> {
|
|
663
|
+
[SERIALIZATION_ERROR]: TMessage;
|
|
548
664
|
}
|
|
549
|
-
interface SerializerExtensions extends DefaultSerializerExtensions {}
|
|
550
665
|
interface SerializationAdapter<TInput, TOutput, TExtendsAdapters extends ReadonlyArray<AnySerializationAdapter>> {
|
|
551
666
|
'~types': SerializationAdapterTypes<TInput, TOutput, TExtendsAdapters>;
|
|
552
667
|
key: string;
|
|
@@ -564,15 +679,16 @@ type AnySerializationAdapter = SerializationAdapter<any, any, any>;
|
|
|
564
679
|
type ValidateSerializableInput<TRegister, T> = ValidateSerializable<T, RegisteredSerializableInput<TRegister>>;
|
|
565
680
|
type RegisteredSerializableInput<TRegister> = (unknown extends RegisteredSerializationAdapters<TRegister> ? never : RegisteredSerializationAdapters<TRegister> extends ReadonlyArray<AnySerializationAdapter> ? RegisteredSerializationAdapters<TRegister>[number]['~types']['input'] : never) | Serializable;
|
|
566
681
|
type RegisteredSerializationAdapters<TRegister> = RegisteredConfigType<TRegister, 'serializationAdapters'>;
|
|
567
|
-
type ValidateSerializableResult<T, TSerializable> = T extends ReadonlyArray<unknown> ? ResolveArrayShape<T, TSerializable, 'result'> : T extends TSerializable ? T : unknown extends SerializerExtensions['ReadableStream'] ? { [K in keyof T]: ValidateSerializableResult<T[K], TSerializable> } : T extends SerializerExtensions['ReadableStream'] ? ReadableStream : { [K in keyof T]: ValidateSerializableResult<T[K], TSerializable> };
|
|
568
682
|
type RegisteredSSROption<TRegister> = unknown extends RegisteredConfigType<TRegister, 'defaultSsr'> ? SSROption : RegisteredConfigType<TRegister, 'defaultSsr'>;
|
|
569
683
|
type ValidateSerializableLifecycleResult<TRegister, TParentRoute extends AnyRoute, TSSR, TFn> = false extends RegisteredSsr<TRegister> ? any : ValidateSerializableLifecycleResultSSR<TRegister, TParentRoute, TSSR, TFn> extends infer TInput ? TInput : never;
|
|
570
684
|
type ValidateSerializableLifecycleResultSSR<TRegister, TParentRoute extends AnyRoute, TSSR, TFn> = ResolveAllSSR<TParentRoute, TSSR> extends false ? any : RegisteredSSROption<TRegister> extends false ? any : ValidateSerializableInput<TRegister, LooseReturnType<TFn>>;
|
|
571
|
-
type
|
|
572
|
-
|
|
573
|
-
|
|
685
|
+
type RegisteredReadableStream = unknown extends SerializerExtensions['ReadableStream'] ? never : SerializerExtensions['ReadableStream'];
|
|
686
|
+
interface DefaultSerializerExtensions {
|
|
687
|
+
ReadableStream: unknown;
|
|
688
|
+
}
|
|
689
|
+
interface SerializerExtensions extends DefaultSerializerExtensions {}
|
|
574
690
|
//#endregion
|
|
575
|
-
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.
|
|
691
|
+
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.171.34/node_modules/@tanstack/router-core/dist/esm/route.d.ts
|
|
576
692
|
type AnyPathParams = {};
|
|
577
693
|
type SearchSchemaInput = {
|
|
578
694
|
__TSearchSchemaInput__: 'TSearchSchemaInput';
|
|
@@ -585,9 +701,16 @@ type RoutePathOptions<TCustomId, TPath> = {
|
|
|
585
701
|
};
|
|
586
702
|
interface StaticDataRouteOption {}
|
|
587
703
|
type SearchFilter<TInput, TResult = TInput> = (prev: TInput) => TResult;
|
|
704
|
+
type SearchMiddlewareMeta = {
|
|
705
|
+
removed?: Map<string, unknown>;
|
|
706
|
+
removedAny?: Set<string>;
|
|
707
|
+
defaulted?: Map<string, unknown>;
|
|
708
|
+
explicit?: unknown;
|
|
709
|
+
};
|
|
588
710
|
type SearchMiddlewareContext<TSearchSchema> = {
|
|
589
711
|
search: TSearchSchema;
|
|
590
712
|
next: (newSearch: TSearchSchema) => TSearchSchema;
|
|
713
|
+
meta?: SearchMiddlewareMeta;
|
|
591
714
|
};
|
|
592
715
|
type SearchMiddleware<TSearchSchema> = (ctx: SearchMiddlewareContext<TSearchSchema>) => TSearchSchema;
|
|
593
716
|
type InferFullSearchSchema<TRoute> = TRoute extends {
|
|
@@ -613,17 +736,25 @@ type InferAllContext<TRoute> = unknown extends TRoute ? TRoute : TRoute extends
|
|
|
613
736
|
type ResolveRequiredParams<TPath extends string, T> = { [K in ParsePathParams<TPath>['required']]: T };
|
|
614
737
|
type ResolveOptionalParams<TPath extends string, T> = { [K in ParsePathParams<TPath>['optional']]?: T | undefined };
|
|
615
738
|
type ResolveParams<TPath extends string, T = string> = ResolveRequiredParams<TPath, T> & ResolveOptionalParams<TPath, T>;
|
|
616
|
-
type ParseParamsFn<in out TPath extends string, in out TParams> = (rawParams: Expand<ResolveParams<TPath>>) => TParams
|
|
739
|
+
type ParseParamsFn<in out TPath extends string, in out TParams> = (rawParams: Expand<ResolveParams<TPath>>) => TParams | false;
|
|
740
|
+
type ValidateParsedParams<TPath extends string, TParams> = [TParams] extends [ResolveParams<TPath, any>] ? unknown : never;
|
|
617
741
|
type StringifyParamsFn<in out TPath extends string, in out TParams> = (params: TParams) => ResolveParams<TPath>;
|
|
618
742
|
type ParamsOptions<in out TPath extends string, in out TParams> = {
|
|
619
743
|
params?: {
|
|
620
|
-
parse?: ParseParamsFn<TPath, TParams>;
|
|
744
|
+
parse?: ParseParamsFn<TPath, TParams> & ValidateParsedParams<TPath, TParams>;
|
|
745
|
+
/**
|
|
746
|
+
* When multiple route candidates use `params.parse` during matching,
|
|
747
|
+
* higher priorities are tried first.
|
|
748
|
+
*
|
|
749
|
+
* @default 0
|
|
750
|
+
*/
|
|
751
|
+
priority?: number;
|
|
621
752
|
stringify?: StringifyParamsFn<TPath, TParams>;
|
|
622
753
|
};
|
|
623
754
|
/**
|
|
624
755
|
@deprecated Use params.parse instead
|
|
625
756
|
*/
|
|
626
|
-
parseParams?: ParseParamsFn<TPath, TParams>;
|
|
757
|
+
parseParams?: ParseParamsFn<TPath, TParams> & ValidateParsedParams<TPath, TParams>;
|
|
627
758
|
/**
|
|
628
759
|
@deprecated Use params.stringify instead
|
|
629
760
|
*/
|
|
@@ -640,7 +771,14 @@ type TrimPathRight<T extends string> = T extends '/' ? '/' : T extends `${infer
|
|
|
640
771
|
type ContextReturnType<TContextFn> = unknown extends TContextFn ? TContextFn : LooseReturnType<TContextFn> extends never ? AnyContext : LooseReturnType<TContextFn>;
|
|
641
772
|
type ContextAsyncReturnType<TContextFn> = unknown extends TContextFn ? TContextFn : LooseAsyncReturnType<TContextFn> extends never ? AnyContext : LooseAsyncReturnType<TContextFn>;
|
|
642
773
|
type ResolveRouteContext<TRouteContextFn, TBeforeLoadFn> = Assign<ContextReturnType<TRouteContextFn>, ContextAsyncReturnType<TBeforeLoadFn>>;
|
|
643
|
-
type
|
|
774
|
+
type ResolveRouteLoaderFn<TLoaderFn> = TLoaderFn extends {
|
|
775
|
+
handler: infer THandler;
|
|
776
|
+
} ? THandler : TLoaderFn;
|
|
777
|
+
type RouteLoaderObject<TRegister, TParentRoute extends AnyRoute = AnyRoute, TId extends string = string, TParams = {}, TLoaderDeps = {}, TRouterContext = {}, TRouteContextFn = AnyContext, TBeforeLoadFn = AnyContext, TServerMiddlewares = unknown, THandlers = undefined> = {
|
|
778
|
+
handler: RouteLoaderFn<TRegister, TParentRoute, TId, TParams, TLoaderDeps, TRouterContext, TRouteContextFn, TBeforeLoadFn, TServerMiddlewares, THandlers>;
|
|
779
|
+
staleReloadMode?: LoaderStaleReloadMode;
|
|
780
|
+
};
|
|
781
|
+
type ResolveLoaderData<TLoaderFn> = unknown extends TLoaderFn ? TLoaderFn : LooseAsyncReturnType<ResolveRouteLoaderFn<TLoaderFn>> extends never ? undefined : LooseAsyncReturnType<ResolveRouteLoaderFn<TLoaderFn>>;
|
|
644
782
|
type ResolveFullSearchSchema<TParentRoute extends AnyRoute, TSearchValidator> = unknown extends TParentRoute ? ResolveValidatorOutput<TSearchValidator> : IntersectAssign<InferFullSearchSchema<TParentRoute>, ResolveValidatorOutput<TSearchValidator>>;
|
|
645
783
|
type ResolveFullSearchSchemaInput<TParentRoute extends AnyRoute, TSearchValidator> = IntersectAssign<InferFullSearchSchemaInput<TParentRoute>, ResolveSearchValidatorInput<TSearchValidator>>;
|
|
646
784
|
type ResolveAllParamsFromParent<TParentRoute extends AnyRoute, TParams> = Assign<InferAllParams<TParentRoute>, TParams>;
|
|
@@ -703,9 +841,7 @@ interface Route<in out TRegister, in out TParentRoute extends AnyRoute, in out T
|
|
|
703
841
|
lazyFn?: () => Promise<LazyRoute<Route<TRegister, TParentRoute, TPath, TFullPath, TCustomId, TId, TSearchValidator, TParams, TRouterContext, TRouteContextFn, TBeforeLoadFn, TLoaderDeps, TLoaderFn, TChildren, TFileRouteTypes, TSSR, TServerMiddlewares, THandlers>>>;
|
|
704
842
|
rank: number;
|
|
705
843
|
to: TrimPathRight<TFullPath>;
|
|
706
|
-
init: (
|
|
707
|
-
originalIndex: number;
|
|
708
|
-
}) => void;
|
|
844
|
+
init: (originalIndex: number) => void;
|
|
709
845
|
update: (options: UpdatableRouteOptions<TParentRoute, TCustomId, TFullPath, TParams, TSearchValidator, TLoaderFn, TLoaderDeps, TRouterContext, TRouteContextFn, TBeforeLoadFn>) => this;
|
|
710
846
|
lazy: RouteLazyFn<Route<TRegister, TParentRoute, TPath, TFullPath, TCustomId, TId, TSearchValidator, TParams, TRouterContext, TRouteContextFn, TBeforeLoadFn, TLoaderDeps, TLoaderFn, TChildren, TFileRouteTypes, TSSR, TServerMiddlewares, THandlers>>;
|
|
711
847
|
addChildren: RouteAddChildrenFn<TRegister, TParentRoute, TPath, TFullPath, TCustomId, TId, TSearchValidator, TParams, TRouterContext, TRouteContextFn, TBeforeLoadFn, TLoaderDeps, TLoaderFn, TFileRouteTypes, TSSR, TServerMiddlewares, THandlers>;
|
|
@@ -721,7 +857,7 @@ interface Route<in out TRegister, in out TParentRoute extends AnyRoute, in out T
|
|
|
721
857
|
redirect: RedirectFnRoute<TFullPath>;
|
|
722
858
|
}
|
|
723
859
|
type AnyRoute = Route<any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any>;
|
|
724
|
-
type RouteOptions<TRegister, TParentRoute extends AnyRoute = AnyRoute, TId extends string = string, TCustomId extends string = string, TFullPath extends string = string, TPath extends string = string, TSearchValidator = undefined, TParams = AnyPathParams, TLoaderDeps extends Record<string, any> = {}, TLoaderFn = undefined, TRouterContext = {}, TRouteContextFn = AnyContext, TBeforeLoadFn = AnyContext, TSSR = unknown, TServerMiddlewares = unknown, THandlers = undefined> = BaseRouteOptions<TRegister, TParentRoute, TId, TCustomId, TPath, TSearchValidator, TParams, TLoaderDeps, TLoaderFn, TRouterContext, TRouteContextFn, TBeforeLoadFn, TSSR, TServerMiddlewares, THandlers> & UpdatableRouteOptions<NoInfer
|
|
860
|
+
type RouteOptions<TRegister, TParentRoute extends AnyRoute = AnyRoute, TId extends string = string, TCustomId extends string = string, TFullPath extends string = string, TPath extends string = string, TSearchValidator = undefined, TParams = AnyPathParams, TLoaderDeps extends Record<string, any> = {}, TLoaderFn = undefined, TRouterContext = {}, TRouteContextFn = AnyContext, TBeforeLoadFn = AnyContext, TSSR = unknown, TServerMiddlewares = unknown, THandlers = undefined> = BaseRouteOptions<TRegister, TParentRoute, TId, TCustomId, TPath, TSearchValidator, TParams, TLoaderDeps, TLoaderFn, TRouterContext, TRouteContextFn, TBeforeLoadFn, TSSR, TServerMiddlewares, THandlers> & UpdatableRouteOptions<NoInfer<TParentRoute>, NoInfer<TCustomId>, NoInfer<TFullPath>, NoInfer<TParams>, NoInfer<TSearchValidator>, NoInfer<TLoaderFn>, NoInfer<TLoaderDeps>, NoInfer<TRouterContext>, NoInfer<TRouteContextFn>, NoInfer<TBeforeLoadFn>>;
|
|
725
861
|
type FileBaseRouteOptions<TRegister, TParentRoute extends AnyRoute = AnyRoute, TId extends string = string, TPath extends string = string, TSearchValidator = undefined, TParams = {}, TLoaderDeps extends Record<string, any> = {}, TLoaderFn = undefined, TRouterContext = {}, TRouteContextFn = AnyContext, TBeforeLoadFn = AnyContext, TRemountDepsFn = AnyContext, TSSR = unknown, TServerMiddlewares = unknown, THandlers = undefined> = ParamsOptions<TPath, TParams> & FilebaseRouteOptionsInterface<TRegister, TParentRoute, TId, TPath, TSearchValidator, TParams, TLoaderDeps, TLoaderFn, TRouterContext, TRouteContextFn, TBeforeLoadFn, TRemountDepsFn, TSSR, TServerMiddlewares, THandlers>;
|
|
726
862
|
interface FilebaseRouteOptionsInterface<TRegister, TParentRoute extends AnyRoute = AnyRoute, TId extends string = string, TPath extends string = string, TSearchValidator = undefined, TParams = {}, TLoaderDeps extends Record<string, any> = {}, TLoaderFn = undefined, TRouterContext = {}, TRouteContextFn = AnyContext, TBeforeLoadFn = AnyContext, TRemountDepsFn = AnyContext, TSSR = unknown, TServerMiddlewares = unknown, THandlers = undefined> {
|
|
727
863
|
validateSearch?: Constrain<TSearchValidator, AnyValidator, DefaultValidator>;
|
|
@@ -731,7 +867,7 @@ interface FilebaseRouteOptionsInterface<TRegister, TParentRoute extends AnyRoute
|
|
|
731
867
|
beforeLoad?: Constrain<TBeforeLoadFn, (ctx: BeforeLoadContextOptions<TRegister, TParentRoute, TSearchValidator, TParams, TRouterContext, TRouteContextFn, TId, TServerMiddlewares, THandlers>) => ValidateSerializableLifecycleResult<TRegister, TParentRoute, TSSR, TBeforeLoadFn>>;
|
|
732
868
|
loaderDeps?: (opts: FullSearchSchemaOption<TParentRoute, TSearchValidator>) => TLoaderDeps;
|
|
733
869
|
remountDeps?: Constrain<TRemountDepsFn, (opt: RemountDepsOptions<TId, ResolveFullSearchSchema<TParentRoute, TSearchValidator>, Expand<ResolveAllParamsFromParent<TParentRoute, TParams>>, TLoaderDeps>) => any>;
|
|
734
|
-
loader?: Constrain<TLoaderFn,
|
|
870
|
+
loader?: Constrain<TLoaderFn, RouteLoaderFn<TRegister, TParentRoute, TId, TParams, TLoaderDeps, TRouterContext, TRouteContextFn, TBeforeLoadFn, TServerMiddlewares, THandlers> | RouteLoaderObject<TRegister, TParentRoute, TId, TParams, TLoaderDeps, TRouterContext, TRouteContextFn, TBeforeLoadFn, TServerMiddlewares, THandlers>>;
|
|
735
871
|
}
|
|
736
872
|
type BaseRouteOptions<TRegister, TParentRoute extends AnyRoute = AnyRoute, TId extends string = string, TCustomId extends string = string, TPath extends string = string, TSearchValidator = undefined, TParams = {}, TLoaderDeps extends Record<string, any> = {}, TLoaderFn = undefined, TRouterContext = {}, TRouteContextFn = AnyContext, TBeforeLoadFn = AnyContext, TSSR = unknown, TServerMiddlewares = unknown, THandlers = undefined> = RoutePathOptions<TCustomId, TPath> & FileBaseRouteOptions<TRegister, TParentRoute, TId, TPath, TSearchValidator, TParams, TLoaderDeps, TLoaderFn, TRouterContext, TRouteContextFn, TBeforeLoadFn, AnyContext, TSSR, TServerMiddlewares, THandlers> & {
|
|
737
873
|
getParentRoute: () => TParentRoute;
|
|
@@ -792,37 +928,6 @@ interface DefaultUpdatableRouteOptionsExtensions {
|
|
|
792
928
|
}
|
|
793
929
|
interface UpdatableRouteOptionsExtensions extends DefaultUpdatableRouteOptionsExtensions {}
|
|
794
930
|
interface UpdatableRouteOptions<in out TParentRoute extends AnyRoute, in out TRouteId, in out TFullPath, in out TParams, in out TSearchValidator, in out TLoaderFn, in out TLoaderDeps, in out TRouterContext, in out TRouteContextFn, in out TBeforeLoadFn> extends UpdatableStaticRouteOption, UpdatableRouteOptionsExtensions {
|
|
795
|
-
/**
|
|
796
|
-
* Options to control route matching behavior with runtime code.
|
|
797
|
-
*
|
|
798
|
-
* @experimental 🚧 this feature is subject to change
|
|
799
|
-
*
|
|
800
|
-
* @link https://tanstack.com/router/latest/docs/framework/react/api/router/RouteOptionsType
|
|
801
|
-
*/
|
|
802
|
-
skipRouteOnParseError?: {
|
|
803
|
-
/**
|
|
804
|
-
* If `true`, skip this route during matching if `params.parse` fails.
|
|
805
|
-
*
|
|
806
|
-
* Without this option, a `/$param` route could match *any* value for `param`,
|
|
807
|
-
* and only later during the route lifecycle would `params.parse` run and potentially
|
|
808
|
-
* show the `errorComponent` if validation failed.
|
|
809
|
-
*
|
|
810
|
-
* With this option enabled, the route will only match if `params.parse` succeeds.
|
|
811
|
-
* If it fails, the router will continue trying to match other routes, potentially
|
|
812
|
-
* finding a different route that works, or ultimately showing the `notFoundComponent`.
|
|
813
|
-
*
|
|
814
|
-
* @default false
|
|
815
|
-
*/
|
|
816
|
-
params?: boolean;
|
|
817
|
-
/**
|
|
818
|
-
* In cases where multiple routes would need to run `params.parse` during matching
|
|
819
|
-
* to determine which route to pick, this priority number can be used as a tie-breaker
|
|
820
|
-
* for which route to try first. Higher number = higher priority.
|
|
821
|
-
*
|
|
822
|
-
* @default 0
|
|
823
|
-
*/
|
|
824
|
-
priority?: number;
|
|
825
|
-
};
|
|
826
931
|
/**
|
|
827
932
|
* If true, this route will be matched as case-sensitive
|
|
828
933
|
*
|
|
@@ -841,7 +946,7 @@ interface UpdatableRouteOptions<in out TParentRoute extends AnyRoute, in out TRo
|
|
|
841
946
|
preloadStaleTime?: number;
|
|
842
947
|
preloadGcTime?: number;
|
|
843
948
|
search?: {
|
|
844
|
-
middlewares?: Array<SearchMiddleware<
|
|
949
|
+
middlewares?: Array<SearchMiddleware<ResolveFullSearchSchema<TParentRoute, TSearchValidator>>>;
|
|
845
950
|
};
|
|
846
951
|
/**
|
|
847
952
|
@deprecated Use search.middlewares instead
|
|
@@ -851,7 +956,7 @@ interface UpdatableRouteOptions<in out TParentRoute extends AnyRoute, in out TRo
|
|
|
851
956
|
@deprecated Use search.middlewares instead
|
|
852
957
|
*/
|
|
853
958
|
postSearchFilters?: Array<SearchFilter<ResolveFullSearchSchema<TParentRoute, TSearchValidator>>>;
|
|
854
|
-
onCatch?: (error:
|
|
959
|
+
onCatch?: (error: ErrorBoundaryTypes['error']) => void;
|
|
855
960
|
onError?: (err: any) => void;
|
|
856
961
|
onEnter?: (match: RouteMatch$1<TRouteId, TFullPath, ResolveAllParamsFromParent<TParentRoute, TParams>, ResolveFullSearchSchema<TParentRoute, TSearchValidator>, ResolveLoaderData<TLoaderFn>, ResolveAllContext<TParentRoute, TRouterContext, TRouteContextFn, TBeforeLoadFn>, TLoaderDeps>) => void;
|
|
857
962
|
onStay?: (match: RouteMatch$1<TRouteId, TFullPath, ResolveAllParamsFromParent<TParentRoute, TParams>, ResolveFullSearchSchema<TParentRoute, TSearchValidator>, ResolveLoaderData<TLoaderFn>, ResolveAllContext<TParentRoute, TRouterContext, TRouteContextFn, TBeforeLoadFn>, TLoaderDeps>) => void;
|
|
@@ -866,6 +971,8 @@ interface UpdatableRouteOptions<in out TParentRoute extends AnyRoute, in out TRo
|
|
|
866
971
|
scripts?: (ctx: AssetFnContextOptions<TRouteId, TFullPath, TParentRoute, TParams, TSearchValidator, TLoaderFn, TRouterContext, TRouteContextFn, TBeforeLoadFn, TLoaderDeps>) => Awaitable<AnyRouteMatch['scripts']>;
|
|
867
972
|
codeSplitGroupings?: Array<Array<'loader' | 'component' | 'pendingComponent' | 'notFoundComponent' | 'errorComponent'>>;
|
|
868
973
|
}
|
|
974
|
+
type RouteLoaderFn<in out TRegister, in out TParentRoute extends AnyRoute = AnyRoute, in out TId extends string = string, in out TParams = {}, in out TLoaderDeps = {}, in out TRouterContext = {}, in out TRouteContextFn = AnyContext, in out TBeforeLoadFn = AnyContext, in out TServerMiddlewares = unknown, in out THandlers = undefined> = (match: LoaderFnContext<TRegister, TParentRoute, TId, TParams, TLoaderDeps, TRouterContext, TRouteContextFn, TBeforeLoadFn, TServerMiddlewares, THandlers>) => any;
|
|
975
|
+
type LoaderStaleReloadMode = 'background' | 'blocking';
|
|
869
976
|
interface LoaderFnContext<in out TRegister = unknown, in out TParentRoute extends AnyRoute = AnyRoute, in out TId extends string = string, in out TParams = {}, in out TLoaderDeps = {}, in out TRouterContext = {}, in out TRouteContextFn = AnyContext, in out TBeforeLoadFn = AnyContext, in out TServerMiddlewares = unknown, in out THandlers = undefined> {
|
|
870
977
|
abortController: AbortController;
|
|
871
978
|
preload: boolean;
|
|
@@ -891,136 +998,19 @@ type RouteMask<TRouteTree extends AnyRoute> = {
|
|
|
891
998
|
state?: any;
|
|
892
999
|
unmaskOnReload?: boolean;
|
|
893
1000
|
};
|
|
894
|
-
|
|
895
|
-
|
|
896
|
-
interface StandardSchemaValidatorProps<TInput, TOutput> {
|
|
897
|
-
readonly types?: StandardSchemaValidatorTypes<TInput, TOutput> | undefined;
|
|
898
|
-
readonly validate: AnyStandardSchemaValidate;
|
|
899
|
-
}
|
|
900
|
-
interface StandardSchemaValidator<TInput, TOutput> {
|
|
901
|
-
readonly '~standard': StandardSchemaValidatorProps<TInput, TOutput>;
|
|
902
|
-
}
|
|
903
|
-
type AnyStandardSchemaValidator = StandardSchemaValidator<any, any>;
|
|
904
|
-
interface StandardSchemaValidatorTypes<TInput, TOutput> {
|
|
905
|
-
readonly input: TInput;
|
|
906
|
-
readonly output: TOutput;
|
|
907
|
-
}
|
|
908
|
-
interface AnyStandardSchemaValidateSuccess {
|
|
909
|
-
readonly value: any;
|
|
910
|
-
readonly issues?: undefined;
|
|
911
|
-
}
|
|
912
|
-
interface AnyStandardSchemaValidateFailure {
|
|
913
|
-
readonly issues: ReadonlyArray<AnyStandardSchemaValidateIssue>;
|
|
914
|
-
}
|
|
915
|
-
interface AnyStandardSchemaValidateIssue {
|
|
916
|
-
readonly message: string;
|
|
917
|
-
}
|
|
918
|
-
type AnyStandardSchemaValidate = (value: unknown) => (AnyStandardSchemaValidateSuccess | AnyStandardSchemaValidateFailure) | Promise<AnyStandardSchemaValidateSuccess | AnyStandardSchemaValidateFailure>;
|
|
919
|
-
interface ValidatorObj<TInput, TOutput> {
|
|
920
|
-
parse: ValidatorFn<TInput, TOutput>;
|
|
921
|
-
}
|
|
922
|
-
type AnyValidatorObj = ValidatorObj<any, any>;
|
|
923
|
-
interface ValidatorAdapter<TInput, TOutput> {
|
|
924
|
-
types: {
|
|
925
|
-
input: TInput;
|
|
926
|
-
output: TOutput;
|
|
927
|
-
};
|
|
928
|
-
parse: (input: unknown) => TOutput;
|
|
929
|
-
}
|
|
930
|
-
type AnyValidatorAdapter = ValidatorAdapter<any, any>;
|
|
931
|
-
type ValidatorFn<TInput, TOutput> = (input: TInput) => TOutput;
|
|
932
|
-
type Validator<TInput, TOutput> = ValidatorObj<TInput, TOutput> | ValidatorFn<TInput, TOutput> | ValidatorAdapter<TInput, TOutput> | StandardSchemaValidator<TInput, TOutput> | undefined;
|
|
933
|
-
type AnyValidator = Validator<any, any>;
|
|
934
|
-
type AnySchema = {};
|
|
935
|
-
type DefaultValidator = Validator<Record<string, unknown>, AnySchema>;
|
|
936
|
-
type ResolveSearchValidatorInputFn<TValidator> = TValidator extends ((input: infer TSchemaInput) => any) ? TSchemaInput extends SearchSchemaInput ? Omit<TSchemaInput, keyof SearchSchemaInput> : ResolveValidatorOutputFn<TValidator> : AnySchema;
|
|
937
|
-
type ResolveSearchValidatorInput<TValidator> = TValidator extends AnyStandardSchemaValidator ? NonNullable<TValidator['~standard']['types']>['input'] : TValidator extends AnyValidatorAdapter ? TValidator['types']['input'] : TValidator extends AnyValidatorObj ? ResolveSearchValidatorInputFn<TValidator['parse']> : ResolveSearchValidatorInputFn<TValidator>;
|
|
938
|
-
type ResolveValidatorOutputFn<TValidator> = TValidator extends ((...args: any) => infer TSchema) ? TSchema : AnySchema;
|
|
939
|
-
type ResolveValidatorOutput<TValidator> = unknown extends TValidator ? TValidator : TValidator extends AnyStandardSchemaValidator ? NonNullable<TValidator['~standard']['types']>['output'] : TValidator extends AnyValidatorAdapter ? TValidator['types']['output'] : TValidator extends AnyValidatorObj ? ResolveValidatorOutputFn<TValidator['parse']> : ResolveValidatorOutputFn<TValidator>;
|
|
940
|
-
//#endregion
|
|
941
|
-
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.166.6/node_modules/@tanstack/router-core/dist/esm/location.d.ts
|
|
942
|
-
interface ParsedLocation<TSearchObj extends AnySchema = {}> {
|
|
943
|
-
/**
|
|
944
|
-
* The full path of the location, including pathname, search, and hash.
|
|
945
|
-
* Does not include the origin. Is the equivalent of calling
|
|
946
|
-
* `url.replace(url.origin, '')`
|
|
947
|
-
*/
|
|
948
|
-
href: string;
|
|
949
|
-
/**
|
|
950
|
-
* @description The pathname of the location, including the leading slash.
|
|
951
|
-
*/
|
|
952
|
-
pathname: string;
|
|
953
|
-
/**
|
|
954
|
-
* The parsed search parameters of the location in object form.
|
|
955
|
-
*/
|
|
956
|
-
search: TSearchObj;
|
|
957
|
-
/**
|
|
958
|
-
* The search string of the location, including the leading question mark.
|
|
959
|
-
*/
|
|
960
|
-
searchStr: string;
|
|
961
|
-
/**
|
|
962
|
-
* The in-memory state of the location as it *may* exist in the browser's history.
|
|
963
|
-
*/
|
|
964
|
-
state: ParsedHistoryState;
|
|
965
|
-
/**
|
|
966
|
-
* The hash of the location, excluding the leading hash character.
|
|
967
|
-
* (e.g., '123' instead of '#123')
|
|
968
|
-
*/
|
|
969
|
-
hash: string;
|
|
970
|
-
/**
|
|
971
|
-
* The masked location of the location.
|
|
972
|
-
*/
|
|
973
|
-
maskedLocation?: ParsedLocation<TSearchObj>;
|
|
974
|
-
/**
|
|
975
|
-
* Whether to unmask the location on reload.
|
|
976
|
-
*/
|
|
977
|
-
unmaskOnReload?: boolean;
|
|
978
|
-
/**
|
|
979
|
-
* @private
|
|
980
|
-
* @description The public href of the location.
|
|
981
|
-
* If a rewrite is applied, the `href` property will be the rewritten URL.
|
|
982
|
-
*/
|
|
983
|
-
publicHref: string;
|
|
984
|
-
/**
|
|
985
|
-
* @private
|
|
986
|
-
* @description Whether the publicHref is external (different origin from rewrite).
|
|
987
|
-
*/
|
|
988
|
-
external: boolean;
|
|
989
|
-
}
|
|
990
|
-
//#endregion
|
|
991
|
-
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.166.6/node_modules/@tanstack/router-core/dist/esm/load-matches.d.ts
|
|
992
|
-
type RouteComponentType = 'component' | 'errorComponent' | 'pendingComponent' | 'notFoundComponent';
|
|
993
|
-
declare function loadRouteChunk(route: AnyRoute, componentTypesToLoad?: Array<RouteComponentType>): Promise<void> | undefined;
|
|
994
|
-
//#endregion
|
|
995
|
-
//#region ../../node_modules/.pnpm/@tanstack+store@0.9.2/node_modules/@tanstack/store/dist/esm/types.d.ts
|
|
996
|
-
type Observer<T> = {
|
|
997
|
-
next?: (value: T) => void;
|
|
998
|
-
error?: (err: unknown) => void;
|
|
999
|
-
complete?: () => void;
|
|
1000
|
-
};
|
|
1001
|
-
interface Subscription {
|
|
1002
|
-
unsubscribe: () => void;
|
|
1003
|
-
}
|
|
1004
|
-
//#endregion
|
|
1005
|
-
//#region ../../node_modules/.pnpm/@tanstack+store@0.9.2/node_modules/@tanstack/store/dist/esm/store.d.ts
|
|
1006
|
-
declare class Store<T> {
|
|
1007
|
-
private atom;
|
|
1008
|
-
constructor(getValue: (prev?: NoInfer<T>) => T);
|
|
1009
|
-
constructor(initialValue: T);
|
|
1010
|
-
setState(updater: (prev: T) => T): void;
|
|
1011
|
-
get state(): T;
|
|
1012
|
-
get(): T;
|
|
1013
|
-
subscribe(observerOrFn: Observer<T> | ((value: T) => void)): Subscription;
|
|
1001
|
+
interface DefaultErrorBoundaryTypes {
|
|
1002
|
+
error: unknown;
|
|
1014
1003
|
}
|
|
1004
|
+
/** Frameworks can specialize the error exposed by boundary components and callbacks. */
|
|
1005
|
+
interface ErrorBoundaryTypes extends DefaultErrorBoundaryTypes {}
|
|
1015
1006
|
//#endregion
|
|
1016
|
-
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.
|
|
1017
|
-
type
|
|
1018
|
-
|
|
1019
|
-
|
|
1020
|
-
clear: () => void;
|
|
1007
|
+
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.171.34/node_modules/@tanstack/router-core/dist/esm/path.d.ts
|
|
1008
|
+
type InterpolationSegment = string | DynamicPathSegment;
|
|
1009
|
+
type RouteInterpolation = Array<InterpolationSegment> & {
|
|
1010
|
+
names?: Array<string>;
|
|
1021
1011
|
};
|
|
1022
1012
|
//#endregion
|
|
1023
|
-
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.
|
|
1013
|
+
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.171.34/node_modules/@tanstack/router-core/dist/esm/new-process-route-tree.d.ts
|
|
1024
1014
|
declare const SEGMENT_TYPE_PATHNAME = 0;
|
|
1025
1015
|
declare const SEGMENT_TYPE_PARAM = 1;
|
|
1026
1016
|
declare const SEGMENT_TYPE_WILDCARD = 2;
|
|
@@ -1035,18 +1025,22 @@ type SegmentKind = typeof SEGMENT_TYPE_PATHNAME | typeof SEGMENT_TYPE_PARAM | ty
|
|
|
1035
1025
|
* All the kinds of segments that can be present in the segment tree.
|
|
1036
1026
|
*/
|
|
1037
1027
|
type ExtendedSegmentKind = SegmentKind | typeof SEGMENT_TYPE_INDEX | typeof SEGMENT_TYPE_PATHLESS;
|
|
1028
|
+
type DynamicPathSegment = [kind: Exclude<SegmentKind, typeof SEGMENT_TYPE_PATHNAME>, key: string, prefix: string, /** Undefined marks a bare splat, which discards the remaining template. */suffix: string | undefined];
|
|
1038
1029
|
type StaticSegmentNode<T extends RouteLike> = SegmentNode<T> & {
|
|
1039
1030
|
kind: typeof SEGMENT_TYPE_PATHNAME | typeof SEGMENT_TYPE_PATHLESS | typeof SEGMENT_TYPE_INDEX;
|
|
1040
1031
|
};
|
|
1041
1032
|
type DynamicSegmentNode<T extends RouteLike> = SegmentNode<T> & {
|
|
1042
1033
|
kind: typeof SEGMENT_TYPE_PARAM | typeof SEGMENT_TYPE_WILDCARD | typeof SEGMENT_TYPE_OPTIONAL_PARAM;
|
|
1043
|
-
prefix
|
|
1044
|
-
suffix
|
|
1034
|
+
prefix: string;
|
|
1035
|
+
suffix: string;
|
|
1045
1036
|
caseSensitive: boolean;
|
|
1046
1037
|
};
|
|
1047
1038
|
type AnySegmentNode<T extends RouteLike> = StaticSegmentNode<T> | DynamicSegmentNode<T>;
|
|
1048
1039
|
type SegmentNode<T extends RouteLike> = {
|
|
1049
1040
|
kind: ExtendedSegmentKind;
|
|
1041
|
+
prefix?: string;
|
|
1042
|
+
suffix?: string;
|
|
1043
|
+
caseSensitive?: boolean;
|
|
1050
1044
|
pathless: Array<StaticSegmentNode<T>> | null; /** Exact index segment (highest priority) */
|
|
1051
1045
|
index: StaticSegmentNode<T> | null; /** Static segments (2nd priority) */
|
|
1052
1046
|
static: Map<string, StaticSegmentNode<T>> | null; /** Case insensitive static segments (3rd highest priority) */
|
|
@@ -1054,28 +1048,26 @@ type SegmentNode<T extends RouteLike> = {
|
|
|
1054
1048
|
dynamic: Array<DynamicSegmentNode<T>> | null; /** Optional dynamic segments ({-$param}) */
|
|
1055
1049
|
optional: Array<DynamicSegmentNode<T>> | null; /** Wildcard segments ($ - lowest priority) */
|
|
1056
1050
|
wildcard: Array<DynamicSegmentNode<T>> | null; /** Terminal route (if this path can end here) */
|
|
1057
|
-
route: T | null; /**
|
|
1058
|
-
|
|
1059
|
-
parent: AnySegmentNode<T> |
|
|
1051
|
+
route: T | null; /** Original template data for this candidate or parse gate. */
|
|
1052
|
+
data: RouteInterpolation | undefined;
|
|
1053
|
+
parent: AnySegmentNode<T> | undefined;
|
|
1060
1054
|
depth: number; /** route.options.params.parse function, set on the last node of the route */
|
|
1061
|
-
parse: null | ((params: Record<string, string>) =>
|
|
1062
|
-
|
|
1063
|
-
parsingPriority: number;
|
|
1055
|
+
parse: null | ((params: Record<string, string>) => unknown); /** route.options.params.priority ?? 0 */
|
|
1056
|
+
priority: number;
|
|
1064
1057
|
};
|
|
1065
1058
|
type RouteLike = {
|
|
1059
|
+
_interpolation?: RouteInterpolation;
|
|
1066
1060
|
id?: string;
|
|
1067
1061
|
path?: string;
|
|
1068
1062
|
children?: Array<RouteLike>;
|
|
1069
1063
|
parentRoute?: RouteLike;
|
|
1070
1064
|
isRoot?: boolean;
|
|
1071
1065
|
options?: {
|
|
1072
|
-
skipRouteOnParseError?: {
|
|
1073
|
-
params?: boolean;
|
|
1074
|
-
priority?: number;
|
|
1075
|
-
};
|
|
1076
1066
|
caseSensitive?: boolean;
|
|
1067
|
+
parseParams?: (params: Record<string, string>) => unknown;
|
|
1077
1068
|
params?: {
|
|
1078
|
-
parse?: (params: Record<string, string>) =>
|
|
1069
|
+
parse?: (params: Record<string, string>) => unknown;
|
|
1070
|
+
priority?: number;
|
|
1079
1071
|
};
|
|
1080
1072
|
};
|
|
1081
1073
|
} & ({
|
|
@@ -1094,16 +1086,15 @@ type ProcessedTree<TTree extends Extract<RouteLike, {
|
|
|
1094
1086
|
}>> = {
|
|
1095
1087
|
/** a representation of the `routeTree` as a segment tree */segmentTree: AnySegmentNode<TTree>; /** a mini route tree generated from the flat `routeMasks` list */
|
|
1096
1088
|
masksTree: AnySegmentNode<TFlat> | null; /** @deprecated keep until v2 so that `router.matchRoute` can keep not caring about the actual route tree */
|
|
1097
|
-
singleCache:
|
|
1098
|
-
matchCache:
|
|
1099
|
-
flatCache:
|
|
1089
|
+
singleCache: SieveCache<string, AnySegmentNode<TSingle>>; /** a cache of route matches from the `segmentTree` */
|
|
1090
|
+
matchCache: SieveCache<string, RouteMatch<TTree> | null>; /** a cache of route matches from the `masksTree` */
|
|
1091
|
+
flatCache: SieveCache<string, ReturnType<typeof findMatch<TFlat>>> | null;
|
|
1100
1092
|
};
|
|
1101
1093
|
type RouteMatch<T extends Extract<RouteLike, {
|
|
1102
1094
|
fullPath: string;
|
|
1103
1095
|
}>> = {
|
|
1104
1096
|
route: T;
|
|
1105
1097
|
rawParams: Record<string, string>;
|
|
1106
|
-
parsedParams?: Record<string, unknown>;
|
|
1107
1098
|
branch: ReadonlyArray<T>;
|
|
1108
1099
|
};
|
|
1109
1100
|
interface ProcessRouteTreeResult<TRouteLike extends Extract<RouteLike, {
|
|
@@ -1125,44 +1116,195 @@ declare function findMatch<T extends RouteLike>(path: string, segmentTree: AnySe
|
|
|
1125
1116
|
* This will be the exhaustive list of all params defined in the route's path.
|
|
1126
1117
|
*/
|
|
1127
1118
|
rawParams: Record<string, string>;
|
|
1128
|
-
/**
|
|
1129
|
-
* The accumlulated parsed params of each route in the branch that had `skipRouteOnParseError` enabled.
|
|
1130
|
-
* Will not contain all params defined in the route's path. Those w/ a `params.parse` but no `skipRouteOnParseError` will need to be parsed separately.
|
|
1131
|
-
*/
|
|
1132
|
-
parsedParams?: Record<string, unknown>;
|
|
1133
1119
|
} | null;
|
|
1134
1120
|
//#endregion
|
|
1135
|
-
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.
|
|
1121
|
+
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.171.34/node_modules/@tanstack/router-core/dist/esm/searchParams.d.ts
|
|
1136
1122
|
type SearchSerializer = (searchObj: Record<string, any>) => string;
|
|
1137
1123
|
type SearchParser = (searchStr: string) => Record<string, any>;
|
|
1138
1124
|
//#endregion
|
|
1139
|
-
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.
|
|
1125
|
+
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.171.34/node_modules/@tanstack/router-core/dist/esm/ssr/constants.d.ts
|
|
1126
|
+
declare const GLOBAL_TSR = "$_TSR";
|
|
1127
|
+
declare const GLOBAL_SEROVAL: '$R';
|
|
1128
|
+
//#endregion
|
|
1129
|
+
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.171.34/node_modules/@tanstack/router-core/dist/esm/manifest.d.ts
|
|
1130
|
+
type AssetCrossOrigin = 'anonymous' | 'use-credentials';
|
|
1131
|
+
type ScriptFormat = 'module' | 'iife';
|
|
1132
|
+
declare const DEV_STYLES_ATTR = "data-tanstack-router-dev-styles";
|
|
1133
|
+
type ManifestAssetLink = string | {
|
|
1134
|
+
href: string;
|
|
1135
|
+
crossOrigin?: AssetCrossOrigin;
|
|
1136
|
+
};
|
|
1140
1137
|
type Manifest = {
|
|
1141
|
-
|
|
1142
|
-
|
|
1143
|
-
|
|
1144
|
-
|
|
1145
|
-
|
|
1138
|
+
scriptFormat?: ScriptFormat;
|
|
1139
|
+
inlineStyle?: ManifestInlineCss;
|
|
1140
|
+
routes: Record<string, ManifestRoute>;
|
|
1141
|
+
};
|
|
1142
|
+
type ServerManifest = {
|
|
1143
|
+
scriptFormat?: ScriptFormat;
|
|
1144
|
+
inlineCss?: ServerManifestInlineCss;
|
|
1145
|
+
routes: Record<string, ServerManifestRoute>;
|
|
1146
|
+
};
|
|
1147
|
+
type ServerManifestInlineCss = {
|
|
1148
|
+
styles: Record<string, string>;
|
|
1149
|
+
templates?: Record<string, InlineCssTemplate>;
|
|
1146
1150
|
};
|
|
1147
|
-
type
|
|
1151
|
+
type InlineCssTemplate = {
|
|
1152
|
+
strings: Array<string>;
|
|
1153
|
+
urls: Array<string>;
|
|
1154
|
+
};
|
|
1155
|
+
type ManifestRoute = {
|
|
1156
|
+
filePath?: string;
|
|
1157
|
+
preloads?: Array<ManifestAssetLink>;
|
|
1158
|
+
scripts?: Array<ManifestScript>;
|
|
1159
|
+
css?: Array<ManifestCssLink>;
|
|
1160
|
+
};
|
|
1161
|
+
type ServerManifestRoute = ManifestRoute;
|
|
1162
|
+
type ManifestRouteAssets = Pick<ManifestRoute, 'preloads' | 'scripts' | 'css'>;
|
|
1163
|
+
type RouterManagedTitleTag = {
|
|
1148
1164
|
tag: 'title';
|
|
1149
1165
|
attrs?: Record<string, any>;
|
|
1150
1166
|
children: string;
|
|
1151
|
-
}
|
|
1152
|
-
|
|
1167
|
+
};
|
|
1168
|
+
type RouterManagedMetaTag = {
|
|
1169
|
+
tag: 'meta';
|
|
1153
1170
|
attrs?: Record<string, any>;
|
|
1154
1171
|
children?: never;
|
|
1155
|
-
}
|
|
1172
|
+
};
|
|
1173
|
+
type RouterManagedLinkTag = {
|
|
1174
|
+
tag: 'link';
|
|
1175
|
+
attrs?: Record<string, any>;
|
|
1176
|
+
children?: never;
|
|
1177
|
+
};
|
|
1178
|
+
type RouterManagedScriptTag = {
|
|
1156
1179
|
tag: 'script';
|
|
1157
1180
|
attrs?: Record<string, any>;
|
|
1158
1181
|
children?: string;
|
|
1159
|
-
}
|
|
1182
|
+
};
|
|
1183
|
+
type ManifestScript = Omit<RouterManagedScriptTag, 'tag'>;
|
|
1184
|
+
type RouterManagedStyleTag = {
|
|
1160
1185
|
tag: 'style';
|
|
1161
1186
|
attrs?: Record<string, any>;
|
|
1162
1187
|
children?: string;
|
|
1188
|
+
inlineCss?: true;
|
|
1189
|
+
};
|
|
1190
|
+
type RouterManagedTag = RouterManagedTitleTag | RouterManagedMetaTag | RouterManagedLinkTag | RouterManagedScriptTag | RouterManagedStyleTag;
|
|
1191
|
+
type ManifestCssLink = string | {
|
|
1192
|
+
href: string;
|
|
1193
|
+
crossOrigin?: AssetCrossOrigin;
|
|
1194
|
+
[DEV_STYLES_ATTR]?: true;
|
|
1195
|
+
};
|
|
1196
|
+
type ManifestInlineCss = {
|
|
1197
|
+
attrs?: Record<string, any>;
|
|
1198
|
+
children?: string;
|
|
1199
|
+
};
|
|
1200
|
+
//#endregion
|
|
1201
|
+
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.171.34/node_modules/@tanstack/router-core/dist/esm/ssr/types.d.ts
|
|
1202
|
+
interface DehydratedMatch {
|
|
1203
|
+
i: MakeRouteMatch['id'];
|
|
1204
|
+
l?: MakeRouteMatch['loaderData'];
|
|
1205
|
+
e?: MakeRouteMatch['error'];
|
|
1206
|
+
u: MakeRouteMatch['updatedAt'];
|
|
1207
|
+
s: MakeRouteMatch['status'];
|
|
1208
|
+
ssr?: MakeRouteMatch['ssr'];
|
|
1209
|
+
g?: true;
|
|
1210
|
+
}
|
|
1211
|
+
interface DehydratedRouter {
|
|
1212
|
+
manifest: Manifest | undefined;
|
|
1213
|
+
dehydratedData?: any;
|
|
1214
|
+
matches: Array<DehydratedMatch>;
|
|
1215
|
+
}
|
|
1216
|
+
interface TsrSsrGlobal {
|
|
1217
|
+
router?: DehydratedRouter;
|
|
1218
|
+
h: () => void;
|
|
1219
|
+
e: () => void;
|
|
1220
|
+
c: () => void;
|
|
1221
|
+
p: (script: () => void) => void;
|
|
1222
|
+
buffer: Array<() => void>;
|
|
1223
|
+
t?: Map<string, (value: any) => any>;
|
|
1224
|
+
initialized?: boolean;
|
|
1225
|
+
hydrated?: boolean;
|
|
1226
|
+
streamEnded?: boolean;
|
|
1227
|
+
}
|
|
1228
|
+
//#endregion
|
|
1229
|
+
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.171.34/node_modules/@tanstack/router-core/dist/esm/load-client.d.ts
|
|
1230
|
+
declare const SUCCESS = 0;
|
|
1231
|
+
declare const ERROR = 1;
|
|
1232
|
+
declare const NOT_FOUND = 2;
|
|
1233
|
+
declare const REDIRECTED = 3;
|
|
1234
|
+
declare const CANCELED = 4;
|
|
1235
|
+
type NonRedirectOutcome = [kind: typeof SUCCESS, data: unknown] | [kind: typeof ERROR, error: unknown] | [kind: typeof NOT_FOUND, error: NotFoundError] | [kind: typeof CANCELED];
|
|
1236
|
+
type RawLoaderOutcome = NonRedirectOutcome | [kind: typeof REDIRECTED, redirect: AnyRedirect];
|
|
1237
|
+
type LoaderFlight = [outcome: Promise<RawLoaderOutcome>, controller: AbortController, leases: number];
|
|
1238
|
+
type LoadTransaction = [controller: AbortController, redirects: number, location: ParsedLocation, matches: Array<AnyRouteMatch>, startedAt: number, done: Promise<void>,
|
|
1239
|
+
/**
|
|
1240
|
+
* Dev-only HMR refresh mode. Presence forces successor rematerialization
|
|
1241
|
+
* until this publication is acknowledged. The optional hydration handoff is
|
|
1242
|
+
* retired when the refresh publishes.
|
|
1243
|
+
*/
|
|
1244
|
+
refresh?: [handoff: NonNullable<AnyRouter['_handoff']> | undefined]];
|
|
1245
|
+
type PendingSession = [generation: LoadTransaction, boundaryId: string, /** Pending reveal time until acknowledged, then minimum-visible-until time. */deadline: number, revealTimer?: ReturnType<typeof setTimeout>, ack?: Promise<boolean> | true, component?: unknown];
|
|
1246
|
+
declare global {
|
|
1247
|
+
interface Window {
|
|
1248
|
+
[GLOBAL_TSR]?: TsrSsrGlobal;
|
|
1249
|
+
[GLOBAL_SEROVAL]?: any;
|
|
1250
|
+
}
|
|
1251
|
+
}
|
|
1252
|
+
//#endregion
|
|
1253
|
+
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.171.34/node_modules/@tanstack/router-core/dist/esm/load-server.d.ts
|
|
1254
|
+
type ServerLoadResult = {
|
|
1255
|
+
type: 'render';
|
|
1256
|
+
status: 200 | 404 | 500;
|
|
1257
|
+
matches: Array<AnyRouteMatch>;
|
|
1258
|
+
} | {
|
|
1259
|
+
type: 'redirect';
|
|
1260
|
+
redirect: AnyRedirect;
|
|
1261
|
+
};
|
|
1262
|
+
//#endregion
|
|
1263
|
+
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.171.34/node_modules/@tanstack/router-core/dist/esm/ssr/hydrationScripts.d.ts
|
|
1264
|
+
/** The one-time initial `<Scripts>` take: hydration tags plus the boundary. */
|
|
1265
|
+
type InitialHydrationScriptTags = {
|
|
1266
|
+
before: Array<RouterManagedTag>;
|
|
1267
|
+
boundary: RouterManagedTag;
|
|
1163
1268
|
};
|
|
1164
1269
|
//#endregion
|
|
1165
|
-
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.
|
|
1270
|
+
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.171.34/node_modules/@tanstack/router-core/dist/esm/stores.d.ts
|
|
1271
|
+
interface RouterReadableStore<TValue> {
|
|
1272
|
+
get: () => TValue;
|
|
1273
|
+
}
|
|
1274
|
+
interface RouterWritableStore<TValue> extends RouterReadableStore<TValue> {
|
|
1275
|
+
set: ((updater: (prev: TValue) => TValue) => void) & ((value: TValue) => void);
|
|
1276
|
+
}
|
|
1277
|
+
type RouterBatchFn = (fn: () => void) => void;
|
|
1278
|
+
type MutableStoreFactory = <TValue>(initialValue: TValue) => RouterWritableStore<TValue>;
|
|
1279
|
+
type ReadonlyStoreFactory = <TValue>(read: () => TValue) => RouterReadableStore<TValue>;
|
|
1280
|
+
type GetStoreConfig = (opts: {
|
|
1281
|
+
isServer?: boolean;
|
|
1282
|
+
}) => StoreConfig;
|
|
1283
|
+
type StoreConfig = {
|
|
1284
|
+
createMutableStore: MutableStoreFactory;
|
|
1285
|
+
createReadonlyStore: ReadonlyStoreFactory;
|
|
1286
|
+
batch: RouterBatchFn;
|
|
1287
|
+
};
|
|
1288
|
+
type MatchStore = RouterWritableStore<AnyRouteMatch | undefined>;
|
|
1289
|
+
type ReadableStore<TValue> = RouterReadableStore<TValue>;
|
|
1290
|
+
/** SSR non-reactive createMutableStore */
|
|
1291
|
+
interface RouterStores<in out TRouteTree extends AnyRoute> {
|
|
1292
|
+
status: RouterWritableStore<RouterState<TRouteTree>['status']>;
|
|
1293
|
+
location: RouterWritableStore<ParsedLocation<FullSearchSchema<TRouteTree>>>;
|
|
1294
|
+
resolvedLocation: RouterWritableStore<ParsedLocation<FullSearchSchema<TRouteTree>> | undefined>;
|
|
1295
|
+
ids: RouterWritableStore<Array<string>>;
|
|
1296
|
+
matches: ReadableStore<Array<AnyRouteMatch>>;
|
|
1297
|
+
__store: RouterReadableStore<RouterState<TRouteTree>>;
|
|
1298
|
+
byRoute: Map<string, MatchStore>;
|
|
1299
|
+
/**
|
|
1300
|
+
* Get the stable atom for a route's presented match. The atom remains in the
|
|
1301
|
+
* pool when the route leaves and contains `undefined` until it re-enters.
|
|
1302
|
+
*/
|
|
1303
|
+
getMatchStore: (routeId: string) => RouterReadableStore<AnyRouteMatch | undefined>;
|
|
1304
|
+
setMatches: (nextMatches: Array<AnyRouteMatch>) => void;
|
|
1305
|
+
}
|
|
1306
|
+
//#endregion
|
|
1307
|
+
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.171.34/node_modules/@tanstack/router-core/dist/esm/router.d.ts
|
|
1166
1308
|
interface Register {}
|
|
1167
1309
|
type RegisteredSsr<TRegister = Register> = TRegister extends {
|
|
1168
1310
|
ssr: infer TSSR;
|
|
@@ -1218,7 +1360,8 @@ interface RouterOptions<TRouteTree extends AnyRoute, TTrailingSlashOption extend
|
|
|
1218
1360
|
*/
|
|
1219
1361
|
defaultPreload?: false | 'intent' | 'viewport' | 'render';
|
|
1220
1362
|
/**
|
|
1221
|
-
* The delay in milliseconds
|
|
1363
|
+
* The delay in milliseconds before intent focus/hover and viewport preloading.
|
|
1364
|
+
* Touch intent preloads immediately.
|
|
1222
1365
|
*
|
|
1223
1366
|
* @default 50
|
|
1224
1367
|
* @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#defaultpreloaddelay-property)
|
|
@@ -1257,6 +1400,15 @@ interface RouterOptions<TRouteTree extends AnyRoute, TTrailingSlashOption extend
|
|
|
1257
1400
|
* @link [Guide](https://tanstack.com/router/latest/docs/framework/react/guide/data-loading#key-options)
|
|
1258
1401
|
*/
|
|
1259
1402
|
defaultStaleTime?: number;
|
|
1403
|
+
/**
|
|
1404
|
+
* The default stale reload mode a route loader should use if no `loader.staleReloadMode` is provided.
|
|
1405
|
+
*
|
|
1406
|
+
* `'background'` preserves the current stale-while-revalidate behavior.
|
|
1407
|
+
* `'blocking'` waits for stale loader reloads to complete before resolving navigation.
|
|
1408
|
+
*
|
|
1409
|
+
* @default 'background'
|
|
1410
|
+
*/
|
|
1411
|
+
defaultStaleReloadMode?: LoaderStaleReloadMode;
|
|
1260
1412
|
/**
|
|
1261
1413
|
* The default `preloadStaleTime` a route should use if no preloadStaleTime is provided.
|
|
1262
1414
|
*
|
|
@@ -1266,9 +1418,9 @@ interface RouterOptions<TRouteTree extends AnyRoute, TTrailingSlashOption extend
|
|
|
1266
1418
|
*/
|
|
1267
1419
|
defaultPreloadStaleTime?: number;
|
|
1268
1420
|
/**
|
|
1269
|
-
* The default `
|
|
1421
|
+
* The default `preloadGcTime` a route should use if none is provided.
|
|
1270
1422
|
*
|
|
1271
|
-
* @default
|
|
1423
|
+
* @default 300_000 `(5 minutes)`
|
|
1272
1424
|
* @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#defaultpreloadgctime-property)
|
|
1273
1425
|
* @link [Guide](https://tanstack.com/router/latest/docs/framework/react/guide/preloading)
|
|
1274
1426
|
*/
|
|
@@ -1300,7 +1452,7 @@ interface RouterOptions<TRouteTree extends AnyRoute, TTrailingSlashOption extend
|
|
|
1300
1452
|
/**
|
|
1301
1453
|
* The default `gcTime` a route should use if no gcTime is provided.
|
|
1302
1454
|
*
|
|
1303
|
-
* @default
|
|
1455
|
+
* @default 300_000 `(5 minutes)`
|
|
1304
1456
|
* @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#defaultgctime-property)
|
|
1305
1457
|
* @link [Guide](https://tanstack.com/router/latest/docs/framework/react/guide/data-loading#key-options)
|
|
1306
1458
|
*/
|
|
@@ -1347,7 +1499,7 @@ interface RouterOptions<TRouteTree extends AnyRoute, TTrailingSlashOption extend
|
|
|
1347
1499
|
* @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#dehydrate-method)
|
|
1348
1500
|
* @link [Guide](https://tanstack.com/router/latest/docs/framework/react/guide/external-data-loading#critical-dehydrationhydration)
|
|
1349
1501
|
*/
|
|
1350
|
-
dehydrate?: () => Constrain<TDehydrated, ValidateSerializableInput<Register, TDehydrated
|
|
1502
|
+
dehydrate?: () => Awaitable<Constrain<TDehydrated, ValidateSerializableInput<Register, TDehydrated>>>;
|
|
1351
1503
|
/**
|
|
1352
1504
|
* A function that will be called when the router is hydrated.
|
|
1353
1505
|
*
|
|
@@ -1431,11 +1583,12 @@ interface RouterOptions<TRouteTree extends AnyRoute, TTrailingSlashOption extend
|
|
|
1431
1583
|
defaultStructuralSharing?: TDefaultStructuralSharingOption;
|
|
1432
1584
|
/**
|
|
1433
1585
|
* Configures which URI characters are allowed in path params that would ordinarily be escaped by encodeURIComponent.
|
|
1586
|
+
* This is read only during initialization. Create a new router to change it.
|
|
1434
1587
|
*
|
|
1435
1588
|
* @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#pathparamsallowedcharacters-property)
|
|
1436
1589
|
* @link [Guide](https://tanstack.com/router/latest/docs/framework/react/guide/path-params#allowed-characters)
|
|
1437
1590
|
*/
|
|
1438
|
-
pathParamsAllowedCharacters?:
|
|
1591
|
+
readonly pathParamsAllowedCharacters?: ReadonlyArray<';' | ':' | '@' | '&' | '=' | '+' | '$' | ','>;
|
|
1439
1592
|
defaultRemountDeps?: DefaultRemountDepsFn<TRouteTree>;
|
|
1440
1593
|
/**
|
|
1441
1594
|
* If `true`, scroll restoration will be enabled
|
|
@@ -1490,6 +1643,11 @@ interface RouterOptions<TRouteTree extends AnyRoute, TTrailingSlashOption extend
|
|
|
1490
1643
|
* This is useful for shifting data from the origin to the path (for things like subdomain routing), or other advanced use cases.
|
|
1491
1644
|
*/
|
|
1492
1645
|
rewrite?: LocationRewrite;
|
|
1646
|
+
/**
|
|
1647
|
+
* The origin used to resolve URLs. Pass a normalized origin, such as
|
|
1648
|
+
* `https://example.com` or `http://localhost:3000`, without a path or trailing slash.
|
|
1649
|
+
* Defaults to the browser origin, or `http://localhost` on the server.
|
|
1650
|
+
*/
|
|
1493
1651
|
origin?: string;
|
|
1494
1652
|
ssr?: {
|
|
1495
1653
|
nonce?: string;
|
|
@@ -1522,16 +1680,10 @@ type LocationRewriteFunction = ({
|
|
|
1522
1680
|
}) => undefined | string | URL;
|
|
1523
1681
|
interface RouterState<in out TRouteTree extends AnyRoute = AnyRoute, in out TRouteMatch = MakeRouteMatchUnion> {
|
|
1524
1682
|
status: 'pending' | 'idle';
|
|
1525
|
-
loadedAt: number;
|
|
1526
1683
|
isLoading: boolean;
|
|
1527
|
-
isTransitioning: boolean;
|
|
1528
1684
|
matches: Array<TRouteMatch>;
|
|
1529
|
-
pendingMatches?: Array<TRouteMatch>;
|
|
1530
|
-
cachedMatches: Array<TRouteMatch>;
|
|
1531
1685
|
location: ParsedLocation<FullSearchSchema<TRouteTree>>;
|
|
1532
1686
|
resolvedLocation?: ParsedLocation<FullSearchSchema<TRouteTree>>;
|
|
1533
|
-
statusCode: number;
|
|
1534
|
-
redirect?: AnyRedirect;
|
|
1535
1687
|
}
|
|
1536
1688
|
interface BuildNextOptions {
|
|
1537
1689
|
to?: string | number | null;
|
|
@@ -1588,9 +1740,7 @@ type RouterListener<TRouterEvent extends RouterEvent> = {
|
|
|
1588
1740
|
};
|
|
1589
1741
|
type SubscribeFn = <TType extends keyof RouterEvents>(eventType: TType, fn: ListenerFn<RouterEvents[TType]>) => () => void;
|
|
1590
1742
|
interface MatchRoutesOpts {
|
|
1591
|
-
preload?: boolean;
|
|
1592
1743
|
throwOnError?: boolean;
|
|
1593
|
-
dest?: BuildNextOptions;
|
|
1594
1744
|
}
|
|
1595
1745
|
type InferRouterContext<TRouteTree extends AnyRoute> = TRouteTree['types']['routerContext'];
|
|
1596
1746
|
type RouterContextOptions<TRouteTree extends AnyRoute> = AnyContext extends InferRouterContext<TRouteTree> ? {
|
|
@@ -1599,32 +1749,30 @@ type RouterContextOptions<TRouteTree extends AnyRoute> = AnyContext extends Infe
|
|
|
1599
1749
|
context: InferRouterContext<TRouteTree>;
|
|
1600
1750
|
};
|
|
1601
1751
|
type RouterConstructorOptions<TRouteTree extends AnyRoute, TTrailingSlashOption extends TrailingSlashOption, TDefaultStructuralSharingOption extends boolean, TRouterHistory extends RouterHistory, TDehydrated extends Record<string, any>> = Omit<RouterOptions<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory, TDehydrated>, 'context' | 'serializationAdapters' | 'defaultSsr'> & RouterContextOptions<TRouteTree>;
|
|
1602
|
-
type PreloadRouteFn<TRouteTree extends AnyRoute, TTrailingSlashOption extends TrailingSlashOption, TDefaultStructuralSharingOption extends boolean, TRouterHistory extends RouterHistory> = <TFrom extends RoutePaths<TRouteTree> | string = string, TTo extends string | undefined = undefined, TMaskFrom extends RoutePaths<TRouteTree> | string = TFrom, TMaskTo extends string = ''>(opts: NavigateOptions<RouterCore<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory>, TFrom, TTo, TMaskFrom, TMaskTo>
|
|
1603
|
-
type MatchRouteFn<TRouteTree extends AnyRoute, TTrailingSlashOption extends TrailingSlashOption, TDefaultStructuralSharingOption extends boolean, TRouterHistory extends RouterHistory> = <TFrom extends RoutePaths<TRouteTree> = '/', TTo extends string | undefined = undefined, TResolved = ResolveRelativePath<TFrom, NoInfer
|
|
1604
|
-
type UpdateFn<TRouteTree extends AnyRoute, TTrailingSlashOption extends TrailingSlashOption, TDefaultStructuralSharingOption extends boolean, TRouterHistory extends RouterHistory, TDehydrated extends Record<string, any>> = (newOptions: RouterConstructorOptions<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory, TDehydrated>) => void;
|
|
1752
|
+
type PreloadRouteFn<TRouteTree extends AnyRoute, TTrailingSlashOption extends TrailingSlashOption, TDefaultStructuralSharingOption extends boolean, TRouterHistory extends RouterHistory, TDehydrated extends Record<string, any> = Record<string, any>> = <TFrom extends RoutePaths<TRouteTree> | string = string, TTo extends string | undefined = undefined, TMaskFrom extends RoutePaths<TRouteTree> | string = TFrom, TMaskTo extends string = ''>(opts: NavigateOptions<RouterCore<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory, TDehydrated>, TFrom, TTo, TMaskFrom, TMaskTo>) => Promise<Array<AnyRouteMatch> | undefined>;
|
|
1753
|
+
type MatchRouteFn<TRouteTree extends AnyRoute, TTrailingSlashOption extends TrailingSlashOption, TDefaultStructuralSharingOption extends boolean, TRouterHistory extends RouterHistory> = <TFrom extends RoutePaths<TRouteTree> = '/', TTo extends string | undefined = undefined, TResolved = ResolveRelativePath<TFrom, NoInfer<TTo>>>(location: ToOptions<RouterCore<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory>, TFrom, TTo>, opts?: MatchRouteOptions) => false | RouteById<TRouteTree, TResolved>['types']['allParams'];
|
|
1754
|
+
type UpdateFn<TRouteTree extends AnyRoute, TTrailingSlashOption extends TrailingSlashOption, TDefaultStructuralSharingOption extends boolean, TRouterHistory extends RouterHistory, TDehydrated extends Record<string, any>> = (newOptions: Omit<RouterConstructorOptions<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory, TDehydrated>, 'pathParamsAllowedCharacters'>) => void;
|
|
1605
1755
|
type InvalidateFn<TRouter extends AnyRouter> = (opts?: {
|
|
1606
1756
|
filter?: (d: MakeRouteMatchUnion<TRouter>) => boolean;
|
|
1607
1757
|
sync?: boolean;
|
|
1608
1758
|
forcePending?: boolean;
|
|
1609
1759
|
}) => Promise<void>;
|
|
1610
1760
|
type ParseLocationFn<TRouteTree extends AnyRoute> = (locationToParse: HistoryLocation, previousLocation?: ParsedLocation<FullSearchSchema<TRouteTree>>) => ParsedLocation<FullSearchSchema<TRouteTree>>;
|
|
1611
|
-
type GetMatchRoutesFn = (pathname: string) =>
|
|
1612
|
-
matchedRoutes: ReadonlyArray<AnyRoute>; /** exhaustive params, still in their string form */
|
|
1613
|
-
routeParams: Record<string, string>; /** partial params, parsed from routeParams during matching */
|
|
1614
|
-
parsedParams: Record<string, unknown> | undefined;
|
|
1615
|
-
foundRoute: AnyRoute | undefined;
|
|
1616
|
-
parseError?: unknown;
|
|
1617
|
-
};
|
|
1761
|
+
type GetMatchRoutesFn = (pathname: string) => [matchedRoutes: ReadonlyArray<AnyRoute>, /** exhaustive params, still in their string form */rawParams: Record<string, string>, foundRoute: AnyRoute | undefined];
|
|
1618
1762
|
type EmitFn = (routerEvent: RouterEvent) => void;
|
|
1619
1763
|
type LoadFn = (opts?: {
|
|
1620
1764
|
sync?: boolean;
|
|
1765
|
+
action?: {
|
|
1766
|
+
type: HistoryAction;
|
|
1767
|
+
};
|
|
1768
|
+
_signal?: AbortSignal;
|
|
1621
1769
|
}) => Promise<void>;
|
|
1622
1770
|
type CommitLocationFn = ({
|
|
1623
1771
|
viewTransition,
|
|
1624
1772
|
ignoreBlocker,
|
|
1625
1773
|
...next
|
|
1626
1774
|
}: ParsedLocation & CommitLocationOptions) => Promise<void>;
|
|
1627
|
-
type StartTransitionFn = (fn: () => void) =>
|
|
1775
|
+
type StartTransitionFn = (fn: () => void, expected: Array<AnyRouteMatch>) => Promise<boolean>;
|
|
1628
1776
|
interface MatchRoutesFn {
|
|
1629
1777
|
(pathname: string, locationSearch?: AnySchema, opts?: MatchRoutesOpts): Array<MakeRouteMatchUnion>;
|
|
1630
1778
|
/**
|
|
@@ -1633,34 +1781,54 @@ interface MatchRoutesFn {
|
|
|
1633
1781
|
(next: ParsedLocation, opts?: MatchRoutesOpts): Array<AnyRouteMatch>;
|
|
1634
1782
|
(pathnameOrNext: string | ParsedLocation, locationSearchOrOpts?: AnySchema | MatchRoutesOpts, opts?: MatchRoutesOpts): Array<AnyRouteMatch>;
|
|
1635
1783
|
}
|
|
1636
|
-
type GetMatchFn = (matchId: string) => AnyRouteMatch | undefined;
|
|
1637
|
-
type UpdateMatchFn = (id: string, updater: (match: AnyRouteMatch) => AnyRouteMatch) => void;
|
|
1638
1784
|
type ClearCacheFn<TRouter extends AnyRouter> = (opts?: {
|
|
1639
1785
|
filter?: (d: MakeRouteMatchUnion<TRouter>) => boolean;
|
|
1640
1786
|
}) => void;
|
|
1787
|
+
/**
|
|
1788
|
+
* Server-side SSR request contract.
|
|
1789
|
+
*
|
|
1790
|
+
* Tiering rule: the flat methods are the adapter/framework contract;
|
|
1791
|
+
* `hydrationScripts` is transport for the core SSR stream merger only.
|
|
1792
|
+
* New members must land on the matching tier.
|
|
1793
|
+
*/
|
|
1641
1794
|
interface ServerSsr {
|
|
1642
|
-
/**
|
|
1643
|
-
* Injects HTML synchronously into the stream.
|
|
1644
|
-
* Emits an onInjectedHtml event that listeners can handle.
|
|
1645
|
-
* If no subscriber is listening, the HTML is buffered and can be retrieved via takeBufferedHtml().
|
|
1646
|
-
*/
|
|
1647
|
-
injectHtml: (html: string) => void;
|
|
1648
|
-
/**
|
|
1649
|
-
* Injects a script tag synchronously into the stream.
|
|
1650
|
-
*/
|
|
1651
|
-
injectScript: (script: string) => void;
|
|
1652
|
-
isDehydrated: () => boolean;
|
|
1653
|
-
isSerializationFinished: () => boolean;
|
|
1795
|
+
/** Framework-only. */
|
|
1654
1796
|
onRenderFinished: (listener: () => void) => void;
|
|
1655
|
-
|
|
1656
|
-
|
|
1657
|
-
|
|
1658
|
-
|
|
1659
|
-
|
|
1660
|
-
*
|
|
1661
|
-
|
|
1662
|
-
|
|
1663
|
-
|
|
1797
|
+
/** Framework-only. */
|
|
1798
|
+
setRenderFinished: () => void;
|
|
1799
|
+
/** Framework-only. */
|
|
1800
|
+
cleanup: () => void;
|
|
1801
|
+
/**
|
|
1802
|
+
* Register a listener invoked when the SSR request lifecycle ends (success,
|
|
1803
|
+
* error, abort, or stream lifetime expiry). Use to tear down per-request
|
|
1804
|
+
* resources whose references would otherwise pin the router (e.g. query
|
|
1805
|
+
* cache subscriptions, gcTime timers, abort controllers).
|
|
1806
|
+
*
|
|
1807
|
+
* `settled` is true when every value the router dehydrated has settled, so
|
|
1808
|
+
* no loader work can still be pending. It is false when the response ended
|
|
1809
|
+
* early (abort, cancellation, timeout) or never consumed the loader data.
|
|
1810
|
+
*
|
|
1811
|
+
* Listeners run synchronously and exactly once. Errors are caught and logged.
|
|
1812
|
+
* A listener registered after cleanup already ran is invoked immediately.
|
|
1813
|
+
*/
|
|
1814
|
+
onCleanup: (listener: (settled: boolean) => void) => void;
|
|
1815
|
+
/** Framework-only. */
|
|
1816
|
+
dehydrate: (opts?: {
|
|
1817
|
+
requestAssets?: ManifestRouteAssets;
|
|
1818
|
+
signal?: AbortSignal;
|
|
1819
|
+
}) => Promise<void>;
|
|
1820
|
+
/**
|
|
1821
|
+
* Framework-only: opt this request out of hydration output entirely (for
|
|
1822
|
+
* example a `hydrate: false` page). Call instead of `dehydrate()`, before
|
|
1823
|
+
* rendering starts. No hydration scripts are emitted, `<Scripts>` renders
|
|
1824
|
+
* no boundary, and the response takes the pass-through stream path.
|
|
1825
|
+
*/
|
|
1826
|
+
disableHydration: () => void;
|
|
1827
|
+
/** Framework-only. */
|
|
1828
|
+
takeInitialHydrationScriptTags: () => InitialHydrationScriptTags | undefined;
|
|
1829
|
+
}
|
|
1830
|
+
interface RouterSsrLifecycle {
|
|
1831
|
+
onServerSsrAttach?: Array<(serverSsr: ServerSsr) => void>;
|
|
1664
1832
|
}
|
|
1665
1833
|
type AnyRouter = RouterCore<any, any, any, any, any>;
|
|
1666
1834
|
interface ViewTransitionOptions {
|
|
@@ -1679,54 +1847,100 @@ declare const trailingSlashOptions: {
|
|
|
1679
1847
|
readonly preserve: "preserve";
|
|
1680
1848
|
};
|
|
1681
1849
|
type TrailingSlashOption = (typeof trailingSlashOptions)[keyof typeof trailingSlashOptions];
|
|
1850
|
+
/** Indexes and caches rebuilt together when the route tree changes. */
|
|
1851
|
+
type RouteTreeCaches<TRouteTree extends AnyRoute> = ProcessRouteTreeResult<TRouteTree> & {
|
|
1852
|
+
resolvePathCache: SieveCache<string, string>;
|
|
1853
|
+
};
|
|
1682
1854
|
declare global {
|
|
1683
1855
|
var __TSR_CACHE__: {
|
|
1684
1856
|
routeTree: AnyRoute;
|
|
1685
|
-
|
|
1686
|
-
|
|
1857
|
+
caseSensitive: boolean | undefined;
|
|
1858
|
+
processRouteTreeResult: RouteTreeCaches<AnyRoute>;
|
|
1687
1859
|
} | undefined;
|
|
1688
1860
|
}
|
|
1861
|
+
interface RouterCore<in out TRouteTree extends AnyRoute, in out TTrailingSlashOption extends TrailingSlashOption, in out TDefaultStructuralSharingOption extends boolean, in out TRouterHistory extends RouterHistory = RouterHistory, in out TDehydrated extends Record<string, any> = Record<string, any>> {
|
|
1862
|
+
shouldViewTransition?: boolean | ViewTransitionOptions;
|
|
1863
|
+
/**
|
|
1864
|
+
* Foreground lifecycle boundary survives invalidation/background statuses.
|
|
1865
|
+
* Zero or undefined means the whole branch participates.
|
|
1866
|
+
*/
|
|
1867
|
+
_lifecycleEnd?: number;
|
|
1868
|
+
/** Current client load transaction and owner of navigation writes. */
|
|
1869
|
+
_tx?: LoadTransaction;
|
|
1870
|
+
/** Joinable in-flight loader generations keyed by match ID. */
|
|
1871
|
+
_flights?: Map<string, LoaderFlight>;
|
|
1872
|
+
/** Active speculative lanes retained for cancellation, invalidation, and cache clearing. */
|
|
1873
|
+
_preloads?: Map<AbortController, Array<AnyRouteMatch>>;
|
|
1874
|
+
/** Owns cancellable work before a client transaction publishes. */
|
|
1875
|
+
_preflight?: AbortController;
|
|
1876
|
+
/** Transfers one reconstructed SSR prefix into its initial client load. */
|
|
1877
|
+
_handoff?: HydrationHandoff;
|
|
1878
|
+
/** Pending-boundary reveal and minimum-visible timing state. */
|
|
1879
|
+
_pending?: PendingSession;
|
|
1880
|
+
/** Result of the latest server load, used to render or redirect. */
|
|
1881
|
+
_serverResult?: ServerLoadResult;
|
|
1882
|
+
/** Framework publication waiting for an exact render acknowledgement. */
|
|
1883
|
+
_rendered?: [offered?: Array<AnyRouteMatch>, settle?: (rendered: boolean) => void];
|
|
1884
|
+
/** Development-only HMR reload for a route and its descendants. */
|
|
1885
|
+
_refreshRoute: (() => Promise<void>) | undefined;
|
|
1886
|
+
/** Development-only replacement for a route's lazy chunk owner. */
|
|
1887
|
+
_replaceRouteChunk: ((route: AnyRoute, lazyFn: AnyRoute['lazyFn']) => void) | undefined;
|
|
1888
|
+
}
|
|
1889
|
+
type HydrationHandoff = [claim: () => AbortController | undefined, finish: (matches?: Array<AnyRouteMatch>) => number | undefined];
|
|
1890
|
+
/**
|
|
1891
|
+
* Core, framework-agnostic router engine that powers TanStack Router.
|
|
1892
|
+
*
|
|
1893
|
+
* Provides navigation, matching, loading, preloading, caching and event APIs
|
|
1894
|
+
* used by framework adapters (React/Solid). Prefer framework helpers like
|
|
1895
|
+
* `createRouter` in app code.
|
|
1896
|
+
*
|
|
1897
|
+
* @link https://tanstack.com/router/latest/docs/framework/react/api/router/RouterType
|
|
1898
|
+
*/
|
|
1689
1899
|
declare class RouterCore<in out TRouteTree extends AnyRoute, in out TTrailingSlashOption extends TrailingSlashOption, in out TDefaultStructuralSharingOption extends boolean, in out TRouterHistory extends RouterHistory = RouterHistory, in out TDehydrated extends Record<string, any> = Record<string, any>> {
|
|
1690
1900
|
tempLocationKey: string | undefined;
|
|
1691
|
-
|
|
1692
|
-
|
|
1693
|
-
|
|
1901
|
+
_scroll: {
|
|
1902
|
+
n: boolean;
|
|
1903
|
+
h?: boolean;
|
|
1904
|
+
e?: boolean;
|
|
1905
|
+
s?: boolean;
|
|
1906
|
+
r?: boolean;
|
|
1907
|
+
};
|
|
1694
1908
|
subscribers: Set<RouterListener<RouterEvent>>;
|
|
1695
|
-
|
|
1696
|
-
|
|
1697
|
-
|
|
1698
|
-
|
|
1909
|
+
/** Accepted off-screen loader generations keyed by match ID. */
|
|
1910
|
+
_cache: Map<string, AnyRouteMatch>;
|
|
1911
|
+
/** Accepted semantic lane, excluding temporary pending presentation. */
|
|
1912
|
+
_committed: Array<AnyRouteMatch>;
|
|
1913
|
+
stores: RouterStores<TRouteTree>;
|
|
1914
|
+
private getStoreConfig;
|
|
1915
|
+
batch: (fn: () => void) => void;
|
|
1699
1916
|
options: PickAsRequired<RouterOptions<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory, TDehydrated>, 'stringifySearch' | 'parseSearch' | 'context'>;
|
|
1700
1917
|
history: TRouterHistory;
|
|
1701
1918
|
rewrite?: LocationRewrite;
|
|
1702
|
-
origin
|
|
1919
|
+
origin: string;
|
|
1703
1920
|
latestLocation: ParsedLocation<FullSearchSchema<TRouteTree>>;
|
|
1704
|
-
|
|
1921
|
+
_pendingLocation?: ParsedLocation<FullSearchSchema<TRouteTree>>;
|
|
1705
1922
|
basepath: string;
|
|
1706
1923
|
routeTree: TRouteTree;
|
|
1707
1924
|
routesById: RoutesById<TRouteTree>;
|
|
1708
1925
|
routesByPath: RoutesByPath<TRouteTree>;
|
|
1709
1926
|
processedTree: ProcessedTree<TRouteTree, any, any>;
|
|
1710
|
-
resolvePathCache:
|
|
1927
|
+
resolvePathCache: SieveCache<string, string>;
|
|
1928
|
+
private lightweightCache;
|
|
1929
|
+
private staticLocations;
|
|
1711
1930
|
isServer: boolean;
|
|
1712
|
-
pathParamsDecoder?: (encoded: string) => string;
|
|
1931
|
+
readonly pathParamsDecoder?: (encoded: string) => string;
|
|
1713
1932
|
protocolAllowlist: Set<string>;
|
|
1714
1933
|
/**
|
|
1715
1934
|
* @deprecated Use the `createRouter` function instead
|
|
1716
1935
|
*/
|
|
1717
|
-
constructor(options: RouterConstructorOptions<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory, TDehydrated
|
|
1936
|
+
constructor(options: RouterConstructorOptions<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory, TDehydrated>, getStoreConfig: GetStoreConfig);
|
|
1718
1937
|
startTransition: StartTransitionFn;
|
|
1719
1938
|
isShell(): boolean;
|
|
1720
|
-
isPrerendering(): boolean;
|
|
1721
1939
|
update: UpdateFn<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory, TDehydrated>;
|
|
1722
1940
|
get state(): RouterState<TRouteTree>;
|
|
1723
1941
|
updateLatestLocation: () => void;
|
|
1724
|
-
buildRouteTree: () =>
|
|
1725
|
-
setRoutes(
|
|
1726
|
-
routesById,
|
|
1727
|
-
routesByPath,
|
|
1728
|
-
processedTree
|
|
1729
|
-
}: ProcessRouteTreeResult<TRouteTree>): void;
|
|
1942
|
+
buildRouteTree: () => RouteTreeCaches<TRouteTree>;
|
|
1943
|
+
setRoutes(caches: RouteTreeCaches<TRouteTree>): void;
|
|
1730
1944
|
/**
|
|
1731
1945
|
* Subscribe to router lifecycle events like `onBeforeNavigate`, `onLoad`,
|
|
1732
1946
|
* `onResolved`, etc. Returns an unsubscribe function.
|
|
@@ -1740,30 +1954,28 @@ declare class RouterCore<in out TRouteTree extends AnyRoute, in out TTrailingSla
|
|
|
1740
1954
|
* current router options, rewrite rules and search parser/stringifier.
|
|
1741
1955
|
*/
|
|
1742
1956
|
parseLocation: ParseLocationFn<TRouteTree>;
|
|
1743
|
-
/** Resolve a path against the router basepath and trailing-slash policy. */
|
|
1744
|
-
resolvePathWithBase: (from: string, path: string) => string;
|
|
1745
|
-
get looseRoutesById(): Record<string, AnyRoute>;
|
|
1746
1957
|
matchRoutes: MatchRoutesFn;
|
|
1747
|
-
private getParentContext;
|
|
1748
1958
|
private matchRoutesInternal;
|
|
1749
1959
|
getMatchedRoutes: GetMatchRoutesFn;
|
|
1750
1960
|
/**
|
|
1751
1961
|
* Lightweight route matching for buildLocation.
|
|
1752
1962
|
* Only computes fullPath, accumulated search, and params - skipping expensive
|
|
1753
|
-
* operations like AbortController,
|
|
1963
|
+
* operations like AbortController, loaderDeps, and full match objects.
|
|
1754
1964
|
*/
|
|
1755
1965
|
private matchRoutesLightweight;
|
|
1756
|
-
cancelMatch: (id: string) => void;
|
|
1757
|
-
cancelMatches: () => void;
|
|
1758
1966
|
/**
|
|
1759
1967
|
* Build the next ParsedLocation from navigation options without committing.
|
|
1760
1968
|
* Resolves `to`/`from`, params/search/hash/state, applies search validation
|
|
1761
|
-
* and middlewares, and returns a
|
|
1969
|
+
* and middlewares, and returns a stringified location object. The built
|
|
1970
|
+
* `search` and `state` are not structurally shared with the current
|
|
1971
|
+
* location; `parseLocation` stabilizes them once the location is committed.
|
|
1762
1972
|
*
|
|
1763
1973
|
* @link https://tanstack.com/router/latest/docs/framework/react/api/router/RouterType#buildlocation-method
|
|
1764
1974
|
*/
|
|
1765
1975
|
buildLocation: BuildLocationFn;
|
|
1766
|
-
|
|
1976
|
+
_commitPromise: (Promise<void> & {
|
|
1977
|
+
resolve: () => void;
|
|
1978
|
+
}) | undefined;
|
|
1767
1979
|
/**
|
|
1768
1980
|
* Commit a previously built location to history (push/replace), optionally
|
|
1769
1981
|
* using view transitions and scroll restoration options.
|
|
@@ -1776,7 +1988,6 @@ declare class RouterCore<in out TRouteTree extends AnyRoute, in out TTrailingSla
|
|
|
1776
1988
|
hashScrollIntoView,
|
|
1777
1989
|
viewTransition,
|
|
1778
1990
|
ignoreBlocker,
|
|
1779
|
-
href,
|
|
1780
1991
|
...rest
|
|
1781
1992
|
}?: BuildNextOptions & CommitLocationOptions) => Promise<void>;
|
|
1782
1993
|
/**
|
|
@@ -1787,52 +1998,129 @@ declare class RouterCore<in out TRouteTree extends AnyRoute, in out TTrailingSla
|
|
|
1787
1998
|
* @link https://tanstack.com/router/latest/docs/framework/react/api/router/NavigateOptionsType
|
|
1788
1999
|
*/
|
|
1789
2000
|
navigate: NavigateFn;
|
|
1790
|
-
latestLoadPromise: undefined | Promise<void>;
|
|
1791
|
-
beforeLoad: () => void;
|
|
1792
2001
|
load: LoadFn;
|
|
1793
|
-
startViewTransition: (fn: () => Promise<void>) =>
|
|
1794
|
-
updateMatch: UpdateMatchFn;
|
|
1795
|
-
getMatch: GetMatchFn;
|
|
2002
|
+
startViewTransition: (fn: () => Promise<void>) => any;
|
|
1796
2003
|
/**
|
|
1797
|
-
* Invalidate
|
|
2004
|
+
* Invalidate selected match generations and optionally force current matches
|
|
2005
|
+
* back into a pending state.
|
|
2006
|
+
*
|
|
2007
|
+
* - Marks committed and cached matches whose IDs are selected as invalid.
|
|
2008
|
+
* - Retires selected active preloads so older work cannot publish fresh data.
|
|
1798
2009
|
*
|
|
1799
|
-
*
|
|
1800
|
-
*
|
|
1801
|
-
* its status is reset to `'pending'` and its `error` cleared so that the loader is re-run
|
|
1802
|
-
* on the next `load()` call (eg. after HMR or a manual invalidation).
|
|
2010
|
+
* The next load decides when to publish pending UI, so invalidation does not
|
|
2011
|
+
* mutate the currently rendered status.
|
|
1803
2012
|
*/
|
|
1804
2013
|
invalidate: InvalidateFn<RouterCore<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory, TDehydrated>>;
|
|
1805
|
-
getParsedLocationHref: (location: ParsedLocation) => string;
|
|
1806
2014
|
resolveRedirect: (redirect: AnyRedirect) => AnyRedirect;
|
|
1807
2015
|
clearCache: ClearCacheFn<this>;
|
|
1808
|
-
|
|
1809
|
-
|
|
1810
|
-
preloadRoute: PreloadRouteFn<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory>;
|
|
2016
|
+
loadRouteChunk: (route: AnyRoute, componentType?: 'errorComponent' | 'notFoundComponent' | false) => Promise<void> | undefined;
|
|
2017
|
+
preloadRoute: PreloadRouteFn<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory, TDehydrated>;
|
|
1811
2018
|
matchRoute: MatchRouteFn<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory>;
|
|
1812
2019
|
ssr?: {
|
|
1813
2020
|
manifest: Manifest | undefined;
|
|
1814
2021
|
};
|
|
1815
2022
|
serverSsr?: ServerSsr;
|
|
1816
|
-
|
|
2023
|
+
serverSsrLifecycle?: RouterSsrLifecycle;
|
|
1817
2024
|
}
|
|
1818
2025
|
//#endregion
|
|
1819
|
-
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.
|
|
2026
|
+
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.171.34/node_modules/@tanstack/router-core/dist/esm/global.d.ts
|
|
1820
2027
|
declare global {
|
|
1821
2028
|
interface Window {
|
|
1822
2029
|
__TSR_ROUTER__?: AnyRouter;
|
|
1823
2030
|
}
|
|
1824
2031
|
}
|
|
1825
2032
|
//#endregion
|
|
1826
|
-
//#region ../../node_modules/.pnpm/@tanstack+react-start-server@1.
|
|
2033
|
+
//#region ../../node_modules/.pnpm/@tanstack+react-start-server@1.167.46_crossws@0.4.4_srvx@0.8.16__react-dom@19.2.1_react@19.2.1__react@19.2.1/node_modules/@tanstack/react-start-server/dist/esm/StartServer.d.ts
|
|
1827
2034
|
declare function StartServer<TRouter extends AnyRouter>(props: {
|
|
1828
2035
|
router: TRouter;
|
|
1829
2036
|
}): import("react/jsx-runtime").JSX.Element;
|
|
1830
2037
|
//#endregion
|
|
1831
|
-
//#region ../../node_modules/.pnpm/@tanstack+start-server-core@1.
|
|
2038
|
+
//#region ../../node_modules/.pnpm/@tanstack+start-server-core@1.169.39_crossws@0.4.4_srvx@0.8.16_/node_modules/@tanstack/start-server-core/dist/esm/early-hints.d.ts
|
|
2039
|
+
type EarlyHint = {
|
|
2040
|
+
href: string;
|
|
2041
|
+
rel: 'preload' | 'modulepreload' | 'preconnect' | 'dns-prefetch';
|
|
2042
|
+
as?: 'fetch' | 'font' | 'image' | 'script' | 'style' | 'track';
|
|
2043
|
+
crossOrigin?: AssetCrossOrigin | '';
|
|
2044
|
+
type?: string;
|
|
2045
|
+
integrity?: string;
|
|
2046
|
+
referrerPolicy?: string;
|
|
2047
|
+
fetchPriority?: string;
|
|
2048
|
+
};
|
|
2049
|
+
type EarlyHintsPhase = 'static' | 'dynamic';
|
|
2050
|
+
type EarlyHintsEvent = {
|
|
2051
|
+
phase: EarlyHintsPhase;
|
|
2052
|
+
hints: ReadonlyArray<EarlyHint>;
|
|
2053
|
+
links: Array<string>;
|
|
2054
|
+
allHints: ReadonlyArray<EarlyHint>;
|
|
2055
|
+
allLinks: Array<string>;
|
|
2056
|
+
};
|
|
2057
|
+
type OnEarlyHints = (event: EarlyHintsEvent) => void | Promise<void>;
|
|
2058
|
+
type ResponseLinkHeaderEntry = {
|
|
2059
|
+
phase: EarlyHintsPhase;
|
|
2060
|
+
hint: EarlyHint;
|
|
2061
|
+
link: string;
|
|
2062
|
+
};
|
|
2063
|
+
type ResponseLinkHeaderFilter = (entry: ResponseLinkHeaderEntry) => boolean;
|
|
2064
|
+
type ResponseLinkHeaderOptions = {
|
|
2065
|
+
filter?: ResponseLinkHeaderFilter;
|
|
2066
|
+
};
|
|
2067
|
+
//#endregion
|
|
2068
|
+
//#region ../../node_modules/.pnpm/@tanstack+start-server-core@1.169.39_crossws@0.4.4_srvx@0.8.16_/node_modules/@tanstack/start-server-core/dist/esm/request-handler.d.ts
|
|
1832
2069
|
type BaseContext = {
|
|
1833
2070
|
nonce?: string;
|
|
1834
2071
|
};
|
|
1835
|
-
type
|
|
2072
|
+
type EarlyHintsOptions = {
|
|
2073
|
+
/**
|
|
2074
|
+
* Fire-and-forget callback for HTTP 103 Early Hints.
|
|
2075
|
+
* Only invoked in production (when TSS_DEV_SERVER !== 'true').
|
|
2076
|
+
*
|
|
2077
|
+
* The `static` phase contains transformed manifest preloads and stylesheets
|
|
2078
|
+
* for matched routes.
|
|
2079
|
+
* The `dynamic` phase runs after route load, is skipped for redirects, and
|
|
2080
|
+
* can contain route `head().links` or empty `hints` and `links` arrays.
|
|
2081
|
+
* `hints` and `links` contain only values not emitted in earlier phases.
|
|
2082
|
+
* `allHints` and `allLinks` contain all values collected so far for the
|
|
2083
|
+
* request. Browsers generally process only the first 103 response for a
|
|
2084
|
+
* navigation, so runtimes should usually write at most one Early Hints
|
|
2085
|
+
* response.
|
|
2086
|
+
*
|
|
2087
|
+
* @example
|
|
2088
|
+
* ```ts
|
|
2089
|
+
* export default {
|
|
2090
|
+
* async fetch(request) {
|
|
2091
|
+
* return handler.fetch(request, {
|
|
2092
|
+
* onEarlyHints: ({ links }) => {
|
|
2093
|
+
* // Send 103 Early Hints via runtime-specific API
|
|
2094
|
+
* }
|
|
2095
|
+
* })
|
|
2096
|
+
* }
|
|
2097
|
+
* }
|
|
2098
|
+
* ```
|
|
2099
|
+
*/
|
|
2100
|
+
onEarlyHints?: OnEarlyHints;
|
|
2101
|
+
/**
|
|
2102
|
+
* Append collected Early Hints `Link` values to the final HTML response's
|
|
2103
|
+
* `Link` header. This is useful as a fallback when the runtime cannot write
|
|
2104
|
+
* `103` responses, or for CDNs that generate Early Hints from response
|
|
2105
|
+
* `Link` headers.
|
|
2106
|
+
*
|
|
2107
|
+
* `true` appends all collected static and dynamic links after Start confirms
|
|
2108
|
+
* the request is not a redirect. Use `filter` to remove links that are not
|
|
2109
|
+
* public and cache-safe for your deployment.
|
|
2110
|
+
*/
|
|
2111
|
+
responseLinkHeader?: boolean | ResponseLinkHeaderOptions;
|
|
2112
|
+
};
|
|
2113
|
+
type InlineCssOptions = {
|
|
2114
|
+
/**
|
|
2115
|
+
* Controls whether Start inlines build-collected CSS for this request.
|
|
2116
|
+
*
|
|
2117
|
+
* This only has an effect when the build was created with
|
|
2118
|
+
* `server.build.inlineCss` enabled. Defaults to `true` so builds with inline
|
|
2119
|
+
* CSS enabled continue to inline CSS unless a request opts out.
|
|
2120
|
+
*/
|
|
2121
|
+
inlineCss?: boolean;
|
|
2122
|
+
};
|
|
2123
|
+
type RequestOptions<TRegister> = EarlyHintsOptions & InlineCssOptions & (TRegister extends {
|
|
1836
2124
|
server: {
|
|
1837
2125
|
requestContext: infer TRequestContext;
|
|
1838
2126
|
};
|
|
@@ -1842,21 +2130,30 @@ type RequestOptions<TRegister> = TRegister extends {
|
|
|
1842
2130
|
context: TRequestContext & BaseContext;
|
|
1843
2131
|
} : {
|
|
1844
2132
|
context?: BaseContext;
|
|
1845
|
-
};
|
|
2133
|
+
});
|
|
1846
2134
|
type HasRequired<T> = keyof T extends never ? false : { [K in keyof T]-?: undefined extends T[K] ? never : K }[keyof T] extends never ? false : true;
|
|
1847
2135
|
type RequestHandler$1<TRegister> = HasRequired<RequestOptions<TRegister>> extends true ? (request: Request, opts: RequestOptions<TRegister>) => Promise<Response> | Response : (request: Request, opts?: RequestOptions<TRegister>) => Promise<Response> | Response;
|
|
1848
2136
|
//#endregion
|
|
1849
|
-
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.
|
|
2137
|
+
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.171.34/node_modules/@tanstack/router-core/dist/esm/ssr/handlerCallback.d.ts
|
|
2138
|
+
type SsrResponse = {
|
|
2139
|
+
response: Response;
|
|
2140
|
+
serverSsrCleanup: 'none';
|
|
2141
|
+
} | {
|
|
2142
|
+
response: Response;
|
|
2143
|
+
serverSsrCleanup: 'stream';
|
|
2144
|
+
dispose: (reason?: unknown) => undefined;
|
|
2145
|
+
};
|
|
2146
|
+
type HandlerCallbackResult = Response | SsrResponse;
|
|
1850
2147
|
interface HandlerCallback<TRouter extends AnyRouter> {
|
|
1851
2148
|
(ctx: {
|
|
1852
2149
|
request: Request;
|
|
1853
2150
|
router: TRouter;
|
|
1854
2151
|
responseHeaders: Headers;
|
|
1855
|
-
}):
|
|
2152
|
+
}): HandlerCallbackResult | Promise<HandlerCallbackResult>;
|
|
1856
2153
|
}
|
|
1857
2154
|
declare function defineHandlerCallback<TRouter extends AnyRouter>(handler: HandlerCallback<TRouter>): HandlerCallback<TRouter>;
|
|
1858
2155
|
//#endregion
|
|
1859
|
-
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.
|
|
2156
|
+
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.171.34/node_modules/@tanstack/router-core/dist/esm/ssr/createRequestHandler.d.ts
|
|
1860
2157
|
type RequestHandler<TRouter extends AnyRouter> = (cb: HandlerCallback<TRouter>) => Promise<Response>;
|
|
1861
2158
|
declare function createRequestHandler<TRouter extends AnyRouter>({
|
|
1862
2159
|
createRouter,
|
|
@@ -1865,44 +2162,70 @@ declare function createRequestHandler<TRouter extends AnyRouter>({
|
|
|
1865
2162
|
}: {
|
|
1866
2163
|
createRouter: () => TRouter;
|
|
1867
2164
|
request: Request;
|
|
1868
|
-
getRouterManifest?: () =>
|
|
2165
|
+
getRouterManifest?: () => ServerManifest | Promise<ServerManifest>;
|
|
1869
2166
|
}): RequestHandler<TRouter>;
|
|
1870
2167
|
//#endregion
|
|
1871
|
-
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.
|
|
1872
|
-
|
|
1873
|
-
|
|
2168
|
+
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.171.34/node_modules/@tanstack/router-core/dist/esm/ssr/transformStreamWithRouter.d.ts
|
|
2169
|
+
type TransformStreamWithRouterOptions = {
|
|
2170
|
+
/** Timeout for serialization to complete after app render finishes (default: 60000ms) */timeoutMs?: number; /** Maximum lifetime of the stream transform. Defaults to twice timeoutMs. */
|
|
2171
|
+
lifetimeMs?: number; /** Cancels the transform and releases SSR state when the request ends. */
|
|
2172
|
+
signal?: AbortSignal;
|
|
2173
|
+
/**
|
|
2174
|
+
* Additional point after which the renderer guarantees that a router script
|
|
2175
|
+
* can be inserted. This is an adapter contract, not a user streaming policy.
|
|
2176
|
+
* The router boundary, canonical document close, and EOF are always safe.
|
|
2177
|
+
*/
|
|
2178
|
+
rendererSafePoint?: 'script-close' | 'record-end';
|
|
2179
|
+
/**
|
|
2180
|
+
* Called exactly once when the stream is torn down due to abort/error/
|
|
2181
|
+
* cancel/timeout — NOT on natural successful completion. Use this to
|
|
2182
|
+
* abort a hidden producer upstream of any stream passed to this transform.
|
|
2183
|
+
* Errors thrown from this callback are swallowed.
|
|
2184
|
+
*/
|
|
2185
|
+
onAbort?: (reason?: unknown) => void;
|
|
2186
|
+
};
|
|
2187
|
+
type AppStreamValue = Uint8Array | string;
|
|
2188
|
+
/** Renderer output: UTF-8 bytes, or string records from a Node pipeable. */
|
|
2189
|
+
type AppStream = ReadableStream<Uint8Array> | ReadableStream<string> | ReadableStream<AppStreamValue> | ReadableStream$1<AppStreamValue>;
|
|
2190
|
+
declare function transformPipeableStreamWithRouter(router: AnyRouter, routerStream: Readable, opts?: TransformStreamWithRouterOptions): Readable;
|
|
2191
|
+
declare function transformReadableStreamWithRouter(router: AnyRouter, appStream: AppStream, opts?: TransformStreamWithRouterOptions): ReadableStream<Uint8Array<ArrayBufferLike>>;
|
|
1874
2192
|
//#endregion
|
|
1875
|
-
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.
|
|
1876
|
-
declare module '../router' {
|
|
1877
|
-
interface ServerSsr {
|
|
1878
|
-
setRenderFinished: () => void;
|
|
1879
|
-
cleanup: () => void;
|
|
1880
|
-
}
|
|
1881
|
-
interface RouterEvents {
|
|
1882
|
-
onInjectedHtml: {
|
|
1883
|
-
type: 'onInjectedHtml';
|
|
1884
|
-
};
|
|
1885
|
-
onSerializationFinished: {
|
|
1886
|
-
type: 'onSerializationFinished';
|
|
1887
|
-
};
|
|
1888
|
-
}
|
|
1889
|
-
}
|
|
2193
|
+
//#region ../../node_modules/.pnpm/@tanstack+router-core@1.171.34/node_modules/@tanstack/router-core/dist/esm/ssr/ssr-server.d.ts
|
|
1890
2194
|
declare function attachRouterServerSsrUtils({
|
|
1891
2195
|
router,
|
|
1892
|
-
manifest
|
|
2196
|
+
manifest,
|
|
2197
|
+
getRequestAssets
|
|
1893
2198
|
}: {
|
|
1894
2199
|
router: AnyRouter;
|
|
1895
|
-
manifest:
|
|
2200
|
+
manifest: ServerManifest | undefined;
|
|
2201
|
+
getRequestAssets?: () => ManifestRouteAssets | undefined;
|
|
1896
2202
|
}): void;
|
|
1897
2203
|
//#endregion
|
|
1898
|
-
//#region ../../node_modules/.pnpm/@tanstack+start-server-core@1.
|
|
1899
|
-
type
|
|
1900
|
-
|
|
2204
|
+
//#region ../../node_modules/.pnpm/@tanstack+start-server-core@1.169.39_crossws@0.4.4_srvx@0.8.16_/node_modules/@tanstack/start-server-core/dist/esm/inlineCss.d.ts
|
|
2205
|
+
type HandlerInlineCssOption = boolean | ((ctx: {
|
|
2206
|
+
request: Request;
|
|
2207
|
+
}) => Awaitable<boolean>);
|
|
2208
|
+
//#endregion
|
|
2209
|
+
//#region ../../node_modules/.pnpm/@tanstack+start-server-core@1.169.39_crossws@0.4.4_srvx@0.8.16_/node_modules/@tanstack/start-server-core/dist/esm/transformAssetUrls.d.ts
|
|
2210
|
+
type TransformAssetsContext = {
|
|
1901
2211
|
url: string;
|
|
1902
|
-
|
|
1903
|
-
}
|
|
1904
|
-
|
|
1905
|
-
|
|
2212
|
+
kind: 'script';
|
|
2213
|
+
} | {
|
|
2214
|
+
url: string;
|
|
2215
|
+
kind: 'stylesheet';
|
|
2216
|
+
} | {
|
|
2217
|
+
url: string;
|
|
2218
|
+
kind: 'css-url';
|
|
2219
|
+
stylesheetHref: string;
|
|
2220
|
+
};
|
|
2221
|
+
type TransformAssetKind = TransformAssetsContext['kind'];
|
|
2222
|
+
type TransformAssetsShorthandCrossOriginKind = Exclude<TransformAssetKind, 'css-url'>;
|
|
2223
|
+
type TransformAssetResult = string | {
|
|
2224
|
+
href: string;
|
|
2225
|
+
crossOrigin?: AssetCrossOrigin;
|
|
2226
|
+
};
|
|
2227
|
+
type TransformAssetsFn = (context: TransformAssetsContext) => Awaitable<TransformAssetResult>;
|
|
2228
|
+
type CreateTransformAssetsContext = {
|
|
1906
2229
|
/** True when the server is computing the cached manifest during startup warmup. */warmup: true;
|
|
1907
2230
|
} | {
|
|
1908
2231
|
/**
|
|
@@ -1913,12 +2236,8 @@ type CreateTransformAssetUrlsContext = {
|
|
|
1913
2236
|
request: Request; /** False when transforming URLs as part of request handling. */
|
|
1914
2237
|
warmup: false;
|
|
1915
2238
|
};
|
|
1916
|
-
|
|
1917
|
-
|
|
1918
|
-
* per-asset transform.
|
|
1919
|
-
*/
|
|
1920
|
-
type CreateTransformAssetUrlsFn = (ctx: CreateTransformAssetUrlsContext) => Awaitable<TransformAssetUrlsFn>;
|
|
1921
|
-
type TransformAssetUrlsOptionsBase = {
|
|
2239
|
+
type CreateTransformAssetsFn = (ctx: CreateTransformAssetsContext) => Awaitable<TransformAssetsFn>;
|
|
2240
|
+
type TransformAssetsOptionsBase = {
|
|
1922
2241
|
/**
|
|
1923
2242
|
* Whether to cache the transformed manifest after the first request.
|
|
1924
2243
|
*
|
|
@@ -1942,84 +2261,83 @@ type TransformAssetUrlsOptionsBase = {
|
|
|
1942
2261
|
*/
|
|
1943
2262
|
warmup?: boolean;
|
|
1944
2263
|
};
|
|
1945
|
-
type
|
|
1946
|
-
|
|
1947
|
-
* The transform to apply to asset URLs. Can be a string prefix or a callback.
|
|
1948
|
-
*
|
|
1949
|
-
* **String** — prepended to every asset URL.
|
|
1950
|
-
* **Callback** — receives `{ url, type }` and returns a new URL.
|
|
1951
|
-
*/
|
|
1952
|
-
transform: string | TransformAssetUrlsFn;
|
|
2264
|
+
type TransformAssetsOptions = (TransformAssetsOptionsBase & {
|
|
2265
|
+
transform: string | TransformAssetsFn;
|
|
1953
2266
|
createTransform?: never;
|
|
1954
|
-
}) | (
|
|
2267
|
+
}) | (TransformAssetsOptionsBase & {
|
|
2268
|
+
createTransform: CreateTransformAssetsFn;
|
|
2269
|
+
transform?: never;
|
|
2270
|
+
});
|
|
2271
|
+
/**
|
|
2272
|
+
* Per-kind crossOrigin configuration for the object shorthand.
|
|
2273
|
+
*
|
|
2274
|
+
* Accepts either a single value applied to all asset kinds, or a per-kind
|
|
2275
|
+
* record (matching `HeadContent`'s `assetCrossOrigin` shape):
|
|
2276
|
+
*
|
|
2277
|
+
* ```ts
|
|
2278
|
+
* // All assets get the same value
|
|
2279
|
+
* crossOrigin: 'anonymous'
|
|
2280
|
+
*
|
|
2281
|
+
* // Different values per kind
|
|
2282
|
+
* crossOrigin: { script: 'anonymous', stylesheet: 'use-credentials' }
|
|
2283
|
+
* ```
|
|
2284
|
+
*/
|
|
2285
|
+
type TransformAssetsCrossOriginConfig = AssetCrossOrigin | Partial<Record<TransformAssetsShorthandCrossOriginKind, AssetCrossOrigin>>;
|
|
2286
|
+
/**
|
|
2287
|
+
* Object shorthand for `transformAssets`. Combines a URL prefix with optional
|
|
2288
|
+
* per-asset `crossOrigin` without needing a callback:
|
|
2289
|
+
*
|
|
2290
|
+
* ```ts
|
|
2291
|
+
* transformAssets: {
|
|
2292
|
+
* prefix: 'https://cdn.example.com',
|
|
2293
|
+
* crossOrigin: 'anonymous',
|
|
2294
|
+
* }
|
|
2295
|
+
* ```
|
|
2296
|
+
*/
|
|
2297
|
+
interface TransformAssetsObjectShorthand {
|
|
2298
|
+
/** URL prefix prepended to every asset URL. */
|
|
2299
|
+
prefix: string;
|
|
1955
2300
|
/**
|
|
1956
|
-
*
|
|
2301
|
+
* Optional crossOrigin attribute applied to transformed script and stylesheet assets.
|
|
1957
2302
|
*
|
|
1958
|
-
*
|
|
1959
|
-
* `cache: false`, or once per server when `cache: true`). It can do async
|
|
1960
|
-
* setup work (fetch config, read from a KV, etc.) and return a fast
|
|
1961
|
-
* per-asset transformer.
|
|
2303
|
+
* Accepts a single value or a per-kind record.
|
|
1962
2304
|
*/
|
|
1963
|
-
|
|
1964
|
-
|
|
1965
|
-
|
|
1966
|
-
type TransformAssetUrls = string | TransformAssetUrlsFn | TransformAssetUrlsOptions;
|
|
2305
|
+
crossOrigin?: TransformAssetsCrossOriginConfig;
|
|
2306
|
+
}
|
|
2307
|
+
type TransformAssets = string | TransformAssetsFn | TransformAssetsObjectShorthand | TransformAssetsOptions;
|
|
1967
2308
|
//#endregion
|
|
1968
|
-
//#region ../../node_modules/.pnpm/@tanstack+start-server-core@1.
|
|
1969
|
-
interface
|
|
1970
|
-
handler: HandlerCallback<AnyRouter>;
|
|
2309
|
+
//#region ../../node_modules/.pnpm/@tanstack+start-server-core@1.169.39_crossws@0.4.4_srvx@0.8.16_/node_modules/@tanstack/start-server-core/dist/esm/finalManifest.d.ts
|
|
2310
|
+
interface FinalManifestOptions {
|
|
1971
2311
|
/**
|
|
1972
|
-
*
|
|
2312
|
+
* Controls whether Start inlines build-collected CSS by default at runtime.
|
|
1973
2313
|
*
|
|
1974
|
-
*
|
|
1975
|
-
*
|
|
1976
|
-
*
|
|
1977
|
-
* handler: defaultStreamHandler,
|
|
1978
|
-
* transformAssetUrls: 'https://cdn.example.com',
|
|
1979
|
-
* })
|
|
1980
|
-
* ```
|
|
1981
|
-
*
|
|
1982
|
-
* **Callback** — receives `{ url, type }` and returns a new URL
|
|
1983
|
-
* (cached by default — runs once on first request):
|
|
1984
|
-
* ```ts
|
|
1985
|
-
* createStartHandler({
|
|
1986
|
-
* handler: defaultStreamHandler,
|
|
1987
|
-
* transformAssetUrls: ({ url, type }) => {
|
|
1988
|
-
* return `https://cdn.example.com${url}`
|
|
1989
|
-
* },
|
|
1990
|
-
* })
|
|
1991
|
-
* ```
|
|
2314
|
+
* This only has an effect when the build was created with
|
|
2315
|
+
* `server.build.inlineCss` enabled. Pass a callback to decide per request.
|
|
2316
|
+
* `handler(request, { inlineCss })` overrides this value for that request.
|
|
1992
2317
|
*
|
|
1993
|
-
*
|
|
1994
|
-
|
|
1995
|
-
|
|
1996
|
-
|
|
1997
|
-
*
|
|
1998
|
-
*
|
|
1999
|
-
* const region = getRequest().headers.get('x-region') || 'us'
|
|
2000
|
-
* return `https://cdn-${region}.example.com${url}`
|
|
2001
|
-
* },
|
|
2002
|
-
* cache: false, // transform per-request
|
|
2003
|
-
* },
|
|
2004
|
-
* })
|
|
2005
|
-
* ```
|
|
2006
|
-
*
|
|
2007
|
-
* `type` is one of `'modulepreload' | 'stylesheet' | 'clientEntry'`.
|
|
2008
|
-
*
|
|
2009
|
-
* By default, the transformed manifest is cached after the first request
|
|
2010
|
-
* (`cache: true`). Set `cache: false` for per-request transforms.
|
|
2011
|
-
*
|
|
2012
|
-
* If you're using a cached transform, you can optionally set `warmup: true`
|
|
2013
|
-
* (object form only) to compute the transformed manifest in the background at
|
|
2014
|
-
* server startup.
|
|
2318
|
+
* @default true
|
|
2319
|
+
*/
|
|
2320
|
+
inlineCss?: HandlerInlineCssOption;
|
|
2321
|
+
/**
|
|
2322
|
+
* Transform manifest-managed asset URLs and attributes at runtime, e.g. to
|
|
2323
|
+
* prepend a CDN prefix.
|
|
2015
2324
|
*
|
|
2016
|
-
*
|
|
2017
|
-
*
|
|
2018
|
-
*
|
|
2019
|
-
* configure Vite's `experimental.renderBuiltUrl` in your vite.config.ts.
|
|
2325
|
+
* This covers JS preloads, manifest script tags, CSS links, and URLs inside
|
|
2326
|
+
* build-collected inline CSS. Asset imports used directly in
|
|
2327
|
+
* components should be handled by the bundler instead.
|
|
2020
2328
|
*/
|
|
2021
|
-
|
|
2329
|
+
transformAssets?: TransformAssets;
|
|
2330
|
+
}
|
|
2331
|
+
//#endregion
|
|
2332
|
+
//#region ../../node_modules/.pnpm/@tanstack+start-server-core@1.169.39_crossws@0.4.4_srvx@0.8.16_/node_modules/@tanstack/start-server-core/dist/esm/createStartHandler.d.ts
|
|
2333
|
+
interface CreateStartHandlerOptions extends FinalManifestOptions {
|
|
2334
|
+
handler: HandlerCallback<AnyRouter>;
|
|
2022
2335
|
}
|
|
2336
|
+
/**
|
|
2337
|
+
* Marks `response` as directly derived from the current `source`.
|
|
2338
|
+
* Middleware must consume or cancel any other `clone()` or `tee()` branches.
|
|
2339
|
+
*/
|
|
2340
|
+
declare function transferResponseBodyOwnership<TResponse extends Response>(source: Response, response: TResponse): TResponse;
|
|
2023
2341
|
/**
|
|
2024
2342
|
* Creates the TanStack Start request handler.
|
|
2025
2343
|
*
|
|
@@ -2032,7 +2350,7 @@ interface CreateStartHandlerOptions {
|
|
|
2032
2350
|
* ```ts
|
|
2033
2351
|
* export default createStartHandler({
|
|
2034
2352
|
* handler: defaultStreamHandler,
|
|
2035
|
-
*
|
|
2353
|
+
* transformAssets: 'https://cdn.example.com',
|
|
2036
2354
|
* })
|
|
2037
2355
|
* ```
|
|
2038
2356
|
*
|
|
@@ -2040,10 +2358,10 @@ interface CreateStartHandlerOptions {
|
|
|
2040
2358
|
* ```ts
|
|
2041
2359
|
* export default createStartHandler({
|
|
2042
2360
|
* handler: defaultStreamHandler,
|
|
2043
|
-
*
|
|
2361
|
+
* transformAssets: {
|
|
2044
2362
|
* transform: ({ url }) => {
|
|
2045
2363
|
* const cdnBase = getRequest().headers.get('x-cdn-base') || ''
|
|
2046
|
-
* return `${cdnBase}${url}`
|
|
2364
|
+
* return { href: `${cdnBase}${url}` }
|
|
2047
2365
|
* },
|
|
2048
2366
|
* cache: false,
|
|
2049
2367
|
* },
|
|
@@ -2378,7 +2696,7 @@ interface CookieSerializeOptions {
|
|
|
2378
2696
|
* Additional parsing options
|
|
2379
2697
|
*/
|
|
2380
2698
|
//#endregion
|
|
2381
|
-
//#region ../../node_modules/.pnpm/@tanstack+start-server-core@1.
|
|
2699
|
+
//#region ../../node_modules/.pnpm/@tanstack+start-server-core@1.169.39_crossws@0.4.4_srvx@0.8.16_/node_modules/@tanstack/start-server-core/dist/esm/session.d.ts
|
|
2382
2700
|
/** Algorithm used for encryption and decryption. */
|
|
2383
2701
|
type EncryptionAlgorithm = 'aes-128-ctr' | 'aes-256-cbc';
|
|
2384
2702
|
/** Algorithm used for integrity verification. */
|
|
@@ -2493,7 +2811,7 @@ declare namespace StandardSchemaV1 {
|
|
|
2493
2811
|
export {};
|
|
2494
2812
|
}
|
|
2495
2813
|
//#endregion
|
|
2496
|
-
//#region ../../node_modules/.pnpm/@tanstack+start-server-core@1.
|
|
2814
|
+
//#region ../../node_modules/.pnpm/@tanstack+start-server-core@1.169.39_crossws@0.4.4_srvx@0.8.16_/node_modules/@tanstack/start-server-core/dist/esm/request-response.d.ts
|
|
2497
2815
|
declare function requestHandler<TRegister = unknown>(handler: RequestHandler$1<TRegister>): (request: Request, requestOpts: any) => Promise<Response> | Response;
|
|
2498
2816
|
declare function getRequest(): Request;
|
|
2499
2817
|
declare function getRequestHeaders(): TypedHeaders<RequestHeaderMap>;
|
|
@@ -2609,28 +2927,29 @@ declare function getResponse(): {
|
|
|
2609
2927
|
status?: number;
|
|
2610
2928
|
statusText?: string;
|
|
2611
2929
|
get headers(): Headers;
|
|
2930
|
+
get errHeaders(): Headers;
|
|
2612
2931
|
};
|
|
2613
2932
|
declare function getValidatedQuery<TSchema extends StandardSchemaV1>(schema: StandardSchemaV1): Promise<StandardSchemaV1.InferOutput<TSchema>>;
|
|
2614
2933
|
//#endregion
|
|
2615
|
-
//#region ../../node_modules/.pnpm/@tanstack+start-server-core@1.
|
|
2934
|
+
//#region ../../node_modules/.pnpm/@tanstack+start-server-core@1.169.39_crossws@0.4.4_srvx@0.8.16_/node_modules/@tanstack/start-server-core/dist/esm/virtual-modules.d.ts
|
|
2616
2935
|
declare const VIRTUAL_MODULES: {
|
|
2617
2936
|
readonly startManifest: "tanstack-start-manifest:v";
|
|
2618
|
-
readonly injectedHeadScripts: "tanstack-start-injected-head-scripts:v";
|
|
2619
2937
|
readonly serverFnResolver: "#tanstack-start-server-fn-resolver";
|
|
2938
|
+
readonly pluginAdapters: "#tanstack-start-plugin-adapters";
|
|
2620
2939
|
};
|
|
2621
2940
|
//#endregion
|
|
2622
|
-
//#region ../../node_modules/.pnpm/@tanstack+start-server-core@1.
|
|
2941
|
+
//#region ../../node_modules/.pnpm/@tanstack+start-server-core@1.169.39_crossws@0.4.4_srvx@0.8.16_/node_modules/@tanstack/start-server-core/dist/esm/constants.d.ts
|
|
2623
2942
|
declare const HEADERS: {
|
|
2624
2943
|
readonly TSS_SHELL: "X-TSS_SHELL";
|
|
2625
2944
|
};
|
|
2626
2945
|
//#endregion
|
|
2627
|
-
//#region ../../node_modules/.pnpm/@tanstack+react-start-server@1.
|
|
2946
|
+
//#region ../../node_modules/.pnpm/@tanstack+react-start-server@1.167.46_crossws@0.4.4_srvx@0.8.16__react-dom@19.2.1_react@19.2.1__react@19.2.1/node_modules/@tanstack/react-start-server/dist/esm/defaultStreamHandler.d.ts
|
|
2628
2947
|
declare const defaultStreamHandler: HandlerCallback<AnyRouter>;
|
|
2629
2948
|
//#endregion
|
|
2630
|
-
//#region ../../node_modules/.pnpm/@tanstack+react-start-server@1.
|
|
2949
|
+
//#region ../../node_modules/.pnpm/@tanstack+react-start-server@1.167.46_crossws@0.4.4_srvx@0.8.16__react-dom@19.2.1_react@19.2.1__react@19.2.1/node_modules/@tanstack/react-start-server/dist/esm/defaultRenderHandler.d.ts
|
|
2631
2950
|
declare const defaultRenderHandler: HandlerCallback<AnyRouter>;
|
|
2632
2951
|
declare namespace server_d_exports {
|
|
2633
|
-
export {
|
|
2952
|
+
export { CreateStartHandlerOptions, CreateTransformAssetsContext, EarlyHint, EarlyHintsEvent, EarlyHintsPhase, HEADERS, HandlerCallback, OnEarlyHints, RequestHandler$1 as RequestHandler, RequestHeaderName, RequestOptions, ResponseHeaderName, ResponseLinkHeaderEntry, ResponseLinkHeaderFilter, ResponseLinkHeaderOptions, SessionConfig, StartServer, TransformAssetKind, TransformAssetResult, TransformAssets, TransformAssetsContext, TransformAssetsCrossOriginConfig, TransformAssetsFn, TransformAssetsObjectShorthand, TransformAssetsOptions, VIRTUAL_MODULES, attachRouterServerSsrUtils, clearResponseHeaders, clearSession, createRequestHandler, createStartHandler, defaultRenderHandler, defaultStreamHandler, defineHandlerCallback, deleteCookie, getCookie, getCookies, getRequest, getRequestHeader, getRequestHeaders, getRequestHost, getRequestIP, getRequestProtocol, getRequestUrl, getResponse, getResponseHeader, getResponseHeaders, getResponseStatus, getSession, getValidatedQuery, removeResponseHeader, requestHandler, sealSession, setCookie, setResponseHeader, setResponseHeaders, setResponseStatus, transferResponseBodyOwnership, transformPipeableStreamWithRouter, transformReadableStreamWithRouter, unsealSession, updateSession, useSession };
|
|
2634
2953
|
}
|
|
2635
2954
|
//#endregion
|
|
2636
2955
|
//#region src/tanstack-start-server-context.d.ts
|