@tanstack/router-core 1.171.15 → 1.171.16-pre.0

package/dist/esm/index.js

@@ -7,9 +7,10 @@ import { decode, encode } from "./qss.js";
 import { defaultParseSearch, defaultStringifySearch, parseSearchWith, stringifySearchWith } from "./searchParams.js";
 import { rootRouteId } from "./root.js";
 import { isRedirect, isResolvedRedirect, parseRedirect, redirect } from "./redirect.js";
+import { _getAssetMatches, _getRenderedMatches } from "./load-client.js";
 import { composeRewrites, executeRewriteInput } from "./rewrite.js";
 import { createNonReactiveMutableStore, createNonReactiveReadonlyStore } from "./stores.js";
-import { PathParamError, RouterCore, SearchParamError, defaultSerializeError, getInitialRouterState, getLocationChangeInfo, getMatchedRoutes, lazyFn, trailingSlashOptions } from "./router.js";
+import { PathParamError, RouterCore, SearchParamError, defaultSerializeError, getInitialRouterState, getLocationChangeInfo, lazyFn, trailingSlashOptions } from "./router.js";
 import { TSR_DEFERRED_PROMISE, defer } from "./defer.js";
 import { preloadWarning } from "./link.js";
 import { DEV_STYLES_ATTR, appendUniqueUserTags, createInlineCssStyleAsset, getAssetCrossOrigin, getManifestScriptFormat, getScriptPreloadAttrs, getStylesheetHref, resolveManifestAssetLink, resolveManifestCssLink } from "./manifest.js";
@@ -20,4 +21,4 @@ import { retainSearchParams, stripSearchParams } from "./searchMiddleware.js";
 import { createSerializationAdapter, makeSerovalPlugin, makeSsrSerovalPlugin } from "./ssr/serializer/transformer.js";
 import { RawStream, createRawStreamDeserializePlugin, createRawStreamRPCPlugin } from "./ssr/serializer/RawStream.js";
 import { defaultSerovalPlugins } from "./ssr/serializer/seroval-plugins.js";
-export { BaseRootRoute, BaseRoute, BaseRouteApi, DEFAULT_PROTOCOL_ALLOWLIST, DEV_STYLES_ATTR, PathParamError, RawStream, RouterCore, SearchParamError, TSR_DEFERRED_PROMISE, appendUniqueUserTags, buildDevStylesUrl, cleanPath, composeRewrites, createControlledPromise, createInlineCssStyleAsset, createNonReactiveMutableStore, createNonReactiveReadonlyStore, createRawStreamDeserializePlugin, createRawStreamRPCPlugin, createRouterConfig, createSerializationAdapter, decode, deepEqual, defaultGetScrollRestorationKey, defaultParseSearch, defaultSerializeError, defaultSerovalPlugins, defaultStringifySearch, defer, encode, escapeHtml, exactPathTest, executeRewriteInput, functionalUpdate, getAssetCrossOrigin, getElementScrollRestorationEntry, getInitialRouterState, getLocationChangeInfo, getManifestScriptFormat, getMatchedRoutes, getScriptPreloadAttrs, getStylesheetHref, hasKeys, interpolatePath, invariant, isDangerousProtocol, isMatch, isModuleNotFoundError, isNotFound, isPlainArray, isPlainObject, isRedirect, isResolvedRedirect, joinPaths, lazyFn, makeSerovalPlugin, makeSsrSerovalPlugin, notFound, parseRedirect, parseSearchWith, preloadWarning, redirect, removeTrailingSlash, replaceEqualDeep, resolveManifestAssetLink, resolveManifestCssLink, resolvePath, retainSearchParams, rootRouteId, setupScrollRestoration, storageKey, stringifySearchWith, stripSearchParams, trailingSlashOptions, trimPath, trimPathLeft, trimPathRight };
+export { BaseRootRoute, BaseRoute, BaseRouteApi, DEFAULT_PROTOCOL_ALLOWLIST, DEV_STYLES_ATTR, PathParamError, RawStream, RouterCore, SearchParamError, TSR_DEFERRED_PROMISE, _getAssetMatches, _getRenderedMatches, appendUniqueUserTags, buildDevStylesUrl, cleanPath, composeRewrites, createControlledPromise, createInlineCssStyleAsset, createNonReactiveMutableStore, createNonReactiveReadonlyStore, createRawStreamDeserializePlugin, createRawStreamRPCPlugin, createRouterConfig, createSerializationAdapter, decode, deepEqual, defaultGetScrollRestorationKey, defaultParseSearch, defaultSerializeError, defaultSerovalPlugins, defaultStringifySearch, defer, encode, escapeHtml, exactPathTest, executeRewriteInput, functionalUpdate, getAssetCrossOrigin, getElementScrollRestorationEntry, getInitialRouterState, getLocationChangeInfo, getManifestScriptFormat, getScriptPreloadAttrs, getStylesheetHref, hasKeys, interpolatePath, invariant, isDangerousProtocol, isMatch, isModuleNotFoundError, isNotFound, isPlainArray, isPlainObject, isRedirect, isResolvedRedirect, joinPaths, lazyFn, makeSerovalPlugin, makeSsrSerovalPlugin, notFound, parseRedirect, parseSearchWith, preloadWarning, redirect, removeTrailingSlash, replaceEqualDeep, resolveManifestAssetLink, resolveManifestCssLink, resolvePath, retainSearchParams, rootRouteId, setupScrollRestoration, storageKey, stringifySearchWith, stripSearchParams, trailingSlashOptions, trimPath, trimPathLeft, trimPathRight };

package/dist/esm/isServer/client.d.ts

@@ -1 +1,2 @@
 export declare const isServer = false;
+export declare const loadServerRoute: never;

package/dist/esm/isServer/client.js

@@ -1,6 +1,7 @@
 //#region src/isServer/client.ts
 const isServer = false;
+const loadServerRoute = void 0;
 //#endregion
-export { isServer };
+export { isServer, loadServerRoute };
 
 //# sourceMappingURL=client.js.map

package/dist/esm/isServer/client.js.map

@@ -1 +1 @@
-{"version":3,"file":"client.js","names":[],"sources":["../../../src/isServer/client.ts"],"sourcesContent":["export const isServer = false\n"],"mappings":";AAAA,MAAa,WAAW"}
+{"version":3,"file":"client.js","names":[],"sources":["../../../src/isServer/client.ts"],"sourcesContent":["export const isServer = false\nexport const loadServerRoute: never = undefined as never\n"],"mappings":";AAAA,MAAa,WAAW;AACxB,MAAa,kBAAyB,KAAA"}

package/dist/esm/isServer/development.d.ts

@@ -1 +1,2 @@
 export declare const isServer: boolean | undefined;
+export { loadServerRoute } from '../load-server.js';

package/dist/esm/isServer/development.js

@@ -1,6 +1,7 @@
+import { loadServerRoute } from "../load-server.js";
 //#region src/isServer/development.ts
 const isServer = void 0;
 //#endregion
-export { isServer };
+export { isServer, loadServerRoute };
 
 //# sourceMappingURL=development.js.map

package/dist/esm/isServer/development.js.map

@@ -1 +1 @@
-{"version":3,"file":"development.js","names":[],"sources":["../../../src/isServer/development.ts"],"sourcesContent":["// Development/test mode - returns undefined so fallback to router.isServer is used\nexport const isServer: boolean | undefined = undefined\n"],"mappings":";AACA,MAAa,WAAgC,KAAA"}
+{"version":3,"file":"development.js","names":[],"sources":["../../../src/isServer/development.ts"],"sourcesContent":["// Development/test mode - returns undefined so fallback to router.isServer is used\nexport const isServer: boolean | undefined = undefined\nexport { loadServerRoute } from '../load-server'\n"],"mappings":";;AACA,MAAa,WAAgC,KAAA"}

package/dist/esm/isServer/server.d.ts

@@ -1 +1,2 @@
 export declare const isServer: boolean | undefined;
+export { loadServerRoute } from '../load-server.js';

package/dist/esm/isServer/server.js

@@ -1,6 +1,7 @@
+import { loadServerRoute } from "../load-server.js";
 //#region src/isServer/server.ts
 const isServer = process.env.NODE_ENV === "test" ? void 0 : true;
 //#endregion
-export { isServer };
+export { isServer, loadServerRoute };
 
 //# sourceMappingURL=server.js.map

package/dist/esm/isServer/server.js.map

@@ -1 +1 @@
-{"version":3,"file":"server.js","names":[],"sources":["../../../src/isServer/server.ts"],"sourcesContent":["export const isServer = process.env.NODE_ENV === 'test' ? undefined : true\n"],"mappings":";AAAA,MAAa,WAAA,QAAA,IAAA,aAAoC,SAAS,KAAA,IAAY"}
+{"version":3,"file":"server.js","names":[],"sources":["../../../src/isServer/server.ts"],"sourcesContent":["export const isServer = process.env.NODE_ENV === 'test' ? undefined : true\nexport { loadServerRoute } from '../load-server'\n"],"mappings":";;AAAA,MAAa,WAAA,QAAA,IAAA,aAAoC,SAAS,KAAA,IAAY"}

package/dist/esm/load-client.d.ts

@@ -0,0 +1,147 @@
+import { GLOBAL_SEROVAL, GLOBAL_TSR } from './ssr/constants.js';
+import { TsrSsrGlobal } from './ssr/types.js';
+import { ParsedLocation } from './location.js';
+import { AnyRouteMatch } from './Matches.js';
+import { NotFoundError } from './not-found.js';
+import { AnyRoute } from './route.js';
+import { AnyRedirect } from './redirect.js';
+import { AnyRouter } from './router.js';
+export declare function replaceRouteChunk(route: AnyRoute, lazyFn: AnyRoute['lazyFn']): void;
+export declare function loadRouteChunk(route: AnyRoute, componentType?: 'errorComponent' | 'notFoundComponent' | false): Promise<void> | undefined;
+/** Return the structural lane through the first terminal render boundary. */
+export declare function _getRenderedMatches(matches: Array<AnyRouteMatch>): Array<AnyRouteMatch>;
+/** Return the lane whose document assets belong to the current presentation. */
+export declare function _getAssetMatches(matches: Array<AnyRouteMatch>): Array<AnyRouteMatch>;
+declare const lanePhase: unique symbol;
+type LanePhase = 'matched' | 'contextualized' | 'reduced' | 'projected';
+/**
+ * Lane matches carry their lane's phase so functions can demand evidence of
+ * pipeline position (e.g. `commitMatches` only accepts a projected lane's
+ * matches). The brand is phantom — it never exists at runtime.
+ */
+type LaneMatches<TPhase extends LanePhase> = Array<WorkMatch> & {
+    readonly [lanePhase]?: TPhase;
+};
+type Lane<TPhase extends LanePhase> = [
+    location: ParsedLocation,
+    matches: LaneMatches<TPhase>,
+    background?: Array<BackgroundLoaderTask>,
+    backgroundSettlement?: Promise<IndexedOutcome | undefined>
+] & {
+    readonly [lanePhase]?: TPhase;
+};
+type ReducedLane = Lane<'reduced'>;
+type ProjectedLane = Lane<'projected'>;
+declare const SUCCESS = 0;
+declare const ERROR = 1;
+declare const NOT_FOUND = 2;
+declare const REDIRECTED = 3;
+declare const CANCELED = 4;
+type LoaderOutcome = [typeof SUCCESS, data: unknown] | [typeof ERROR, error: unknown] | [typeof NOT_FOUND, error: NotFoundError] | [typeof REDIRECTED, redirect: AnyRedirect] | [typeof CANCELED];
+type IndexedOutcome = [index: number, outcome: LoaderOutcome, boundary?: number];
+export type LoaderFlight = [
+    outcome: Promise<LoaderOutcome>,
+    controller: AbortController,
+    leases: number
+];
+type WorkMatch = AnyRouteMatch & {
+    _flight?: LoaderFlight;
+};
+declare const matchPhase: unique symbol;
+/**
+ * A match whose loader outcome has been applied by `settleInto`, which is the
+ * sole granter of this brand (phantom, zero-runtime). Consumers that require
+ * it — e.g. `cacheLoaderMatch` — can only be reached after settlement, so the
+ * compiler enforces the loader→settle→cache ordering. Sources that arrive
+ * already settled (dehydrated server data) must cast at a named boundary.
+ */
+type SettledMatch = WorkMatch & {
+    readonly [matchPhase]: 'settled';
+};
+export type LaneInputs = [
+    routeTree: AnyRoute,
+    context: unknown,
+    additionalContext: unknown,
+    state: object,
+    search: object,
+    maskedLocation: [
+        href: string,
+        state: object,
+        search: object,
+        unmaskOnReload: boolean | undefined
+    ] | undefined
+];
+export type ActivePreload = [
+    matches: Array<AnyRouteMatch>,
+    controller: AbortController,
+    result: Promise<LaneResult>,
+    semanticOwner: Array<AnyRouteMatch>,
+    inputs: LaneInputs,
+    redirects: number
+];
+export type LoadTransaction = [
+    controller: AbortController,
+    redirects: number,
+    location: ParsedLocation,
+    matches: Array<AnyRouteMatch>,
+    startedAt: number,
+    done: Promise<void>,
+    /**
+     * Dev-only HMR refresh mode. Presence is the mode flag; a refresh always
+     * carries the presentation it started from, while the hydration handoff is
+     * genuinely optional — the tuple makes a half-armed refresh unrepresentable.
+     */
+    refresh?: [
+        presentation: Array<AnyRouteMatch>,
+        handoff: NonNullable<AnyRouter['_handoff']> | undefined
+    ]
+];
+export type PendingSession = [
+    owner: LoadTransaction,
+    boundary: number,
+    /** Pending reveal time until acknowledged, then minimum-visible-until time. */
+    deadline: number,
+    timer?: ReturnType<typeof setTimeout>,
+    ack?: Promise<boolean>,
+    component?: unknown
+];
+type CoordinatorRouter = AnyRouter & {
+    /** Whole speculative lanes that a matching navigation may adopt. */
+    _preloads?: Map<string, ActivePreload>;
+    _refreshNextLoad?: boolean;
+    _rollbackRefresh?: () => void;
+    _cancelTransition?: () => void;
+};
+type BackgroundLoaderTask = [
+    index: number,
+    outcome: Promise<LoaderOutcome>,
+    ready: Promise<IndexedOutcome | undefined>,
+    candidate: WorkMatch
+];
+type ControlOutcome = [typeof REDIRECTED, redirect: AnyRedirect] | [typeof CANCELED];
+type LaneResult = ProjectedLane | ControlOutcome;
+export declare function waitFor<T>(value: T | PromiseLike<T>, signal: AbortSignal): Promise<T>;
+export declare function getRoute(router: AnyRouter, match: WorkMatch): AnyRoute;
+export declare function navigateFrom(router: AnyRouter, location: ParsedLocation): (opts: any) => Promise<void>;
+export declare function laneInputs(router: AnyRouter, location: ParsedLocation): LaneInputs;
+/**
+ * Not passing in a `next` ownership recipient
+ * is equivalent to discarding the match resources
+ */
+export declare function transferMatchResources(router: AnyRouter, previous: Array<AnyRouteMatch>, next?: Array<AnyRouteMatch>): void;
+export declare function cacheLoaderMatch(router: CoordinatorRouter, match: SettledMatch, planned: AnyRouteMatch | undefined): void;
+export declare function projectLane(router: AnyRouter, lane: ReducedLane, signal: AbortSignal, start?: number, end?: number): Promise<ProjectedLane>;
+export declare function loadClientRoute(router: CoordinatorRouter, opts?: {
+    sync?: boolean;
+    _dedupe?: boolean;
+}): Promise<void>;
+export declare function refreshClientRoute(router: CoordinatorRouter): Promise<void>;
+export declare function preloadClientRoute(router: CoordinatorRouter, opts: any, redirects?: number): Promise<Array<AnyRouteMatch> | undefined>;
+declare global {
+    interface Window {
+        [GLOBAL_TSR]?: TsrSsrGlobal;
+        [GLOBAL_SEROVAL]?: any;
+    }
+}
+export declare function hydrate(router: AnyRouter): Promise<void>;
+export {};