vinext 1.4.1 → 1.4.3

package/dist/shims/slot.js

@@ -1,6 +1,6 @@
 "use client";
 import { APP_BFCACHE_SEGMENT_IDENTITIES_KEY, AppElementsWire, UNMATCHED_SLOT } from "../server/app-elements-wire.js";
-import "../server/app-elements.js";
+import { readOptimisticStateKeyRebinder } from "../server/app-elements.js";
 import { isNestedBfcacheSlotSegmentId, isNestedBfcacheSlotSegmentIdFor } from "../server/bfcache-identity.js";
 import { notFound } from "./navigation-errors.js";
 import { getBfcacheIdMapContext, getBfcacheSegmentIdContext } from "./navigation-context-state.js";
@@ -51,6 +51,25 @@ const BfcacheSegmentIdContext = getBfcacheSegmentIdContext();
 const EMPTY_BFCACHE_STATE_KEYS = Object.freeze({});
 const MAX_BFCACHE_SLOT_ENTRIES_WITH_CACHE_COMPONENTS = 3;
 const MAX_BFCACHE_SLOT_ENTRIES_WITHOUT_CACHE_COMPONENTS = 1;
+const rootBfcacheRetainedKeysReports = /* @__PURE__ */ new Map();
+function isBfcacheIdentityRetained(identity) {
+	return hasBfcacheRetainedKey(rootBfcacheRetainedKeysReports, identity);
+}
+function hasBfcacheRetainedKey(reports, identity) {
+	for (const report of reports.values()) {
+		if (report.keys.includes(identity) || report.hiddenKeys.includes(identity)) return true;
+		if (hasBfcacheRetainedKey(report.activeReports, identity)) return true;
+	}
+	return false;
+}
+const BfcacheRetainedKeysContext = React$1.createContext(rootBfcacheRetainedKeysReports);
+function collectBfcacheRetainedKeys(reports, keys) {
+	for (const report of reports.values()) {
+		for (const key of report.keys) keys.add(key);
+		for (const key of report.hiddenKeys) keys.add(key);
+		collectBfcacheRetainedKeys(report.activeReports, keys);
+	}
+}
 const BfcacheIdentityMapContext = React$1.createContext(EMPTY_BFCACHE_STATE_KEYS);
 function isCacheComponentsEnabled() {
 	return String(process.env.__NEXT_CACHE_COMPONENTS) === "true";
@@ -136,34 +155,71 @@ function warnTransportMetadataEntry(id) {
 * falling back to the live boundary values for entries that predate per-entry
 * capture.
 */
-function BfcacheEntryProviders({ entry, fallbackElements, fallbackSegmentId, fallbackStateKeyMap, SegmentContext }) {
+function BfcacheEntryProviders({ entry, fallbackElements, fallbackSegmentId, fallbackStateKeyMap, retainedKeysReports, SegmentContext }) {
 	return /* @__PURE__ */ jsx(BfcacheIdentityMapContext.Provider, {
 		value: entry.stateKeyMap ?? fallbackStateKeyMap,
 		children: /* @__PURE__ */ jsx(ElementsContext.Provider, {
 			value: entry.elements ?? fallbackElements,
 			children: /* @__PURE__ */ jsx(SegmentContext.Provider, {
 				value: entry.segmentId ?? fallbackSegmentId,
-				children: entry.content
+				children: /* @__PURE__ */ jsx(BfcacheRetainedKeysContext.Provider, {
+					value: retainedKeysReports,
+					children: entry.content
+				})
 			})
 		})
 	});
 }
-function useBfcacheSlotEntries(activeEntry) {
+function useBfcacheSlotEntries(listId, activeEntry) {
 	const snapshotsByStateKey = React$1.useRef(/* @__PURE__ */ new Map());
 	const [entryOrder, setEntryOrder] = React$1.useState(() => [activeEntry.stateKey]);
+	const [retainedKeysReportsByStateKey] = React$1.useState(() => /* @__PURE__ */ new Map());
+	const getRetainedKeysReports = (stateKey) => {
+		let reports = retainedKeysReportsByStateKey.get(stateKey);
+		if (!reports) {
+			reports = /* @__PURE__ */ new Map();
+			retainedKeysReportsByStateKey.set(stateKey, reports);
+		}
+		return reports;
+	};
 	const committedSnapshots = snapshotsByStateKey.current;
 	const staged = stageBfcacheSlotEntryForRender(committedSnapshots, entryOrder, activeEntry);
+	for (const [index, entry] of staged.entries.entries()) {
+		if (entry.stateKey === activeEntry.stateKey || entry.retainedKeys) continue;
+		const retainedKeys = /* @__PURE__ */ new Set([entry.stateKey]);
+		collectBfcacheRetainedKeys(getRetainedKeysReports(entry.stateKey), retainedKeys);
+		const hiddenEntry = {
+			...entry,
+			retainedKeys: [...retainedKeys]
+		};
+		staged.entries[index] = hiddenEntry;
+		staged.snapshots.set(entry.stateKey, hiddenEntry);
+	}
 	const nextOrder = staged.order;
 	const orderChanged = !haveSameBfcacheSlotEntryOrder(entryOrder, nextOrder);
 	React$1.useLayoutEffect(() => {
 		snapshotsByStateKey.current = staged.snapshots;
-	}, [staged.snapshots]);
+		for (const stateKey of retainedKeysReportsByStateKey.keys()) if (!staged.snapshots.has(stateKey)) retainedKeysReportsByStateKey.delete(stateKey);
+	}, [retainedKeysReportsByStateKey, staged.snapshots]);
+	const hiddenKeys = [...new Set(staged.entries.flatMap((entry) => entry.retainedKeys ?? []))];
+	const enclosingReports = React$1.useContext(BfcacheRetainedKeysContext);
+	const report = {
+		activeReports: getRetainedKeysReports(activeEntry.stateKey),
+		hiddenKeys,
+		keys: staged.entries.map((entry) => entry.stateKey)
+	};
+	React$1.useLayoutEffect(() => {
+		enclosingReports.set(listId, report);
+	});
 	if (process.env.NODE_ENV !== "production" && !staged.snapshots.has(activeEntry.stateKey)) throw new Error("BFCache Activity slot is missing the active entry snapshot");
 	if (orderChanged) setEntryOrder(nextOrder);
-	return staged.entries;
+	return {
+		entries: staged.entries,
+		getRetainedKeysReports
+	};
 }
 function BfcacheActivitySlotBoundary({ activeStateKey, content, elements, id, SegmentContext, stateKeyMap }) {
-	const renderEntries = useBfcacheSlotEntries({
+	const { entries: renderEntries, getRetainedKeysReports } = useBfcacheSlotEntries(id, {
 		content,
 		elements,
 		segmentId: id,
@@ -177,6 +233,7 @@ function BfcacheActivitySlotBoundary({ activeStateKey, content, elements, id, Se
 			fallbackElements: elements,
 			fallbackSegmentId: id,
 			fallbackStateKeyMap: stateKeyMap,
+			retainedKeysReports: getRetainedKeysReports(entry.stateKey),
 			SegmentContext
 		})
 	}, entry.stateKey)) });
@@ -228,7 +285,8 @@ function BfcacheChildrenActivityBoundary({ children, id, IdMapContext, SegmentCo
 	const identityMap = React$1.useContext(BfcacheIdentityMapContext);
 	const bfcacheIdMap = React$1.useContext(IdMapContext);
 	const segmentId = React$1.useContext(SegmentContext);
-	const activeStateKey = stateKey ?? (id === void 0 ? void 0 : resolveBfcacheSegmentStateKey(id, identityMap, bfcacheIdMap));
+	const rebindStateKey = readOptimisticStateKeyRebinder(elements);
+	const activeStateKey = stateKey !== void 0 ? rebindStateKey?.(stateKey) ?? stateKey : id === void 0 ? void 0 : resolveBfcacheSegmentStateKey(id, identityMap, bfcacheIdMap);
 	if (segmentId === null || activeStateKey === void 0) return /* @__PURE__ */ jsx(Fragment$1, { children });
 	return /* @__PURE__ */ jsx(BfcacheActivitySlotBoundary, {
 		activeStateKey,
@@ -375,4 +433,4 @@ function ParallelSlot({ name }) {
 	return React$1.useContext(ParallelSlotsContext)?.[name] ?? null;
 }
 //#endregion
-export { BfcacheChildrenBoundary, BfcacheIdentityMapContext, BfcacheSegmentBoundary, Children, ChildrenContext, ElementsContext, ParallelSlot, ParallelSlotsContext, RenderedSearchContext, Slot, UNMATCHED_SLOT, bindAppElementsRenderedSearch, getNonCacheComponentsSegmentKey, mergeElements, resolveBfcacheSegmentStateKey, setAppElementsRenderedSearch, stageBfcacheSlotEntryForRender, updateBfcacheSlotEntryOrder };
+export { BfcacheChildrenBoundary, BfcacheIdentityMapContext, BfcacheSegmentBoundary, Children, ChildrenContext, ElementsContext, ParallelSlot, ParallelSlotsContext, RenderedSearchContext, Slot, UNMATCHED_SLOT, bindAppElementsRenderedSearch, getNonCacheComponentsSegmentKey, isBfcacheIdentityRetained, mergeElements, resolveBfcacheSegmentStateKey, setAppElementsRenderedSearch, stageBfcacheSlotEntryForRender, updateBfcacheSlotEntryOrder };

package/dist/shims/url-utils.js

@@ -115,12 +115,17 @@ function normalizePathTrailingSlash(path, trailingSlash) {
 	if (!path.startsWith("/") || path.startsWith("//") || process.env.__VINEXT_MANUAL_TRAILING_SLASH === "true") return path;
 	const { pathname, query, hash } = parsePath(path);
 	if (trailingSlash) {
-		if (/\.[^/]+\/?$/.test(pathname)) return `${removeRouteTrailingSlash(pathname)}${query}${hash}`;
+		if (hasFileLikeLastSegment(pathname)) return `${removeRouteTrailingSlash(pathname)}${query}${hash}`;
 		if (pathname.endsWith("/")) return `${pathname}${query}${hash}`;
 		return `${pathname}/${query}${hash}`;
 	}
 	return `${removeRouteTrailingSlash(pathname)}${query}${hash}`;
 }
+function hasFileLikeLastSegment(pathname) {
+	const end = pathname.endsWith("/") ? pathname.length - 1 : pathname.length;
+	const dot = pathname.indexOf(".", pathname.lastIndexOf("/", end - 1) + 1);
+	return dot !== -1 && dot < end - 1;
+}
 /**
 * Prepend basePath to a local path for browser URLs / fetches.
 */

package/dist/utils/base-path.d.ts

@@ -21,6 +21,13 @@ export declare function stripBasePath(pathname: string, basePath: string): strin
  * this pathname-only helper.
  */
 export declare function addBasePathToPathname(pathname: string, basePath: string | undefined): string;
+/**
+ * Re-add a basePath that `stripBasePath` removed. Unlike
+ * `addBasePathToPathname`, this always prepends it: a stripped route whose
+ * first segment equals the basePath (basePath "/docs", route "/docs/a") still
+ * starts with the basePath and must not be mistaken for the original URL.
+ */
+export declare function restoreBasePath(pathname: string, basePath: string | undefined): string;
 /**
  * Remove trailing slashes from a pathname while preserving the root "/".
  * Collapses any number of trailing slashes ("/a//" → "/a"). Used by the

package/dist/utils/base-path.js

@@ -31,6 +31,16 @@ function addBasePathToPathname(pathname, basePath) {
 	return pathname === "/" ? basePath : `${basePath}${pathname}`;
 }
 /**
+* Re-add a basePath that `stripBasePath` removed. Unlike
+* `addBasePathToPathname`, this always prepends it: a stripped route whose
+* first segment equals the basePath (basePath "/docs", route "/docs/a") still
+* starts with the basePath and must not be mistaken for the original URL.
+*/
+function restoreBasePath(pathname, basePath) {
+	if (!basePath) return pathname;
+	return pathname === "/" ? basePath : `${basePath}${pathname}`;
+}
+/**
 * Remove trailing slashes from a pathname while preserving the root "/".
 * Collapses any number of trailing slashes ("/a//" → "/a"). Used by the
 * trailing-slash redirect path and route pattern normalization.
@@ -42,4 +52,4 @@ function removeTrailingSlash(pathname) {
 	return end === 0 ? "/" : pathname.slice(0, end);
 }
 //#endregion
-export { addBasePathToPathname, hasBasePath, removeTrailingSlash, stripBasePath };
+export { addBasePathToPathname, hasBasePath, removeTrailingSlash, restoreBasePath, stripBasePath };

package/dist/utils/client-entry-manifest.d.ts

@@ -11,6 +11,11 @@ export declare const VINEXT_CLIENT_REFERENCE_SOURCES = ".vite/vinext-client-refe
 export type ClientEntryManifest = {
   pagesClientEntry?: string;
   appBrowserEntry?: string;
+  /**
+   * The chunk holding the App Router browser runtime, whose evaluation starts
+   * hydration. A user chunk group can move it out of `appBrowserEntry`.
+   */
+  appBrowserRuntime?: string;
   /** The App Router RouteManifest chunk, which the browser entry imports as it boots. */
   appRouteManifest?: string;
   /** What each App Router client reference loads in the browser. */

package/dist/utils/client-entry-manifest.js

@@ -20,6 +20,7 @@ function readClientEntryManifest(clientDir) {
 		const manifest = {};
 		if (typeof value.pagesClientEntry === "string") manifest.pagesClientEntry = value.pagesClientEntry;
 		if (typeof value.appBrowserEntry === "string") manifest.appBrowserEntry = value.appBrowserEntry;
+		if (typeof value.appBrowserRuntime === "string") manifest.appBrowserRuntime = value.appBrowserRuntime;
 		if (typeof value.appRouteManifest === "string") manifest.appRouteManifest = value.appRouteManifest;
 		if (isUnknownRecord(value.appClientReferenceChunks)) manifest.appClientReferenceChunks = value.appClientReferenceChunks;
 		return manifest.pagesClientEntry || manifest.appBrowserEntry ? manifest : void 0;

package/dist/utils/client-runtime-metadata.d.ts

@@ -3,6 +3,7 @@ import { ClientReferenceChunks } from "./client-reference-chunks.js";
 type ClientRuntimeMetadata = {
   clientEntryFile?: string;
   appBootstrapPreinitModules?: string[];
+  appBootstrapPreloadModules?: string[];
   appRouteManifestModule?: string;
   appClientReferenceChunks?: ClientReferenceChunks;
   cssGraph?: Record<string, {
@@ -17,6 +18,10 @@ type ClientRuntimeMetadata = {
  * Read the client build manifest and compute runtime metadata used by
  * Cloudflare worker entry injection and Node production server startup.
  *
+ * - `appBootstrapPreinitModules` — chunks the App Router browser entry imports,
+ *   preinitialized during SSR.
+ * - `appBootstrapPreloadModules` — those of them that would start hydration if
+ *   evaluated ahead of the shell, preloaded during SSR instead.
  * - `appRouteManifestModule` — the App Router RouteManifest chunk, which the
  *   browser entry imports as it boots, preloaded during SSR.
  * - `appClientReferenceChunks` — what each App Router client reference loads

package/dist/utils/client-runtime-metadata.js

@@ -41,11 +41,28 @@ function collectCssGraph(buildManifest, applyBase) {
 	}
 	return Object.keys(cssGraph).length > 0 ? cssGraph : void 0;
 }
-function collectAppBootstrapPreinitModules(buildManifest, appBrowserEntry, applyBase) {
-	if (!appBrowserEntry) return void 0;
+/**
+* The chunks the App Router browser entry statically imports, split by whether
+* they can run ahead of the shell. A preinitialized module evaluates as soon as
+* it loads, which on a reload can be before `<body>` has streamed. Evaluating
+* the browser runtime starts hydration, so a chunk that holds or imports it is
+* only preloaded, and runs when React's bootstrap script does. A user chunk
+* group can put the runtime in one of these chunks.
+*/
+function collectAppBootstrapModules(buildManifest, appBrowserEntry, appBrowserRuntime, applyBase) {
+	if (!appBrowserEntry) return {};
 	const entryKey = Object.keys(buildManifest).find((key) => buildManifest[key].file === appBrowserEntry);
-	if (!entryKey) return void 0;
-	const modules = [];
+	if (!entryKey) return {};
+	function evaluatesRuntime(key, seen = /* @__PURE__ */ new Set()) {
+		if (seen.has(key)) return false;
+		seen.add(key);
+		const chunk = buildManifest[key];
+		if (!chunk) return false;
+		if (chunk.file === appBrowserRuntime) return true;
+		return (chunk.imports ?? []).some((importedKey) => evaluatesRuntime(importedKey, seen));
+	}
+	const preinit = [];
+	const preload = [];
 	const seenFiles = /* @__PURE__ */ new Set();
 	const visitedChunks = /* @__PURE__ */ new Set();
 	function visit(key) {
@@ -57,18 +74,25 @@ function collectAppBootstrapPreinitModules(buildManifest, appBrowserEntry, apply
 			const importedChunk = buildManifest[importedKey];
 			if (importedChunk?.file.endsWith(".js") && !seenFiles.has(importedChunk.file)) {
 				seenFiles.add(importedChunk.file);
-				modules.push(applyBase(importedChunk.file));
+				(evaluatesRuntime(importedKey) ? preload : preinit).push(applyBase(importedChunk.file));
 			}
 			visit(importedKey);
 		}
 	}
 	visit(entryKey);
-	return modules.length > 0 ? modules : void 0;
+	return {
+		...preinit.length > 0 ? { preinit } : {},
+		...preload.length > 0 ? { preload } : {}
+	};
 }
 /**
 * Read the client build manifest and compute runtime metadata used by
 * Cloudflare worker entry injection and Node production server startup.
 *
+* - `appBootstrapPreinitModules` — chunks the App Router browser entry imports,
+*   preinitialized during SSR.
+* - `appBootstrapPreloadModules` — those of them that would start hydration if
+*   evaluated ahead of the shell, preloaded during SSR instead.
 * - `appRouteManifestModule` — the App Router RouteManifest chunk, which the
 *   browser entry imports as it boots, preloaded during SSR.
 * - `appClientReferenceChunks` — what each App Router client reference loads
@@ -118,7 +142,9 @@ function computeClientRuntimeMetadata(opts) {
 		metadata.cssGraph = collectCssGraph(buildManifest, (file) => manifestFileWithBase(file, opts.assetBase));
 		metadata.sharedChunks = collectSharedChunkFiles(buildManifest, (file) => manifestFileWithBase(file, opts.assetBase));
 	}
-	metadata.appBootstrapPreinitModules = collectAppBootstrapPreinitModules(buildManifest, clientEntryManifest?.appBrowserEntry, appAssetUrl);
+	const appBootstrapModules = collectAppBootstrapModules(buildManifest, clientEntryManifest?.appBrowserEntry, clientEntryManifest?.appBrowserRuntime, appAssetUrl);
+	metadata.appBootstrapPreinitModules = appBootstrapModules.preinit;
+	metadata.appBootstrapPreloadModules = appBootstrapModules.preload;
 	if (clientEntryManifest?.appRouteManifest) metadata.appRouteManifestModule = appAssetUrl(clientEntryManifest.appRouteManifest);
 	const lazyChunks = computeLazyChunks(buildManifest).map((file) => manifestFileWithBase(file, opts.assetBase));
 	if (lazyChunks.length > 0) metadata.lazyChunks = lazyChunks;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vinext",
-  "version": "1.4.1",
+  "version": "1.4.3",
   "description": "Run Next.js apps on Vite. Drop-in replacement for the next CLI.",
   "homepage": "https://vinext.dev/",
   "license": "MIT",