@tanstack/react-router 1.97.14 → 1.97.17
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/Match.cjs +8 -24
- package/dist/cjs/Match.cjs.map +1 -1
- package/dist/cjs/Matches.cjs +1 -1
- package/dist/cjs/Matches.cjs.map +1 -1
- package/dist/cjs/RouterProvider.cjs.map +1 -1
- package/dist/cjs/RouterProvider.d.cts +0 -1
- package/dist/cjs/ScriptOnce.cjs +1 -8
- package/dist/cjs/ScriptOnce.cjs.map +1 -1
- package/dist/cjs/ScriptOnce.d.cts +1 -1
- package/dist/cjs/Transitioner.cjs +1 -2
- package/dist/cjs/Transitioner.cjs.map +1 -1
- package/dist/cjs/awaited.cjs +1 -22
- package/dist/cjs/awaited.cjs.map +1 -1
- package/dist/cjs/index.cjs +2 -7
- package/dist/cjs/index.cjs.map +1 -1
- package/dist/cjs/index.d.cts +4 -6
- package/dist/cjs/router.cjs +11 -129
- package/dist/cjs/router.cjs.map +1 -1
- package/dist/cjs/router.d.cts +33 -93
- package/dist/cjs/routerContext.cjs.map +1 -1
- package/dist/cjs/routerContext.d.cts +7 -2
- package/dist/cjs/serializer.d.cts +15 -0
- package/dist/cjs/useRouterState.cjs +1 -1
- package/dist/cjs/useRouterState.cjs.map +1 -1
- package/dist/cjs/utils.cjs.map +1 -1
- package/dist/cjs/utils.d.cts +2 -2
- package/dist/esm/Match.js +9 -25
- package/dist/esm/Match.js.map +1 -1
- package/dist/esm/Matches.js +1 -1
- package/dist/esm/Matches.js.map +1 -1
- package/dist/esm/RouterProvider.d.ts +0 -1
- package/dist/esm/RouterProvider.js.map +1 -1
- package/dist/esm/ScriptOnce.d.ts +1 -1
- package/dist/esm/ScriptOnce.js +1 -8
- package/dist/esm/ScriptOnce.js.map +1 -1
- package/dist/esm/Transitioner.js +1 -2
- package/dist/esm/Transitioner.js.map +1 -1
- package/dist/esm/awaited.js +1 -22
- package/dist/esm/awaited.js.map +1 -1
- package/dist/esm/index.d.ts +4 -6
- package/dist/esm/index.js +1 -6
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/router.d.ts +33 -93
- package/dist/esm/router.js +11 -129
- package/dist/esm/router.js.map +1 -1
- package/dist/esm/routerContext.d.ts +7 -2
- package/dist/esm/routerContext.js.map +1 -1
- package/dist/esm/serializer.d.ts +15 -0
- package/dist/esm/useRouterState.js +1 -1
- package/dist/esm/useRouterState.js.map +1 -1
- package/dist/esm/utils.d.ts +2 -2
- package/dist/esm/utils.js.map +1 -1
- package/package.json +1 -1
- package/src/Match.tsx +4 -29
- package/src/Matches.tsx +1 -1
- package/src/RouterProvider.tsx +3 -3
- package/src/ScriptOnce.tsx +0 -8
- package/src/Transitioner.tsx +1 -1
- package/src/awaited.tsx +3 -25
- package/src/index.tsx +12 -34
- package/src/router.ts +44 -271
- package/src/routerContext.tsx +7 -1
- package/src/serializer.ts +24 -0
- package/src/useRouterState.tsx +1 -1
- package/src/utils.ts +1 -1
- package/dist/cjs/isServerSideError.cjs +0 -22
- package/dist/cjs/isServerSideError.cjs.map +0 -1
- package/dist/cjs/isServerSideError.d.cts +0 -5
- package/dist/cjs/transformer.cjs +0 -137
- package/dist/cjs/transformer.cjs.map +0 -1
- package/dist/cjs/transformer.d.cts +0 -16
- package/dist/esm/isServerSideError.d.ts +0 -5
- package/dist/esm/isServerSideError.js +0 -22
- package/dist/esm/isServerSideError.js.map +0 -1
- package/dist/esm/transformer.d.ts +0 -16
- package/dist/esm/transformer.js +0 -137
- package/dist/esm/transformer.js.map +0 -1
- package/src/isServerSideError.tsx +0 -23
- package/src/transformer.ts +0 -192
|
@@ -25,7 +25,6 @@ export type BuildLocationFn = <TRouter extends RegisteredRouter, TTo extends str
|
|
|
25
25
|
leaveParams?: boolean;
|
|
26
26
|
_includeValidateSearch?: boolean;
|
|
27
27
|
}) => ParsedLocation;
|
|
28
|
-
export type InjectedHtmlEntry = string | (() => Promise<string> | string);
|
|
29
28
|
export declare function RouterContextProvider<TRouter extends AnyRouter = RegisteredRouter, TDehydrated extends Record<string, any> = Record<string, any>>({ router, children, ...rest }: RouterProps<TRouter, TDehydrated> & {
|
|
30
29
|
children: React.ReactNode;
|
|
31
30
|
}): import("react/jsx-runtime").JSX.Element;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"RouterProvider.js","sources":["../../src/RouterProvider.tsx"],"sourcesContent":["import * as React from 'react'\nimport { Matches } from './Matches'\nimport { getRouterContext } from './routerContext'\nimport type { NavigateOptions, ToOptions } from './link'\nimport type { ParsedLocation } from './location'\nimport type { RoutePaths } from './routeInfo'\nimport type {\n AnyRouter,\n RegisteredRouter,\n Router,\n RouterOptions,\n ViewTransitionOptions,\n} from './router'\n\nexport interface CommitLocationOptions {\n replace?: boolean\n resetScroll?: boolean\n hashScrollIntoView?: boolean | ScrollIntoViewOptions\n viewTransition?: boolean | ViewTransitionOptions\n /**\n * @deprecated All navigations use React transitions under the hood now\n **/\n startTransition?: boolean\n ignoreBlocker?: boolean\n}\n\nexport interface MatchLocation {\n to?: string | number | null\n fuzzy?: boolean\n caseSensitive?: boolean\n from?: string\n}\n\nexport type NavigateFn = <\n TRouter extends RegisteredRouter,\n TTo extends string | undefined,\n TFrom extends RoutePaths<TRouter['routeTree']> | string = string,\n TMaskFrom extends RoutePaths<TRouter['routeTree']> | string = TFrom,\n TMaskTo extends string = '',\n>(\n opts: NavigateOptions<TRouter, TFrom, TTo, TMaskFrom, TMaskTo>,\n) => Promise<void> | void\n\nexport type BuildLocationFn = <\n TRouter extends RegisteredRouter,\n TTo extends string | undefined,\n TFrom extends RoutePaths<TRouter['routeTree']> | string = string,\n TMaskFrom extends RoutePaths<TRouter['routeTree']> | string = TFrom,\n TMaskTo extends string = '',\n>(\n opts: ToOptions<TRouter, TFrom, TTo, TMaskFrom, TMaskTo> & {\n leaveParams?: boolean\n _includeValidateSearch?: boolean\n },\n) => ParsedLocation\n\nexport
|
|
1
|
+
{"version":3,"file":"RouterProvider.js","sources":["../../src/RouterProvider.tsx"],"sourcesContent":["import * as React from 'react'\nimport { Matches } from './Matches'\nimport { getRouterContext } from './routerContext'\nimport type { NavigateOptions, ToOptions } from './link'\nimport type { ParsedLocation } from './location'\nimport type { RoutePaths } from './routeInfo'\nimport type {\n AnyRouter,\n RegisteredRouter,\n Router,\n RouterOptions,\n ViewTransitionOptions,\n} from './router'\n\nexport interface CommitLocationOptions {\n replace?: boolean\n resetScroll?: boolean\n hashScrollIntoView?: boolean | ScrollIntoViewOptions\n viewTransition?: boolean | ViewTransitionOptions\n /**\n * @deprecated All navigations use React transitions under the hood now\n **/\n startTransition?: boolean\n ignoreBlocker?: boolean\n}\n\nexport interface MatchLocation {\n to?: string | number | null\n fuzzy?: boolean\n caseSensitive?: boolean\n from?: string\n}\n\nexport type NavigateFn = <\n TRouter extends RegisteredRouter,\n TTo extends string | undefined,\n TFrom extends RoutePaths<TRouter['routeTree']> | string = string,\n TMaskFrom extends RoutePaths<TRouter['routeTree']> | string = TFrom,\n TMaskTo extends string = '',\n>(\n opts: NavigateOptions<TRouter, TFrom, TTo, TMaskFrom, TMaskTo>,\n) => Promise<void> | void\n\nexport type BuildLocationFn = <\n TRouter extends RegisteredRouter,\n TTo extends string | undefined,\n TFrom extends RoutePaths<TRouter['routeTree']> | string = string,\n TMaskFrom extends RoutePaths<TRouter['routeTree']> | string = TFrom,\n TMaskTo extends string = '',\n>(\n opts: ToOptions<TRouter, TFrom, TTo, TMaskFrom, TMaskTo> & {\n leaveParams?: boolean\n _includeValidateSearch?: boolean\n },\n) => ParsedLocation\n\nexport function RouterContextProvider<\n TRouter extends AnyRouter = RegisteredRouter,\n TDehydrated extends Record<string, any> = Record<string, any>,\n>({\n router,\n children,\n ...rest\n}: RouterProps<TRouter, TDehydrated> & {\n children: React.ReactNode\n}) {\n // Allow the router to update options on the router instance\n router.update({\n ...router.options,\n ...rest,\n context: {\n ...router.options.context,\n ...rest.context,\n },\n } as any)\n\n const routerContext = getRouterContext()\n\n const provider = (\n <routerContext.Provider value={router as AnyRouter}>\n {children}\n </routerContext.Provider>\n )\n\n if (router.options.Wrap) {\n return <router.options.Wrap>{provider}</router.options.Wrap>\n }\n\n return provider\n}\n\nexport function RouterProvider<\n TRouter extends AnyRouter = RegisteredRouter,\n TDehydrated extends Record<string, any> = Record<string, any>,\n>({ router, ...rest }: RouterProps<TRouter, TDehydrated>) {\n return (\n <RouterContextProvider router={router} {...rest}>\n <Matches />\n </RouterContextProvider>\n )\n}\n\nexport type RouterProps<\n TRouter extends AnyRouter = RegisteredRouter,\n TDehydrated extends Record<string, any> = Record<string, any>,\n> = Omit<\n RouterOptions<\n TRouter['routeTree'],\n NonNullable<TRouter['options']['trailingSlash']>,\n NonNullable<TRouter['options']['defaultStructuralSharing']>,\n TRouter['history'],\n TDehydrated\n >,\n 'context'\n> & {\n router: Router<\n TRouter['routeTree'],\n NonNullable<TRouter['options']['trailingSlash']>,\n NonNullable<TRouter['options']['defaultStructuralSharing']>,\n TRouter['history']\n >\n context?: Partial<\n RouterOptions<\n TRouter['routeTree'],\n NonNullable<TRouter['options']['trailingSlash']>,\n NonNullable<TRouter['options']['defaultStructuralSharing']>,\n TRouter['history'],\n TDehydrated\n >['context']\n >\n}\n"],"names":[],"mappings":";;;AAwDO,SAAS,sBAGd;AAAA,EACA;AAAA,EACA;AAAA,EACA,GAAG;AACL,GAEG;AAED,SAAO,OAAO;AAAA,IACZ,GAAG,OAAO;AAAA,IACV,GAAG;AAAA,IACH,SAAS;AAAA,MACP,GAAG,OAAO,QAAQ;AAAA,MAClB,GAAG,KAAK;AAAA,IAAA;AAAA,EACV,CACM;AAER,QAAM,gBAAgB,iBAAiB;AAEvC,QAAM,WACH,oBAAA,cAAc,UAAd,EAAuB,OAAO,QAC5B,UACH;AAGE,MAAA,OAAO,QAAQ,MAAM;AACvB,WAAQ,oBAAA,OAAO,QAAQ,MAAf,EAAqB,UAAS,UAAA;AAAA,EAAA;AAGjC,SAAA;AACT;AAEO,SAAS,eAGd,EAAE,QAAQ,GAAG,QAA2C;AACxD,6BACG,uBAAsB,EAAA,QAAiB,GAAG,MACzC,UAAA,oBAAC,UAAQ,CAAA,GACX;AAEJ;"}
|
package/dist/esm/ScriptOnce.d.ts
CHANGED
package/dist/esm/ScriptOnce.js
CHANGED
|
@@ -1,19 +1,12 @@
|
|
|
1
1
|
import { jsx } from "react/jsx-runtime";
|
|
2
2
|
import jsesc from "jsesc";
|
|
3
|
-
import { useRouter } from "./useRouter.js";
|
|
4
3
|
function ScriptOnce({
|
|
5
4
|
children,
|
|
6
|
-
log
|
|
7
|
-
sync
|
|
5
|
+
log
|
|
8
6
|
}) {
|
|
9
|
-
const router = useRouter();
|
|
10
7
|
if (typeof document !== "undefined") {
|
|
11
8
|
return null;
|
|
12
9
|
}
|
|
13
|
-
if (!sync) {
|
|
14
|
-
router.injectScript(children, { logScript: log });
|
|
15
|
-
return null;
|
|
16
|
-
}
|
|
17
10
|
return /* @__PURE__ */ jsx(
|
|
18
11
|
"script",
|
|
19
12
|
{
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ScriptOnce.js","sources":["../../src/ScriptOnce.tsx"],"sourcesContent":["import jsesc from 'jsesc'\
|
|
1
|
+
{"version":3,"file":"ScriptOnce.js","sources":["../../src/ScriptOnce.tsx"],"sourcesContent":["import jsesc from 'jsesc'\n\nexport function ScriptOnce({\n children,\n log,\n}: {\n children: string\n log?: boolean\n sync?: boolean\n}) {\n if (typeof document !== 'undefined') {\n return null\n }\n\n return (\n <script\n className=\"tsr-once\"\n dangerouslySetInnerHTML={{\n __html: [\n children,\n (log ?? true) && process.env.NODE_ENV === 'development'\n ? `console.info(\\`Injected From Server:\n${jsesc(children.toString(), { quotes: 'backtick' })}\\`)`\n : '',\n 'if (typeof __TSR__ !== \"undefined\") __TSR__.cleanScripts()',\n ]\n .filter(Boolean)\n .join('\\n'),\n }}\n />\n )\n}\n"],"names":[],"mappings":";;AAEO,SAAS,WAAW;AAAA,EACzB;AAAA,EACA;AACF,GAIG;AACG,MAAA,OAAO,aAAa,aAAa;AAC5B,WAAA;AAAA,EAAA;AAIP,SAAA;AAAA,IAAC;AAAA,IAAA;AAAA,MACC,WAAU;AAAA,MACV,yBAAyB;AAAA,QACvB,QAAQ;AAAA,UACN;AAAA,WACC,OAAO,SAAS,QAAQ,IAAI,aAAa,gBACtC;AAAA,EACZ,MAAM,SAAS,YAAY,EAAE,QAAQ,WAAY,CAAA,CAAC,QACtC;AAAA,UACJ;AAAA,QAEC,EAAA,OAAO,OAAO,EACd,KAAK,IAAI;AAAA,MAAA;AAAA,IACd;AAAA,EACF;AAEJ;"}
|
package/dist/esm/Transitioner.js
CHANGED
|
@@ -46,8 +46,7 @@ function Transitioner() {
|
|
|
46
46
|
};
|
|
47
47
|
}, [router, router.history]);
|
|
48
48
|
useLayoutEffect(() => {
|
|
49
|
-
|
|
50
|
-
if (typeof window !== "undefined" && ((_a = window.__TSR__) == null ? void 0 : _a.dehydrated) || mountLoadForRouter.current.router === router && mountLoadForRouter.current.mounted) {
|
|
49
|
+
if (typeof window !== "undefined" && router.clientSsr || mountLoadForRouter.current.router === router && mountLoadForRouter.current.mounted) {
|
|
51
50
|
return;
|
|
52
51
|
}
|
|
53
52
|
mountLoadForRouter.current = { router, mounted: true };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Transitioner.js","sources":["../../src/Transitioner.tsx"],"sourcesContent":["import * as React from 'react'\nimport { useLayoutEffect, usePrevious } from './utils'\nimport { useRouter } from './useRouter'\nimport { useRouterState } from './useRouterState'\nimport { trimPathRight } from './path'\n\nexport function Transitioner() {\n const router = useRouter()\n const mountLoadForRouter = React.useRef({ router, mounted: false })\n const isLoading = useRouterState({\n select: ({ isLoading }) => isLoading,\n })\n\n const [isTransitioning, setIsTransitioning] = React.useState(false)\n // Track pending state changes\n const hasPendingMatches = useRouterState({\n select: (s) => s.matches.some((d) => d.status === 'pending'),\n structuralSharing: true,\n })\n\n const previousIsLoading = usePrevious(isLoading)\n\n const isAnyPending = isLoading || isTransitioning || hasPendingMatches\n const previousIsAnyPending = usePrevious(isAnyPending)\n\n const isPagePending = isLoading || hasPendingMatches\n const previousIsPagePending = usePrevious(isPagePending)\n\n if (!router.isServer) {\n router.startReactTransition = (fn: () => void) => {\n setIsTransitioning(true)\n React.startTransition(() => {\n fn()\n setIsTransitioning(false)\n })\n }\n }\n\n // Subscribe to location changes\n // and try to load the new location\n React.useEffect(() => {\n const unsub = router.history.subscribe(router.load)\n\n const nextLocation = router.buildLocation({\n to: router.latestLocation.pathname,\n search: true,\n params: true,\n hash: true,\n state: true,\n _includeValidateSearch: true,\n })\n\n if (\n trimPathRight(router.latestLocation.href) !==\n trimPathRight(nextLocation.href)\n ) {\n router.commitLocation({ ...nextLocation, replace: true })\n }\n\n return () => {\n unsub()\n }\n }, [router, router.history])\n\n // Try to load the initial location\n useLayoutEffect(() => {\n if (\n (typeof window !== 'undefined' &&
|
|
1
|
+
{"version":3,"file":"Transitioner.js","sources":["../../src/Transitioner.tsx"],"sourcesContent":["import * as React from 'react'\nimport { useLayoutEffect, usePrevious } from './utils'\nimport { useRouter } from './useRouter'\nimport { useRouterState } from './useRouterState'\nimport { trimPathRight } from './path'\n\nexport function Transitioner() {\n const router = useRouter()\n const mountLoadForRouter = React.useRef({ router, mounted: false })\n const isLoading = useRouterState({\n select: ({ isLoading }) => isLoading,\n })\n\n const [isTransitioning, setIsTransitioning] = React.useState(false)\n // Track pending state changes\n const hasPendingMatches = useRouterState({\n select: (s) => s.matches.some((d) => d.status === 'pending'),\n structuralSharing: true,\n })\n\n const previousIsLoading = usePrevious(isLoading)\n\n const isAnyPending = isLoading || isTransitioning || hasPendingMatches\n const previousIsAnyPending = usePrevious(isAnyPending)\n\n const isPagePending = isLoading || hasPendingMatches\n const previousIsPagePending = usePrevious(isPagePending)\n\n if (!router.isServer) {\n router.startReactTransition = (fn: () => void) => {\n setIsTransitioning(true)\n React.startTransition(() => {\n fn()\n setIsTransitioning(false)\n })\n }\n }\n\n // Subscribe to location changes\n // and try to load the new location\n React.useEffect(() => {\n const unsub = router.history.subscribe(router.load)\n\n const nextLocation = router.buildLocation({\n to: router.latestLocation.pathname,\n search: true,\n params: true,\n hash: true,\n state: true,\n _includeValidateSearch: true,\n })\n\n if (\n trimPathRight(router.latestLocation.href) !==\n trimPathRight(nextLocation.href)\n ) {\n router.commitLocation({ ...nextLocation, replace: true })\n }\n\n return () => {\n unsub()\n }\n }, [router, router.history])\n\n // Try to load the initial location\n useLayoutEffect(() => {\n if (\n (typeof window !== 'undefined' && router.clientSsr) ||\n (mountLoadForRouter.current.router === router &&\n mountLoadForRouter.current.mounted)\n ) {\n return\n }\n mountLoadForRouter.current = { router, mounted: true }\n\n const tryLoad = async () => {\n try {\n await router.load()\n } catch (err) {\n console.error(err)\n }\n }\n\n tryLoad()\n }, [router])\n\n useLayoutEffect(() => {\n // The router was loading and now it's not\n if (previousIsLoading && !isLoading) {\n const toLocation = router.state.location\n const fromLocation = router.state.resolvedLocation\n const pathChanged = fromLocation.pathname !== toLocation.pathname\n const hrefChanged = fromLocation.href !== toLocation.href\n\n router.emit({\n type: 'onLoad', // When the new URL has committed, when the new matches have been loaded into state.matches\n fromLocation,\n toLocation,\n pathChanged,\n hrefChanged,\n })\n }\n }, [previousIsLoading, router, isLoading])\n\n useLayoutEffect(() => {\n // emit onBeforeRouteMount\n if (previousIsPagePending && !isPagePending) {\n const toLocation = router.state.location\n const fromLocation = router.state.resolvedLocation\n const pathChanged = fromLocation.pathname !== toLocation.pathname\n const hrefChanged = fromLocation.href !== toLocation.href\n\n router.emit({\n type: 'onBeforeRouteMount',\n fromLocation,\n toLocation,\n pathChanged,\n hrefChanged,\n })\n }\n }, [isPagePending, previousIsPagePending, router])\n\n useLayoutEffect(() => {\n // The router was pending and now it's not\n if (previousIsAnyPending && !isAnyPending) {\n const toLocation = router.state.location\n const fromLocation = router.state.resolvedLocation\n const pathChanged = fromLocation.pathname !== toLocation.pathname\n const hrefChanged = fromLocation.href !== toLocation.href\n\n router.emit({\n type: 'onResolved',\n fromLocation,\n toLocation,\n pathChanged,\n hrefChanged,\n })\n\n router.__store.setState((s) => ({\n ...s,\n status: 'idle',\n resolvedLocation: s.location,\n }))\n\n if (typeof document !== 'undefined' && (document as any).querySelector) {\n const hashScrollIntoViewOptions =\n router.state.location.state.__hashScrollIntoViewOptions ?? true\n\n if (hashScrollIntoViewOptions && router.state.location.hash !== '') {\n const el = document.getElementById(router.state.location.hash)\n if (el) {\n el.scrollIntoView(hashScrollIntoViewOptions)\n }\n }\n }\n }\n }, [isAnyPending, previousIsAnyPending, router])\n\n return null\n}\n"],"names":["isLoading"],"mappings":";;;;;AAMO,SAAS,eAAe;AAC7B,QAAM,SAAS,UAAU;AACzB,QAAM,qBAAqB,MAAM,OAAO,EAAE,QAAQ,SAAS,OAAO;AAClE,QAAM,YAAY,eAAe;AAAA,IAC/B,QAAQ,CAAC,EAAE,WAAAA,iBAAgBA;AAAAA,EAAA,CAC5B;AAED,QAAM,CAAC,iBAAiB,kBAAkB,IAAI,MAAM,SAAS,KAAK;AAElE,QAAM,oBAAoB,eAAe;AAAA,IACvC,QAAQ,CAAC,MAAM,EAAE,QAAQ,KAAK,CAAC,MAAM,EAAE,WAAW,SAAS;AAAA,IAC3D,mBAAmB;AAAA,EAAA,CACpB;AAEK,QAAA,oBAAoB,YAAY,SAAS;AAEzC,QAAA,eAAe,aAAa,mBAAmB;AAC/C,QAAA,uBAAuB,YAAY,YAAY;AAErD,QAAM,gBAAgB,aAAa;AAC7B,QAAA,wBAAwB,YAAY,aAAa;AAEnD,MAAA,CAAC,OAAO,UAAU;AACb,WAAA,uBAAuB,CAAC,OAAmB;AAChD,yBAAmB,IAAI;AACvB,YAAM,gBAAgB,MAAM;AACvB,WAAA;AACH,2BAAmB,KAAK;AAAA,MAAA,CACzB;AAAA,IACH;AAAA,EAAA;AAKF,QAAM,UAAU,MAAM;AACpB,UAAM,QAAQ,OAAO,QAAQ,UAAU,OAAO,IAAI;AAE5C,UAAA,eAAe,OAAO,cAAc;AAAA,MACxC,IAAI,OAAO,eAAe;AAAA,MAC1B,QAAQ;AAAA,MACR,QAAQ;AAAA,MACR,MAAM;AAAA,MACN,OAAO;AAAA,MACP,wBAAwB;AAAA,IAAA,CACzB;AAGC,QAAA,cAAc,OAAO,eAAe,IAAI,MACxC,cAAc,aAAa,IAAI,GAC/B;AACA,aAAO,eAAe,EAAE,GAAG,cAAc,SAAS,MAAM;AAAA,IAAA;AAG1D,WAAO,MAAM;AACL,YAAA;AAAA,IACR;AAAA,EACC,GAAA,CAAC,QAAQ,OAAO,OAAO,CAAC;AAG3B,kBAAgB,MAAM;AAEjB,QAAA,OAAO,WAAW,eAAe,OAAO,aACxC,mBAAmB,QAAQ,WAAW,UACrC,mBAAmB,QAAQ,SAC7B;AACA;AAAA,IAAA;AAEF,uBAAmB,UAAU,EAAE,QAAQ,SAAS,KAAK;AAErD,UAAM,UAAU,YAAY;AACtB,UAAA;AACF,cAAM,OAAO,KAAK;AAAA,eACX,KAAK;AACZ,gBAAQ,MAAM,GAAG;AAAA,MAAA;AAAA,IAErB;AAEQ,YAAA;AAAA,EAAA,GACP,CAAC,MAAM,CAAC;AAEX,kBAAgB,MAAM;AAEhB,QAAA,qBAAqB,CAAC,WAAW;AAC7B,YAAA,aAAa,OAAO,MAAM;AAC1B,YAAA,eAAe,OAAO,MAAM;AAC5B,YAAA,cAAc,aAAa,aAAa,WAAW;AACnD,YAAA,cAAc,aAAa,SAAS,WAAW;AAErD,aAAO,KAAK;AAAA,QACV,MAAM;AAAA;AAAA,QACN;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,MAAA,CACD;AAAA,IAAA;AAAA,EAEF,GAAA,CAAC,mBAAmB,QAAQ,SAAS,CAAC;AAEzC,kBAAgB,MAAM;AAEhB,QAAA,yBAAyB,CAAC,eAAe;AACrC,YAAA,aAAa,OAAO,MAAM;AAC1B,YAAA,eAAe,OAAO,MAAM;AAC5B,YAAA,cAAc,aAAa,aAAa,WAAW;AACnD,YAAA,cAAc,aAAa,SAAS,WAAW;AAErD,aAAO,KAAK;AAAA,QACV,MAAM;AAAA,QACN;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,MAAA,CACD;AAAA,IAAA;AAAA,EAEF,GAAA,CAAC,eAAe,uBAAuB,MAAM,CAAC;AAEjD,kBAAgB,MAAM;AAEhB,QAAA,wBAAwB,CAAC,cAAc;AACnC,YAAA,aAAa,OAAO,MAAM;AAC1B,YAAA,eAAe,OAAO,MAAM;AAC5B,YAAA,cAAc,aAAa,aAAa,WAAW;AACnD,YAAA,cAAc,aAAa,SAAS,WAAW;AAErD,aAAO,KAAK;AAAA,QACV,MAAM;AAAA,QACN;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,MAAA,CACD;AAEM,aAAA,QAAQ,SAAS,CAAC,OAAO;AAAA,QAC9B,GAAG;AAAA,QACH,QAAQ;AAAA,QACR,kBAAkB,EAAE;AAAA,MAAA,EACpB;AAEF,UAAI,OAAO,aAAa,eAAgB,SAAiB,eAAe;AACtE,cAAM,4BACJ,OAAO,MAAM,SAAS,MAAM,+BAA+B;AAE7D,YAAI,6BAA6B,OAAO,MAAM,SAAS,SAAS,IAAI;AAClE,gBAAM,KAAK,SAAS,eAAe,OAAO,MAAM,SAAS,IAAI;AAC7D,cAAI,IAAI;AACN,eAAG,eAAe,yBAAyB;AAAA,UAAA;AAAA,QAC7C;AAAA,MACF;AAAA,IACF;AAAA,EAED,GAAA,CAAC,cAAc,sBAAsB,MAAM,CAAC;AAExC,SAAA;AACT;"}
|
package/dist/esm/awaited.js
CHANGED
|
@@ -1,36 +1,15 @@
|
|
|
1
1
|
import { jsx } from "react/jsx-runtime";
|
|
2
2
|
import * as React from "react";
|
|
3
|
-
import warning from "tiny-warning";
|
|
4
|
-
import { useRouter } from "./useRouter.js";
|
|
5
|
-
import { defaultSerializeError } from "./router.js";
|
|
6
3
|
import { defer, TSR_DEFERRED_PROMISE } from "./defer.js";
|
|
7
|
-
import { isServerSideError, defaultDeserializeError } from "./isServerSideError.js";
|
|
8
4
|
function useAwaited({
|
|
9
5
|
promise: _promise
|
|
10
6
|
}) {
|
|
11
|
-
var _a, _b;
|
|
12
|
-
const router = useRouter();
|
|
13
7
|
const promise = defer(_promise);
|
|
14
8
|
if (promise[TSR_DEFERRED_PROMISE].status === "pending") {
|
|
15
9
|
throw promise;
|
|
16
10
|
}
|
|
17
11
|
if (promise[TSR_DEFERRED_PROMISE].status === "error") {
|
|
18
|
-
|
|
19
|
-
if (isServerSideError(promise[TSR_DEFERRED_PROMISE].error)) {
|
|
20
|
-
throw (((_a = router.options.errorSerializer) == null ? void 0 : _a.deserialize) ?? defaultDeserializeError)(promise[TSR_DEFERRED_PROMISE].error.data);
|
|
21
|
-
} else {
|
|
22
|
-
warning(
|
|
23
|
-
false,
|
|
24
|
-
"Encountered a server-side error that doesn't fit the expected shape"
|
|
25
|
-
);
|
|
26
|
-
throw promise[TSR_DEFERRED_PROMISE].error;
|
|
27
|
-
}
|
|
28
|
-
} else {
|
|
29
|
-
throw {
|
|
30
|
-
data: (((_b = router.options.errorSerializer) == null ? void 0 : _b.serialize) ?? defaultSerializeError)(promise[TSR_DEFERRED_PROMISE].error),
|
|
31
|
-
__isServerError: true
|
|
32
|
-
};
|
|
33
|
-
}
|
|
12
|
+
throw promise[TSR_DEFERRED_PROMISE].error;
|
|
34
13
|
}
|
|
35
14
|
return [promise[TSR_DEFERRED_PROMISE].data, promise];
|
|
36
15
|
}
|
package/dist/esm/awaited.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"awaited.js","sources":["../../src/awaited.tsx"],"sourcesContent":["import * as React from 'react'\
|
|
1
|
+
{"version":3,"file":"awaited.js","sources":["../../src/awaited.tsx"],"sourcesContent":["import * as React from 'react'\n\nimport { TSR_DEFERRED_PROMISE, defer } from './defer'\nimport type { DeferredPromise } from './defer'\n\nexport type AwaitOptions<T> = {\n promise: Promise<T>\n}\n\nexport function useAwaited<T>({\n promise: _promise,\n}: AwaitOptions<T>): [T, DeferredPromise<T>] {\n const promise = defer(_promise)\n\n if (promise[TSR_DEFERRED_PROMISE].status === 'pending') {\n throw promise\n }\n\n if (promise[TSR_DEFERRED_PROMISE].status === 'error') {\n throw promise[TSR_DEFERRED_PROMISE].error\n }\n\n return [promise[TSR_DEFERRED_PROMISE].data, promise]\n}\n\nexport function Await<T>(\n props: AwaitOptions<T> & {\n fallback?: React.ReactNode\n children: (result: T) => React.ReactNode\n },\n) {\n const inner = <AwaitInner {...props} />\n if (props.fallback) {\n return <React.Suspense fallback={props.fallback}>{inner}</React.Suspense>\n }\n return inner\n}\n\nfunction AwaitInner<T>(\n props: AwaitOptions<T> & {\n fallback?: React.ReactNode\n children: (result: T) => React.ReactNode\n },\n): React.JSX.Element {\n const [data] = useAwaited(props)\n\n return props.children(data) as React.JSX.Element\n}\n"],"names":[],"mappings":";;;AASO,SAAS,WAAc;AAAA,EAC5B,SAAS;AACX,GAA6C;AACrC,QAAA,UAAU,MAAM,QAAQ;AAE9B,MAAI,QAAQ,oBAAoB,EAAE,WAAW,WAAW;AAChD,UAAA;AAAA,EAAA;AAGR,MAAI,QAAQ,oBAAoB,EAAE,WAAW,SAAS;AAC9C,UAAA,QAAQ,oBAAoB,EAAE;AAAA,EAAA;AAGtC,SAAO,CAAC,QAAQ,oBAAoB,EAAE,MAAM,OAAO;AACrD;AAEO,SAAS,MACd,OAIA;AACA,QAAM,QAAQ,oBAAC,YAAY,EAAA,GAAG,MAAO,CAAA;AACrC,MAAI,MAAM,UAAU;AAClB,+BAAQ,MAAM,UAAN,EAAe,UAAU,MAAM,UAAW,UAAM,OAAA;AAAA,EAAA;AAEnD,SAAA;AACT;AAEA,SAAS,WACP,OAImB;AACnB,QAAM,CAAC,IAAI,IAAI,WAAW,KAAK;AAExB,SAAA,MAAM,SAAS,IAAI;AAC5B;"}
|
package/dist/esm/index.d.ts
CHANGED
|
@@ -4,7 +4,6 @@ export { default as invariant } from 'tiny-invariant';
|
|
|
4
4
|
export { default as warning } from 'tiny-warning';
|
|
5
5
|
export { useAwaited, Await } from './awaited.js';
|
|
6
6
|
export type { AwaitOptions } from './awaited.js';
|
|
7
|
-
export { ScriptOnce } from './ScriptOnce.js';
|
|
8
7
|
export { defer, TSR_DEFERRED_PROMISE } from './defer.js';
|
|
9
8
|
export type { DeferredPromiseState, DeferredPromise } from './defer.js';
|
|
10
9
|
export { CatchBoundary, ErrorComponent } from './CatchBoundary.js';
|
|
@@ -19,7 +18,6 @@ export { Matches, useMatchRoute, MatchRoute, useMatches, useParentMatches, useCh
|
|
|
19
18
|
export type { RouteMatch, AnyRouteMatch, MatchRouteOptions, UseMatchRouteOptions, MakeMatchRouteOptions, MakeRouteMatch, MakeRouteMatchUnion, } from './Matches.js';
|
|
20
19
|
export { matchContext } from './matchContext.js';
|
|
21
20
|
export { Match, Outlet } from './Match.js';
|
|
22
|
-
export { isServerSideError, defaultDeserializeError } from './isServerSideError.js';
|
|
23
21
|
export { useMatch } from './useMatch.js';
|
|
24
22
|
export { useLoaderDeps } from './useLoaderDeps.js';
|
|
25
23
|
export { useLoaderData } from './useLoaderData.js';
|
|
@@ -34,15 +32,14 @@ export { RouteApi, getRouteApi, Route, createRoute, RootRoute, rootRouteWithCont
|
|
|
34
32
|
export type { AnyPathParams, ResolveParams, SearchSchemaInput, AnyContext, RouteContext, PreloadableObj, RoutePathOptions, StaticDataRouteOption, RoutePathOptionsIntersection, RouteOptions, FileBaseRouteOptions, BaseRouteOptions, UpdatableRouteOptions, UpdatableStaticRouteOption, MetaDescriptor, RouteLinkEntry, ParseParamsFn, RouteLoaderFn, LoaderFnContext, SearchFilter, ResolveId, InferFullSearchSchema, InferFullSearchSchemaInput, ResolveFullSearchSchema, ResolveFullSearchSchemaInput, AnyRoute, RouteConstraints, AnyRootRoute, ResolveFullPath, RouteMask, ErrorRouteProps, ErrorComponentProps, NotFoundRouteProps, ReactNode, SyncRouteComponent, AsyncRouteComponent, RouteComponent, ErrorRouteComponent, NotFoundRouteComponent, TrimPath, TrimPathLeft, TrimPathRight, RootRouteOptions, AnyRouteWithContext, ParseSplatParams, SplatParams, StringifyParamsFn, ParamsOptions, FullSearchSchemaOption, RouteContextFn, RouteContextOptions, BeforeLoadFn, BeforeLoadContextOptions, ContextOptions, InferAllParams, InferAllContext, LooseReturnType, LooseAsyncReturnType, ContextReturnType, ContextAsyncReturnType, RouteContextParameter, BeforeLoadContextParameter, ResolveAllContext, ResolveLoaderData, ResolveAllParamsFromParent, ResolveRouteContext, } from './route.js';
|
|
35
33
|
export type { ParseRoute, RoutesById, RouteById, RouteIds, RoutesByPath, RouteByPath, RoutePaths, FullSearchSchema, AllParams, AllLoaderData, FullSearchSchemaInput, AllContext, } from './routeInfo.js';
|
|
36
34
|
export { componentTypes, createRouter, Router, lazyFn, SearchParamError, PathParamError, getInitialRouterState, defaultSerializeError, } from './router.js';
|
|
37
|
-
export type { Register, AnyRouter, RegisteredRouter,
|
|
35
|
+
export type { Register, AnyRouter, RegisteredRouter, RouterContextOptions, TrailingSlashOption, RouterOptions, RouterErrorSerializer, RouterState, ListenerFn, BuildNextOptions, RouterConstructorOptions, RouterEvents, RouterEvent, RouterListener, AnyRouterWithContext, ControllablePromise, InjectedHtmlEntry, } from './router.js';
|
|
36
|
+
export type { StartSerializer, Serializable, SerializerParse, SerializerParseBy, SerializerStringify, SerializerStringifyBy, } from './serializer.js';
|
|
38
37
|
export { RouterProvider, RouterContextProvider } from './RouterProvider.js';
|
|
39
|
-
export type { RouterProps, CommitLocationOptions, MatchLocation, NavigateFn, BuildLocationFn,
|
|
38
|
+
export type { RouterProps, CommitLocationOptions, MatchLocation, NavigateFn, BuildLocationFn, } from './RouterProvider.js';
|
|
40
39
|
export { useScrollRestoration, useElementScrollRestoration, ScrollRestoration, } from './scroll-restoration.js';
|
|
41
40
|
export type { ScrollRestorationOptions } from './scroll-restoration.js';
|
|
42
41
|
export { defaultParseSearch, defaultStringifySearch, parseSearchWith, stringifySearchWith, } from './searchParams.js';
|
|
43
42
|
export type { SearchSerializer, SearchParser } from './searchParams.js';
|
|
44
|
-
export { defaultTransformer } from './transformer.js';
|
|
45
|
-
export type { RouterTransformer, TransformerParse, TransformerStringify, DefaultSerializable, DefaultTransformerParse, DefaultTransformerStringify, } from './transformer.js';
|
|
46
43
|
export type { UseBlockerOpts, ShouldBlockFn } from './useBlocker.js';
|
|
47
44
|
export { useBlocker, Block } from './useBlocker.js';
|
|
48
45
|
export { useNavigate, Navigate } from './useNavigate.js';
|
|
@@ -66,3 +63,4 @@ export type { ControlledPromise, Constrain, Expand, MergeAll, Assign, } from './
|
|
|
66
63
|
export type { ResolveValidatorInput, ResolveValidatorOutput, AnyValidator, DefaultValidator, ValidatorFn, AnySchema, AnyValidatorAdapter, AnyValidatorFn, AnyValidatorObj, ResolveValidatorInputFn, ResolveValidatorOutputFn, ResolveSearchValidatorInput, ResolveSearchValidatorInputFn, Validator, ValidatorAdapter, ValidatorObj, } from './validators.js';
|
|
67
64
|
export { retainSearchParams, stripSearchParams } from './searchMiddleware.js';
|
|
68
65
|
export * from './typePrimitives.js';
|
|
66
|
+
export { ScriptOnce } from './ScriptOnce.js';
|
package/dist/esm/index.js
CHANGED
|
@@ -2,7 +2,6 @@ import { createBrowserHistory, createHashHistory, createHistory, createMemoryHis
|
|
|
2
2
|
import { default as default2 } from "tiny-invariant";
|
|
3
3
|
import { default as default3 } from "tiny-warning";
|
|
4
4
|
import { Await, useAwaited } from "./awaited.js";
|
|
5
|
-
import { ScriptOnce } from "./ScriptOnce.js";
|
|
6
5
|
import { TSR_DEFERRED_PROMISE, defer } from "./defer.js";
|
|
7
6
|
import { CatchBoundary, ErrorComponent } from "./CatchBoundary.js";
|
|
8
7
|
import { FileRoute, FileRouteLoader, LazyRoute, createFileRoute, createLazyFileRoute, createLazyRoute } from "./fileRoute.js";
|
|
@@ -11,7 +10,6 @@ import { Link, createLink, linkOptions, useLinkProps } from "./link.js";
|
|
|
11
10
|
import { MatchRoute, Matches, isMatch, useChildMatches, useMatchRoute, useMatches, useParentMatches } from "./Matches.js";
|
|
12
11
|
import { matchContext } from "./matchContext.js";
|
|
13
12
|
import { Match, Outlet } from "./Match.js";
|
|
14
|
-
import { defaultDeserializeError, isServerSideError } from "./isServerSideError.js";
|
|
15
13
|
import { useMatch } from "./useMatch.js";
|
|
16
14
|
import { useLoaderDeps } from "./useLoaderDeps.js";
|
|
17
15
|
import { useLoaderData } from "./useLoaderData.js";
|
|
@@ -24,7 +22,6 @@ import { PathParamError, Router, SearchParamError, componentTypes, createRouter,
|
|
|
24
22
|
import { RouterContextProvider, RouterProvider } from "./RouterProvider.js";
|
|
25
23
|
import { ScrollRestoration, useElementScrollRestoration, useScrollRestoration } from "./scroll-restoration.js";
|
|
26
24
|
import { defaultParseSearch, defaultStringifySearch, parseSearchWith, stringifySearchWith } from "./searchParams.js";
|
|
27
|
-
import { defaultTransformer } from "./transformer.js";
|
|
28
25
|
import { Block, useBlocker } from "./useBlocker.js";
|
|
29
26
|
import { Navigate, useNavigate } from "./useNavigate.js";
|
|
30
27
|
import { useParams } from "./useParams.js";
|
|
@@ -38,6 +35,7 @@ import { useCanGoBack } from "./useCanGoBack.js";
|
|
|
38
35
|
import { createControlledPromise, deepEqual, escapeJSON, functionalUpdate, isPlainArray, isPlainObject, pick, replaceEqualDeep, shallow, useLayoutEffect, useStableCallback } from "./utils.js";
|
|
39
36
|
import { CatchNotFound, DefaultGlobalNotFound, isNotFound, notFound } from "./not-found.js";
|
|
40
37
|
import { retainSearchParams, stripSearchParams } from "./searchMiddleware.js";
|
|
38
|
+
import { ScriptOnce } from "./ScriptOnce.js";
|
|
41
39
|
export {
|
|
42
40
|
Await,
|
|
43
41
|
Block,
|
|
@@ -84,11 +82,9 @@ export {
|
|
|
84
82
|
createRouter,
|
|
85
83
|
decode,
|
|
86
84
|
deepEqual,
|
|
87
|
-
defaultDeserializeError,
|
|
88
85
|
defaultParseSearch,
|
|
89
86
|
defaultSerializeError,
|
|
90
87
|
defaultStringifySearch,
|
|
91
|
-
defaultTransformer,
|
|
92
88
|
defer,
|
|
93
89
|
encode,
|
|
94
90
|
escapeJSON,
|
|
@@ -103,7 +99,6 @@ export {
|
|
|
103
99
|
isPlainArray,
|
|
104
100
|
isPlainObject,
|
|
105
101
|
isRedirect,
|
|
106
|
-
isServerSideError,
|
|
107
102
|
joinPaths,
|
|
108
103
|
lazyFn,
|
|
109
104
|
lazyRouteComponent,
|
package/dist/esm/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
|
package/dist/esm/router.d.ts
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { Store, NoInfer } from '@tanstack/react-store';
|
|
2
|
+
import { StartSerializer } from './serializer.js';
|
|
2
3
|
import { HistoryLocation, HistoryState, ParsedHistoryState, RouterHistory } from '@tanstack/history';
|
|
3
4
|
import { Manifest } from './manifest.js';
|
|
4
5
|
import { AnyContext, AnyRoute, AnyRouteWithContext, ErrorRouteComponent, NotFoundRouteComponent, RootRoute, RouteComponent, RouteMask } from './route.js';
|
|
@@ -11,33 +12,13 @@ import { BuildLocationFn, CommitLocationOptions, NavigateFn } from './RouterProv
|
|
|
11
12
|
import { AnyRedirect, ResolvedRedirect } from './redirects.js';
|
|
12
13
|
import { NotFoundError } from './not-found.js';
|
|
13
14
|
import { NavigateOptions, ResolveRelativePath, ToOptions } from './link.js';
|
|
14
|
-
import { RouterTransformer } from './transformer.js';
|
|
15
15
|
import { AnySchema } from './validators.js';
|
|
16
16
|
import type * as React from 'react';
|
|
17
|
-
export interface TSRGlobalMatch {
|
|
18
|
-
index: number;
|
|
19
|
-
__beforeLoadContext?: string;
|
|
20
|
-
loaderData?: string;
|
|
21
|
-
extracted: Record<string, ClientExtractedEntry>;
|
|
22
|
-
}
|
|
23
|
-
export interface TSRGlobal {
|
|
24
|
-
matches: Array<TSRGlobalMatch>;
|
|
25
|
-
streamedValues: Record<string, {
|
|
26
|
-
value: any;
|
|
27
|
-
parsed: any;
|
|
28
|
-
}>;
|
|
29
|
-
cleanScripts: () => void;
|
|
30
|
-
dehydrated?: any;
|
|
31
|
-
}
|
|
32
17
|
declare global {
|
|
33
18
|
interface Window {
|
|
34
|
-
|
|
35
|
-
__TSR_ROUTER_CONTEXT__?: React.Context<Router<any, any, any>>;
|
|
19
|
+
__TSR_ROUTER__?: AnyRouter;
|
|
36
20
|
}
|
|
37
21
|
}
|
|
38
|
-
type RegisteredTSRGlobal = Register extends {
|
|
39
|
-
__TSR__: infer TTSR extends TSRGlobal;
|
|
40
|
-
} ? TTSR : TSRGlobal;
|
|
41
22
|
export interface Register {
|
|
42
23
|
}
|
|
43
24
|
export type AnyRouter = Router<any, any, any, any, any, any>;
|
|
@@ -45,40 +26,19 @@ export type AnyRouterWithContext<TContext> = Router<AnyRouteWithContext<TContext
|
|
|
45
26
|
export type RegisteredRouter = Register extends {
|
|
46
27
|
router: infer TRouter extends AnyRouter;
|
|
47
28
|
} ? TRouter : AnyRouter;
|
|
48
|
-
export type HydrationCtx = {
|
|
49
|
-
router: DehydratedRouter;
|
|
50
|
-
payload: Record<string, any>;
|
|
51
|
-
};
|
|
52
29
|
export type InferRouterContext<TRouteTree extends AnyRoute> = TRouteTree extends RootRoute<any, infer TRouterContext extends AnyContext, any, any, any, any, any, any> ? TRouterContext : AnyContext;
|
|
53
|
-
export interface ClientExtractedBaseEntry {
|
|
54
|
-
type: string;
|
|
55
|
-
path: Array<string>;
|
|
56
|
-
}
|
|
57
30
|
export type ControllablePromise<T = any> = Promise<T> & {
|
|
58
31
|
resolve: (value: T) => void;
|
|
59
32
|
reject: (value?: any) => void;
|
|
60
33
|
};
|
|
61
|
-
export interface ClientExtractedPromise extends ClientExtractedBaseEntry {
|
|
62
|
-
type: 'promise';
|
|
63
|
-
value?: ControllablePromise<any>;
|
|
64
|
-
}
|
|
65
|
-
export interface ClientExtractedStream extends ClientExtractedBaseEntry {
|
|
66
|
-
type: 'stream';
|
|
67
|
-
value?: ReadableStream & {
|
|
68
|
-
controller?: ReadableStreamDefaultController;
|
|
69
|
-
};
|
|
70
|
-
}
|
|
71
|
-
export type ClientExtractedEntry = ClientExtractedStream | ClientExtractedPromise;
|
|
72
|
-
export type StreamState = {
|
|
73
|
-
promises: Array<ControlledPromise<string | null>>;
|
|
74
|
-
};
|
|
75
34
|
export type RouterContextOptions<TRouteTree extends AnyRoute> = AnyContext extends InferRouterContext<TRouteTree> ? {
|
|
76
35
|
context?: InferRouterContext<TRouteTree>;
|
|
77
36
|
} : {
|
|
78
37
|
context: InferRouterContext<TRouteTree>;
|
|
79
38
|
};
|
|
80
39
|
export type TrailingSlashOption = 'always' | 'never' | 'preserve';
|
|
81
|
-
export
|
|
40
|
+
export type InjectedHtmlEntry = Promise<string>;
|
|
41
|
+
export interface RouterOptions<TRouteTree extends AnyRoute, TTrailingSlashOption extends TrailingSlashOption, TDefaultStructuralSharingOption extends boolean = false, TRouterHistory extends RouterHistory = RouterHistory, TDehydrated extends Record<string, any> = Record<string, any>> {
|
|
82
42
|
/**
|
|
83
43
|
* The history object that will be used to manage the browser history.
|
|
84
44
|
*
|
|
@@ -336,19 +296,6 @@ export interface RouterOptions<TRouteTree extends AnyRoute, TTrailingSlashOption
|
|
|
336
296
|
* @link [Guide](https://tanstack.com/router/latest/docs/framework/react/guide/not-found-errors#default-router-wide-not-found-handling)
|
|
337
297
|
*/
|
|
338
298
|
defaultNotFoundComponent?: NotFoundRouteComponent;
|
|
339
|
-
/**
|
|
340
|
-
* The transformer that will be used when sending data between the server and the client during SSR.
|
|
341
|
-
*
|
|
342
|
-
* @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#transformer-property)
|
|
343
|
-
* @link [Guide](https://tanstack.com/router/latest/docs/framework/react/guide/ssr#data-transformers)
|
|
344
|
-
*/
|
|
345
|
-
transformer?: RouterTransformer;
|
|
346
|
-
/**
|
|
347
|
-
* The serializer object that will be used to determine how errors are serialized and deserialized between the server and the client.
|
|
348
|
-
*
|
|
349
|
-
* @link [API Docs](https://tanstack.com/router/latest/docs/framework/react/api/router/RouterOptionsType#errorserializer-property)
|
|
350
|
-
*/
|
|
351
|
-
errorSerializer?: RouterErrorSerializer<TSerializedError>;
|
|
352
299
|
/**
|
|
353
300
|
* Configures how trailing slashes are treated.
|
|
354
301
|
*
|
|
@@ -431,18 +378,10 @@ export interface MatchedRoutesResult {
|
|
|
431
378
|
matchedRoutes: Array<AnyRoute>;
|
|
432
379
|
routeParams: Record<string, string>;
|
|
433
380
|
}
|
|
434
|
-
export interface DehydratedRouterState {
|
|
435
|
-
dehydratedMatches: Array<DehydratedRouteMatch>;
|
|
436
|
-
}
|
|
437
|
-
export type DehydratedRouteMatch = Pick<MakeRouteMatch, 'id' | 'status' | 'updatedAt' | 'loaderData'>;
|
|
438
|
-
export interface DehydratedRouter {
|
|
439
|
-
state: DehydratedRouterState;
|
|
440
|
-
manifest?: Manifest;
|
|
441
|
-
}
|
|
442
381
|
export interface ViewTransitionOptions {
|
|
443
382
|
types: Array<string>;
|
|
444
383
|
}
|
|
445
|
-
export type RouterConstructorOptions<TRouteTree extends AnyRoute, TTrailingSlashOption extends TrailingSlashOption, TDefaultStructuralSharingOption extends boolean, TRouterHistory extends RouterHistory, TDehydrated extends Record<string, any
|
|
384
|
+
export 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'> & RouterContextOptions<TRouteTree>;
|
|
446
385
|
export declare const componentTypes: readonly ["component", "errorComponent", "pendingComponent", "notFoundComponent"];
|
|
447
386
|
export type RouterEvents = {
|
|
448
387
|
onBeforeNavigate: {
|
|
@@ -480,13 +419,17 @@ export type RouterEvents = {
|
|
|
480
419
|
pathChanged: boolean;
|
|
481
420
|
hrefChanged: boolean;
|
|
482
421
|
};
|
|
422
|
+
onInjectedHtml: {
|
|
423
|
+
type: 'onInjectedHtml';
|
|
424
|
+
promise: Promise<string>;
|
|
425
|
+
};
|
|
483
426
|
};
|
|
484
427
|
export type RouterEvent = RouterEvents[keyof RouterEvents];
|
|
485
428
|
export type RouterListener<TRouterEvent extends RouterEvent> = {
|
|
486
429
|
eventType: TRouterEvent['type'];
|
|
487
430
|
fn: ListenerFn<TRouterEvent>;
|
|
488
431
|
};
|
|
489
|
-
export declare function createRouter<TRouteTree extends AnyRoute, TTrailingSlashOption extends TrailingSlashOption, TDefaultStructuralSharingOption extends boolean, TRouterHistory extends RouterHistory = RouterHistory, TDehydrated extends Record<string, any> = Record<string, any>, TSerializedError extends Record<string, any> = Record<string, any>>(options: undefined extends number ? 'strictNullChecks must be enabled in tsconfig.json' : RouterConstructorOptions<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory, TDehydrated
|
|
432
|
+
export declare function createRouter<TRouteTree extends AnyRoute, TTrailingSlashOption extends TrailingSlashOption, TDefaultStructuralSharingOption extends boolean, TRouterHistory extends RouterHistory = RouterHistory, TDehydrated extends Record<string, any> = Record<string, any>, TSerializedError extends Record<string, any> = Record<string, any>>(options: undefined extends number ? 'strictNullChecks must be enabled in tsconfig.json' : RouterConstructorOptions<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory, TDehydrated>): Router<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory, TDehydrated, TSerializedError>;
|
|
490
433
|
type MatchRoutesOpts = {
|
|
491
434
|
preload?: boolean;
|
|
492
435
|
throwOnError?: boolean;
|
|
@@ -499,22 +442,9 @@ export declare class Router<in out TRouteTree extends AnyRoute, in out TTrailing
|
|
|
499
442
|
shouldViewTransition?: boolean | ViewTransitionOptions;
|
|
500
443
|
isViewTransitionTypesSupported?: boolean;
|
|
501
444
|
subscribers: Set<RouterListener<RouterEvent>>;
|
|
502
|
-
dehydratedData?: TDehydrated;
|
|
503
445
|
viewTransitionPromise?: ControlledPromise<true>;
|
|
504
|
-
manifest?: Manifest;
|
|
505
|
-
AfterEachMatch?: (props: {
|
|
506
|
-
match: Pick<AnyRouteMatch, 'id' | 'status' | 'error' | 'loadPromise' | 'minPendingPromise'>;
|
|
507
|
-
matchIndex: number;
|
|
508
|
-
}) => any;
|
|
509
|
-
serializeLoaderData?: (type: '__beforeLoadContext' | 'loaderData', loaderData: any, ctx: {
|
|
510
|
-
router: AnyRouter;
|
|
511
|
-
match: AnyRouteMatch;
|
|
512
|
-
}) => any;
|
|
513
|
-
serializer?: (data: any) => string;
|
|
514
446
|
__store: Store<RouterState<TRouteTree>>;
|
|
515
|
-
options: PickAsRequired<
|
|
516
|
-
transformer: RouterTransformer;
|
|
517
|
-
}, 'stringifySearch' | 'parseSearch' | 'context'>;
|
|
447
|
+
options: PickAsRequired<RouterOptions<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory, TDehydrated>, 'stringifySearch' | 'parseSearch' | 'context'>;
|
|
518
448
|
history: TRouterHistory;
|
|
519
449
|
latestLocation: ParsedLocation<FullSearchSchema<TRouteTree>>;
|
|
520
450
|
basepath: string;
|
|
@@ -527,9 +457,9 @@ export declare class Router<in out TRouteTree extends AnyRoute, in out TTrailing
|
|
|
527
457
|
/**
|
|
528
458
|
* @deprecated Use the `createRouter` function instead
|
|
529
459
|
*/
|
|
530
|
-
constructor(options: RouterConstructorOptions<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory, TDehydrated
|
|
460
|
+
constructor(options: RouterConstructorOptions<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory, TDehydrated>);
|
|
531
461
|
startReactTransition: (fn: () => void) => void;
|
|
532
|
-
update: (newOptions: RouterConstructorOptions<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory, TDehydrated
|
|
462
|
+
update: (newOptions: RouterConstructorOptions<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory, TDehydrated>) => void;
|
|
533
463
|
get state(): RouterState<TRouteTree, import('./Matches.js').RouteMatch<any, any, any, any, any, any, any>>;
|
|
534
464
|
buildRouteTree: () => void;
|
|
535
465
|
subscribe: <TType extends keyof RouterEvents>(eventType: TType, fn: ListenerFn<RouterEvents[TType]>) => () => void;
|
|
@@ -589,16 +519,26 @@ export declare class Router<in out TRouteTree extends AnyRoute, in out TTrailing
|
|
|
589
519
|
loadRouteChunk: (route: AnyRoute) => Promise<void[]>;
|
|
590
520
|
preloadRoute: <TFrom extends RoutePaths<TRouteTree> | string = string, TTo extends string | undefined = undefined, TMaskFrom extends RoutePaths<TRouteTree> | string = TFrom, TMaskTo extends string = "">(opts: NavigateOptions<Router<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory, TDehydrated, TSerializedError>, TFrom, TTo, TMaskFrom, TMaskTo>) => Promise<Array<AnyRouteMatch> | undefined>;
|
|
591
521
|
matchRoute: <TFrom extends RoutePaths<TRouteTree> = "/", TTo extends string | undefined = undefined, TResolved = ResolveRelativePath<TFrom, NoInfer<TTo>>>(location: ToOptions<Router<TRouteTree, TTrailingSlashOption, TDefaultStructuralSharingOption, TRouterHistory, TDehydrated, TSerializedError>, TFrom, TTo>, opts?: MatchRouteOptions) => false | RouteById<TRouteTree, TResolved>["types"]["allParams"];
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
|
|
522
|
+
ssr?: {
|
|
523
|
+
manifest: Manifest | undefined;
|
|
524
|
+
serializer: StartSerializer;
|
|
525
|
+
};
|
|
526
|
+
serverSsr?: {
|
|
527
|
+
injectedHtml: Array<InjectedHtmlEntry>;
|
|
528
|
+
injectHtml: (getHtml: () => string | Promise<string>) => Promise<void>;
|
|
529
|
+
injectScript: (getScript: () => string | Promise<string>, opts?: {
|
|
530
|
+
logScript?: boolean;
|
|
531
|
+
}) => Promise<void>;
|
|
532
|
+
streamValue: (key: string, value: any) => void;
|
|
533
|
+
streamedKeys: Set<string>;
|
|
534
|
+
onMatchSettled: (opts: {
|
|
535
|
+
router: AnyRouter;
|
|
536
|
+
match: AnyRouteMatch;
|
|
537
|
+
}) => any;
|
|
538
|
+
};
|
|
539
|
+
clientSsr?: {
|
|
540
|
+
getStreamedValue: <T>(key: string) => T | undefined;
|
|
541
|
+
};
|
|
602
542
|
_handleNotFound: (matches: Array<AnyRouteMatch>, err: NotFoundError, { updateMatch, }?: {
|
|
603
543
|
updateMatch?: (id: string, updater: (match: AnyRouteMatch) => AnyRouteMatch) => void;
|
|
604
544
|
}) => void;
|